rolfvreijdenberger / izzum-statemachine

src/command/IComposite.php

Doc Comments +2 added lines, -1 removed lines

@@ -17,6 +17,7 @@ 
      * 
      * @param
      *            command the ICommand to add
+     * @return void
      */
     public function add(ICommand $command);
 
@@ -25,7 +26,7 @@ 
      * 
      * @param
      *            command the ICommand to remove
-     * @return Boolean, whether or not the removal was succesful
+     * @return boolean whether or not the removal was succesful
      */
     public function remove(ICommand $command);
 

src/rules/Rule.php

Doc Comments +4 added lines, -1 removed lines

@@ -261,6 +261,9 @@ 
         $this->cache = null;
     }
 
+    /**
+     * @param boolean $result
+     */
     private function setCache($result)
     {
         if ($this->getCacheEnabled()) {
@@ -281,7 +284,7 @@ 
     /**
      * should we cache the result if the rule is applied more than once?
      * 
-     * @param boolean $cache            
+     * @param boolean $cached            
      */
     public final function setCacheEnabled($cached = true)
     {

src/statemachine/AbstractFactory.php

Doc Comments -1 removed lines

@@ -121,7 +121,6 @@
      * and persistence adapter for a concrete statemachine type.
      *
      *
-     * @param Identifier $id            
      * @return Context
      * @throws Exception
      * @link https://en.wikipedia.org/wiki/Abstract_factory_pattern

src/statemachine/Context.php

Doc Comments +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
      * @param string $state 
      * @param string $message optional message. this can be used by the persistence adapter
      *          to be part of the transition history to provide extra information about the transition.            
-     * @return boolan true if there was never any state persisted for this
+     * @return boolean true if there was never any state persisted for this
      *         machine before (just added for the
      *         first time), false otherwise
      */

src/statemachine/EntityBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -131,7 +131,7 @@
      * domain object.
      *
      * @param Identifier $identifier            
-     * @return Object an object of any type defined by the subclass
+     * @return Identifier an object of any type defined by the subclass
      */
     protected function build(Identifier $identifier)
     {

src/statemachine/Identifier.php

Doc Comments +2 added lines, -2 removed lines

@@ -45,10 +45,10 @@
     /**
      * Constructor
      *
-     * @param mixed $entity_id
+     * @param string $entity_id
      *            the id of the domain specific entity (it will internally be
      *            converted to a string)
-     * @param string $machine
+     * @param string $machine_name
      *            the name of the statemachine (eg: 'order')
      */
     public function __construct($entity_id, $machine_name)

src/statemachine/persistence/MongoDB.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
      * since we do not want to burden a client of this code with the responsiblity of
      * creating indexes, we take a statistical approach to check if we need to 
      * create an index in the background. This will only be done once.
-     * @param number $check_index_once_in check for index creation. on average, every <x> times
+     * @param integer $check_index_once_in check for index creation. on average, every <x> times
      *      the index should be created if it is not there already
      */
     protected function checkAndCreateIndexesIfNecessary($check_index_once_in = 1000)

Unused Use Statements -5 removed lines

@@ -2,14 +2,9 @@
 namespace izzum\statemachine\persistence;
 use izzum\statemachine\loader\Loader;
 use izzum\statemachine\StateMachine;
-use izzum\statemachine\Context;
-use izzum\statemachine\loader\LoaderArray;
-use izzum\statemachine\loader\LoaderData;
 use izzum\statemachine\Exception;
 use izzum\statemachine\Identifier;
-use izzum\statemachine\Transition;
 use izzum\statemachine\loader\JSON;
-use izzum\statemachine\State;
 /**
  * MongoDB (from humongous) is a cross-platform document-oriented database.
  * MongoDB is an open-source document database that provides high performance, high availability, and automatic scaling. 

src/statemachine/persistence/PDO.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 use izzum\statemachine\StateMachine;
 use izzum\statemachine\Identifier;
 use izzum\statemachine\loader\LoaderArray;
-use izzum\statemachine\loader\LoaderData;
 use izzum\statemachine\Exception;
 use izzum\statemachine\Transition;
 use izzum\statemachine\State;

src/statemachine/persistence/Redis.php

Doc Comments +1 added lines, -1 removed lines

@@ -142,7 +142,7 @@
      *
      * @param string $host optional
      * @param int $port optional
-     * @param float $timeout value in seconds. default is 0 meaning unlimited
+     * @param integer $timeout value in seconds. default is 0 meaning unlimited
      * @param string $reserved should be NULL if $retry is specified
      * @param int $retry value in milliseconds
      */

Unused Use Statements -4 removed lines

@@ -2,12 +2,8 @@
 namespace izzum\statemachine\persistence;
 use izzum\statemachine\loader\Loader;
 use izzum\statemachine\StateMachine;
-use izzum\statemachine\Context;
-use izzum\statemachine\loader\LoaderArray;
-use izzum\statemachine\loader\LoaderData;
 use izzum\statemachine\Exception;
 use izzum\statemachine\Identifier;
-use izzum\statemachine\Transition;
 use izzum\statemachine\loader\JSON;
 /**
  * Redis is an open source advanced key-value (nosql database) cache and store using