Merge pull request #47 from spryker-middleware/bugfix/interfaces

Fix api annotations.
spryker-middleware · Sep 7, 2018 · d5f23d2 · d5f23d2
2 parents 2e592af + 7a744ef
commit d5f23d2
Show file tree

Hide file tree

Showing 73 changed files with 315 additions and 20 deletions.
diff --git a/src/SprykerMiddleware/Service/Process/Model/StreamService.php b/src/SprykerMiddleware/Service/Process/Model/StreamService.php
@@ -15,8 +15,6 @@ class StreamService implements StreamServiceInterface
     /**
      * Stream service
      *
-     * @api
-     *
      * @param \SprykerMiddleware\Shared\Process\Stream\ReadStreamInterface $stream
      *
      * @return mixed
@@ -29,8 +27,6 @@ public function read(ReadStreamInterface $stream)
     /**
      * Stream service
      *
-     * @api
-     *
      * @param \SprykerMiddleware\Shared\Process\Stream\WriteStreamInterface $stream
      * @param array $data
      *

diff --git a/src/SprykerMiddleware/Service/Process/Model/StreamServiceInterface.php b/src/SprykerMiddleware/Service/Process/Model/StreamServiceInterface.php
@@ -15,8 +15,6 @@ interface StreamServiceInterface
     /**
      * Stream service interface.
      *
-     * @api
-     *
      * @param \SprykerMiddleware\Shared\Process\Stream\ReadStreamInterface $stream
      *
      * @return mixed
@@ -26,8 +24,6 @@ public function read(ReadStreamInterface $stream);
     /**
      * Stream service interface.
      *
-     * @api
-     *
      * @param \SprykerMiddleware\Shared\Process\Stream\WriteStreamInterface $stream
      * @param mixed $data
      *

diff --git a/src/SprykerMiddleware/Service/Process/ProcessService.php b/src/SprykerMiddleware/Service/Process/ProcessService.php
@@ -19,8 +19,6 @@ class ProcessService extends AbstractService implements ProcessServiceInterface
     /**
      * {@inheritdoc}
      *
-     * @api
-     *
      * @param \SprykerMiddleware\Shared\Process\Stream\ReadStreamInterface $stream
      *
      * @return mixed
@@ -35,7 +33,6 @@ public function read(ReadStreamInterface $stream)
     /**
      * {@inheritdoc}
      *
-     * @api
      *
      * @param \SprykerMiddleware\Shared\Process\Stream\WriteStreamInterface $stream
      * @param mixed $data

diff --git a/src/SprykerMiddleware/Service/Process/ProcessServiceInterface.php b/src/SprykerMiddleware/Service/Process/ProcessServiceInterface.php
@@ -16,8 +16,6 @@ interface ProcessServiceInterface
      * Specification:
      * - Read data from given stream.
      *
-     * @api
-     *
      * @param \SprykerMiddleware\Shared\Process\Stream\ReadStreamInterface $stream
      *
      * @return mixed
@@ -28,8 +26,6 @@ public function read(ReadStreamInterface $stream);
      * Specification:
      * - Write given data to given stream.
      *
-     * @api
-     *
      * @param \SprykerMiddleware\Shared\Process\Stream\WriteStreamInterface $stream
      * @param mixed $data
      *

diff --git a/...ware/Zed/Process/Communication/Plugin/Configuration/DefaultConfigurationProfilePlugin.php b/...ware/Zed/Process/Communication/Plugin/Configuration/DefaultConfigurationProfilePlugin.php
@@ -17,6 +17,8 @@
 class DefaultConfigurationProfilePlugin extends AbstractPlugin implements ConfigurationProfilePluginInterface
 {
     /**
+     * @api
+     *
      * @return \SprykerMiddleware\Zed\Process\Dependency\Plugin\Configuration\ProcessConfigurationPluginInterface[]
      */
     public function getProcessConfigurationPlugins(): array
