getCompatibleEvents()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 0
dl 0
loc 4
rs 10
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\Action;
13
14
use Jitamin\Model\TaskModel;
15
16
/**
17
 * Move a task to another column when not moved during a given period.
18
 */
19
class TaskMoveColumnNotMovedPeriod extends Base
20
{
21
    /**
22
     * Get automatic action description.
23
     *
24
     * @return string
25
     */
26
    public function getDescription()
27
    {
28
        return t('Move the task to another column when not moved during a given period');
29
    }
30
31
    /**
32
     * Get the list of compatible events.
33
     *
34
     * @return array
35
     */
36
    public function getCompatibleEvents()
37
    {
38
        return [TaskModel::EVENT_DAILY_CRONJOB];
39
    }
40
41
    /**
42
     * Get the required parameter for the action (defined by the user).
43
     *
44
     * @return array
45
     */
46
    public function getActionRequiredParameters()
47
    {
48
        return [
49
            'duration'       => t('Duration in days'),
50
            'src_column_id'  => t('Source column'),
51
            'dest_column_id' => t('Destination column'),
52
        ];
53
    }
54
55
    /**
56
     * Get the required parameter for the event.
57
     *
58
     * @return string[]
59
     */
60
    public function getEventRequiredParameters()
61
    {
62
        return ['tasks'];
63
    }
64
65
    /**
66
     * Execute the action (close the task).
67
     *
68
     * @param array $data Event data dictionary
69
     *
70
     * @return bool True if the action was executed or false when not executed
71
     */
72
    public function doAction(array $data)
73
    {
74
        $results = [];
75
        $max = $this->getParam('duration') * 86400;
76
77
        foreach ($data['tasks'] as $task) {
78
            $duration = time() - $task['date_moved'];
79
80
            if ($duration > $max && $task['column_id'] == $this->getParam('src_column_id')) {
81
                $results[] = $this->taskPositionModel->movePosition(
0 ignored issues
show
Documentation introduced by
The property taskPositionModel does not exist on object<Jitamin\Action\Ta...veColumnNotMovedPeriod>. 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...
82
                    $task['project_id'],
83
                    $task['id'],
84
                    $this->getParam('dest_column_id'),
85
                    1,
86
                    $task['swimlane_id'],
87
                    false
88
                );
89
            }
90
        }
91
92
        return in_array(true, $results, true);
93
    }
94
95
    /**
96
     * Check if the event data meet the action condition.
97
     *
98
     * @param array $data Event data dictionary
99
     *
100
     * @return bool
101
     */
102
    public function hasRequiredCondition(array $data)
103
    {
104
        return count($data['tasks']) > 0;
105
    }
106
}
107