silverstripe-australia / advancedworkflow

code/admin/AdvancedWorkflowAdmin.php

Doc Comments +1 added lines, -2 removed lines

@@ -219,9 +219,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)

code/admin/WorkflowDefinitionExporter.php

Doc Comments +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
      * Used for pushing data to the browser to prompt for download
      * 
      * @param string $str
-     * @return number $bytes
+     * @return integer $bytes
      */
     public function getExportSize($str)
     {

code/controllers/FrontEndWorkflowController.php

Doc Comments +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
      * - required fields from the Context Object
      * - Actions from the connected WorkflowTransitions
      * 
-     * @return Form
+     * @return null|FrontendWorkflowForm
      */
     public function Form()
     {

code/dataobjects/WorkflowAction.php

Doc Comments +3 added lines, -3 removed lines

@@ -53,7 +53,7 @@ 
      * if null is returned from this method.
      *
      * @param  DataObject $target
-     * @return bool
+     * @return boolean|null
      */
     public function canEditTarget(DataObject $target)
     {
@@ -64,7 +64,7 @@ 
      * Does this action restrict viewing of the document?
      *
      * @param  DataObject $target
-     * @return bool
+     * @return boolean|null
      */
     public function canViewTarget(DataObject $target)
     {
@@ -75,7 +75,7 @@ 
      * Does this action restrict the publishing of a document?
      *
      * @param  DataObject $target
-     * @return bool
+     * @return boolean|null
      */
     public function canPublishTarget(DataObject $target)
     {

code/dataobjects/WorkflowActionInstance.php

Doc Comments +7 added lines

@@ -44,6 +44,7 @@ 
 
     /**
      * Gets fields for when this is part of an active workflow
+     * @param FieldList $fields
      */
     public function updateWorkflowFields($fields)
     {
@@ -52,6 +53,9 @@ 
         }
     }
 
+    /**
+     * @param FieldList $fields
+     */
     public function updateFrontendWorkflowFields($fields)
     {
         if ($this->BaseAction()->AllowCommenting) {
@@ -86,6 +90,9 @@ 
         return $obj;
     }
 
+    /**
+     * @param FieldList $actions
+     */
     public function updateFrontEndWorkflowActions($actions)
     {
         $ba = $this->BaseAction();

code/dataobjects/WorkflowDefinition.php

Doc Comments +2 added lines, -1 removed lines

@@ -403,7 +403,7 @@ 
     /**
      *
      * @param Member $member
-     * @return boolean
+     * @return boolean|null
      */
     public function canView($member=null)
     {
@@ -451,6 +451,7 @@ 
      * Checks whether the passed user is able to view this ModelAdmin
      *
      * @param $memberID
+     * @param Member|null $member
      */
     protected function userHasAccess($member)
     {

code/dataobjects/WorkflowInstance.php

Doc Comments +4 added lines, -3 removed lines

@@ -446,6 +446,7 @@ 
      * workflow
      *
      * @param $memberID
+     * @param Member|null $member
      */
     protected function userHasAccess($member)
     {
@@ -500,7 +501,7 @@ 
     /**
      * Does this action restrict the publishing of a document?
      *
-     * @return boolean
+     * @return boolean|null
      */
     public function canPublishTarget()
     {
@@ -513,7 +514,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()
     {
@@ -679,7 +680,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/extensions/WorkflowApplicable.php

Doc Comments +1 added lines

@@ -299,6 +299,7 @@
     /**
      * Gets the history of a workflow instance
      *
+     * @param integer $limit
      * @return DataObjectSet
      */
     public function getWorkflowHistory($limit = null)

code/formfields/WorkflowField.php

Doc Comments +4 added lines

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