ScheduledExecutionJob - Code Metrics - Inspection of "SilverStripe 4 compatibility" - silverstripe-australia/silverstripe-queuedjobs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#109)

by Robbie

created 2016-12-22 20:23 UTC

ScheduledExecutionJob A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
wmc	11
lcom	1
cbo	2
dl	0
loc	76
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	__construct()	11	2
A	getDataObject()	4	1
A	getTitle()	8	1
A	setup()	3	1
B	process()	32	6

<?php

namespace SilverStripe\QueuedJobs\Jobs;

use SilverStripe\ORM\DataObject;
use SilverStripe\QueuedJobs\Services\AbstractQueuedJob;

/**
 * A job that gets executed on a particular schedule. When it runs,
 * it will call the onScheduledExecution method on the owning
 * dataobject.
 *
 * @author [email protected]
 * @license BSD License http://silverstripe.org/bsd-license/
 */
class ScheduledExecutionJob extends AbstractQueuedJob
{
    /**
     * @param DataObject $dataObject
     * @param int $timesExecuted
     */
    public function __construct($dataObject = null, $timesExecuted = 0)
    {
        if ($dataObject) {
            $this->objectID = $dataObject->ID;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->objectType = $dataObject->ClassName;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

            // captured so we have a unique hash generated for this job
            $this->timesExecuted = $timesExecuted;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->totalSteps = 1;
        }
    }

    /**
     * @return DataObject
     */
    public function getDataObject()
    {
        return DataObject::get_by_id($this->objectType, $this->objectID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return _t(
            'ScheduledExecutionJob.Title',
            'Scheduled execution for {title}',
            array('title' => $this->getDataObject()->getTitle())
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );
    }


    public function setup()
    {
    }

    public function process()
    {
        $object = $this->getDataObject();
        if ($object) {
            $object->onScheduledExecution();

            // figure out what our rescheduled date should be
            $timeStr = $object->ExecuteFree;
            if ($object->ExecuteEvery) {
                $executeInterval = $object->ExecuteInterval;
                if (!$executeInterval || !is_numeric($executeInterval)) {
                    $executeInterval = 1;
                }
                $timeStr = '+' . $executeInterval . ' ' . $object->ExecuteEvery;
            }

            $next = strtotime($timeStr);
            if ($next > time()) {
                // in the future
                $nextGen = date('Y-m-d H:i:s', $next);
                $nextId = singleton('SilverStripe\\QueuedJobs\\Services\\QueuedJobService')->queueJob(
                    new ScheduledExecutionJob($object, $this->timesExecuted + 1),
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $nextGen
                );
                $object->ScheduledJobID = $nextId;
                $object->write();
            }
        }

        $this->currentStep++;
        $this->isComplete = true;
    }
}


1			<?php
2
3			namespace SilverStripe\QueuedJobs\Jobs;
4
5			use SilverStripe\ORM\DataObject;
6			use SilverStripe\QueuedJobs\Services\AbstractQueuedJob;
7
8			/**
9			* A job that gets executed on a particular schedule. When it runs,
10			* it will call the onScheduledExecution method on the owning
11			* dataobject.
12			*
13			* @author [email protected]
14			* @license BSD License http://silverstripe.org/bsd-license/
15			*/
16			class ScheduledExecutionJob extends AbstractQueuedJob
17			{
18			/**
19			* @param DataObject $dataObject
20			* @param int $timesExecuted
21			*/
22			public function __construct($dataObject = null, $timesExecuted = 0)
23			{
24			if ($dataObject) {
25			$this->objectID = $dataObject->ID;
			0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `objectID` does not exist on `object<SilverStripe\Queu...\ScheduledExecutionJob>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
26			$this->objectType = $dataObject->ClassName;
			0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `objectType` does not exist on `object<SilverStripe\Queu...\ScheduledExecutionJob>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
27
28			// captured so we have a unique hash generated for this job
29			$this->timesExecuted = $timesExecuted;
			0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `timesExecuted` does not exist on `object<SilverStripe\Queu...\ScheduledExecutionJob>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
30			$this->totalSteps = 1;
31			}
32			}
33
34			/**
35			* @return DataObject
36			*/
37			public function getDataObject()
38			{
39			return DataObject::get_by_id($this->objectType, $this->objectID);
			0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `objectType` does not exist on `object<SilverStripe\Queu...\ScheduledExecutionJob>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `objectID` does not exist on `object<SilverStripe\Queu...\ScheduledExecutionJob>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
40			}
41
42			/**
43			* @return string
44			*/
45			public function getTitle()
46			{
47			return _t(
48			'ScheduledExecutionJob.Title',
49			'Scheduled execution for {title}',
50			array('title' => $this->getDataObject()->getTitle())
			0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report `array('title' => $this->...taObject()->getTitle())` is of type `array<string,string,{"title":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
51			);
52			}
53
54
55			public function setup()
56			{
57			}
58
59			public function process()
60			{
61			$object = $this->getDataObject();
62			if ($object) {
63			$object->onScheduledExecution();
64
65			// figure out what our rescheduled date should be
66			$timeStr = $object->ExecuteFree;
67			if ($object->ExecuteEvery) {
68			$executeInterval = $object->ExecuteInterval;
69			if (!$executeInterval \|\| !is_numeric($executeInterval)) {
70			$executeInterval = 1;
71			}
72			$timeStr = '+' . $executeInterval . ' ' . $object->ExecuteEvery;
73			}
74
75			$next = strtotime($timeStr);
76			if ($next > time()) {
77			// in the future
78			$nextGen = date('Y-m-d H:i:s', $next);
79			$nextId = singleton('SilverStripe\\QueuedJobs\\Services\\QueuedJobService')->queueJob(
80			new ScheduledExecutionJob($object, $this->timesExecuted + 1),
			0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `timesExecuted` does not exist on `object<SilverStripe\Queu...\ScheduledExecutionJob>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
81			$nextGen
82			);
83			$object->ScheduledJobID = $nextId;
84			$object->write();
85			}
86			}
87
88			$this->currentStep++;
89			$this->isComplete = true;
90			}
91			}
92

silverstripe-australia / silverstripe-queuedjobs

Pull Request — master (#109)

ScheduledExecutionJob A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like