symbiote / silverstripe-advancedworkflow

src/Admin/AdvancedWorkflowAdmin.php

Doc Comments +3 added lines, -4 removed lines

@@ -250,9 +250,8 @@ 
     /**
      * Get WorkflowInstance Target objects to show for users in initial gridfield(s)
      *
-     * @param Member $member
      * @param string $fieldName The name of the gridfield that determines which dataset to return
-     * @return DataList
+     * @return ArrayList
      * @todo Add the ability to see embargo/expiry dates in report-gridfields at-a-glance if QueuedJobs module installed
      */
     public function userObjects(Member $user, $fieldName)
@@ -303,7 +302,7 @@ 
      * Spits out an exported version of the selected WorkflowDefinition for download.
      *
      * @param HTTPRequest $request
-     * @return HTTPResponse
+     * @return \SilverStripe\Control\HTTPResponse|null
      */
     public function export(HTTPRequest $request)
     {
@@ -326,7 +325,7 @@ 
     /**
      * Required so we can simply change the visible label of the "Import" button and lose some redundant form-fields.
      *
-     * @return Form
+     * @return null|\SilverStripe\Forms\Form
      */
     public function ImportForm()
     {

src/Controllers/FrontEndWorkflowController.php

Doc Comments +2 added lines, -2 removed lines

@@ -94,7 +94,7 @@ 
      * - required fields from the Context Object
      * - Actions from the connected WorkflowTransitions
      *
-     * @return Form
+     * @return null|FrontendWorkflowForm
      */
     public function Form()
     {
@@ -150,7 +150,7 @@ 
      *
      * @param array $data
      * @param Form $form
-     * @param SS_HTTPRequest $request
+     * @param HTTPRequest $request
      * @throws Exception
      */
     public function doFrontEndAction(array $data, Form $form, HTTPRequest $request)

src/DataObjects/WorkflowAction.php

Doc Comments +6 added lines, -6 removed lines

@@ -70,7 +70,7 @@ 
      * if null is returned from this method.
      *
      * @param  DataObject $target
-     * @return bool
+     * @return boolean|null
      */
     public function canEditTarget(DataObject $target)
     {
@@ -81,7 +81,7 @@ 
      * Does this action restrict viewing of the document?
      *
      * @param  DataObject $target
-     * @return bool
+     * @return boolean|null
      */
     public function canViewTarget(DataObject $target)
     {
@@ -92,7 +92,7 @@ 
      * Does this action restrict the publishing of a document?
      *
      * @param  DataObject $target
-     * @return bool
+     * @return boolean|null
      */
     public function canPublishTarget(DataObject $target)
     {
@@ -104,7 +104,7 @@ 
      *
      * @param Member $member
      * @param array $context
-     * @return bool
+     * @return boolean|string
      */
     public function canCreate($member = null, $context = array())
     {
@@ -113,7 +113,7 @@ 
 
     /**
      * @param  Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -122,7 +122,7 @@ 
 
     /**
      * @param  Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {

src/DataObjects/WorkflowActionInstance.php

Doc Comments +7 added lines

@@ -57,6 +57,7 @@ 
 
     /**
      * Gets fields for when this is part of an active workflow
+     * @param \SilverStripe\Forms\FieldList $fields
      */
     public function updateWorkflowFields($fields)
     {
@@ -74,6 +75,9 @@ 
         }
     }
 
+    /**
+     * @param \SilverStripe\Forms\FieldList $fields
+     */
     public function updateFrontendWorkflowFields($fields)
     {
         if ($this->BaseAction()->AllowCommenting) {
@@ -108,6 +112,9 @@ 
         return $obj;
     }
 
+    /**
+     * @param \SilverStripe\Forms\FieldList $actions
+     */
     public function updateFrontEndWorkflowActions($actions)
     {
         $ba = $this->BaseAction();

src/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)

src/DataObjects/WorkflowTransition.php

Doc Comments +3 added lines, -3 removed lines

@@ -217,7 +217,7 @@ 
      *
      * @param  Member $member
      * @param array $context
-     * @return bool
+     * @return boolean|string
      */
     public function canCreate($member = null, $context = array())
     {
@@ -226,7 +226,7 @@ 
 
     /**
      * @param  Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -235,7 +235,7 @@ 
 
     /**
      * @param  Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {

src/Extensions/WorkflowApplicable.php

Doc Comments +2 added lines, -1 removed lines

@@ -328,7 +328,8 @@
     /**
      * Gets the history of a workflow instance
      *
-     * @return DataObjectSet
+     * @param integer $limit
+     * @return \SilverStripe\ORM\DataList|null
      */
     public function getWorkflowHistory($limit = null)
     {

src/Extensions/WorkflowEmbargoExpiryExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -535,7 +535,7 @@
      * disabled.
      *
      * @param Member $member
-     * @return bool|null
+     * @return false|null
      */
     public function canEdit($member)
     {

src/FormFields/WorkflowField.php

Doc Comments +4 added lines

@@ -33,6 +33,10 @@
 
     protected $definition;
 
+    /**
+     * @param string $name
+     * @param string $title
+     */
     public function __construct($name, $title, WorkflowDefinition $definition)
     {
         $this->definition = $definition;