DummyQueuedJob::getTitle() - 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

DummyQueuedJob::getTitle() A

↳ Parent: DummyQueuedJob

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace SilverStripe\QueuedJobs\Tasks;

use SilverStripe\Core\ClassInfo;
use SilverStripe\Dev\BuildTask;
use SilverStripe\QueuedJobs\Services\AbstractQueuedJob;
use SilverStripe\QueuedJobs\Services\QueuedJob;

/**
 * A task that can be used to create a queued job.
 *
 * Useful to hook a queued job in to place that needs to exist if it doesn't already.
 *
 * If no name is given, it creates a demo dummy job to help test that things
 * are set up and working
 *
 * @author Marcus Nyeholt <[email protected]>
 * @license BSD http://silverstripe.org/bsd-license/
 */
class CreateQueuedJobTask extends BuildTask
{
    /**
     * {@inheritDoc}
     * @var string
     */
    private static $segment = 'CreateQueuedJobTask';


    /**
     * @return string
     */
    public function getDescription()
    {
        return _t(
            'CreateQueuedJobTask.Description',
            'A task used to create a queued job. Pass the queued job class name as the "name" parameter, pass an optional "start" parameter (parseable by strtotime) to set a start time for the job.'
        );
    }

    /**
     * @param SS_HTTPRequest $request
     */
    public function run($request)
    {
        if (isset($request['name']) && ClassInfo::exists($request['name'])) {
            $clz = $request['name'];
            $job = new $clz;
        } else {
            $job = new DummyQueuedJob(mt_rand(10, 100));
        }

        if (isset($request['start'])) {
            $start = strtotime($request['start']);
            $now = time();
            if ($start >= $now) {
                $friendlyStart = date('Y-m-d H:i:s', $start);
                echo "Job ".$request['name']. " queued to start at: <b>".$friendlyStart."</b>";
                singleton('SilverStripe\\QueuedJobs\\Services\\QueuedJobService')->queueJob($job, $start);
            } else {
                echo "'start' parameter must be a date/time in the future, parseable with strtotime";
            }
        } else {
            echo "Job Queued";
            singleton('SilverStripe\\QueuedJobs\\Services\\QueuedJobService')->queueJob($job);
        }
    }
}

class DummyQueuedJob extends AbstractQueuedJob implements QueuedJob

{
    /**
     * @param int $number
     */
    public function __construct($number = 0)
    {
        if ($number) {
            $this->startNumber = $number;
<?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 = $this->startNumber;
<?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 "Some test job for ".$this->startNumber.' seconds';
<?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 getJobType()
    {
        return QueuedJob::QUEUED;
    }

    public function setup()
    {
        // just demonstrating how to get a job going...
        $this->totalSteps = $this->startNumber;
<?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->times = array();
<?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.");
        }
    }

}
    }

    public function process()

    {
        $times = $this->times;
<?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.");
        }
    }

}
        // needed due to quirks with __set
        $times[] = date('Y-m-d H:i:s');
        $this->times = $times;
<?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->addMessage("Updated time to " . date('Y-m-d H:i:s'));
        sleep(1);

        // make sure we're incrementing
        $this->currentStep++;

        // if ($this->currentStep > 1) {

        //     $this->currentStep = 1;

        // }

        // and checking whether we're complete
        if ($this->currentStep >= $this->totalSteps) {
            $this->isComplete = true;
        }
    }
}


