PublishItemsJob::__construct() - Code Metrics - Inspection of "VENDOR UPDATE." - silverstripe-australia/silverstripe-queuedjobs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c5ed18...ed0fce )

by Nathan

created 2017-06-30 01:50 UTC

PublishItemsJob::__construct() A

↳ Parent: PublishItemsJob

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	3
nc	2
nop	1

<?php

namespace Symbiote\QueuedJobs\Jobs;

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

/**
 * An example queued job
 *
 * Use this as an example of how you can write your own jobs
 *
 * @author Marcus Nyeholt <[email protected]>
 * @license BSD http://silverstripe.org/bsd-license/
 */
class PublishItemsJob extends AbstractQueuedJob implements QueuedJob
{
    /**
     * @param DataObject $rootNodeID
     */
    public function __construct($rootNodeID = null)
    {
        // this value is automatically persisted between processing requests for
        // this job
        if ($rootNodeID) {
            $this->rootID = $rootNodeID;
<?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.");
        }
    }

}
        }
    }

    protected function getRoot()
    {
        return DataObject::get_by_id('Page', $this->rootID);
<?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.");
        }
    }

}
    }

    /**
     * Defines the title of the job
     *
     * @return string
     */
    public function getTitle()
    {
        return _t(
            'PublishItemsJob.Title',
            "Publish items beneath {title}",
            array('title' => $this->getRoot()->Title)
        );
    }

    /**
     * Indicate to the system which queue we think we should be in based
     * on how many objects we're going to touch on while processing.
     *
     * We want to make sure we also set how many steps we think we might need to take to
     * process everything - note that this does not need to be 100% accurate, but it's nice
     * to give a reasonable approximation
     *
     * @return int
     */
    public function getJobType()
    {
        $this->totalSteps = 'Lots';
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        return QueuedJob::QUEUED;
    }

    /**
     * This is called immediately before a job begins - it gives you a chance
     * to initialise job data and make sure everything's good to go
     *
     * What we're doing in our case is to queue up the list of items we know we need to
     * process still (it's not everything - just the ones we know at the moment)
     *
     * When we go through, we'll constantly add and remove from this queue, meaning
     * we never overload it with content
     */
    public function setup()
    {
        if (!$this->getRoot()) {
            // we're missing for some reason!
            $this->isComplete = true;
            $this->remainingChildren = 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.");
        }
    }

}
            return;
        }
        $remainingChildren = array();
        $remainingChildren[] = $this->getRoot()->ID;
        $this->remainingChildren = $remainingChildren;
<?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.");
        }
    }

}

        // we reset this to 1; this is because we only know for sure about 1 item remaining
        // as time goes by, this will increase as we discover more items that need processing
        $this->totalSteps = 1;
    }

    /**
     * Lets process a single node, and publish it if necessary
     */
    public function process()
    {
        $remainingChildren = $this->remainingChildren;
<?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 there's no more, we're done!
        if (!count($remainingChildren)) {
            $this->isComplete = true;
            return;
        }

        // we need to always increment! This is important, because if we don't then our container
        // that executes around us thinks that the job has died, and will stop it running.
        $this->currentStep++;

        // lets process our first item - note that we take it off the list of things left to do
        $ID = array_shift($remainingChildren);

        // get the page
        $page = DataObject::get_by_id('Page', $ID);
        if ($page) {
            // publish it
            $page->doPublish();

            // and add its children to the list to be published
            foreach ($page->Children() as $child) {
                $remainingChildren[] = $child->ID;
                // we increase how many steps we need to do - this means our total steps constantly rises,
                // but it gives users an idea of exactly how many more we know about
                $this->totalSteps++;
            }
            $page->destroy();
            unset($page);
        }

        // and now we store the new list of remaining children
        $this->remainingChildren = $remainingChildren;
<?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 (!count($remainingChildren)) {
            $this->isComplete = true;
            return;
        }
    }
}


