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

AbstractQueuedJob::loadCustomConfig() A
last analyzed 2019-12-18 20:39 UTC

↳ Parent: AbstractQueuedJob

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	4
nc	4
nop	0

<?php

namespace Symbiote\QueuedJobs\Services;

use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\Subsites\State\SubsiteState;
use stdClass;
use Symbiote\QueuedJobs\Interfaces\UserContextInterface;

/**
 * A base implementation of a queued job that provides some convenience for implementations
 *
 * This implementation assumes that when you created your job class, you initialised the
 * jobData with relevant variables needed to process() your job later on in execution. If you do not,
 * please ensure you do before you queueJob() the job, to ensure the signature that is generated is 'correct'.
 *
 * @author Marcus Nyeholt <[email protected]>
 * @license BSD http://silverstripe.org/bsd-license/
 * @skipUpgrade
 */
abstract class AbstractQueuedJob implements QueuedJob, UserContextInterface
{
    /**
     * @var stdClass
     */
    protected $jobData;

    /**
     * @var array
     */
    protected $messages = array();

    /**
     * @var int
     */
    protected $totalSteps = 0;

    /**
     * @var int
     */
    protected $currentStep = 0;

    /**
     * @var boolean
     */
    protected $isComplete = false;

    /**
     * Extensions can have a construct but don't have too.
     * Without a construct, it's impossible to create a job in the CMS
     * @var array params
     */
    public function __construct($params = array())
    {
    }

    /**
     * @return string
     */
    abstract public function getTitle();

    /**
     * Sets a data object for persisting by adding its id and type to the serialised vars
     *
     * @param DataObject $object
     * @param string $name A name to give it, if you want to store more than one
     */
    protected function setObject(DataObject $object, $name = 'Object')
    {
        $this->{$name . 'ID'} = $object->ID;
        $this->{$name . 'Type'} = $object->ClassName;
    }

    /**
     * @param string $name
     * @return DataObject|null
     */
    protected function getObject($name = 'Object')
    {
        $id = $this->{$name . 'ID'};
        $type = $this->{$name . 'Type'};
        if ($id) {
            return DataObject::get_by_id($type, $id);
        }
    }

    /**
     * Return a signature for this queued job
     *
     * @return string
     */
    public function getSignature()
    {
        return md5(get_class($this) . serialize($this->jobData));
    }

    /**
     * Generate a somewhat random signature
     *
     * useful if you're want to make sure something is always added
     *
     * @return string
     */
    protected function randomSignature()
    {
        return md5(get_class($this) . DBDatetime::now()->getTimestamp() . mt_rand(0, 100000));
    }

    /**
     * By default jobs should just go into the default processing queue
     *
     * @return string
     */
    public function getJobType()
    {
        return QueuedJob::QUEUED;
    }

    public function getRunAsMemberID()
    {
        return null;
    }

    /**
     * Performs setup tasks the first time this job is run.
     *
     * This is only executed once for every job. If you want to run something on every job restart, use the
     * {@link prepareForRestart} method.
     */
    public function setup()
    {
        $this->loadCustomConfig();
    }

    /**
     * Run when an already setup job is being restarted.
     */
    public function prepareForRestart()
    {
        $this->loadCustomConfig();
    }

    /**
     * Do some processing yourself!
     */
    abstract public function process();

    /**
     * Method for determining whether the job is finished - you may override it if there's
     * more to it than just this
     */
    public function jobFinished()
    {
        return $this->isComplete;
    }

    /**
     * Called when the job is determined to be 'complete'
     */
    public function afterComplete()
    {
    }