@@ -26,6 +28,8 @@ public function getProcessConfigurationPlugins(): array
     }
 
     /**
+     * @api
+     *
      * @return \SprykerMiddleware\Zed\Process\Dependency\Plugin\TranslatorFunction\TranslatorFunctionPluginInterface[]
      */
     public function getTranslatorFunctionPlugins(): array
@@ -35,6 +39,8 @@ public function getTranslatorFunctionPlugins(): array
     }
 
     /**
+     * @api
+     *
      * @return \SprykerMiddleware\Zed\Process\Dependency\Plugin\Validator\ValidatorPluginInterface[]
      */
     public function getValidatorPlugins(): array

diff --git a/src/SprykerMiddleware/Zed/Process/Communication/Plugin/Handler/StdErrStreamHandlerPlugin.php b/src/SprykerMiddleware/Zed/Process/Communication/Plugin/Handler/StdErrStreamHandlerPlugin.php
@@ -37,6 +37,8 @@ protected function getHandler(): AbstractHandler
     }
 
     /**
+     * @api
+     *
      * @param array $record
      *
      * @return bool
@@ -47,6 +49,8 @@ public function isHandling(array $record): bool
     }
 
     /**
+     * @api
+     *
      * @param array $record
      *
      * @return bool
@@ -57,6 +61,8 @@ public function handle(array $record): bool
     }
 
     /**
+     * @api
+     *
      * @param array $records
      *
      * @return void
@@ -67,6 +73,8 @@ public function handleBatch(array $records): void
     }
 
     /**
+     * @api
+     *
      * @param callable $callback
      *
      * @return \Monolog\Handler\HandlerInterface
@@ -77,6 +85,8 @@ public function pushProcessor($callback): HandlerInterface
     }
 
     /**
+     * @api
+     *
      * @return callable
      */
     public function popProcessor(): callable
@@ -85,6 +95,8 @@ public function popProcessor(): callable
     }
 
     /**
+     * @api
+     *
      * @param \Monolog\Formatter\FormatterInterface $formatter
      *
      * @return \Monolog\Handler\HandlerInterface
@@ -95,6 +107,8 @@ public function setFormatter(FormatterInterface $formatter): HandlerInterface
     }
 
     /**
+     * @api
+     *
      * @return \Monolog\Formatter\FormatterInterface
      */
     public function getFormatter(): FormatterInterface
@@ -103,6 +117,8 @@ public function getFormatter(): FormatterInterface
     }
 
     /**
+     * @api
+     *
      * @param int|string $level
      *
      * @return \Monolog\Handler\HandlerInterface

diff --git a/...rykerMiddleware/Zed/Process/Communication/Plugin/Iterator/JsonDirectoryIteratorPlugin.php b/...rykerMiddleware/Zed/Process/Communication/Plugin/Iterator/JsonDirectoryIteratorPlugin.php
@@ -22,6 +22,8 @@ class JsonDirectoryIteratorPlugin extends AbstractPlugin implements ProcessItera
     protected const PLUGIN_NAME = 'JsonDirectoryIteratorPlugin';
 
     /**
+     * @api
+     *
      * @param \SprykerMiddleware\Shared\Process\Stream\ReadStreamInterface $inStream
      * @param \Generated\Shared\Transfer\IteratorConfigTransfer $iteratorConfigTransfer
      *
@@ -35,6 +37,8 @@ public function getIterator(ReadStreamInterface $inStream, IteratorConfigTransfe
     }
 
     /**
+     * @api
+     *
      * @return string
      */
     public function getName(): string