1			<?php
2
3			namespace Symbiote\QueuedJobs\Jobs;
4
5			use SilverStripe\ORM\DataObject;
6			use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
7			use Symbiote\QueuedJobs\Services\QueuedJob;
8
9			/**
10			* An example queued job
11			*
12			* Use this as an example of how you can write your own jobs
13			*
14			* @author Marcus Nyeholt <[email protected]>
15			* @license BSD http://silverstripe.org/bsd-license/
16			*/
17			class PublishItemsJob extends AbstractQueuedJob implements QueuedJob
18			{
19			/**
20			* @param DataObject $rootNodeID
21			*/
22			public function __construct($rootNodeID = null)
23			{
24			// this value is automatically persisted between processing requests for
25			// this job
26			if ($rootNodeID) {
27			$this->rootID = $rootNodeID;
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `rootID` does not exist on `object<Symbiote\QueuedJobs\Jobs\PublishItemsJob>`. 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...
28			}
29			}
30
31			protected function getRoot()
32			{
33			return DataObject::get_by_id('Page', $this->rootID);
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `rootID` does not exist on `object<Symbiote\QueuedJobs\Jobs\PublishItemsJob>`. 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...
34			}
35
36			/**
37			* Defines the title of the job
38			*
39			* @return string
40			*/
41			public function getTitle()
42			{
43			return _t(
44			'PublishItemsJob.Title',
45			"Publish items beneath {title}",
46			array('title' => $this->getRoot()->Title)
47			);
48			}
49
50			/**
51			* Indicate to the system which queue we think we should be in based
52			* on how many objects we're going to touch on while processing.
53			*
54			* We want to make sure we also set how many steps we think we might need to take to
55			* process everything - note that this does not need to be 100% accurate, but it's nice
56			* to give a reasonable approximation
57			*
58			* @return int
59			*/
60			public function getJobType()
61			{
62			$this->totalSteps = 'Lots';
			0 ignored issues – show Documentation Bug introduced 2016-12-21 23:52 UTC by Report Bug Copy Issue Report The property `$totalSteps` was declared of type `integer`, but `'Lots'` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
63			return QueuedJob::QUEUED;
64			}
65
66			/**
67			* This is called immediately before a job begins - it gives you a chance
68			* to initialise job data and make sure everything's good to go
69			*
70			* What we're doing in our case is to queue up the list of items we know we need to
71			* process still (it's not everything - just the ones we know at the moment)
72			*
73			* When we go through, we'll constantly add and remove from this queue, meaning
74			* we never overload it with content
75			*/
76			public function setup()
77			{
78			if (!$this->getRoot()) {
79			// we're missing for some reason!
80			$this->isComplete = true;
81			$this->remainingChildren = array();
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `remainingChildren` does not exist on `object<Symbiote\QueuedJobs\Jobs\PublishItemsJob>`. 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...
82			return;
83			}
84			$remainingChildren = array();
85			$remainingChildren[] = $this->getRoot()->ID;
86			$this->remainingChildren = $remainingChildren;
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `remainingChildren` does not exist on `object<Symbiote\QueuedJobs\Jobs\PublishItemsJob>`. 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...
87
88			// we reset this to 1; this is because we only know for sure about 1 item remaining
89			// as time goes by, this will increase as we discover more items that need processing
90			$this->totalSteps = 1;
91			}
92
93			/**
94			* Lets process a single node, and publish it if necessary
95			*/
96			public function process()
97			{
98			$remainingChildren = $this->remainingChildren;
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `remainingChildren` does not exist on `object<Symbiote\QueuedJobs\Jobs\PublishItemsJob>`. 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...
99
100			// if there's no more, we're done!
101			if (!count($remainingChildren)) {
102			$this->isComplete = true;
103			return;
104			}
105
106			// we need to always increment! This is important, because if we don't then our container
107			// that executes around us thinks that the job has died, and will stop it running.
108			$this->currentStep++;
109
110			// lets process our first item - note that we take it off the list of things left to do
111			$ID = array_shift($remainingChildren);
112
113			// get the page
114			$page = DataObject::get_by_id('Page', $ID);
115			if ($page) {
116			// publish it
117			$page->doPublish();
118
119			// and add its children to the list to be published
120			foreach ($page->Children() as $child) {
121			$remainingChildren[] = $child->ID;
122			// we increase how many steps we need to do - this means our total steps constantly rises,
123			// but it gives users an idea of exactly how many more we know about
124			$this->totalSteps++;
125			}
126			$page->destroy();
127			unset($page);
128			}
129
130			// and now we store the new list of remaining children
131			$this->remainingChildren = $remainingChildren;
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `remainingChildren` does not exist on `object<Symbiote\QueuedJobs\Jobs\PublishItemsJob>`. 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...
132
133			if (!count($remainingChildren)) {
134			$this->isComplete = true;
135			return;
136			}
137			}
138			}
139

silverstripe-australia / silverstripe-queuedjobs

Push — master ( c5ed18...ed0fce )

PublishItemsJob::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like