symbiote / silverstripe-advancedworkflow

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

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

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

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

src/Templates/WorkflowTemplate.php

Doc Comments +5 added lines, -2 removed lines

@@ -83,6 +83,9 @@ 
      */
     protected $structure;
 
+    /**
+     * @param string $name
+     */
     public function __construct($name, $description = '', $version = '0.0', $remindDays = 0, $sort = 0)
     {
         $this->name = $name;
@@ -131,7 +134,7 @@ 
      * Creates the relevant data objects for this structure, returning an array
      * of actions in the order they've been created
      *
-     * @param WorkflowDefinition $definitino
+     * @param WorkflowDefinition $definition
      *              An optional workflow definition to bind the actions into
      * @return array
      */
@@ -183,7 +186,7 @@ 
      * Create a workflow action based on a template
      *
      * @param string $name
-     * @param array $template
+     * @param array $actionTemplate
      * @param WorkflowDefinition $definition
      * @return WorkflowAction
      * @throws Exception

src/Admin/WorkflowDefinitionImporter.php

Doc Comments +1 added lines

@@ -24,6 +24,7 @@
      *
      * @param string $name. If set, a single-value array comprising a WorkflowTemplate object who's first
      *                      constructor param matches $name is returned.
+     * @param string $name
      * @return WorkflowTemplate|WorkflowTemplate[]
      */
     public function getImportedWorkflows($name = null)

src/Admin/AdvancedWorkflowAdmin.php

Doc Comments +2 added lines, -3 removed lines

@@ -256,9 +256,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)
@@ -334,7 +333,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/Extensions/AdvancedWorkflowExtension.php

Doc Comments +3 added lines

@@ -158,6 +158,9 @@
         return $this->returnResponse($form);
     }
 
+    /**
+     * @param Form $form
+     */
     protected function returnResponse($form)
     {
         if ($this->owner instanceof GridFieldDetailForm_ItemRequest) {

Unused Use Statements -2 removed lines

@@ -5,11 +5,9 @@
 use SilverStripe\Control\Controller;
 use SilverStripe\Control\HTTPRequest;
 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;

src/Extensions/WorkflowApplicable.php

Doc Comments +2 added lines, -1 removed lines

@@ -353,6 +353,7 @@ 
     /**
      * Gets the history of a workflow instance
      *
+     * @param integer $limit
      * @return DataList
      */
     public function getWorkflowHistory($limit = null)
@@ -414,7 +415,7 @@ 
     /**
      * Can only edit content that's NOT in another person's content changeset
      *
-     * @return bool
+     * @return boolean|null
      */
     public function canEdit($member)
     {