diff --git a/src/SprykerMiddleware/Zed/Process/Communication/Plugin/Iterator/NullIteratorPlugin.php b/src/SprykerMiddleware/Zed/Process/Communication/Plugin/Iterator/NullIteratorPlugin.php
@@ -22,6 +22,8 @@ class NullIteratorPlugin extends AbstractPlugin implements ProcessIteratorPlugin
     protected const PLUGIN_NAME = 'NullIteratorPlugin';
 
     /**
+     * @api
+     *
      * @param \SprykerMiddleware\Shared\Process\Stream\ReadStreamInterface $inStream
      * @param \Generated\Shared\Transfer\IteratorConfigTransfer $iteratorConfigTransfer
      *
@@ -35,6 +37,8 @@ public function getIterator(ReadStreamInterface $inStream, IteratorConfigTransfe
     }
 
     /**
+     * @api
+     *
      * @return string
      */
     public function getName(): string

diff --git a/src/SprykerMiddleware/Zed/Process/Communication/Plugin/Log/MiddlewareLoggerConfigPlugin.php b/src/SprykerMiddleware/Zed/Process/Communication/Plugin/Log/MiddlewareLoggerConfigPlugin.php
@@ -25,6 +25,8 @@ class MiddlewareLoggerConfigPlugin extends AbstractPlugin implements MiddlewareL
     protected $handlers;
 
     /**
+     * @api
+     *
      * @return string
      */
     public function getChannelName(): string
@@ -33,6 +35,8 @@ public function getChannelName(): string
     }
 
     /**
+     * @api
+     *
      * @return \Monolog\Handler\AbstractHandler[]
      */
     public function getHandlers(): array
@@ -45,6 +49,8 @@ public function getHandlers(): array
     }
 
     /**
+     * @api
+     *
      * @return callable[]
      */
     public function getProcessors(): array
@@ -55,6 +61,8 @@ public function getProcessors(): array
     /**
      * Sets minimum logging level at which all handlers will be triggered.
      *
+     * @api
+     *
      * @param int|string $level Level or level name
      *
      * @return void
@@ -68,6 +76,8 @@ public function changeLogLevel($level): void
     }
 
     /**
+     * @api
+     *
      * @return string
      */
     public function getName(): string