1		<?php
2
3		namespace SilverStripe\QueuedJobs\Tasks;
4
5		use SilverStripe\Core\ClassInfo;
6		use SilverStripe\Dev\BuildTask;
7		use SilverStripe\QueuedJobs\Services\AbstractQueuedJob;
8		use SilverStripe\QueuedJobs\Services\QueuedJob;
9
10		/**
11		* A task that can be used to create a queued job.
12		*
13		* Useful to hook a queued job in to place that needs to exist if it doesn't already.
14		*
15		* If no name is given, it creates a demo dummy job to help test that things
16		* are set up and working
17		*
18		* @author Marcus Nyeholt <[email protected]>
19		* @license BSD http://silverstripe.org/bsd-license/
20		*/
21		class CreateQueuedJobTask extends BuildTask
22		{
23		/**
24		* {@inheritDoc}
25		* @var string
26		*/
27		private static $segment = 'CreateQueuedJobTask';
		0 ignored issues – show Comprehensibility introduced 2016-12-21 23:52 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 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `$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...
28
29		/**
30		* @return string
31		*/
32		public function getDescription()
33		{
34		return _t(
35		'CreateQueuedJobTask.Description',
36		'A task used to create a queued job. Pass the queued job class name as the "name" parameter, pass an optional "start" parameter (parseable by strtotime) to set a start time for the job.'
37		);
38		}
39
40		/**
41		* @param SS_HTTPRequest $request
42		*/
43		public function run($request)
44		{
45		if (isset($request['name']) && ClassInfo::exists($request['name'])) {
46		$clz = $request['name'];
47		$job = new $clz;
48		} else {
49		$job = new DummyQueuedJob(mt_rand(10, 100));
50		}
51
52		if (isset($request['start'])) {
53		$start = strtotime($request['start']);
54		$now = time();
55		if ($start >= $now) {
56		$friendlyStart = date('Y-m-d H:i:s', $start);
57		echo "Job ".$request['name']. " queued to start at: <b>".$friendlyStart."</b>";
58		singleton('SilverStripe\\QueuedJobs\\Services\\QueuedJobService')->queueJob($job, $start);
59		} else {
60		echo "'start' parameter must be a date/time in the future, parseable with strtotime";
61		}
62		} else {
63		echo "Job Queued";
64		singleton('SilverStripe\\QueuedJobs\\Services\\QueuedJobService')->queueJob($job);
65		}
66		}
67		}
68
69		class DummyQueuedJob extends AbstractQueuedJob implements QueuedJob
		0 ignored issues – show Coding Style Compatibility introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
70		{
71		/**
72		* @param int $number
73		*/
74		public function __construct($number = 0)
75		{
76		if ($number) {
77		$this->startNumber = $number;
		0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `startNumber` does not exist on `object<SilverStripe\Queu...s\Tasks\DummyQueuedJob>`. 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...
78		$this->totalSteps = $this->startNumber;
		0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `startNumber` does not exist on `object<SilverStripe\Queu...s\Tasks\DummyQueuedJob>`. 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...
79		}
80		}
81
82		/**
83		* @return string
84		*/
85		public function getTitle()
86		{
87		return "Some test job for ".$this->startNumber.' seconds';
		0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `startNumber` does not exist on `object<SilverStripe\Queu...s\Tasks\DummyQueuedJob>`. 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...
88		}
89
90		/**
91		* @return string
92		*/
93		public function getJobType()
94		{
95		return QueuedJob::QUEUED;
96		}
97
98		public function setup()
99		{
100		// just demonstrating how to get a job going...
101		$this->totalSteps = $this->startNumber;
		0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `startNumber` does not exist on `object<SilverStripe\Queu...s\Tasks\DummyQueuedJob>`. 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...
102		$this->times = array();
		0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `times` does not exist on `object<SilverStripe\Queu...s\Tasks\DummyQueuedJob>`. 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...
103		}
104
105	View Code Duplication	public function process()
		0 ignored issues – show Duplication introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
106		{
107		$times = $this->times;
		0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `times` does not exist on `object<SilverStripe\Queu...s\Tasks\DummyQueuedJob>`. 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...
108		// needed due to quirks with __set
109		$times[] = date('Y-m-d H:i:s');
110		$this->times = $times;
		0 ignored issues – show Documentation introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `times` does not exist on `object<SilverStripe\Queu...s\Tasks\DummyQueuedJob>`. 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...
111
112		$this->addMessage("Updated time to " . date('Y-m-d H:i:s'));
113		sleep(1);
114
115		// make sure we're incrementing
116		$this->currentStep++;
117
118		// if ($this->currentStep > 1) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
119		// $this->currentStep = 1;
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
120		// }
121
122		// and checking whether we're complete
123		if ($this->currentStep >= $this->totalSteps) {
124		$this->isComplete = true;
125		}
126		}
127		}
128

silverstripe-australia / silverstripe-queuedjobs

Pull Request — master (#109)

DummyQueuedJob::getTitle() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like