symbiote / silverstripe-advancedworkflow

code/dataobjects/WorkflowInstance.php

Doc Comments +5 added lines, -5 removed lines

@@ -603,7 +603,7 @@ 
     /**
      * Does this action restrict the publishing of a document?
      *
-     * @return boolean
+     * @return boolean|null
      */
     public function canPublishTarget()
     {
@@ -616,7 +616,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()
     {
@@ -750,9 +750,9 @@ 
      * to 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)
@@ -789,7 +789,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

@@ -82,6 +82,7 @@ 
      * Will recursively query parent elements until it finds one, if available
      *
      * @param DataObject $dataObject
+     * @return null|DataObject
      */
     public function getDefinitionFor(DataObject $dataObject)
     {
@@ -140,6 +141,7 @@ 
      * main workflow definition.
      *
      * @param DataObject object
+     * @param DataObject $object
      * @return array
      */
 
@@ -170,7 +172,7 @@ 
      *
      * @param mixed $item
      * @param bool $includeComplete
-     * @return WorkflowInstance|null
+     * @return DataObject|null
      */
     public function getWorkflowFor($item, $includeComplete = false)
     {
@@ -194,6 +196,7 @@ 
     /**
      * Get all the workflow action instances for an item
      *
+     * @param DataObject $item
      * @return DataList|null
      */
     public function getWorkflowHistoryFor($item, $limit = null)
@@ -333,7 +336,6 @@ 
     /**
      * Get items that the passed-in user has awaiting for them to action
      *
-     * @param Member $member
      * @return DataList
      */
     public function userPendingItems(Member $user)
@@ -361,7 +363,6 @@ 
     /**
      * Get items that the passed-in user has submitted for workflow review
      *
-     * @param Member $member
      * @return DataList
      */
     public function userSubmittedItems(Member $user)