Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MNT Update @methods on class docblocks #509

Merged
merged 1 commit into from
Dec 14, 2023
Merged

MNT Update @methods on class docblocks #509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Actions/AssignUsersToWorkflowAction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 0 additions & 2 deletions src/Actions/SetPropertyWorkflowAction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
use Symbiote\AdvancedWorkflow\DataObjects\WorkflowInstance;

/**
*
*
* @author Marcus Nyeholt <marcus@symbiote.com.au>
*/
class SetPropertyWorkflowAction extends WorkflowAction
Expand Down
4 changes: 2 additions & 2 deletions src/Actions/UnpublishItemWorkflowAction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Comment on lines -13 to +14
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was already done in a separate PR - but should be okay here too


/**
* Unpublishes an item
Expand Down
1 change: 1 addition & 0 deletions src/DataObjects/ImportedWorkflowTemplate.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
4 changes: 3 additions & 1 deletion src/DataObjects/WorkflowAction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
3 changes: 3 additions & 0 deletions src/DataObjects/WorkflowActionInstance.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
4 changes: 4 additions & 0 deletions src/DataObjects/WorkflowDefinition.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
10 changes: 6 additions & 4 deletions src/DataObjects/WorkflowInstance.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
6 changes: 4 additions & 2 deletions src/DataObjects/WorkflowTransition.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 2 additions & 0 deletions src/Extensions/WorkflowApplicable.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 2 additions & 0 deletions src/Extensions/WorkflowEmbargoExpiryExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down