Completed
Pull Request — master (#23)
by
unknown
02:14
created

TracksAbstract   A

Complexity

Total Complexity 4

Size/Duplication

Total Lines 65
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 3

Importance

Changes 0
Metric Value
wmc 4
lcom 1
cbo 3
dl 0
loc 65
rs 10
c 0
b 0
f 0

5 Methods

Rating   Name   Duplication   Size   Complexity  
pushToTracks() 0 1 ?
A create() 0 4 1
A update() 0 4 1
A prepareRecord() 0 11 1
A setMetaData() 0 4 1
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 by
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' => env('QUEUE_DRIVER', 'sync'),
53
            'queue_id' => $id,
54
            'payload' => $this->createPayload($job),
55
            'attempts' => 0,
56
            'meta' => json_encode($this->setMetaData($job, $meta)),
57
            'queue_at' => Carbon::now()
58
        ];
59
    }
60
61
    /**
62
     * Include default meta data job_name into meta column
63
     *
64
     * @param $job                  The queue job object
65
     * @param array  $meta          The meta array after add default
66
     */
67
    protected function setMetaData($job, array $meta = [])
68
    {
69
        return array_add($meta, 'job_name', get_class($job));
70
    }
71
}
72