old-town / old-town-workflow

src/AbstractWorkflow.php

Doc Comments +4 added lines, -4 removed lines

@@ -248,7 +248,7 @@ 
      * Переход между двумя статусами
      *
      * @param WorkflowEntryInterface $entry
-     * @param SplObjectStorage|StepInterface[] $currentSteps
+     * @param SplObjectStorage $currentSteps
      * @param WorkflowStoreInterface $store
      * @param WorkflowDescriptor $wf
      * @param ActionDescriptor $action
@@ -497,7 +497,7 @@ 
 
 
     /**
-     * @param       $id
+     * @param       integer $id
      * @param TransientVarsInterface $inputs
      *
      * @return array
@@ -874,7 +874,7 @@ 
 
     /**
      * @param ActionDescriptor $action
-     * @param                  $id
+     * @param                  integer $id
      *
      * @return void
      *
@@ -1170,7 +1170,7 @@ 
      *
      * @param WorkflowDescriptor $wfDesc
      * @param integer $actionId
-     * @param StepInterface[]|SplObjectStorage $currentSteps
+     * @param SplObjectStorage $currentSteps
      * @param TransientVarsInterface $transientVars
      * @param PropertySetInterface $ps
      *

Indentation -1 removed lines

@@ -1931,7 +1931,6 @@
      * @throws \OldTown\Workflow\Exception\WorkflowException
      * @throws \OldTown\Workflow\Exception\StoreException
      * @throws \OldTown\Workflow\Exception\InternalWorkflowException
-
      */
     public function query(WorkflowExpressionQuery $query)
     {

Spacing +17 added lines, -17 removed lines

@@ -119,7 +119,7 @@ 
     public function initialize($workflowName, $initialAction, TransientVarsInterface $inputs = null)
     {
         try {
-            $initialAction = (integer)$initialAction;
+            $initialAction = (integer) $initialAction;
 
             $wf = $this->getConfiguration()->getWorkflow($workflowName);
 
@@ -296,7 +296,7 @@ 
         $theResult = null;
 
 
-        $currentStepId = null !== $step ? $step->getStepId()  : -1;
+        $currentStepId = null !== $step ? $step->getStepId() : -1;
         foreach ($conditionalResults as $conditionalResult) {
             if ($this->passesConditionsWithType(null, $conditionalResult->getConditions(), $transientVars, $ps, $currentStepId)) {
                 $theResult = $conditionalResult;
@@ -314,7 +314,7 @@ 
         }
 
 
-        if (null ===  $theResult) {
+        if (null === $theResult) {
             $theResult = $action->getUnconditionalResult();
             $this->verifyInputs($entry, $theResult->getValidators(), $transientVars, $ps);
             $extraPreFunctions = $theResult->getPreFunctions();
@@ -695,15 +695,15 @@ 
 
             if (null !== $owner) {
                 $o = $variableResolver->translateVariables($owner, $transientVars, $ps);
-                $owner = null !== $o ? (string)$o : null;
+                $owner = null !== $o ? (string) $o : null;
             }
 
 
             $oldStatus = $theResult->getOldStatus();
-            $oldStatus = (string)$variableResolver->translateVariables($oldStatus, $transientVars, $ps);
+            $oldStatus = (string) $variableResolver->translateVariables($oldStatus, $transientVars, $ps);
 
             $status = $theResult->getStatus();
-            $status = (string)$variableResolver->translateVariables($status, $transientVars, $ps);
+            $status = (string) $variableResolver->translateVariables($status, $transientVars, $ps);
 
 
             if (null !== $currentStep) {
@@ -714,7 +714,7 @@ 
             $startDate = new DateTime();
             $dueDate = null;
 
-            $theResultDueDate = (string)$theResult->getDueDate();
+            $theResultDueDate = (string) $theResult->getDueDate();
             $theResultDueDate = trim($theResultDueDate);
             if (strlen($theResultDueDate) > 0) {
                 $dueDateObject = $variableResolver->translateVariables($theResultDueDate, $transientVars, $ps);
@@ -732,15 +732,15 @@ 
             }
 
             $newStep = $store->createCurrentStep($entry->getId(), $nextStep, $owner, $startDate, $dueDate, $status, $previousIds);
-            $transientVars['createdStep'] =  $newStep;
+            $transientVars['createdStep'] = $newStep;
 
             if (null === $currentStep && 0 === count($previousIds)) {
                 $currentSteps = [];
                 $currentSteps[] = $newStep;
-                $transientVars['currentSteps'] =  $currentSteps;
+                $transientVars['currentSteps'] = $currentSteps;
             }
 
-            if (! $transientVars->offsetExists('descriptor')) {
+            if (!$transientVars->offsetExists('descriptor')) {
                 $errMsg = 'Ошибка при получение дескриптора workflow из transientVars';
                 throw new InternalWorkflowException($errMsg);
             }
@@ -801,7 +801,7 @@ 
      */
     public function doAction($id, $actionId, TransientVarsInterface $inputs = null)
     {
-        $actionId = (integer)$actionId;
+        $actionId = (integer) $actionId;
         if (null === $inputs) {
             $inputs = $this->transientVarsFactory();
         }
@@ -1243,7 +1243,7 @@ 
         }
 
 
-        $result = (boolean)$result;
+        $result = (boolean) $result;
 
         return $result;
     }
@@ -1635,9 +1635,9 @@ 
             return $l;
         }
 
-        $actions  = $s->getActions();
+        $actions = $s->getActions();
 
-        if (null === $actions || 0  === $actions->count()) {
+        if (null === $actions || 0 === $actions->count()) {
             return $l;
         }
 
@@ -1773,7 +1773,7 @@ 
     public function getWorkflowNames()
     {
         try {
-            $result =  $this->getConfiguration()->getWorkflowNames();
+            $result = $this->getConfiguration()->getWorkflowNames();
             return $result;
         } catch (FactoryException $e) {
             $errMsg = 'Ошибка при получение имен workflow';
@@ -1955,7 +1955,7 @@ 
      */
     public function setDefaultTypeResolverClass($defaultTypeResolverClass)
     {
-        $this->defaultTypeResolverClass = (string)$defaultTypeResolverClass;
+        $this->defaultTypeResolverClass = (string) $defaultTypeResolverClass;
 
         return $this;
     }
@@ -2059,7 +2059,7 @@ 
         }
 
         if (-1 !== $currentStepId) {
-            $stepId = array_key_exists('stepId', $args) ? (integer)$args['stepId'] : null;
+            $stepId = array_key_exists('stepId', $args) ? (integer) $args['stepId'] : null;
 
             if (null !== $stepId && -1 === $stepId) {
                 $args['stepId'] = $currentStepId;

src/Config/ArrayConfiguration.php

Doc Comments +1 added lines, -1 removed lines

@@ -218,7 +218,7 @@
     }
 
     /**
-     * @return \String[]
+     * @return string[]
      */
     public function getWorkflowNames()
     {

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @link https://github.com/old-town/old-town-workflow
- * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
- */
+     * @link https://github.com/old-town/old-town-workflow
+     * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
+     */
 namespace OldTown\Workflow\Config;
 
 use OldTown\Workflow\Loader\UrlWorkflowFactory;

src/Config/DefaultConfiguration.php

Doc Comments +2 added lines, -2 removed lines

@@ -377,7 +377,7 @@ 
      * Удаляет workflow
      *
      * @param string $workflow имя удаляемого workflow
-     * @return boolean в случае успешного удаления возвращает true, в противном случае false
+     * @return boolean|null в случае успешного удаления возвращает true, в противном случае false
      * @throws FactoryException
      */
     public function removeWorkflow($workflow)
@@ -391,7 +391,7 @@ 
      * @param WorkflowDescriptor $descriptor дескриптор workflow
      * @param boolean $replace - флаг определяющий, можно ли замениить workflow
      *
-     * @return boolean
+     * @return boolean|null
      *
      * @throws FactoryException
      * @throws \OldTown\Workflow\Exception\InvalidWorkflowDescriptorException

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @link https://github.com/old-town/old-town-workflow
- * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
- */
+     * @link https://github.com/old-town/old-town-workflow
+     * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
+     */
 namespace OldTown\Workflow\Config;
 
 use OldTown\Workflow\Exception\FactoryException;

Spacing +4 added lines, -4 removed lines

@@ -202,7 +202,7 @@ 
 
             $p = XmlUtil::getChildElement($root, 'persistence');
             $resolver = XmlUtil::getChildElement($root, 'resolver');
-            $factoryElement =  XmlUtil::getChildElement($root, 'factory');
+            $factoryElement = XmlUtil::getChildElement($root, 'factory');
 
 
             if (null !== $resolver && $resolver->hasAttribute('class')) {
@@ -264,7 +264,7 @@ 
                 } catch (FactoryException $e) {
                     throw $e;
                 } catch (\Exception $e) {
-                    $class = (string)$class;
+                    $class = (string) $class;
                     $errMsg = "Ошибка создания фабрики workflow для класса {$class}";
                     throw new FactoryException($errMsg, $e->getCode(), $e);
                 }
@@ -290,7 +290,7 @@ 
     protected function getContentConfigFile(UriInterface $url = null)
     {
         if (null !== $url) {
-            $urlStr = (string)$url;
+            $urlStr = (string) $url;
             $content = file_get_contents($urlStr);
 
             return $content;
@@ -339,7 +339,7 @@ 
      */
     public static function addDefaultPathToConfig($path)
     {
-        $path = (string)$path;
+        $path = (string) $path;
 
         array_unshift(self::$defaultPathsToConfig, $path);
     }

src/Loader/SecureDtdEntityResolver.php

Doc Comments +4 added lines, -4 removed lines

@@ -44,7 +44,7 @@ 
     /**
      * Возвращает dom документ
      *
-     * @param DomDocumentType $domDocumentType
+     * @param DOMDocumentType $domDocumentType
      *
      * @return string
      * @throws  \OldTown\Workflow\Exception\InvalidDtdSchemaException
@@ -74,7 +74,7 @@ 
     }
 
     /**
-     * @param $path
+     * @param string $path
      *
      * @return string
      * @throws InvalidDtdSchemaException
@@ -149,7 +149,7 @@ 
     }
 
     /**
-     * @param $uri
+     * @param string $uri
      * @return UriInterface
      */
     protected function uriFactory($uri)
@@ -166,7 +166,7 @@ 
     /**
      * Возвращает путь до директории в которой находятся схемы для валидации
      *
-     * @return null|string
+     * @return string
      */
     public function getPathToSchemas()
     {

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @link https://github.com/old-town/old-town-workflow
- * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
- */
+     * @link https://github.com/old-town/old-town-workflow
+     * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
+     */
 namespace OldTown\Workflow\Loader;
 
 use DOMDocumentType;

src/Loader/WorkflowDescriptor.php

Doc Comments +1 added lines, -1 removed lines

@@ -571,7 +571,7 @@
 
 
     /**
-     * @param $id
+     * @param integer $id
      *
      * @return ActionDescriptor|null
      * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @link    https://github.com/old-town/old-town-workflow
- * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
- */
+     * @link    https://github.com/old-town/old-town-workflow
+     * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
+     */
 namespace OldTown\Workflow\Loader;
 
 use OldTown\Workflow\Exception\ArgumentNotNumericException;

Spacing +11 added lines, -11 removed lines

@@ -154,7 +154,7 @@ 
      */
     public function setName($workflowName)
     {
-        $this->workflowName = (string)$workflowName;
+        $this->workflowName = (string) $workflowName;
 
         return $this;
     }
@@ -258,7 +258,7 @@ 
         $dtd = $secureDtdEntityResolver->resolveEntity($dom->doctype);
 
 
-        $systemId = 'data://text/plain;base64,'.base64_encode($dtd);
+        $systemId = 'data://text/plain;base64,' . base64_encode($dtd);
 
         $creator = new DOMImplementation;
         $doctype = $creator->createDocumentType(
@@ -483,7 +483,7 @@ 
             $errMsg = 'Аргумент должен быть числом';
             throw new ArgumentNotNumericException($errMsg);
         }
-        $id = (integer)$id;
+        $id = (integer) $id;
 
         foreach ($this->getSteps() as $step) {
             if ($id === $step->getId()) {
@@ -499,7 +499,7 @@ 
      */
     public function getAction($id)
     {
-        $id = (integer)$id;
+        $id = (integer) $id;
 
         foreach ($this->getGlobalActions() as $actionDescriptor) {
             if ($id === $actionDescriptor->getId()) {
@@ -562,7 +562,7 @@ 
      */
     public function getCommonAction($id)
     {
-        $id = (integer)$id;
+        $id = (integer) $id;
         if (array_key_exists($id, $this->commonActions)) {
             return $this->commonActions[$id];
         }
@@ -582,7 +582,7 @@ 
             $errMsg = 'Аргумент должен быть числом';
             throw new ArgumentNotNumericException($errMsg);
         }
-        $id = (integer)$id;
+        $id = (integer) $id;
 
         $initialActions = $this->getInitialActions();
         foreach ($initialActions as $actionDescriptor) {
@@ -615,7 +615,7 @@ 
             $errMsg = 'Аргумент должен быть числом';
             throw new ArgumentNotNumericException($errMsg);
         }
-        $id = (integer)$id;
+        $id = (integer) $id;
 
         $joins = $this->getJoins();
         foreach ($joins as $joinDescriptor) {
@@ -665,7 +665,7 @@ 
             $errMsg = 'Аргумент должен быть числом';
             throw new ArgumentNotNumericException($errMsg);
         }
-        $id = (integer)$id;
+        $id = (integer) $id;
 
         $splits = $this->getSplits();
         foreach ($splits as $splitDescriptor) {
@@ -690,7 +690,7 @@ 
             $errMsg = 'Аргумент должен быть числом';
             throw new ArgumentNotNumericException($errMsg);
         }
-        $id = (integer)$id;
+        $id = (integer) $id;
         $this->timerFunctions[$id] = $descriptor;
 
         return $this;
@@ -707,7 +707,7 @@ 
             $errMsg = 'Аргумент должен быть числом';
             throw new ArgumentNotNumericException($errMsg);
         }
-        $id = (integer)$id;
+        $id = (integer) $id;
 
         if (!array_key_exists($id, $this->timerFunctions)) {
             $errMsg = sprintf('Не найдена trigger-function с id %s', $id);
@@ -872,7 +872,7 @@ 
     {
         if (null === $dom) {
             $imp = new DOMImplementation();
-            $dtd  = $imp->createDocumentType(
+            $dtd = $imp->createDocumentType(
                 static::DOCUMENT_TYPE_QUALIFIED_NAME,
                 static::DOCUMENT_TYPE_PUBLIC_ID,
                 static::DOCUMENT_TYPE_SYSTEM_ID

src/Spi/Memory/MemoryWorkflowStore.php

Doc Comments +2 added lines, -2 removed lines

@@ -314,7 +314,7 @@ 
     /**
      * Поиск по истории шагов
      *
-     * @param $entryId
+     * @param integer $entryId
      *
      * @return SimpleStep[]|SplObjectStorage
      */
@@ -687,7 +687,7 @@ 
      *
      * @param $value1
      * @param $value2
-     * @param $operator
+     * @param integer $operator
      *
      * @return bool
      *

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @link    https://github.com/old-town/old-town-workflow
- * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
- */
+     * @link    https://github.com/old-town/old-town-workflow
+     * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
+     */
 namespace OldTown\Workflow\Spi\Memory;
 
 use OldTown\PropertySet\PropertySetInterface;

Spacing +6 added lines, -6 removed lines

@@ -89,7 +89,7 @@ 
             $errMsg = sprintf('Аргумент должен быть числом. Актуальное значение %s', $entryId);
             throw new ArgumentNotNumericException($errMsg);
         }
-        $entryId = (integer)$entryId;
+        $entryId = (integer) $entryId;
 
         $ps = $this->createPropertySet();
         static::$propertySetCache[$entryId] = $ps;
@@ -220,7 +220,7 @@ 
             $errMsg = sprintf('Аргумент должен быть числом. Актуальное значение %s', $entryId);
             throw new ArgumentNotNumericException($errMsg);
         }
-        $entryId = (integer)$entryId;
+        $entryId = (integer) $entryId;
 
         if (!array_key_exists($entryId, static::$currentStepsCache)) {
             $currentSteps = new SplObjectStorage();
@@ -389,7 +389,7 @@ 
         $field = $expression->getField();
         $context = $expression->getContext();
 
-        $id = (integer)$entryId;
+        $id = (integer) $entryId;
 
         if ($context === FieldExpression::ENTRY) {
             $theEntry = static::$entryCache[$id];
@@ -404,7 +404,7 @@ 
                     throw new InvalidArgumentException($errMsg);
                 }
 
-                $valueInt = (integer)$value;
+                $valueInt = (integer) $value;
 
                 return $this->compareLong($valueInt, $theEntry->getState(), $operator);
             }
@@ -438,7 +438,7 @@ 
                     throw new InvalidArgumentException($errMsg);
                 }
 
-                $actionId = (integer)$value;
+                $actionId = (integer) $value;
 
                 foreach ($steps as $step) {
                     if ($this->compareLong($step->getActionId(), $actionId, $operator)) {
@@ -525,7 +525,7 @@ 
                     $errMsg = 'unknown field';
                     throw new InvalidArgumentException($errMsg);
                 }
-                $stepId = (integer)$value;
+                $stepId = (integer) $value;
 
                 foreach ($steps as $step) {
                     if ($this->compareLong($step->getStepId(), $stepId, $operator)) {

src/Util/PhpShell/PhpShellConditionProvider.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
      * @param TransientVarsInterface $transientVars
      * @param array $args
      * @param PropertySetInterface $ps
-     * @return bool
+     * @return boolean|string
      *
      * @throws \OldTown\Workflow\Exception\WorkflowException
      * @throws \OldTown\Workflow\Exception\RuntimeException

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @link    https://github.com/old-town/old-town-workflow
- * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
- */
+     * @link    https://github.com/old-town/old-town-workflow
+     * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
+     */
 namespace OldTown\Workflow\Util\PhpShell;
 
 use OldTown\PropertySet\PropertySetInterface;

Spacing +2 added lines, -2 removed lines

@@ -37,10 +37,10 @@
         $script = array_key_exists(static::PHP_SCRIPT, $args) ? $args[static::PHP_SCRIPT] : '';
 
         /**@var WorkflowContextInterface $context */
-        $context = $transientVars->offsetExists('context')  ? $transientVars['context'] : null;
+        $context = $transientVars->offsetExists('context') ? $transientVars['context'] : null;
 
         /**@var WorkflowEntryInterface $entry */
-        $entry = $transientVars->offsetExists('entry')  ? $transientVars['entry'] : null;
+        $entry = $transientVars->offsetExists('entry') ? $transientVars['entry'] : null;
 
 
         $i = new Interpreter($script);

src/WorkflowInterface.php

Doc Comments +3 added lines

@@ -101,6 +101,7 @@ 
      * If the new state is {@link com.opensymphony.workflow.spi.WorkflowEntry.KILLED}
      * or {@link com.opensymphony.workflow.spi.WorkflowEntry.COMPLETED}
      * then all current steps are moved to history steps. If the new state is
+     * @return void
      */
     public function changeEntryState($id, $newState);
 
@@ -110,6 +111,7 @@ 
      * @param integer $actionId The action id to perform (action id's are listed in the workflow descriptor).
      * @param TransientVarsInterface $inputs The inputs to the workflow instance.
      * instance's current state.
+     * @return void
      */
     public function doAction($id, $actionId, TransientVarsInterface $inputs = null);
 
@@ -119,6 +121,7 @@ 
      * @param integer $id The workflow instance id
      * @param integer $triggerId The id of the special trigger-function
      * @thrown WorkflowException
+     * @return void
      */
     public function executeTriggerFunction($id, $triggerId);
 

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @link https://github.com/old-town/old-town-workflow
- * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
- */
+     * @link https://github.com/old-town/old-town-workflow
+     * @author  Malofeykin Andrey  <and-rey2@yandex.ru>
+     */
 namespace OldTown\Workflow;
 
 use OldTown\Workflow\Config\ConfigurationInterface;

test/Behat/bootstrap/WorkflowDescriptorContext.php

Doc Comments +1 added lines, -1 removed lines

@@ -771,7 +771,7 @@
      * @param           $methodName
      * @param TableNode $table
      *
-     * @return mixed
+     * @return AbstractDescriptor
      * @throws \RuntimeException
      */
     public function getTheDescriptorUsingTheMethodOfTheArgumentsOfTheMethod($methodName, TableNode $table)