WorkflowField::CreateableActions() - Code Metrics - Inspection of "Converted to PSR-2" - silverstripe-australia/advancedworkflow - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#230)

by Helpful

created 2015-12-17 18:12 UTC

WorkflowField::CreateableActions() B

↳ Parent: WorkflowField

Complexity

Conditions	4
Paths	5

Size

Total Lines	22
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	22
rs	8.9197
cc	4
eloc	13
nc	5
nop	0

<?php
/**
 * A form field that allows workflow actions and transitions to be edited,
 * while showing a visual overview of the flow.
 *
 * @package advancedworkflow
 */
class WorkflowField extends FormField
namespace YourVendor;

class YourClass { }
{

    public static $allowed_actions = array(
        'action',
        'transition',
        'sort'
    );

    protected $definition;

    public function __construct($name, $title, WorkflowDefinition $definition)
    {
        $this->definition = $definition;
        $this->addExtraClass('workflow-field');

        parent::__construct($name, $title);
    }

    public function action()
    {
        return new WorkflowFieldActionController($this, 'action');
    }

    public function transition()
    {
        return new WorkflowFieldTransitionController($this, 'transition');
    }

    public function sort($request)
    {
        if (!SecurityToken::inst()->checkRequest($request)) {
            $this->httpError(404);
        }

        $class = $request->postVar('class');
        $ids   = $request->postVar('id');

        if ($class == 'WorkflowAction') {
            $objects = $this->Definition()->Actions();

        } elseif ($class == 'WorkflowTransition') {
            $parent = $request->postVar('parent');
            $action = $this->Definition()->Actions()->byID($parent);


            if (!$action) {
                $this->httpError(400, _t('AdvancedWorkflowAdmin.INVALIDPARENTID', 'An invalid parent ID was specified.'));
            }

            $objects = $action->Transitions();
        } else {
            $this->httpError(400, _t('AdvancedWorkflowAdmin.INVALIDCLASSTOORDER', 'An invalid class to order was specified.'));
        }

        if (array_diff($ids, $objects->column('ID'))) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            $this->httpError(400, _t('AdvancedWorkflowAdmin.INVALIDIDLIST', 'An invalid list of IDs was provided.'));
        }

        singleton('WorkflowService')->reorder($objects, $ids);

        return new SS_HTTPResponse(
            null, 200, _t('AdvancedWorkflowAdmin.SORTORDERSAVED', 'The sort order has been saved.')
        );
    }

    public function getTemplate()
    {
        return 'WorkflowField';
    }

    public function FieldHolder($properties = array())
    {
        Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
        Requirements::javascript(THIRDPARTY_DIR . '/jquery-entwine/dist/jquery.entwine-dist.js');
        Requirements::javascript(ADVANCED_WORKFLOW_DIR . '/javascript/WorkflowField.js');
        Requirements::css(ADVANCED_WORKFLOW_DIR . '/css/WorkflowField.css');

        return $this->Field($properties);
    }

    public function Definition()
    {
        return $this->definition;
    }

    public function ActionLink()
    {
        $parts = func_get_args();
        array_unshift($parts, 'action');

        return $this->Link(implode('/', $parts));
    }

    public function TransitionLink()
    {
        $parts = func_get_args();
        array_unshift($parts, 'transition');

        return $this->Link(implode('/', $parts));
    }

    public function CreateableActions()
    {
        $list    = new ArrayList();
        $classes = ClassInfo::subclassesFor('WorkflowAction');

        array_shift($classes);
        sort($classes);

        foreach ($classes as $class) {
            $reflect = new ReflectionClass($class);
            $can     = singleton($class)->canCreate() && !$reflect->isAbstract();

            if ($can) {
                $list->push(new ArrayData(array(
                'Title' => singleton($class)->singular_name(),
                'Class' => $class
            )));
            }
        }

        return $list;
    }
}


