symbiote / silverstripe-advancedworkflow

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

Unused Use Statements -3 removed lines

@@ -9,11 +9,8 @@
 use SilverStripe\Forms\DatetimeField;
 use SilverStripe\Forms\HeaderField;
 use SilverStripe\Forms\LiteralField;
-use SilverStripe\ORM\ArrayList;
 use SilverStripe\ORM\DataExtension;
-use SilverStripe\ORM\DataQuery;
 use SilverStripe\ORM\FieldType\DBDatetime;
-use SilverStripe\ORM\Queries\SQLSelect;
 use SilverStripe\Security\Member;
 use SilverStripe\Security\Permission;
 use SilverStripe\View\Requirements;

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

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

code/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)
     {
@@ -133,6 +134,7 @@ 
      *  Retrieves and collates the workflow definitions for a data object, where the first element will be the main workflow definition.
      *
      *  @param DataObject object
+     * @param DataObject $object
      *  @return array
      */
 
@@ -163,7 +165,7 @@ 
      *
      * @param mixed $item
      * @param bool $includeComplete
-     * @return WorkflowInstance|null
+     * @return DataObject|null
      */
     public function getWorkflowFor($item, $includeComplete = false)
     {
@@ -182,6 +184,7 @@ 
     /**
      * Get all the workflow action instances for an item
      *
+     * @param DataObject $item
      * @return DataList|null
      */
     public function getWorkflowHistoryFor($item, $limit = null)
@@ -312,7 +315,6 @@ 
     /**
      * Get items that the passed-in user has awaiting for them to action
      *
-     * @param Member $member
      * @return DataList
      */
     public function userPendingItems(Member $user)
@@ -340,7 +342,6 @@ 
     /**
      * Get items that the passed-in user has submitted for workflow review
      *
-     * @param Member $member
      * @return DataList
      */
     public function userSubmittedItems(Member $user)

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

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;