Develop

src/Contracts/Dispatchable.php

@@ -1,19 +1,25 @@
 <?php namespace Keios\Apparatus\Contracts;
 
 
+/**
+ * Interface Dispatchable
+ * @package Keios\Apparatus\Contracts
+ */
 interface Dispatchable
 {
 
     /**
      * @fluent
-     * @param $eventName
+     *
+     * @param string $eventName
      *
      * @return Dispatchable
      */
     public function name($eventName);
 
     /**
      * @fluent
+     *
      * @param $data
      *
      * @return Dispatchable
@@ -22,6 +28,7 @@ public function with($data);
 
     /**
      * @fluent
+     *
      * @param array $expectedReactions
      *
      * @return Dispatchable

src/Contracts/LoaderInterface.php

@@ -1,7 +1,14 @@
 <?php namespace Keios\Apparatus\Contracts;
 
 
+/**
+ * Interface LoaderInterface
+ * @package Keios\Apparatus\Contracts
+ */
 interface LoaderInterface
 {
+    /**
+     * @return mixed
+     */
     public function loadScenarios();
 }

src/Contracts/Runnable.php

@@ -1,15 +1,38 @@
 <?php namespace Keios\Apparatus\Contracts;
 
 use Keios\Apparatus\Core\Dispatcher;
-use Keios\Apparatus\Core\Step;
 
+/**
+ * Interface Runnable
+ * @package Keios\Apparatus\Contracts
+ */
 interface Runnable
 {
+    /**
+     * @param Dispatchable $event
+     *
+     * @return mixed
+     */
     public function inject(Dispatchable $event);
 
+    /**
+     * @param Dispatcher $dispatcher
+     *
+     * @return mixed
+     */
     public function setDispatcher(Dispatcher $dispatcher);
 
+    /**
+     * @return mixed
+     */
     public function run();
 
+    /**
+     * @param string $eventName
+     * @param        $data
+     * @param array  $expectedReactions
+     *
+     * @return mixed
+     */
     public function dispatch($eventName, $data, array $expectedReactions);
 } 

src/Core/Dispatcher.php

@@ -34,13 +34,13 @@ public function __construct(ScenarioRepository $scenarioRepository, ScenarioRunn
      * @param \Keios\Apparatus\Contracts\Dispatchable $event
      *
      * @return mixed
+     * @throws \Keios\Apparatus\Exceptions\InvalidScenarioException
+     * @throws \Keios\Apparatus\Exceptions\NoHandlerScenarioFoundException
      */
     public function dispatch(Dispatchable $event)
     {
         $scenario = $this->scenarioRepository->findHandlerScenarioFor($event);
 
-        $reaction = $this->scenarioRunner->run($scenario, $event);
-
-        return $reaction;
+        return $this->scenarioRunner->run($scenario, $event);
     }
 } 

src/Core/Event.php

@@ -54,7 +54,7 @@ public function name($eventName)
     /**
      * @fluent
      *
-     * @param $eventName
+     * @param string $eventName
      *
      * @return \Keios\Apparatus\Contracts\Dispatchable $this
      */
@@ -94,6 +94,7 @@ public function expect(array $expectedReactions)
 
     /**
      * @return mixed
+     * @throws \Keios\Apparatus\Exceptions\NoHandlerScenarioFoundException
      */
     public function getReaction()
     {
@@ -102,7 +103,7 @@ public function getReaction()
     }
 
     /**
-     * @return mixed
+     * @return string|null
      */
     public function getEventName()
     {

src/Core/Scenario.php

@@ -65,6 +65,8 @@ public function __construct()
 
     /**
      * @param \Keios\Apparatus\Core\Dispatcher $dispatcher
+     *
+     * @return mixed|void
      */
     public function setDispatcher(Dispatcher $dispatcher)
     {
@@ -73,6 +75,8 @@ public function setDispatcher(Dispatcher $dispatcher)
 
     /**
      * @param \Keios\Apparatus\Contracts\Dispatchable $event
+     *
+     * @return mixed|void
      */
     public function inject(Dispatchable $event)
     {
@@ -117,6 +121,9 @@ public function has($property)
 
     /**
      * @return mixed
+     * @throws \Keios\Apparatus\Exceptions\NoStepForEventFoundException
+     * @throws \Keios\Apparatus\Exceptions\NotInitializedException
+     * @throws \Keios\Apparatus\Exceptions\NoStepsDefinedException
      */
     public function run()
     {
@@ -143,9 +150,9 @@ public function run()
     }
 
     /**
-     * @param       $eventName
-     * @param       $data
-     * @param array $expectedReactions
+     * @param string $eventName
+     * @param        $data
+     * @param array  $expectedReactions
      *
      * @return mixed
      */
@@ -158,6 +165,9 @@ public function dispatch($eventName, $data, array $expectedReactions)
 
     /**
      * @param \Keios\Apparatus\Core\Step $step
+     *
+     * @throws \Keios\Apparatus\Exceptions\EventAlreadyRegisteredException
+     * @throws \Keios\Apparatus\Exceptions\StepAlreadyRegisteredException
      */
     public function add(Step $step)
     {
@@ -168,6 +178,9 @@ public function add(Step $step)
     /**
      * @param                            $stepName
      * @param \Keios\Apparatus\Core\Step $step
+     *
+     * @throws \Keios\Apparatus\Exceptions\NoStepWithNameFoundException
+     * @throws \Keios\Apparatus\Exceptions\EventAlreadyRegisteredException
      */
     public function replace($stepName, Step $step)
     {
@@ -177,6 +190,9 @@ public function replace($stepName, Step $step)
     /**
      * @param                            $stepName
      * @param \Keios\Apparatus\Core\Step $step
+     *
+     * @throws \Keios\Apparatus\Exceptions\EventAlreadyRegisteredException
+     * @throws \Keios\Apparatus\Exceptions\NoStepWithNameFoundException
      */
     public function insertBefore($stepName, Step $step)
     {
@@ -186,6 +202,9 @@ public function insertBefore($stepName, Step $step)
     /**
      * @param                            $stepName
      * @param \Keios\Apparatus\Core\Step $step
+     *
+     * @throws \Keios\Apparatus\Exceptions\EventAlreadyRegisteredException
+     * @throws \Keios\Apparatus\Exceptions\NoStepWithNameFoundException
      */
     public function insertAfter($stepName, Step $step)
     {

src/Core/ScenarioConfiguration.php

@@ -18,8 +18,8 @@ class ScenarioConfiguration implements LoaderInterface
     protected $registeredScenarios = [];
 
     /**
-     * @param $eventName
-     * @param $scenarioClassName
+     * @param string $eventName
+     * @param string $scenarioClassName
      *
      * @throws \Keios\Apparatus\Exceptions\InvalidScenarioException
      * @throws \Keios\Apparatus\Exceptions\ScenarioNotFoundException
@@ -38,7 +38,7 @@ public function bind($eventName, $scenarioClassName)
     }
 
     /**
-     * @param $scenarioClassName
+     * @param string $scenarioClassName
      *
      * @throws \Keios\Apparatus\Exceptions\ScenarioNotFoundException
      */
@@ -52,7 +52,7 @@ protected function assertScenarioExists($scenarioClassName)
     }
 
     /**
-     * @param $scenarioClassName
+     * @param string $scenarioClassName
      *
      * @throws \Keios\Apparatus\Exceptions\InvalidScenarioException
      */

src/Core/ScenarioFactory.php

@@ -32,6 +32,7 @@ public function __construct(LoaderInterface $scenarioLoader)
      * @param \Keios\Apparatus\Contracts\Dispatchable $event
      *
      * @return mixed
+     * @throws \Keios\Apparatus\Exceptions\InvalidScenarioException
      * @throws \Keios\Apparatus\Exceptions\NoHandlerScenarioFoundException
      */
     public function findHandlerScenarioFor(Dispatchable $event)
@@ -44,7 +45,7 @@ public function findHandlerScenarioFor(Dispatchable $event)
     }
 
     /**
-     * @param $eventName
+     * @param string $eventName
      *
      * @return bool
      */
@@ -93,11 +94,9 @@ protected function make($eventName)
     protected function resolveClosure($closure)
     {
         $scenario = $closure();
-
-        if ($interfaces = class_implements($scenario)) {
-            if (in_array('Keios\Apparatus\Contracts\Runnable', $interfaces)) {
+        $interfaces = class_implements($scenario);
+        if ($interfaces && in_array('Keios\Apparatus\Contracts\Runnable', $interfaces, true)) {
                 return is_object($scenario) ? $scenario : new $scenario();
-            }
         }
 
         throw new InvalidScenarioException(
@@ -106,7 +105,7 @@ protected function resolveClosure($closure)
     }
 
     /**
-     * @param $eventName
+     * @param string $eventName
      *
      * @throws \Keios\Apparatus\Exceptions\NoHandlerScenarioFoundException
      */

src/Core/ScenarioRepository.php

@@ -31,6 +31,8 @@ public function __construct(ScenarioFactory $scenarioFactory)
      * @param \Keios\Apparatus\Contracts\Dispatchable $event
      *
      * @return mixed
+     * @throws \Keios\Apparatus\Exceptions\InvalidScenarioException
+     * @throws \Keios\Apparatus\Exceptions\NoHandlerScenarioFoundException
      */
     public function findHandlerScenarioFor(Dispatchable $event)
     {

src/Core/ScenarioRunner.php

@@ -11,7 +11,7 @@
 class ScenarioRunner
 {
     /**
-     * @var
+     * @var Dispatcher
      */
     protected $dispatcher;