symbiote / silverstripe-advancedworkflow

code/actions/PublishItemWorkflowAction.php

Unused Use Statements -2 removed lines

@@ -3,8 +3,6 @@
 namespace Symbiote\AdvancedWorkflow\Actions;
 
 use SilverStripe\Forms\CheckboxField;
-use SilverStripe\Forms\FieldGroup;
-use SilverStripe\Forms\LabelField;
 use SilverStripe\Forms\NumericField;
 use SilverStripe\ORM\DataObject;
 use Symbiote\AdvancedWorkflow\DataObjects\WorkflowAction;

code/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()
     {

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

code/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)
     {

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SilverStripe\Forms\CheckboxField;
 use SilverStripe\Forms\DropdownField;
 use SilverStripe\Forms\FieldList;
-use SilverStripe\Forms\ReadonlyField;
 use SilverStripe\Forms\RequiredFields;
 use SilverStripe\Forms\TabSet;
 use SilverStripe\Forms\TextField;

code/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();

code/dataobjects/WorkflowDefinition.php

Doc Comments +5 added lines, -5 removed lines

@@ -453,7 +453,7 @@ 
      *
      * @param Member $member
      * @param array $context
-     * @return bool
+     * @return boolean|string
      */
     public function canCreate($member = null, $context = array())
     {
@@ -469,7 +469,7 @@ 
     /**
      *
      * @param Member $member
-     * @return boolean
+     * @return boolean|null
      */
     public function canView($member = null)
     {
@@ -479,7 +479,7 @@ 
     /**
      *
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -489,7 +489,7 @@ 
     /**
      *
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      * @see {@link $this->onBeforeDelete()}
      */
     public function canDelete($member = null)
@@ -517,7 +517,7 @@ 
      * Checks whether the passed user is able to view this ModelAdmin
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|null
      */
     protected function userHasAccess($member)
     {

Unused Use Statements -2 removed lines

@@ -5,7 +5,6 @@ 
 use SilverStripe\Control\Controller;
 use SilverStripe\Forms\CheckboxSetField;
 use SilverStripe\Forms\DropdownField;
-use SilverStripe\Forms\FieldGroup;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\FormAction;
 use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
@@ -16,7 +15,6 @@ 
 use SilverStripe\Forms\GridField\GridFieldViewButton;
 use SilverStripe\Forms\GridField\GridFieldDetailForm;
 use SilverStripe\Forms\GridField\GridFieldConfig_Base;
-use SilverStripe\Forms\LabelField;
 use SilverStripe\Forms\LiteralField;
 use SilverStripe\Forms\NumericField;
 use SilverStripe\Forms\ReadonlyField;

code/dataobjects/WorkflowInstance.php

Doc Comments +5 added lines, -5 removed lines

@@ -585,7 +585,7 @@ 
     /**
      * Does this action restrict the publishing of a document?
      *
-     * @return boolean
+     * @return boolean|null
      */
     public function canPublishTarget()
     {
@@ -598,7 +598,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()
     {
@@ -731,9 +731,9 @@ 
      * We need a way to "associate" an author with this WorkflowInstance and its Target() to see if she is "allowed" 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)
@@ -770,7 +770,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/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)
     {

code/extensions/AdvancedWorkflowExtension.php

Unused Use Statements -1 removed lines

@@ -8,7 +8,6 @@
 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;