    /**
     * @return stdClass
     */
    public function getJobData()
    {
        // okay, we NEED to store the subsite ID if there's one available
        if (!$this->SubsiteID && class_exists(SubsiteState::class)) {
<?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->SubsiteID = SubsiteState::singleton()->getSubsiteId();
<?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.");
        }
    }

}
        }

        $data = new stdClass();
        $data->totalSteps = $this->totalSteps;
        $data->currentStep = $this->currentStep;
        $data->isComplete = $this->isComplete;
        $data->jobData = $this->jobData;
        $data->messages = $this->messages;

        return $data;
    }

    /**
     * @param int $totalSteps
     * @param int $currentStep
     * @param boolean $isComplete
     * @param stdClass $jobData
     * @param array $messages
     */
    public function setJobData($totalSteps, $currentStep, $isComplete, $jobData, $messages)
    {
        $this->totalSteps = $totalSteps;
        $this->currentStep = $currentStep;
        $this->isComplete = $isComplete;
        $this->jobData = $jobData;
        $this->messages = $messages;
    }

    /**
     * Gets custom config settings to use when running the job.
     *
     * @return array|null
     */
    public function getCustomConfig()
    {
        return $this->CustomConfig;
<?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.");
        }
    }

}
    }

    /**
     * Sets custom config settings to use when the job is run.
     *
     * @param array $config
     */
    public function setCustomConfig(array $config)
    {
        $this->CustomConfig = $config;
<?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.");
        }
    }

}
    }

    /**
     * Sets custom configuration settings from the job data.
     */
    private function loadCustomConfig()
    {
        $custom = $this->getCustomConfig();

        if (!is_array($custom)) {
            return;
        }

        foreach ($custom as $class => $settings) {
            foreach ($settings as $setting => $value) {
                Config::modify()->set($class, $setting, $value);
            }
        }
    }

    /**
     * @param string $message
     * @param string $severity
     */
    public function addMessage($message, $severity = 'INFO')
    {
        $severity = strtoupper($severity);
        $this->messages[] = '[' . DBDatetime::now()->Rfc2822() . "][$severity] $message";
    }

    /**
     * Convenience methods for setting and getting job data
     *
     * @param mixed $name
     * @param mixed $value
     */
    public function __set($name, $value)
    {
        if (!$this->jobData) {
            $this->jobData = new stdClass();
        }
        $this->jobData->$name = $value;
    }

    /**
     * Retrieve some job data
     *
     * @param mixed $name
     * @return mixed
     */
    public function __get($name)
    {
        return isset($this->jobData->$name) ? $this->jobData->$name : null;
    }
}


