symbiote / silverstripe-advancedworkflow

code/dataobjects/WorkflowInstance.php

Doc Comments +5 added lines, -5 removed lines

@@ -609,7 +609,7 @@ 
     /**
      * Does this action restrict the publishing of a document?
      *
-     * @return boolean
+     * @return boolean|null
      */
     public function canPublishTarget()
     {
@@ -622,7 +622,7 @@ 
      * Get the current set of transitions that are valid for the current workflow state,
      * and are available to the current user.
      *
-     * @return array
+     * @return ArrayList
      */
     public function validTransitions()
     {
@@ -756,9 +756,9 @@ 
      * view WorkflowInstances within GridFields
      * @see {@link $this->userHasAccess()}
      *
-     * @param number $recordID
+     * @param integer $recordID
      * @param number $userID
-     * @param number $wasPublished
+     * @param integer $wasPublished
      * @return boolean
      */
     public function getVersionedConnection($recordID, $userID, $wasPublished = 0)
@@ -795,7 +795,7 @@ 
     /**
      * Tells us if $member has had permissions over some part of the current WorkflowInstance.
      *
-     * @param $member
+     * @param Member $member
      * @return WorkflowAction|boolean
      */
     public function getMostRecentActionForUser($member = null)

code/services/WorkflowService.php

Doc Comments +4 added lines, -3 removed lines

@@ -81,6 +81,7 @@ 
      * Will recursively query parent elements until it finds one, if available
      *
      * @param DataObject $dataObject
+     * @return null|DataObject
      */
     public function getDefinitionFor(DataObject $dataObject)
     {
@@ -138,6 +139,7 @@ 
      * workflow definition.
      *
      * @param DataObject object
+     * @param DataObject $object
      * @return array
      */
 
@@ -168,7 +170,7 @@ 
      *
      * @param mixed $item
      * @param bool $includeComplete
-     * @return WorkflowInstance|null
+     * @return DataObject|null
      */
     public function getWorkflowFor($item, $includeComplete = false)
     {
@@ -191,6 +193,7 @@ 
     /**
      * Get all the workflow action instances for an item
      *
+     * @param DataObject $item
      * @return DataList|null
      */
     public function getWorkflowHistoryFor($item, $limit = null)
@@ -330,7 +333,6 @@ 
     /**
      * Get items that the passed-in user has awaiting for them to action
      *
-     * @param Member $member
      * @return DataList
      */
     public function userPendingItems(Member $user)
@@ -358,7 +360,6 @@ 
     /**
      * Get items that the passed-in user has submitted for workflow review
      *
-     * @param Member $member
      * @return DataList
      */
     public function userSubmittedItems(Member $user)

code/templates/WorkflowTemplate.php

Doc Comments +5 added lines, -2 removed lines

@@ -83,6 +83,9 @@ 
      */
     protected $structure;
 
+    /**
+     * @param string $name
+     */
     public function __construct($name, $description = '', $version = '0.0', $remindDays = 0, $sort = 0)
     {
         $this->name = $name;
@@ -131,7 +134,7 @@ 
      * Creates the relevant data objects for this structure, returning an array
      * of actions in the order they've been created
      *
-     * @param  WorkflowDefinition $definitino
+     * @param  WorkflowDefinition $definition
      *              An optional workflow definition to bind the actions into
      * @return array
      */
@@ -183,7 +186,7 @@ 
      * Create a workflow action based on a template
      *
      * @param  string $name
-     * @param  array $template
+     * @param  array $actionTemplate
      * @param  WorkflowDefinition $definition
      * @return WorkflowAction
      * @throws Exception