symbiote / silverstripe-advancedworkflow

code/formfields/WorkflowFieldActionController.php

Doc Comments +4 added lines

@@ -27,6 +27,10 @@
     protected $parent;
     protected $name;
 
+    /**
+     * @param WorkflowField $parent
+     * @param string $name
+     */
     public function __construct($parent, $name)
     {
         $this->parent = $parent;

code/forms/FrontendWorkflowForm.php

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace Symbiote\AdvancedWorkflow\Forms;
 
 use SilverStripe\Forms\Form;
-use FormResponse;
 use SilverStripe\Control\Director;
 use SilverStripe\Control\HTTPResponse;
 use SilverStripe\Core\Convert;

code/forms/gridfield/GridFieldExportAction.php

Doc Comments +2 added lines, -2 removed lines

@@ -66,7 +66,7 @@ 
      * Which columns are handled by this component
      *
      * @param type $gridField
-     * @return type
+     * @return string[]
      */
     public function getColumnsHandled($gridField)
     {
@@ -77,7 +77,7 @@ 
      * Which GridField actions are this component handling
      *
      * @param GridField $gridField
-     * @return array
+     * @return string[]
      */
     public function getActions($gridField)
     {

code/forms/gridfield/GridFieldWorkflowRestrictedEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -73,7 +73,7 @@ 
      * Which columns are handled by this component
      *
      * @param type $gridField
-     * @return type
+     * @return string[]
      */
     public function getColumnsHandled($gridField)
     {
@@ -85,7 +85,7 @@ 
      * @param DataObject $record
      * @param string $columnName
      *
-     * @return string - the HTML for the column
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText - the HTML for the column
      */
     public function getColumnContent($gridField, $record, $columnName)
     {

tests/WorkflowEmbargoExpiryTest.php

Unused Use Statements -1 removed lines

@@ -8,7 +8,6 @@
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\FieldType\DBDatetime;
 use SilverStripe\Translatable\Model\Translatable;
-use SilverStripe\Security\Member;
 use SilverStripe\Subsites\Extensions\SiteTreeSubsites;
 use SilverStripe\Versioned\Versioned;
 use Symbiote\AdvancedWorkflow\DataObjects\WorkflowAction;

code/formfields/WorkflowFieldTransitionController.php

Doc Comments +4 added lines

@@ -27,6 +27,10 @@
     protected $parent;
     protected $name;
 
+    /**
+     * @param WorkflowField $parent
+     * @param string $name
+     */
     public function __construct($parent, $name)
     {
         $this->parent = $parent;

code/extensions/AdvancedWorkflowExtension.php

Unused Use Statements -2 removed lines

@@ -4,11 +4,9 @@
 
 use SilverStripe\Control\Controller;
 use SilverStripe\Core\Extension;
-use SilverStripe\Core\Manifest\ModuleLoader;
 use SilverStripe\Forms\Form;
 use SilverStripe\Forms\GridField\GridFieldDetailForm_ItemRequest;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Security\Permission;
 use SilverStripe\View\Requirements;
 use Symbiote\AdvancedWorkflow\Extensions\WorkflowApplicable;
 use Symbiote\AdvancedWorkflow\Services\WorkflowService;

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)