getActionRequiredParameters()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 7
Code Lines 4

Duplication

Lines 7
Ratio 100 %

Importance

Changes 0
Metric Value
cc 1
eloc 4
nc 1
nop 0
dl 7
loc 7
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\Action;
13
14
use Jitamin\Model\TaskModel;
15
16
/**
17
 * Move a task to another column when an assignee is cleared.
18
 */
19 View Code Duplication
class TaskMoveColumnUnAssigned extends Base
0 ignored issues
show
Duplication introduced by
This class seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
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 assignee is cleared');
29
    }
30
31
    /**
32
     * Get the list of compatible events.
33
     *
34
     * @return array
35
     */
36
    public function getCompatibleEvents()
37
    {
38
        return [
39
            TaskModel::EVENT_ASSIGNEE_CHANGE,
40
            TaskModel::EVENT_UPDATE,
41
        ];
42
    }
43
44
    /**
45
     * Get the required parameter for the action (defined by the user).
46
     *
47
     * @return array
48
     */
49
    public function getActionRequiredParameters()
50
    {
51
        return [
52
            'src_column_id'  => t('Source column'),
53
            'dest_column_id' => t('Destination column'),
54
        ];
55
    }
56
57
    /**
58
     * Get the required parameter for the event.
59
     *
60
     * @return string[]
61
     */
62
    public function getEventRequiredParameters()
63
    {
64
        return [
65
            'task_id',
66
            'task' => [
67
                'project_id',
68
                'column_id',
69
                'owner_id',
70
                'position',
71
                'swimlane_id',
72
            ],
73
        ];
74
    }
75
76
    /**
77
     * Execute the action (move the task to another column).
78
     *
79
     * @param array $data Event data dictionary
80
     *
81
     * @return bool True if the action was executed or false when not executed
82
     */
83
    public function doAction(array $data)
84
    {
85
        return $this->taskPositionModel->movePosition(
0 ignored issues
show
Documentation introduced by
The property taskPositionModel does not exist on object<Jitamin\Action\TaskMoveColumnUnAssigned>. 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
            $data['task']['project_id'],
87
            $data['task_id'],
88
            $this->getParam('dest_column_id'),
89
            $data['task']['position'],
90
            $data['task']['swimlane_id'],
91
            false
92
        );
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 $data['task']['column_id'] == $this->getParam('src_column_id') && $data['task']['owner_id'] == 0;
105
    }
106
}
107