Symbiote\AdvancedWorkflow\Controllers\FrontEndWorkflowController

Complexity

Total Complexity

26

Size/Duplication

Total Lines	195
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
	getContextType()	0	1	?
	getWorkflowDefinition()	0	1	?
A	getContextObject()	0	13	5
A	getContextID()	0	12	5
A	handleAction()	0	4	1
A	Form()	0	36	3
A	getCurrentTransition()	0	8	2
B	doFrontEndAction()	0	41	5
A	Title()	0	13	5

<?php

namespace Symbiote\AdvancedWorkflow\Controllers;

use Exception;
use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Forms\Form;
use SilverStripe\ORM\DataObject;
use Symbiote\AdvancedWorkflow\DataObjects\WorkflowTransition;
use Symbiote\AdvancedWorkflow\Forms\FrontendWorkflowForm;
use Symbiote\AdvancedWorkflow\Services\WorkflowService;

/**
 * Provides a front end Form view of the defined Workflow Actions and Transitions
 *
 * @author  rodney@symbiote.com.au shea@symbiote.com.au
 * @license BSD License (http://silverstripe.org/bsd-license/)
 * @package advancedworkflow
 */
abstract class FrontEndWorkflowController extends Controller
{
    protected $transitionID;
    protected $contextObj;

    /**
     * The title to be displayed on the page
     * @var string
     */
    public $Title;


    /**
     * @return string ClassName of object that Workflow is applied to
     */
    abstract public function getContextType();

    /**
     * @return object Context Object
     */
    public function getContextObject()
    {
        if (!$this->contextObj) {
            if ($id = $this->getContextID()) {
                $cType = $this->getContextType();
                $cObj = DataObject::get_by_id($cType, $id);
                if ($cObj) {
                    $this->contextObj = $cObj->canView() ? $cObj : null;
                }
            }
        }
        return $this->contextObj;
    }

    /**
     * @return int ID of Context Object
     */
    protected function getContextID()
    {
        $id = $this->contextObj ? $this->contextObj->ID : null;
        if (!$id) {

The expression $id of type integer|null is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

            if ($this->request->param('ID')) {
                $id = (int) $this->request->param('ID');
            } elseif ($this->request->requestVar('ID')) {
                $id = (int) $this->request->requestVar('ID');
            }
        }
        return $id;
    }

    /**
     * Specifies the Workflow Definition to be used,
     * ie. retrieve from SiteConfig - or wherever it's defined
     *
     * @return WorkflowDefinition
     */
    abstract public function getWorkflowDefinition();

    /**
     * Handle the Form Action
     * - FrontEndWorkflowForm contains the logic for this
     *
     * @param SS_HTTPRequest $request
     * @todo - is this even required???
     */
    public function handleAction($request, $action)
    {
        return parent::handleAction($request, $action);
    }

    /**
     * Create the Form containing:
     * - fields from the Context Object
     * - required fields from the Context Object
     * - Actions from the connected WorkflowTransitions
     *
     * @return Form
     */
    public function Form()
    {
        $svc            = singleton(WorkflowService::class);
        $active         = $svc->getWorkflowFor($this->getContextObject());

        if (!$active) {
            return;
            //throw new Exception('Workflow not found, or not specified for Context Object');
        }

        $wfFields     = $active->getFrontEndWorkflowFields();
        $wfActions    = $active->getFrontEndWorkflowActions();
        $wfValidator  = $active->getFrontEndRequiredFields();

        //Get DataObject for Form (falls back to ContextObject if not defined in WorkflowAction)
        $wfDataObject = $active->getFrontEndDataObject();

        // set any requirements spcific to this contextobject
        $active->setFrontendFormRequirements();

        // hooks for decorators
        $this->extend('updateFrontEndWorkflowFields', $wfFields);
        $this->extend('updateFrontEndWorkflowActions', $wfActions);
        $this->extend('updateFrontEndRequiredFields', $wfValidator);
        $this->extend('updateFrontendFormRequirements');

        $form = new FrontendWorkflowForm($this, 'Form/' . $this->getContextID(), $wfFields, $wfActions, $wfValidator);

        $form->addExtraClass("fwf");

        if ($wfDataObject) {
            $form->loadDataFrom($wfDataObject);
        }

        return $form;
    }

    /**
     * @return WorkflowTransition
     */
    public function getCurrentTransition()
    {
        $trans = null;
        if ($this->transitionID) {
            $trans = DataObject::get_by_id(WorkflowTransition::class, $this->transitionID);
        }
        return $trans;
    }

    /**
     * Save the Form Data to the defined Context Object
     *
     * @param array $data
     * @param Form $form
     * @param SS_HTTPRequest $request
     * @throws Exception
     */
    public function doFrontEndAction(array $data, Form $form, HTTPRequest $request)
    {
        if (!$obj = $this->getContextObject()) {
            throw new Exception(
                _t(
                    'FrontEndWorkflowController.FRONTENDACTION_CONTEXT_EXCEPTION',
                    'Context Object Not Found'
                )
            );
        }

        if (!$this->getCurrentTransition()->canExecute($this->contextObj->getWorkflowInstance())) {
            throw new Exception(
                _t(
                    'FrontEndWorkflowController.FRONTENDACTION_TRANSITION_EXCEPTION',
                    'You do not have permission to execute this action'
                )
            );
        }

        //Only Save data when Transition is 'Active'
        if ($this->getCurrentTransition()->Type == 'Active') {

The property Type does not exist on object<Symbiote\AdvancedWorkflow\DataObjects\WorkflowTransition>. Since you implemented __get, maybe consider adding a @property annotation.

            //Hand off to WorkflowAction to perform Save
            $svc    = singleton(WorkflowService::class);
            $active = $svc->getWorkflowFor($obj);

            $active->doFrontEndAction($data, $form, $request);
        }

        //run execute on WorkflowInstance instance
        $action = $this->contextObj->getWorkflowInstance()->currentAction();
        $action->BaseAction()->execute($this->contextObj->getWorkflowInstance());

        //get valid transitions
        $transitions = $action->getValidTransitions();

        //tell instance to execute transition if it's in the permitted list
        if ($transitions->find('ID', $this->transitionID)) {
            $this->contextObj->getWorkflowInstance()->performTransition($this->getCurrentTransition());
        }
    }

    /**
     * checks to see if there is a title set on the current workflow action
     * uses that or falls back to controller->Title
     */
    public function Title()
    {
        if (!$this->Title) {
            if ($this->getContextObject()) {
                if ($workflow = $this->contextObj->getWorkflowInstance()) {
                    $this->Title = $workflow->currentAction()->BaseAction()->PageTitle
                        ? $workflow->currentAction()->BaseAction()->PageTitle
                        : $workflow->currentAction()->Title;
                }
            }
        }
        return $this->Title;
    }
}