diff --git a/src/SprykerMiddleware/Zed/Process/Communication/Plugin/MapRule/ArrayMapRulePlugin.php b/src/SprykerMiddleware/Zed/Process/Communication/Plugin/MapRule/ArrayMapRulePlugin.php
@@ -18,6 +18,8 @@
 class ArrayMapRulePlugin extends AbstractPlugin implements MapRulePluginInterface
 {
     /**
+     * @api
+     *
      * @param array $result
      * @param array $payload
      * @param string $key
@@ -32,6 +34,8 @@ public function map(array $result, array $payload, string $key, $value, string $
     }
 
     /**
+     * @api
+     *
      * @param string $key
      * @param mixed $value
      *

diff --git a/src/SprykerMiddleware/Zed/Process/Communication/Plugin/MapRule/ClosureMapRulePlugin.php b/src/SprykerMiddleware/Zed/Process/Communication/Plugin/MapRule/ClosureMapRulePlugin.php
@@ -18,6 +18,8 @@
 class ClosureMapRulePlugin extends AbstractPlugin implements MapRulePluginInterface
 {
     /**
+     * @api
+     *
      * @param array $result
      * @param array $payload
      * @param string $key
@@ -32,6 +34,8 @@ public function map(array $result, array $payload, string $key, $value, string $
     }
 
     /**
+     * @api
+     *
      * @param string $key
      * @param mixed $value
      *

diff --git a/src/SprykerMiddleware/Zed/Process/Communication/Plugin/MapRule/DynamicArrayMapRulePlugin.php b/src/SprykerMiddleware/Zed/Process/Communication/Plugin/MapRule/DynamicArrayMapRulePlugin.php
@@ -21,6 +21,8 @@ class DynamicArrayMapRulePlugin extends AbstractPlugin implements MapRulePluginI
     use MiddlewareLoggerTrait;
 
     /**
+     * @api
+     *
      * @param array $result
      * @param array $payload
      * @param string $key
@@ -35,6 +37,8 @@ public function map(array $result, array $payload, string $key, $value, string $
     }
 
     /**
+     * @api
+     *
      * @param string $key
      * @param mixed $value
      *

diff --git a/src/SprykerMiddleware/Zed/Process/Communication/Plugin/MapRule/DynamicMapRulePlugin.php b/src/SprykerMiddleware/Zed/Process/Communication/Plugin/MapRule/DynamicMapRulePlugin.php
@@ -17,6 +17,8 @@
 class DynamicMapRulePlugin extends AbstractPlugin implements MapRulePluginInterface
 {
     /**
+     * @api
+     *
      * @param array $result
      * @param array $payload
      * @param string $key
@@ -31,6 +33,8 @@ public function map(array $result, array $payload, string $key, $value, string $
     }
 
     /**
+     * @api
+     *
      * @param string $key
      * @param mixed $value
      *

diff --git a/src/SprykerMiddleware/Zed/Process/Communication/Plugin/MapRule/KeyMapRulePlugin.php b/src/SprykerMiddleware/Zed/Process/Communication/Plugin/MapRule/KeyMapRulePlugin.php
@@ -17,6 +17,8 @@
 class KeyMapRulePlugin extends AbstractPlugin implements MapRulePluginInterface
 {
     /**
+     * @api
+     *
      * @param array $result
      * @param array $payload
      * @param string $key
@@ -31,6 +33,8 @@ public function map(array $result, array $payload, string $key, $value, string $
     }
 
     /**
+     * @api
+     *
      * @param string $key
      * @param mixed $value
      *

diff --git a/...kerMiddleware/Zed/Process/Communication/Plugin/Processor/IntrospectionProcessorPlugin.php b/...kerMiddleware/Zed/Process/Communication/Plugin/Processor/IntrospectionProcessorPlugin.php
@@ -18,6 +18,8 @@
 class IntrospectionProcessorPlugin extends AbstractPlugin implements LogProcessorPluginInterface
 {
     /**
+     * @api
+     *
      * @param array $data
      *
      * @return array

diff --git a/src/SprykerMiddleware/Zed/Process/Communication/Plugin/Stream/CsvInputStreamPlugin.php b/src/SprykerMiddleware/Zed/Process/Communication/Plugin/Stream/CsvInputStreamPlugin.php
@@ -20,6 +20,8 @@ class CsvInputStreamPlugin extends AbstractPlugin implements InputStreamPluginIn
     protected const PLUGIN_NAME = 'CsvInputStreamPlugin';
 
     /**
+     * @api
+     *
      * @return string
      */
     public function getName(): string
@@ -28,6 +30,8 @@ public function getName(): string
     }
 
     /**
+     * @api
+     *
      * @param string $path
      *
      * @return \SprykerMiddleware\Shared\Process\Stream\ReadStreamInterface

diff --git a/src/SprykerMiddleware/Zed/Process/Communication/Plugin/Stream/CsvOutputStreamPlugin.php b/src/SprykerMiddleware/Zed/Process/Communication/Plugin/Stream/CsvOutputStreamPlugin.php
@@ -20,6 +20,8 @@ class CsvOutputStreamPlugin extends AbstractPlugin implements OutputStreamPlugin
     protected const PLUGIN_NAME = 'CsvOutputStreamPlugin';
 
     /**
+     * @api
+     *
      * @return string
      */
     public function getName(): string
@@ -28,6 +30,8 @@ public function getName(): string
     }
 
     /**
+     * @api
+     *
      * @param string $path
      *
      * @return \SprykerMiddleware\Shared\Process\Stream\WriteStreamInterface
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,6 +18,8 @@ @@
     class IntrospectionProcessorPlugin extends AbstractPlugin implements LogProcessorPluginInterface
     {
         /**
+         * @api
+         *
          * @param array $data
          *
          * @return array
@@ Expand Down @@