TaskEmail::doAction()   A
last analyzed

Complexity

Conditions 3
Paths 2

Size

Total Lines 20
Code Lines 12

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 12
nc 2
nop 1
dl 0
loc 20
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
 * Email a task to someone.
18
 */
19
class TaskEmail extends Base
20
{
21
    /**
22
     * Get automatic action description.
23
     *
24
     * @return string
25
     */
26
    public function getDescription()
27
    {
28
        return t('Send a task by email to someone');
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
            TaskModel::EVENT_CLOSE,
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
            'column_id' => t('Column'),
53
            'user_id'   => t('User that will receive the email'),
54
            'subject'   => t('Email subject'),
55
        ];
56
    }
57
58
    /**
59
     * Get the required parameter for the event.
60
     *
61
     * @return string[]
62
     */
63
    public function getEventRequiredParameters()
64
    {
65
        return [
66
            'task_id',
67
            'task' => [
68
                'project_id',
69
                'column_id',
70
            ],
71
        ];
72
    }
73
74
    /**
75
     * Execute the action (move the task to another column).
76
     *
77
     * @param array $data Event data dictionary
78
     *
79
     * @return bool True if the action was executed or false when not executed
80
     */
81
    public function doAction(array $data)
82
    {
83
        $user = $this->userModel->getById($this->getParam('user_id'));
0 ignored issues
show
Documentation introduced by
The property userModel does not exist on object<Jitamin\Action\TaskEmail>. 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...
84
85
        if (!empty($user['email'])) {
86
            $this->emailClient->send(
0 ignored issues
show
Documentation introduced by
The property emailClient does not exist on object<Jitamin\Action\TaskEmail>. 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...
87
                $user['email'],
88
                $user['name'] ?: $user['username'],
89
                $this->getParam('subject'),
90
                $this->template->render('notification/task_create', [
0 ignored issues
show
Documentation introduced by
The property template does not exist on object<Jitamin\Action\TaskEmail>. 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...
91
                    'task'            => $data['task'],
92
                    'application_url' => $this->settingModel->get('application_url'),
0 ignored issues
show
Documentation introduced by
The property settingModel does not exist on object<Jitamin\Action\TaskEmail>. 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...
93
                ])
94
            );
95
96
            return true;
97
        }
98
99
        return false;
100
    }
101
102
    /**
103
     * Check if the event data meet the action condition.
104
     *
105
     * @param array $data Event data dictionary
106
     *
107
     * @return bool
108
     */
109
    public function hasRequiredCondition(array $data)
110
    {
111
        return $data['task']['column_id'] == $this->getParam('column_id');
112
    }
113
}
114