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-07 15:49 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\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\Permission;
19			use Symbiote\QueuedJobs\DataObjects\QueuedJobDescriptor;
20			use Symbiote\QueuedJobs\Forms\GridFieldQueuedJobExecute;
21			use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
22			use Symbiote\QueuedJobs\Services\QueuedJob;
23			use Symbiote\QueuedJobs\Services\QueuedJobService;
24
25			/**
26			* @author Marcus Nyeholt <[email protected]>
27			* @license BSD http://silverstripe.org/bsd-license/
28			*/
29			class QueuedJobsAdmin extends ModelAdmin
30			{
31			/**
32			* @var string
33			*/
34			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...
35
36			/**
37			* @var string
38			*/
39			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...
40
41			/**
42			* @var string
43			*/
44			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...
45
46			/**
47			* @var array
48			*/
49			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...
50			QueuedJobDescriptor::class
51			];
52
53			/**
54			* @var array
55			*/
56			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...
57			'jobQueue' => '%$' . QueuedJobService::class,
58			];
59
60			/**
61			* @var array
62			*/
63			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...
64			'EditForm'
65			];
66
67			/**
68			* European date format
69			* @var string
70			*/
71			private static $date_format_european = 'dd/MM/yyyy';
72
73			/**
74			* @var QueuedJobService
75			*/
76			public $jobQueue;
77
78			/**
79			* @config The number of seconds to include jobs that have finished
80			* default: 300 (5 minutes), examples: 3600(1h), 86400(1d)
81			*/
82			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...
83
84			/**
85			* @param int $id
86			* @param FieldList $fields
87			* @return Form
88			*/
89			public function getEditForm($id = null, $fields = null)
90			{
91			$form = parent::getEditForm($id, $fields);
92
93			$filter = $this->jobQueue->getJobListFilter(null, self::config()->max_finished_jobs_age);
94
95			$list = DataList::create(QueuedJobDescriptor::class);
96			$list = $list->where($filter)->sort('Created', 'DESC');
97
98			$gridFieldConfig = GridFieldConfig_RecordEditor::create()
99			->addComponent(new GridFieldQueuedJobExecute('execute'))
100			->addComponent(new GridFieldQueuedJobExecute('pause', function ($record) {
101			return $record->JobStatus == QueuedJob::STATUS_WAIT \|\| $record->JobStatus == QueuedJob::STATUS_RUN;
102			}))
103			->addComponent(new GridFieldQueuedJobExecute('resume', function ($record) {
104			return $record->JobStatus == QueuedJob::STATUS_PAUSED \|\| $record->JobStatus == QueuedJob::STATUS_BROKEN;
105			}))
106			->removeComponentsByType(GridFieldAddNewButton::class);
107
108
109			// Set messages to HTML display format
110			$formatting = array(
111			'Messages' => function ($val, $obj) {
112			return "<div style='max-width: 300px; max-height: 200px; overflow: auto;'>$obj->Messages</div>";
113			},
114			);
115			$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...
116			->setFieldFormatting($formatting);
117
118			// Replace gridfield
119			/** @skipUpgrade */
120			$grid = GridField::create(
121			QueuedJobDescriptor::class,
122			_t(__CLASS__ . '.JobsFieldTitle', 'Jobs'),
123			$list,
124			$gridFieldConfig
125			);
126			$grid->setForm($form);
127			/** @skipUpgrade */
128			$form->Fields()->replaceField('QueuedJobDescriptor', $grid);
129
130			if (Permission::check('ADMIN')) {
131			$types = ClassInfo::subclassesFor(AbstractQueuedJob::class);
132			$types = array_combine($types, $types);
133			unset($types[AbstractQueuedJob::class]);
134			$jobType = DropdownField::create('JobType', _t(__CLASS__ . '.CREATE_JOB_TYPE', 'Create job of type'), $types);
135			$jobType->setEmptyString('(select job to create)');
136			$form->Fields()->push($jobType);
137
138			$jobParams = TextareaField::create(
139			'JobParams',
140			_t(__CLASS__ . '.JOB_TYPE_PARAMS', 'Constructor parameters for job creation (one per line)')
141			);
142			$form->Fields()->push($jobParams);
143
144			$form->Fields()->push(
145			$dt = DatetimeField::create('JobStart', _t(__CLASS__ . '.START_JOB_TIME', 'Start job at'))
146			);
147
148			$actions = $form->Actions();
149			$actions->push(
150			FormAction::create('createjob', _t(__CLASS__ . '.CREATE_NEW_JOB', 'Create new job'))
151			->addExtraClass('btn btn-primary')
152			);
153			}
154
155			$this->extend('updateEditForm', $form);
156
157			return $form;
158			}
159
160			/**
161			* @return string
162			*/
163			public function Tools()
164			{
165			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...
166			}
167
168			/**
169			* @param array $data
170			* @param Form $form
171			* @return HTTPResponse
172			*/
173			public function createjob($data, Form $form)
174			{
175			if (Permission::check('ADMIN')) {
176			$jobType = isset($data['JobType']) ? $data['JobType'] : '';
177			$params = isset($data['JobParams']) ? explode(PHP_EOL, $data['JobParams']) : array();
178			$time = isset($data['JobStart']) && is_array($data['JobStart']) ? implode(" ", $data['JobStart']) : null;
179
180			// If the user has select the European date format as their setting then replace '/' with '-' in the date string so PHP
181			// treats the date as this format.
182			if (Member::currentUser()->DateFormat == self::$date_format_european) {
183			$time = str_replace('/', '-', $time);
184			}
185
186			if ($jobType && class_exists($jobType)) {
187			$jobClass = new ReflectionClass($jobType);
188			$job = $jobClass->newInstanceArgs($params);
189			if ($this->jobQueue->queueJob($job, $time)) {
190			$form->sessionMessage(_t(__CLASS__ . '.QueuedJobSuccess', 'Successfully queued job'), 'success');
191			}
192			}
193			}
194			return $this->redirectBack();
195			}
196			}
197

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