TaskCloseColumn::getCompatibleEvents() - Code Metrics - Jitamin/jitamin - Measure and Improve Code Quality continuously with Scrutinizer

TaskCloseColumn::getCompatibleEvents() A
last analyzed 2017-12-27 06:16 UTC

↳ Parent: TaskCloseColumn

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

/*
 * This file is part of Jitamin.
 *
 * Copyright (C) Jitamin Team
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Jitamin\Action;

use Jitamin\Model\TaskModel;

/**
 * Close automatically a task in a specific column.
 */
class TaskCloseColumn extends Base
{
    /**
     * Get automatic action description.
     *
     * @return string
     */
    public function getDescription()
    {
        return t('Close a task in a specific column');
    }

    /**
     * Get the list of compatible events.
     *
     * @return array
     */
    public function getCompatibleEvents()
    {
        return [
            TaskModel::EVENT_MOVE_COLUMN,
        ];
    }

    /**
     * Get the required parameter for the action (defined by the user).
     *
     * @return array
     */
    public function getActionRequiredParameters()
    {
        return ['column_id' => t('Column')];
    }

    /**
     * Get the required parameter for the event.
     *
     * @return string[]
     */
    public function getEventRequiredParameters()
    {
        return [
            'task_id',
            'task' => [
                'project_id',
                'column_id',
            ],
        ];
    }

    /**
     * Execute the action (close the task).
     *
     * @param array $data Event data dictionary
     *
     * @return bool True if the action was executed or false when not executed
     */
    public function doAction(array $data)
    {
        return $this->taskStatusModel->close($data['task_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.");
        }
    }

}
    }

    /**
     * Check if the event data meet the action condition.
     *
     * @param array $data Event data dictionary
     *
     * @return bool
     */
    public function hasRequiredCondition(array $data)
    {
        return $data['task']['column_id'] == $this->getParam('column_id');
    }
}


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			* Close automatically a task in a specific column.
18			*/
19			class TaskCloseColumn extends Base
20			{
21			/**
22			* Get automatic action description.
23			*
24			* @return string
25			*/
26			public function getDescription()
27			{
28			return t('Close a task in a specific column');
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_MOVE_COLUMN,
40			];
41			}
42
43			/**
44			* Get the required parameter for the action (defined by the user).
45			*
46			* @return array
47			*/
48			public function getActionRequiredParameters()
49			{
50			return ['column_id' => t('Column')];
51			}
52
53			/**
54			* Get the required parameter for the event.
55			*
56			* @return string[]
57			*/
58			public function getEventRequiredParameters()
59			{
60			return [
61			'task_id',
62			'task' => [
63			'project_id',
64			'column_id',
65			],
66			];
67			}
68
69			/**
70			* Execute the action (close the task).
71			*
72			* @param array $data Event data dictionary
73			*
74			* @return bool True if the action was executed or false when not executed
75			*/
76			public function doAction(array $data)
77			{
78			return $this->taskStatusModel->close($data['task_id']);
			0 ignored issues – show Documentation introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report The property `taskStatusModel` does not exist on `object<Jitamin\Action\TaskCloseColumn>`. 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...
79			}
80
81			/**
82			* Check if the event data meet the action condition.
83			*
84			* @param array $data Event data dictionary
85			*
86			* @return bool
87			*/
88			public function hasRequiredCondition(array $data)
89			{
90			return $data['task']['column_id'] == $this->getParam('column_id');
91			}
92			}
93

Jitamin / jitamin

TaskCloseColumn::getCompatibleEvents() A last analyzed 2017-12-27 06:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

TaskCloseColumn::getCompatibleEvents() A
last analyzed 2017-12-27 06:16 UTC