TaskStatusModel::close()   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\Model;
13
14
use Jitamin\Foundation\Database\Model;
15
16
/**
17
 * Task Status.
18
 */
19
class TaskStatusModel extends Model
20
{
21
    /**
22
     * Return true if the task is closed.
23
     *
24
     * @param int $task_id Task id
25
     *
26
     * @return bool
27
     */
28
    public function isClosed($task_id)
29
    {
30
        return $this->checkStatus($task_id, TaskModel::STATUS_CLOSED);
31
    }
32
33
    /**
34
     * Return true if the task is open.
35
     *
36
     * @param int $task_id Task id
37
     *
38
     * @return bool
39
     */
40
    public function isOpen($task_id)
41
    {
42
        return $this->checkStatus($task_id, TaskModel::STATUS_OPEN);
43
    }
44
45
    /**
46
     * Mark a task closed.
47
     *
48
     * @param int $task_id Task id
49
     *
50
     * @return bool
51
     */
52
    public function close($task_id)
53
    {
54
        $this->subtaskStatusModel->closeAll($task_id);
0 ignored issues
show
Documentation introduced by
The property subtaskStatusModel does not exist on object<Jitamin\Model\TaskStatusModel>. 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...
55
56
        return $this->changeStatus($task_id, TaskModel::STATUS_CLOSED, time(), TaskModel::EVENT_CLOSE);
57
    }
58
59
    /**
60
     * Mark a task open.
61
     *
62
     * @param int $task_id Task id
63
     *
64
     * @return bool
65
     */
66
    public function open($task_id)
67
    {
68
        return $this->changeStatus($task_id, TaskModel::STATUS_OPEN, 0, TaskModel::EVENT_OPEN);
69
    }
70
71
    /**
72
     * Close multiple tasks.
73
     *
74
     * @param array $task_ids
75
     */
76
    public function closeMultipleTasks(array $task_ids)
77
    {
78
        foreach ($task_ids as $task_id) {
79
            $this->close($task_id);
80
        }
81
    }
82
83
    /**
84
     * Close all tasks within a column/swimlane.
85
     *
86
     * @param int $swimlane_id
87
     * @param int $column_id
88
     */
89
    public function closeTasksBySwimlaneAndColumn($swimlane_id, $column_id)
90
    {
91
        $task_ids = $this->db
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\TaskStatusModel>. 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...
92
            ->table(TaskModel::TABLE)
93
            ->eq('swimlane_id', $swimlane_id)
94
            ->eq('column_id', $column_id)
95
            ->eq(TaskModel::TABLE.'.is_active', TaskModel::STATUS_OPEN)
96
            ->findAllByColumn('id');
97
98
        $this->closeMultipleTasks($task_ids);
99
    }
100
101
    /**
102
     * Common method to change the status of task.
103
     *
104
     * @param int    $task_id        Task id
105
     * @param int    $status         Task status
106
     * @param int    $date_completed Timestamp
107
     * @param string $event_name     Event name
108
     *
109
     * @return bool
110
     */
111
    private function changeStatus($task_id, $status, $date_completed, $event_name)
112
    {
113
        if (!$this->taskFinderModel->exists($task_id)) {
0 ignored issues
show
Documentation introduced by
The property taskFinderModel does not exist on object<Jitamin\Model\TaskStatusModel>. 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...
114
            return false;
115
        }
116
117
        $result = $this->db
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\TaskStatusModel>. 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...
118
                        ->table(TaskModel::TABLE)
119
                        ->eq('id', $task_id)
120
                        ->update([
121
                            'is_active'         => $status,
122
                            'date_completed'    => $date_completed,
123
                            'date_modification' => time(),
124
                        ]);
125
126
        if ($result) {
127
            $this->queueManager->push($this->taskEventJob->withParams($task_id, [$event_name]));
0 ignored issues
show
Documentation introduced by
The property queueManager does not exist on object<Jitamin\Model\TaskStatusModel>. 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...
Documentation introduced by
The property taskEventJob does not exist on object<Jitamin\Model\TaskStatusModel>. 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...
128
        }
129
130
        return $result;
131
    }
132
133
    /**
134
     * Check the status of a task.
135
     *
136
     * @param int $task_id Task id
137
     * @param int $status  Task status
138
     *
139
     * @return bool
140
     */
141
    private function checkStatus($task_id, $status)
142
    {
143
        return $this->db
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\TaskStatusModel>. 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...
144
                    ->table(TaskModel::TABLE)
145
                    ->eq('id', $task_id)
146
                    ->eq('is_active', $status)
147
                    ->count() === 1;
148
    }
149
}
150