symbiote / silverstripe-advancedworkflow

code/actions/AssignUsersToWorkflowAction.php

<?php

namespace Symbiote\AdvancedWorkflow\Actions;

use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\CheckboxSetField;
use SilverStripe\Forms\HeaderField;
use SilverStripe\Forms\TreeMultiselectField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DB;
use SilverStripe\Security\Group;
use SilverStripe\Security\Member;
use Symbiote\AdvancedWorkflow\DataObjects\WorkflowAction;
use Symbiote\AdvancedWorkflow\DataObjects\WorkflowInstance;

/**
 * A workflow action that allows additional users or groups to be assigned to
 * the workflow part-way through the workflow path.
 *
 * @license    BSD License (http://silverstripe.org/bsd-license/)
 * @package    advancedworkflow
 * @subpackage actions
 */
class AssignUsersToWorkflowAction extends WorkflowAction
{
    private static $db = array(
        'AssignInitiator'       => 'Boolean',
    );

    private static $many_many = array(
        'Users'  => Member::class,
        'Groups' => Group::class,
    );

    private static $icon = 'symbiote/silverstripe-advancedworkflow:images/assign.png';

Consider using a different property name as you override a private property of the parent class.

The property $icon is not used and could be removed.

    private static $table_name = 'AssignUsersToWorkflowAction';

    public function execute(WorkflowInstance $workflow)
    {
        $workflow->Users()->removeAll();
        //Due to http://open.silverstripe.org/ticket/8258, there are errors occuring if Group has been extended
        //We use a direct delete query here before ticket 8258 fixed
        //$workflow->Groups()->removeAll();
        $workflowID = $workflow->ID;
        $query = <<<SQL
		DELETE FROM "WorkflowInstance_Groups" WHERE ("WorkflowInstance_Groups"."WorkflowInstanceID" = '$workflowID');
SQL;
        DB::query($query);
        $workflow->Users()->addMany($this->Users());
        $workflow->Groups()->addMany($this->Groups());
        if ($this->AssignInitiator) {
            $workflow->Users()->add($workflow->Initiator());
        }
        return true;
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $cmsUsers = Member::mapInCMSGroups();

        $fields->addFieldsToTab('Root.Main', array(
            new HeaderField('AssignUsers', $this->fieldLabel('AssignUsers')),
            new CheckboxField('AssignInitiator', $this->fieldLabel('AssignInitiator')),
            $users = CheckboxSetField::create('Users', $this->fieldLabel('Users'), $cmsUsers),
            new TreeMultiselectField('Groups', $this->fieldLabel('Groups'), Group::class)
        ));

        // limit to the users which actually can access the CMS
        $users->setSource(Member::mapInCMSGroups());

        return $fields;
    }

    public function fieldLabels($relations = true)
    {
        return array_merge(parent::fieldLabels($relations), array(
            'AssignUsers'       => _t('AssignUsersToWorkflowAction.ASSIGNUSERS', 'Assign Users'),
            'Users'             => _t('AssignUsersToWorkflowAction.USERS', 'Users'),
            'Groups'            => _t('AssignUsersToWorkflowAction.GROUPS', 'Groups'),
            'AssignInitiator'   => _t('AssignUsersToWorkflowAction.INITIATOR', 'Assign Initiator'),
        ));
    }

    /**
     * Returns a set of all Members that are assigned to this WorkflowAction subclass, either directly or via a group.
     *
     * @return ArrayList
     */
    public function getAssignedMembers()
    {
        $members = $this->Users();
        $groups  = $this->Groups();

        // Can't merge instances of DataList so convert to something where we can
        $_members = ArrayList::create();
        $members->each(function ($item) use ($_members) {
            $_members->push($item);
        });

        $_groups = ArrayList::create();
        $groups->each(function ($item) use ($_groups) {
            $_groups->push($item);
        });

        foreach ($_groups as $group) {
            $_members->merge($group->Members());
        }

        $_members->removeDuplicates();
        return $_members;
    }
}