TracksAbstract::setMetaData() - Code Metrics - Inspection of "Create Qwatcher for larval 5.2+." - maqe/laravel-qwatcher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#25)

unknown

created 2016-11-30 10:35 UTC

TracksAbstract::setMetaData() A

↳ Parent: TracksAbstract

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	2

<?php namespace Maqe\Qwatcher\Tracks;

use Illuminate\Queue\Queue;
use Carbon\Carbon;
use Maqe\Qwatcher\Tracks\Enums\StatusType;

abstract class TracksAbstract extends Queue
{
    /**
     * Push job to tracks table
     *
     * @param  $id          The queue id
     * @param  $job         The queue job object
     * @param  array  $meta The meta data array
     * @return mixed
     */
    abstract public function pushToTracks($id, $job = null, array $meta = []);

    /**
     * Create tracks record from job
     *
     * @param  mixed    $job        The queue job object
     * @param  array    $meta       The meta data array
     * @return integer  $id         The new tracks id
     */
    protected function create($id, $job = null, array $meta = [])
    {
        return Tracks::create($this->prepareRecord($id, $job, $meta))->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.");
        }
    }

}
    }

    /**
     * Update status tracks record by queue id and status type
     *
     * @param  integer  $id         The queue id to track queue record
     * @param  enum     $status     The status tracks type
     * @return boolean|mixed        The update result
     */
    protected function update($id, $job, $status)
    {
        return Tracks::where('queue_id', $id)->update(['attempts' => $job->attempts(), "{$status}_at" => Carbon::now()]);
    }

    /**
     * Prepare record before create new record
     *
     * @param  mixed $job           The queue job object
     * @return array                The array for input to database
     */
    protected function prepareRecord($id, $job, array $meta = [])
    {
        return [
            'driver' => config('queue.default'),
            'queue_id' => $id,
            'payload' => $this->createPayload($job),
            'attempts' => 0,
            'job_name' => get_class($job),
            'meta' => json_encode($this->setMetaData($job, $meta)),
            'queue_at' => Carbon::now(),
        ];
    }

    /**
     * Include default meta data job_name into meta column
     *
     * @param $job                  The queue job object
     * @param array  $meta          The meta array after add default
     */
    protected function setMetaData($job, array $meta = [])
    {
        return array_add($meta, 'job_name', get_class($job));
    }
}


1			<?php namespace Maqe\Qwatcher\Tracks;
2
3			use Illuminate\Queue\Queue;
4			use Carbon\Carbon;
5			use Maqe\Qwatcher\Tracks\Enums\StatusType;
6
7			abstract class TracksAbstract extends Queue
8			{
9			/**
10			* Push job to tracks table
11			*
12			* @param $id The queue id
13			* @param $job The queue job object
14			* @param array $meta The meta data array
15			* @return mixed
16			*/
17			abstract public function pushToTracks($id, $job = null, array $meta = []);
18
19			/**
20			* Create tracks record from job
21			*
22			* @param mixed $job The queue job object
23			* @param array $meta The meta data array
24			* @return integer $id The new tracks id
25			*/
26			protected function create($id, $job = null, array $meta = [])
27			{
28			return Tracks::create($this->prepareRecord($id, $job, $meta))->id;
			0 ignored issues – show Documentation introduced 2016-11-04 04:03 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Maqe\Qwatcher\Tracks\Tracks>`. 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...
29			}
30
31			/**
32			* Update status tracks record by queue id and status type
33			*
34			* @param integer $id The queue id to track queue record
35			* @param enum $status The status tracks type
36			* @return boolean\|mixed The update result
37			*/
38			protected function update($id, $job, $status)
39			{
40			return Tracks::where('queue_id', $id)->update(['attempts' => $job->attempts(), "{$status}_at" => Carbon::now()]);
41			}
42
43			/**
44			* Prepare record before create new record
45			*
46			* @param mixed $job The queue job object
47			* @return array The array for input to database
48			*/
49			protected function prepareRecord($id, $job, array $meta = [])
50			{
51			return [
52			'driver' => config('queue.default'),
53			'queue_id' => $id,
54			'payload' => $this->createPayload($job),
55			'attempts' => 0,
56			'job_name' => get_class($job),
57			'meta' => json_encode($this->setMetaData($job, $meta)),
58			'queue_at' => Carbon::now(),
59			];
60			}
61
62			/**
63			* Include default meta data job_name into meta column
64			*
65			* @param $job The queue job object
66			* @param array $meta The meta array after add default
67			*/
68			protected function setMetaData($job, array $meta = [])
69			{
70			return array_add($meta, 'job_name', get_class($job));
71			}
72			}
73

maqe / laravel-qwatcher

Pull Request — master (#25)

TracksAbstract::setMetaData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like