QueuedJobsAdmin::getEditForm() - Code Metrics - Inspection of "Merge 3 -> master" - symbiote/silverstripe-queuedjobs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#148)

by Daniel

created 2017-11-08 12:07 UTC

QueuedJobsAdmin::getEditForm() B

↳ Parent: QueuedJobsAdmin

Complexity

Conditions	4
Paths	2

Size

Total Lines	70
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	70
rs	8.7445
c	0
b	0
f	0
cc	4
eloc	43
nc	2
nop	2

How to fix Long Method

<?php

namespace Symbiote\QueuedJobs\Controllers;

use ReflectionClass;
use SilverStripe\Admin\ModelAdmin;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Forms\DatetimeField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldAddNewButton;
use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
use SilverStripe\Forms\GridField\GridFieldDataColumns;
use SilverStripe\Forms\TextareaField;
use SilverStripe\ORM\DataList;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;
use Symbiote\QueuedJobs\DataObjects\QueuedJobDescriptor;
use Symbiote\QueuedJobs\Forms\GridFieldQueuedJobExecute;
use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
use Symbiote\QueuedJobs\Services\QueuedJob;
use Symbiote\QueuedJobs\Services\QueuedJobService;

/**
 * @author Marcus Nyeholt <[email protected]>
 * @license BSD http://silverstripe.org/bsd-license/
 */
class QueuedJobsAdmin extends ModelAdmin
{
    /**
     * @var string
     */
    private static $url_segment = 'queuedjobs';


    /**
     * @var string
     */
    private static $menu_title = 'Jobs';


    /**
     * @var string
     */
    private static $menu_icon = "queuedjobs/images/clipboard.png";


    /**
     * @var array
     */
    private static $managed_models = [

        QueuedJobDescriptor::class
    ];

    /**
     * @var array
     */
    private static $dependencies = [

        'jobQueue' => '%$' . QueuedJobService::class,
    ];

    /**
     * @var array
     */
    private static $allowed_actions = [

        'EditForm'
    ];

    /**
     * European date format
     * @var string
     */
    private static $date_format_european = 'dd/MM/yyyy';

    /**
     * @var QueuedJobService
     */
    public $jobQueue;

    /**
     * @config The number of seconds to include jobs that have finished
     * default: 300 (5 minutes), examples: 3600(1h), 86400(1d)
     */
    private static $max_finished_jobs_age = 300;


    /**
     * @param int $id
     * @param FieldList $fields
     * @return Form
     */
    public function getEditForm($id = null, $fields = null)
    {
        $form = parent::getEditForm($id, $fields);

        $filter = $this->jobQueue->getJobListFilter(null, self::config()->max_finished_jobs_age);

        $list = DataList::create(QueuedJobDescriptor::class);
        $list = $list->where($filter)->sort('Created', 'DESC');

        $gridFieldConfig = GridFieldConfig_RecordEditor::create()
            ->addComponent(new GridFieldQueuedJobExecute('execute'))
            ->addComponent(new GridFieldQueuedJobExecute('pause', function ($record) {
                return $record->JobStatus == QueuedJob::STATUS_WAIT || $record->JobStatus == QueuedJob::STATUS_RUN;
            }))
            ->addComponent(new GridFieldQueuedJobExecute('resume', function ($record) {
                return $record->JobStatus == QueuedJob::STATUS_PAUSED || $record->JobStatus == QueuedJob::STATUS_BROKEN;
            }))
            ->removeComponentsByType(GridFieldAddNewButton::class);


        // Set messages to HTML display format
        $formatting = array(
            'Messages' => function ($val, $obj) {
                return "<div style='max-width: 300px; max-height: 200px; overflow: auto;'>$obj->Messages</div>";
            },
        );
        $gridFieldConfig->getComponentByType(GridFieldDataColumns::class)
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->setFieldFormatting($formatting);

        // Replace gridfield
        /** @skipUpgrade */
        $grid = GridField::create(
            QueuedJobDescriptor::class,
            _t(__CLASS__ . '.JobsFieldTitle', 'Jobs'),
            $list,
            $gridFieldConfig
        );
        $grid->setForm($form);
        /** @skipUpgrade */
        $form->Fields()->replaceField('QueuedJobDescriptor', $grid);

        if (Permission::check('ADMIN')) {
            $types = ClassInfo::subclassesFor(AbstractQueuedJob::class);
            $types = array_combine($types, $types);
            unset($types[AbstractQueuedJob::class]);
            $jobType = DropdownField::create('JobType', _t(__CLASS__ . '.CREATE_JOB_TYPE', 'Create job of type'), $types);
            $jobType->setEmptyString('(select job to create)');
            $form->Fields()->push($jobType);

            $jobParams = TextareaField::create(
                'JobParams',
                _t(__CLASS__ . '.JOB_TYPE_PARAMS', 'Constructor parameters for job creation (one per line)')
            );
            $form->Fields()->push($jobParams);

            $form->Fields()->push(
                $dt = DatetimeField::create('JobStart', _t(__CLASS__ . '.START_JOB_TIME', 'Start job at'))
            );

            $actions = $form->Actions();
            $actions->push(
                FormAction::create('createjob', _t(__CLASS__ . '.CREATE_NEW_JOB', 'Create new job'))
                    ->addExtraClass('btn btn-primary')
            );
        }

        $this->extend('updateEditForm', $form);

        return $form;
    }

