SubtaskEventBuilder::withSubtaskId()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 1
dl 0
loc 6
rs 9.4285
c 0
b 0
f 0
1
<?php
2
3
/*
4
 * This file is part of Jitamin.
5
 *
6
 * Copyright (C) Jitamin Team
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Jitamin\Bus\EventBuilder;
13
14
use Jitamin\Bus\Event\GenericEvent;
15
use Jitamin\Bus\Event\SubtaskEvent;
16
use Jitamin\Model\SubtaskModel;
17
18
/**
19
 * Class SubtaskEventBuilder.
20
 */
21
class SubtaskEventBuilder extends BaseEventBuilder
22
{
23
    /**
24
     * SubtaskId.
25
     *
26
     * @var int
27
     */
28
    protected $subtaskId = 0;
29
30
    /**
31
     * Changed values.
32
     *
33
     * @var array
34
     */
35
    protected $values = [];
36
37
    /**
38
     * Set SubtaskId.
39
     *
40
     * @param int $subtaskId
41
     *
42
     * @return $this
43
     */
44
    public function withSubtaskId($subtaskId)
45
    {
46
        $this->subtaskId = $subtaskId;
47
48
        return $this;
49
    }
50
51
    /**
52
     * Set values.
53
     *
54
     * @param array $values
55
     *
56
     * @return $this
57
     */
58
    public function withValues(array $values)
59
    {
60
        $this->values = $values;
61
62
        return $this;
63
    }
64
65
    /**
66
     * Build event data.
67
     *
68
     * @return GenericEvent|null
69
     */
70
    public function buildEvent()
71
    {
72
        $eventData = [];
73
        $eventData['subtask'] = $this->subtaskModel->getById($this->subtaskId, true);
0 ignored issues
show
Documentation introduced by
The property subtaskModel does not exist on object<Jitamin\Bus\Event...er\SubtaskEventBuilder>. 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...
74
75
        if (empty($eventData['subtask'])) {
76
            $this->logger->debug(__METHOD__.': Subtask not found');
0 ignored issues
show
Documentation introduced by
The property logger does not exist on object<Jitamin\Bus\Event...er\SubtaskEventBuilder>. 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...
77
78
            return;
79
        }
80
81
        if (!empty($this->values)) {
82
            $eventData['changes'] = array_diff_assoc($this->values, $eventData['subtask']);
83
        }
84
85
        $eventData['task'] = $this->taskFinderModel->getDetails($eventData['subtask']['task_id']);
0 ignored issues
show
Documentation introduced by
The property taskFinderModel does not exist on object<Jitamin\Bus\Event...er\SubtaskEventBuilder>. 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...
86
87
        return new SubtaskEvent($eventData);
88
    }
89
90
    /**
91
     * Get event title with author.
92
     *
93
     * @param string $author
94
     * @param string $eventName
95
     * @param array  $eventData
96
     *
97
     * @return string
98
     */
99
    public function buildTitleWithAuthor($author, $eventName, array $eventData)
100
    {
101
        switch ($eventName) {
102
            case SubtaskModel::EVENT_UPDATE:
103
                return l('%s updated a subtask for the task #%d', $author, $eventData['task']['id']);
104
            case SubtaskModel::EVENT_CREATE:
105
                return l('%s created a subtask for the task #%d', $author, $eventData['task']['id']);
106
            case SubtaskModel::EVENT_DELETE:
107
                return l('%s removed a subtask for the task #%d', $author, $eventData['task']['id']);
108
            default:
109
                return '';
110
        }
111
    }
112
113
    /**
114
     * Get event title without author.
115
     *
116
     * @param string $eventName
117
     * @param array  $eventData
118
     *
119
     * @return string
120
     */
121
    public function buildTitleWithoutAuthor($eventName, array $eventData)
122
    {
123
        switch ($eventName) {
124
            case SubtaskModel::EVENT_CREATE:
125
                return l('New subtask on task #%d', $eventData['subtask']['task_id']);
126
            case SubtaskModel::EVENT_UPDATE:
127
                return l('Subtask updated on task #%d', $eventData['subtask']['task_id']);
128
            case SubtaskModel::EVENT_DELETE:
129
                return l('Subtask removed on task #%d', $eventData['subtask']['task_id']);
130
            default:
131
                return '';
132
        }
133
    }
134
}
135