Merge pull request #509 from creative-commoners/pulls/6.1/docblock

MNT Update @methods on class docblocks
symbiote · Dec 14, 2023 · dfa839c · dfa839c
2 parents 6abaacf + 90e5926
commit dfa839c
Show file tree

Hide file tree

Showing 11 changed files with 29 additions and 11 deletions.
diff --git a/src/Actions/AssignUsersToWorkflowAction.php b/src/Actions/AssignUsersToWorkflowAction.php
@@ -20,6 +20,8 @@
  * @license    BSD License (http://silverstripe.org/bsd-license/)
  * @package    advancedworkflow
  * @subpackage actions
+ * @method SilverStripe\ORM\ManyManyList<Group> Groups()
+ * @method SilverStripe\ORM\ManyManyList<Member> Users()
  */
 class AssignUsersToWorkflowAction extends WorkflowAction
 {

diff --git a/src/Actions/SetPropertyWorkflowAction.php b/src/Actions/SetPropertyWorkflowAction.php
@@ -7,8 +7,6 @@
 use Symbiote\AdvancedWorkflow\DataObjects\WorkflowInstance;
 
 /**
- *
- *
  * @author Marcus Nyeholt <marcus@symbiote.com.au>
  */
 class SetPropertyWorkflowAction extends WorkflowAction

diff --git a/src/Actions/UnpublishItemWorkflowAction.php b/src/Actions/UnpublishItemWorkflowAction.php
@@ -10,8 +10,8 @@
 use Symbiote\AdvancedWorkflow\DataObjects\WorkflowInstance;
 use Symbiote\AdvancedWorkflow\Extensions\WorkflowEmbargoExpiryExtension;
 use Symbiote\AdvancedWorkflow\Jobs\WorkflowPublishTargetJob;
-use Symbiote\QueuedJob\Services\AbstractQueuedJob;
-use Symbiote\QueuedJob\Services\QueuedJobService;
+use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
+use Symbiote\QueuedJobs\Services\QueuedJobService;
 
 /**
  * Unpublishes an item

diff --git a/src/DataObjects/ImportedWorkflowTemplate.php b/src/DataObjects/ImportedWorkflowTemplate.php
@@ -11,6 +11,7 @@
  * @author  russell@silverstripe.com
  * @license BSD License (http://silverstripe.org/bsd-license/)
  * @package advancedworkflow
+ * @method WorkflowDefinition Definition()
  */
 class ImportedWorkflowTemplate extends DataObject
 {

diff --git a/src/DataObjects/WorkflowAction.php b/src/DataObjects/WorkflowAction.php
@@ -21,10 +21,12 @@
  * the action(s) that occur while in that state. An action can then have
  * subsequent transitions out of the current state.
  *
- * @method WorkflowDefinition WorkflowDef()
  * @author  marcus@symbiote.com.au
  * @license BSD License (http://silverstripe.org/bsd-license/)
  * @package advancedworkflow
+ * @method Member Member()
+ * @method SilverStripe\ORM\HasManyList<WorkflowTransition> Transitions()
+ * @method WorkflowDefinition WorkflowDef()
  */
 class WorkflowAction extends DataObject
 {

diff --git a/src/DataObjects/WorkflowActionInstance.php b/src/DataObjects/WorkflowActionInstance.php
@@ -22,6 +22,9 @@
  *
  * @license BSD License (http://silverstripe.org/bsd-license/)
  * @package advancedworkflow
+ * @method WorkflowAction BaseAction()
+ * @method Member Member()
+ * @method WorkflowInstance Workflow()
  */
 class WorkflowActionInstance extends DataObject
 {

diff --git a/src/DataObjects/WorkflowDefinition.php b/src/DataObjects/WorkflowDefinition.php
@@ -49,6 +49,10 @@
  * @author  marcus@symbiote.com.au
  * @license BSD License (http://silverstripe.org/bsd-license/)
  * @package advancedworkflow
+ * @method SilverStripe\ORM\HasManyList<WorkflowAction> Actions()
+ * @method SilverStripe\ORM\ManyManyList<Group> Groups()
+ * @method SilverStripe\ORM\HasManyList<WorkflowInstance> Instances()
+ * @method SilverStripe\ORM\ManyManyList<Member> Users()
  */
 class WorkflowDefinition extends DataObject
 {

diff --git a/src/DataObjects/WorkflowInstance.php b/src/DataObjects/WorkflowInstance.php
@@ -38,13 +38,15 @@
  * button (eg 'apply for approval'). This creates a standalone object
  * that maintains the state of the workflow process.
  *
- * @method WorkflowDefinition Definition()
- * @method WorkflowActionInstance CurrentAction()
- * @method Member Initiator()
- *
  * @author  marcus@symbiote.com.au
  * @license BSD License (http://silverstripe.org/bsd-license/)
  * @package advancedworkflow
+ * @method SilverStripe\ORM\HasManyList<WorkflowActionInstance> Actions()
+ * @method WorkflowActionInstance CurrentAction()
+ * @method WorkflowDefinition Definition()
+ * @method SilverStripe\ORM\ManyManyList<Group> Groups()
+ * @method Member Initiator()
+ * @method SilverStripe\ORM\ManyManyList<Member> Users()
  */
 class WorkflowInstance extends DataObject
 {

diff --git a/src/DataObjects/WorkflowTransition.php b/src/DataObjects/WorkflowTransition.php
@@ -27,11 +27,13 @@
  * Therefore, any logic around whether the workflow can proceed should be
  * managed within this method.
  *
- * @method WorkflowAction Action()
- * @method WorkflowAction NextAction()
  * @author  marcus@symbiote.com.au
  * @license BSD License (http://silverstripe.org/bsd-license/)
  * @package advancedworkflow
+ * @method WorkflowAction Action()
+ * @method SilverStripe\ORM\ManyManyList<Group> Groups()
+ * @method WorkflowAction NextAction()
+ * @method SilverStripe\ORM\ManyManyList<Member> Users()
  */
 class WorkflowTransition extends DataObject
 {

diff --git a/src/Extensions/WorkflowApplicable.php b/src/Extensions/WorkflowApplicable.php
@@ -35,6 +35,8 @@
  * @author  marcus@symbiote.com.au
  * @license BSD License (http://silverstripe.org/bsd-license/)
  * @package advancedworkflow
+ * @method SilverStripe\ORM\ManyManyList<WorkflowDefinition> AdditionalWorkflowDefinitions()
+ * @method WorkflowDefinition WorkflowDefinition()
  */
 class WorkflowApplicable extends DataExtension
 {

diff --git a/src/Extensions/WorkflowEmbargoExpiryExtension.php b/src/Extensions/WorkflowEmbargoExpiryExtension.php
@@ -35,6 +35,8 @@
  *
  * @author marcus@symbiote.com.au
  * @license BSD License http://silverstripe.org/bsd-license/
+ * @method QueuedJobDescriptor PublishJob()
+ * @method QueuedJobDescriptor UnPublishJob()
  */
 class WorkflowEmbargoExpiryExtension extends DataExtension
 {