    /**
     * @return string
     */
    public function Tools()
    {
        return '';
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @param  array $data
     * @param  Form $form
     * @return HTTPResponse
     */
    public function createjob($data, Form $form)
    {
        if (Permission::check('ADMIN')) {
            $jobType = isset($data['JobType']) ? $data['JobType'] : '';
            $params = isset($data['JobParams']) ? explode(PHP_EOL, $data['JobParams']) : array();
            $time = isset($data['JobStart']) && is_array($data['JobStart']) ? implode(" ", $data['JobStart']) : null;

            // If the user has select the European date format as their setting then replace '/' with '-' in the date string so PHP
            // treats the date as this format.
            if (Member::currentUser()->DateFormat == self::$date_format_european) {

                $time = str_replace('/', '-', $time);
            }

            if ($jobType && class_exists($jobType)) {
                $jobClass = new ReflectionClass($jobType);
                $job = $jobClass->newInstanceArgs($params);
                if ($this->jobQueue->queueJob($job, $time)) {
                    $form->sessionMessage(_t(__CLASS__ . '.QueuedJobSuccess', 'Successfully queued job'), 'success');
                }
            }
        }
        return $this->redirectBack();
    }
}


GitHub Access Token became invalid

Pull Request — master (#148)

QueuedJobsAdmin::getEditForm() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

1			<?php
2
3			namespace Symbiote\QueuedJobs\Controllers;
4
5			use ReflectionClass;
6			use SilverStripe\Admin\ModelAdmin;
7			use SilverStripe\Core\ClassInfo;
8			use SilverStripe\Forms\DatetimeField;
9			use SilverStripe\Forms\DropdownField;
10			use SilverStripe\Forms\Form;
11			use SilverStripe\Forms\FormAction;
12			use SilverStripe\Forms\GridField\GridField;
13			use SilverStripe\Forms\GridField\GridFieldAddNewButton;
14			use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
15			use SilverStripe\Forms\GridField\GridFieldDataColumns;
16			use SilverStripe\Forms\TextareaField;
17			use SilverStripe\ORM\DataList;
18			use SilverStripe\Security\Member;
19			use SilverStripe\Security\Permission;
20			use Symbiote\QueuedJobs\DataObjects\QueuedJobDescriptor;
21			use Symbiote\QueuedJobs\Forms\GridFieldQueuedJobExecute;
22			use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
23			use Symbiote\QueuedJobs\Services\QueuedJob;
24			use Symbiote\QueuedJobs\Services\QueuedJobService;
25
26			/**
27			* @author Marcus Nyeholt <[email protected]>
28			* @license BSD http://silverstripe.org/bsd-license/
29			*/
30			class QueuedJobsAdmin extends ModelAdmin
31			{
32			/**
33			* @var string
34			*/
35			private static $url_segment = 'queuedjobs';
			0 ignored issues – show Comprehensibility introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report The property `$url_segment` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
36
37			/**
38			* @var string
39			*/
40			private static $menu_title = 'Jobs';
			0 ignored issues – show Comprehensibility introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report The property `$menu_title` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
41
42			/**
43			* @var string
44			*/
45			private static $menu_icon = "queuedjobs/images/clipboard.png";
			0 ignored issues – show Comprehensibility introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report The property `$menu_icon` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
46
47			/**
48			* @var array
49			*/
50			private static $managed_models = [
			0 ignored issues – show Comprehensibility introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report The property `$managed_models` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
51			QueuedJobDescriptor::class
52			];
53
54			/**
55			* @var array
56			*/
57			private static $dependencies = [
			0 ignored issues – show Comprehensibility introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report The property `$dependencies` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
58			'jobQueue' => '%$' . QueuedJobService::class,
59			];
60
61			/**
62			* @var array
63			*/
64			private static $allowed_actions = [
			0 ignored issues – show Comprehensibility introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report The property `$allowed_actions` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
65			'EditForm'
66			];
67
68			/**
69			* European date format
70			* @var string
71			*/
72			private static $date_format_european = 'dd/MM/yyyy';
73
74			/**
75			* @var QueuedJobService
76			*/
77			public $jobQueue;
78
79			/**
80			* @config The number of seconds to include jobs that have finished
81			* default: 300 (5 minutes), examples: 3600(1h), 86400(1d)
82			*/
83			private static $max_finished_jobs_age = 300;
			0 ignored issues – show Unused Code introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report The property `$max_finished_jobs_age` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
84
85			/**
86			* @param int $id
87			* @param FieldList $fields
88			* @return Form
89			*/
90			public function getEditForm($id = null, $fields = null)
91			{
92			$form = parent::getEditForm($id, $fields);
93
94			$filter = $this->jobQueue->getJobListFilter(null, self::config()->max_finished_jobs_age);
95
96			$list = DataList::create(QueuedJobDescriptor::class);
97			$list = $list->where($filter)->sort('Created', 'DESC');
98
99			$gridFieldConfig = GridFieldConfig_RecordEditor::create()
100			->addComponent(new GridFieldQueuedJobExecute('execute'))
101			->addComponent(new GridFieldQueuedJobExecute('pause', function ($record) {
102			return $record->JobStatus == QueuedJob::STATUS_WAIT \|\| $record->JobStatus == QueuedJob::STATUS_RUN;
103			}))
104			->addComponent(new GridFieldQueuedJobExecute('resume', function ($record) {
105			return $record->JobStatus == QueuedJob::STATUS_PAUSED \|\| $record->JobStatus == QueuedJob::STATUS_BROKEN;
106			}))
107			->removeComponentsByType(GridFieldAddNewButton::class);
108
109
110			// Set messages to HTML display format
111			$formatting = array(
112			'Messages' => function ($val, $obj) {
113			return "<div style='max-width: 300px; max-height: 200px; overflow: auto;'>$obj->Messages</div>";
114			},
115			);
116			$gridFieldConfig->getComponentByType(GridFieldDataColumns::class)
			0 ignored issues – show Bug introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SilverStripe\Forms\GridField\GridFieldComponent` as the method `setFieldFormatting()` does only exist in the following implementations of said interface: `SilverStripe\Forms\GridField\GridFieldDataColumns`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
117			->setFieldFormatting($formatting);
118
119			// Replace gridfield
120			/** @skipUpgrade */
121			$grid = GridField::create(
122			QueuedJobDescriptor::class,
123			_t(__CLASS__ . '.JobsFieldTitle', 'Jobs'),
124			$list,
125			$gridFieldConfig
126			);
127			$grid->setForm($form);
128			/** @skipUpgrade */
129			$form->Fields()->replaceField('QueuedJobDescriptor', $grid);
130
131			if (Permission::check('ADMIN')) {
132			$types = ClassInfo::subclassesFor(AbstractQueuedJob::class);
133			$types = array_combine($types, $types);
134			unset($types[AbstractQueuedJob::class]);
135			$jobType = DropdownField::create('JobType', _t(__CLASS__ . '.CREATE_JOB_TYPE', 'Create job of type'), $types);
136			$jobType->setEmptyString('(select job to create)');
137			$form->Fields()->push($jobType);
138
139			$jobParams = TextareaField::create(
140			'JobParams',
141			_t(__CLASS__ . '.JOB_TYPE_PARAMS', 'Constructor parameters for job creation (one per line)')
142			);
143			$form->Fields()->push($jobParams);
144
145			$form->Fields()->push(
146			$dt = DatetimeField::create('JobStart', _t(__CLASS__ . '.START_JOB_TIME', 'Start job at'))
147			);
148
149			$actions = $form->Actions();
150			$actions->push(
151			FormAction::create('createjob', _t(__CLASS__ . '.CREATE_NEW_JOB', 'Create new job'))
152			->addExtraClass('btn btn-primary')
153			);
154			}
155
156			$this->extend('updateEditForm', $form);
157
158			return $form;
159			}
160
161			/**
162			* @return string
163			*/
164			public function Tools()
165			{
166			return '';
			0 ignored issues – show Bug Best Practice introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report The return type of `return '';` (`string`) is incompatible with the return type of the parent method `SilverStripe\Admin\LeftAndMain::Tools` of type `SilverStripe\ORM\FieldType\DBHTMLText\|false`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
167			}
168
169			/**
170			* @param array $data
171			* @param Form $form
172			* @return HTTPResponse
173			*/
174			public function createjob($data, Form $form)
175			{
176			if (Permission::check('ADMIN')) {
177			$jobType = isset($data['JobType']) ? $data['JobType'] : '';
178			$params = isset($data['JobParams']) ? explode(PHP_EOL, $data['JobParams']) : array();
179			$time = isset($data['JobStart']) && is_array($data['JobStart']) ? implode(" ", $data['JobStart']) : null;
180
181			// If the user has select the European date format as their setting then replace '/' with '-' in the date string so PHP
182			// treats the date as this format.
183			if (Member::currentUser()->DateFormat == self::$date_format_european) {
			0 ignored issues – show Deprecated Code introduced 2017-11-07 15:59 UTC by Report Bug Copy Issue Report The method `SilverStripe\Security\Member::currentUser()` has been deprecated with message: 5.0.0 use Security::getCurrentUser() This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
184			$time = str_replace('/', '-', $time);
185			}
186
187			if ($jobType && class_exists($jobType)) {
188			$jobClass = new ReflectionClass($jobType);
189			$job = $jobClass->newInstanceArgs($params);
190			if ($this->jobQueue->queueJob($job, $time)) {
191			$form->sessionMessage(_t(__CLASS__ . '.QueuedJobSuccess', 'Successfully queued job'), 'success');
192			}
193			}
194			}
195			return $this->redirectBack();
196			}
197			}
198

symbiote / silverstripe-queuedjobs

GitHub Access Token became invalid

Pull Request — master (#148)

QueuedJobsAdmin::getEditForm() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like