1			<?php
2
3			namespace Symbiote\QueuedJobs\Services;
4
5			use SilverStripe\Core\Config\Config;
6			use SilverStripe\ORM\DataObject;
7			use SilverStripe\ORM\FieldType\DBDatetime;
8			use SilverStripe\Subsites\State\SubsiteState;
9			use stdClass;
10			use Symbiote\QueuedJobs\Interfaces\UserContextInterface;
11
12			/**
13			* A base implementation of a queued job that provides some convenience for implementations
14			*
15			* This implementation assumes that when you created your job class, you initialised the
16			* jobData with relevant variables needed to process() your job later on in execution. If you do not,
17			* please ensure you do before you queueJob() the job, to ensure the signature that is generated is 'correct'.
18			*
19			* @author Marcus Nyeholt <[email protected]>
20			* @license BSD http://silverstripe.org/bsd-license/
21			* @skipUpgrade
22			*/
23			abstract class AbstractQueuedJob implements QueuedJob, UserContextInterface
24			{
25			/**
26			* @var stdClass
27			*/
28			protected $jobData;
29
30			/**
31			* @var array
32			*/
33			protected $messages = array();
34
35			/**
36			* @var int
37			*/
38			protected $totalSteps = 0;
39
40			/**
41			* @var int
42			*/
43			protected $currentStep = 0;
44
45			/**
46			* @var boolean
47			*/
48			protected $isComplete = false;
49
50			/**
51			* Extensions can have a construct but don't have too.
52			* Without a construct, it's impossible to create a job in the CMS
53			* @var array params
54			*/
55			public function __construct($params = array())
56			{
57			}
58
59			/**
60			* @return string
61			*/
62			abstract public function getTitle();
63
64			/**
65			* Sets a data object for persisting by adding its id and type to the serialised vars
66			*
67			* @param DataObject $object
68			* @param string $name A name to give it, if you want to store more than one
69			*/
70			protected function setObject(DataObject $object, $name = 'Object')
71			{
72			$this->{$name . 'ID'} = $object->ID;
73			$this->{$name . 'Type'} = $object->ClassName;
74			}
75
76			/**
77			* @param string $name
78			* @return DataObject\|null
79			*/
80			protected function getObject($name = 'Object')
81			{
82			$id = $this->{$name . 'ID'};
83			$type = $this->{$name . 'Type'};
84			if ($id) {
85			return DataObject::get_by_id($type, $id);
86			}
87			}
88
89			/**
90			* Return a signature for this queued job
91			*
92			* @return string
93			*/
94			public function getSignature()
95			{
96			return md5(get_class($this) . serialize($this->jobData));
97			}
98
99			/**
100			* Generate a somewhat random signature
101			*
102			* useful if you're want to make sure something is always added
103			*
104			* @return string
105			*/
106			protected function randomSignature()
107			{
108			return md5(get_class($this) . DBDatetime::now()->getTimestamp() . mt_rand(0, 100000));
109			}
110
111			/**
112			* By default jobs should just go into the default processing queue
113			*
114			* @return string
115			*/
116			public function getJobType()
117			{
118			return QueuedJob::QUEUED;
119			}
120
121			public function getRunAsMemberID()
122			{
123			return null;
124			}
125
126			/**
127			* Performs setup tasks the first time this job is run.
128			*
129			* This is only executed once for every job. If you want to run something on every job restart, use the
130			* {@link prepareForRestart} method.
131			*/
132			public function setup()
133			{
134			$this->loadCustomConfig();
135			}
136
137			/**
138			* Run when an already setup job is being restarted.
139			*/
140			public function prepareForRestart()
141			{
142			$this->loadCustomConfig();
143			}
144
145			/**
146			* Do some processing yourself!
147			*/
148			abstract public function process();
149
150			/**
151			* Method for determining whether the job is finished - you may override it if there's
152			* more to it than just this
153			*/
154			public function jobFinished()
155			{
156			return $this->isComplete;
157			}
158
159			/**
160			* Called when the job is determined to be 'complete'
161			*/
162			public function afterComplete()
163			{
164			}
165
166			/**
167			* @return stdClass
168			*/
169			public function getJobData()
170			{
171			// okay, we NEED to store the subsite ID if there's one available
172			if (!$this->SubsiteID && class_exists(SubsiteState::class)) {
			0 ignored issues – show Documentation introduced 2018-01-03 14:55 UTC by Report Bug Copy Issue Report The property `SubsiteID` does not exist on `object<Symbiote\QueuedJo...ices\AbstractQueuedJob>`. 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...
173			$this->SubsiteID = SubsiteState::singleton()->getSubsiteId();
			0 ignored issues – show Documentation introduced 2018-01-03 14:55 UTC by Report Bug Copy Issue Report The property `SubsiteID` does not exist on `object<Symbiote\QueuedJo...ices\AbstractQueuedJob>`. 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...
174			}
175
176			$data = new stdClass();
177			$data->totalSteps = $this->totalSteps;
178			$data->currentStep = $this->currentStep;
179			$data->isComplete = $this->isComplete;
180			$data->jobData = $this->jobData;
181			$data->messages = $this->messages;
182
183			return $data;
184			}
185
186			/**
187			* @param int $totalSteps
188			* @param int $currentStep
189			* @param boolean $isComplete
190			* @param stdClass $jobData
191			* @param array $messages
192			*/
193			public function setJobData($totalSteps, $currentStep, $isComplete, $jobData, $messages)
194			{
195			$this->totalSteps = $totalSteps;
196			$this->currentStep = $currentStep;
197			$this->isComplete = $isComplete;
198			$this->jobData = $jobData;
199			$this->messages = $messages;
200			}
201
202			/**
203			* Gets custom config settings to use when running the job.
204			*
205			* @return array\|null
206			*/
207			public function getCustomConfig()
208			{
209			return $this->CustomConfig;
			0 ignored issues – show Documentation introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report The property `CustomConfig` does not exist on `object<Symbiote\QueuedJo...ices\AbstractQueuedJob>`. 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...
210			}
211
212			/**
213			* Sets custom config settings to use when the job is run.
214			*
215			* @param array $config
216			*/
217			public function setCustomConfig(array $config)
218			{
219			$this->CustomConfig = $config;
			0 ignored issues – show Documentation introduced 2017-10-04 23:47 UTC by Report Bug Copy Issue Report The property `CustomConfig` does not exist on `object<Symbiote\QueuedJo...ices\AbstractQueuedJob>`. 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...
220			}
221
222			/**
223			* Sets custom configuration settings from the job data.
224			*/
225			private function loadCustomConfig()
226			{
227			$custom = $this->getCustomConfig();
228
229			if (!is_array($custom)) {
230			return;
231			}
232
233			foreach ($custom as $class => $settings) {
234			foreach ($settings as $setting => $value) {
235			Config::modify()->set($class, $setting, $value);
236			}
237			}
238			}
239
240			/**
241			* @param string $message
242			* @param string $severity
243			*/
244			public function addMessage($message, $severity = 'INFO')
245			{
246			$severity = strtoupper($severity);
247			$this->messages[] = '[' . DBDatetime::now()->Rfc2822() . "][$severity] $message";
248			}
249
250			/**
251			* Convenience methods for setting and getting job data
252			*
253			* @param mixed $name
254			* @param mixed $value
255			*/
256			public function __set($name, $value)
257			{
258			if (!$this->jobData) {
259			$this->jobData = new stdClass();
260			}
261			$this->jobData->$name = $value;
262			}
263
264			/**
265			* Retrieve some job data
266			*
267			* @param mixed $name
268			* @return mixed
269			*/
270			public function __get($name)
271			{
272			return isset($this->jobData->$name) ? $this->jobData->$name : null;
273			}
274			}
275

symbiote / silverstripe-queuedjobs

GitHub Access Token became invalid

AbstractQueuedJob::loadCustomConfig() A last analyzed 2019-12-18 20:39 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AbstractQueuedJob::loadCustomConfig() A
last analyzed 2019-12-18 20:39 UTC