PublishItemsJob::setup() - Code Metrics - symbiote/silverstripe-queuedjobs - Measure and Improve Code Quality continuously with Scrutinizer

PublishItemsJob::setup() A
last analyzed 2019-12-18 20:39 UTC

↳ Parent: PublishItemsJob

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php

namespace Symbiote\QueuedJobs\Jobs;

use Page;
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::class, $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()
    {
        $title = 'Unknown';

        if ($root = $this->getRoot()) {
            $title = $root->Title;
        }

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

symbiote / silverstripe-queuedjobs

GitHub Access Token became invalid

PublishItemsJob::setup() A last analyzed 2019-12-18 20:39 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PublishItemsJob::setup() A
last analyzed 2019-12-18 20:39 UTC