1			<?php
2			/**
3			* A form field that allows workflow actions and transitions to be edited,
4			* while showing a visual overview of the flow.
5			*
6			* @package advancedworkflow
7			*/
8			class WorkflowField extends FormField
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
9			{
10
11			public static $allowed_actions = array(
12			'action',
13			'transition',
14			'sort'
15			);
16
17			protected $definition;
18
19			public function __construct($name, $title, WorkflowDefinition $definition)
20			{
21			$this->definition = $definition;
22			$this->addExtraClass('workflow-field');
23
24			parent::__construct($name, $title);
25			}
26
27			public function action()
28			{
29			return new WorkflowFieldActionController($this, 'action');
30			}
31
32			public function transition()
33			{
34			return new WorkflowFieldTransitionController($this, 'transition');
35			}
36
37			public function sort($request)
38			{
39			if (!SecurityToken::inst()->checkRequest($request)) {
40			$this->httpError(404);
41			}
42
43			$class = $request->postVar('class');
44			$ids = $request->postVar('id');
45
46			if ($class == 'WorkflowAction') {
47			$objects = $this->Definition()->Actions();
			0 ignored issues – show Bug introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report The method `Actions()` does not exist on `WorkflowDefinition`. Did you maybe mean `updateAdminActions()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
48			} elseif ($class == 'WorkflowTransition') {
49			$parent = $request->postVar('parent');
50			$action = $this->Definition()->Actions()->byID($parent);
			0 ignored issues – show Bug introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report The method `Actions()` does not exist on `WorkflowDefinition`. Did you maybe mean `updateAdminActions()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
51
52			if (!$action) {
53			$this->httpError(400, _t('AdvancedWorkflowAdmin.INVALIDPARENTID', 'An invalid parent ID was specified.'));
54			}
55
56			$objects = $action->Transitions();
57			} else {
58			$this->httpError(400, _t('AdvancedWorkflowAdmin.INVALIDCLASSTOORDER', 'An invalid class to order was specified.'));
59			}
60
61			if (array_diff($ids, $objects->column('ID'))) {
			0 ignored issues – show Bug introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report The variable `$objects` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
62			$this->httpError(400, _t('AdvancedWorkflowAdmin.INVALIDIDLIST', 'An invalid list of IDs was provided.'));
63			}
64
65			singleton('WorkflowService')->reorder($objects, $ids);
66
67			return new SS_HTTPResponse(
68			null, 200, _t('AdvancedWorkflowAdmin.SORTORDERSAVED', 'The sort order has been saved.')
69			);
70			}
71
72			public function getTemplate()
73			{
74			return 'WorkflowField';
75			}
76
77			public function FieldHolder($properties = array())
78			{
79			Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
80			Requirements::javascript(THIRDPARTY_DIR . '/jquery-entwine/dist/jquery.entwine-dist.js');
81			Requirements::javascript(ADVANCED_WORKFLOW_DIR . '/javascript/WorkflowField.js');
82			Requirements::css(ADVANCED_WORKFLOW_DIR . '/css/WorkflowField.css');
83
84			return $this->Field($properties);
85			}
86
87			public function Definition()
88			{
89			return $this->definition;
90			}
91
92			public function ActionLink()
93			{
94			$parts = func_get_args();
95			array_unshift($parts, 'action');
96
97			return $this->Link(implode('/', $parts));
98			}
99
100			public function TransitionLink()
101			{
102			$parts = func_get_args();
103			array_unshift($parts, 'transition');
104
105			return $this->Link(implode('/', $parts));
106			}
107
108			public function CreateableActions()
109			{
110			$list = new ArrayList();
111			$classes = ClassInfo::subclassesFor('WorkflowAction');
112
113			array_shift($classes);
114			sort($classes);
115
116			foreach ($classes as $class) {
117			$reflect = new ReflectionClass($class);
118			$can = singleton($class)->canCreate() && !$reflect->isAbstract();
119
120			if ($can) {
121			$list->push(new ArrayData(array(
122			'Title' => singleton($class)->singular_name(),
123			'Class' => $class
124			)));
125			}
126			}
127
128			return $list;
129			}
130			}
131

silverstripe-australia / advancedworkflow

Pull Request — master (#230)

WorkflowField::CreateableActions() B

Complexity

Size

Duplication

Available Fixes

Duplication Side-by-Side

Filter issues like