Symbiote\AdvancedWorkflow\Extensions\FileWorkflowApplicable

Complexity

Total Complexity

12

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	updateSummaryFields()	0	5	1
A	updateCMSFields()	0	25	3
B	onAfterWrite()	0	37	8

<?php

namespace Symbiote\AdvancedWorkflow\Extensions;

use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;

/**
 * WorkflowApplicable extension specifically for File objects, which don't have the same CMS
 * UI structure so need to be handled a little differently. Additionally, it doesn't really
 * work without custom code to handle the triggering of workflow, and in general is not
 * ready for production use just yet.
 *
 * @author  marcus@symbiote.com.au
 * @license BSD License (http://silverstripe.org/bsd-license/)
 * @package advancedworkflow
 */
class FileWorkflowApplicable extends WorkflowApplicable
{
    public function updateSummaryFields(&$fields)
    {
        $fields['ID'] = 'ID';
        $fields['ParentID'] = 'ParentID';
    }

    public function updateCMSFields(FieldList $fields)
    {
        if (!$this->owner->ID) {
            return $fields;
        }
        parent::updateCMSFields($fields);

        // add the workflow fields directly. It's a requirement of workflow on file objects
        // that CMS admins mark the workflow step as being editable for files to be administerable
        $active = $this->getWorkflowService()->getWorkflowFor($this->owner);
        if ($active) {
            $current = $active->CurrentAction();
            $wfFields = $active->getWorkflowFields();

            // loading data in a somewhat hack way
            $form = new Form($this, 'DummyForm', $wfFields, new FieldList());

$this is of type this<Symbiote\AdvancedWorkflow\Extensions\FileWorkflowApplicable>, but the function expects a null|object<SilverStripe\Control\RequestHandler>.

            $form->loadDataFrom($current);

            $fields->findOrMakeTab(
                'Root.WorkflowActions',
                _t('Workflow.WorkflowActionsTabTitle', 'Workflow Actions')
            );
            $fields->addFieldsToTab('Root.WorkflowActions', $wfFields);
        }
    }

    public function onAfterWrite()
    {
        parent::onAfterWrite();

        $workflow = $this->getWorkflowService()->getWorkflowFor($this->owner);
        $rawData = $this->owner->toMap();
        if ($workflow && $this->owner->TransitionID) {
            // we want to transition, so do so if that's a valid transition to take.
            $action = $workflow->CurrentAction();
            if (!$this->canEditWorkflow()) {
                return;
            }

            $allowedFields = $workflow->getWorkflowFields()->saveableFields();
            unset($allowedFields['TransitionID']);

            $allowed = array_keys($allowedFields);

            foreach ($allowed as $field) {
                if (isset($rawData[$field])) {
                    $action->$field = $rawData[$field];
                }
            }

            $action->write();

            if (isset($rawData['TransitionID']) && $rawData['TransitionID']) {
                // unset the transition ID so this doesn't get re-executed
                $this->owner->TransitionID = null;
                $this->getWorkflowService()->executeTransition($this->owner, $rawData['TransitionID']);
            } else {
                // otherwise, just try to execute the current workflow to see if it
                // can now proceed based on user input
                $workflow->execute();
            }
        }
    }
}