AverageTimeSpentColumnAnalytic::initialize()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 16
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 10
nc 2
nop 1
dl 0
loc 16
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\Analytic;
13
14
use Jitamin\Foundation\Base;
15
use Jitamin\Model\TaskModel;
16
17
/**
18
 * Average Time Spent by Column.
19
 */
20
class AverageTimeSpentColumnAnalytic extends Base
21
{
22
    /**
23
     * Build report.
24
     *
25
     * @param int $project_id Project id
26
     *
27
     * @return array
28
     */
29
    public function build($project_id)
30
    {
31
        $stats = $this->initialize($project_id);
32
33
        $this->processTasks($stats, $project_id);
34
        $this->calculateAverage($stats);
35
36
        return $stats;
37
    }
38
39
    /**
40
     * Initialize default values for each column.
41
     *
42
     * @param int $project_id
43
     *
44
     * @return array
45
     */
46
    private function initialize($project_id)
47
    {
48
        $stats = [];
49
        $columns = $this->columnModel->getList($project_id);
0 ignored issues
show
Documentation introduced by
The property columnModel does not exist on object<Jitamin\Analytic\...imeSpentColumnAnalytic>. 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...
50
51
        foreach ($columns as $column_id => $column_title) {
52
            $stats[$column_id] = [
53
                'count'      => 0,
54
                'time_spent' => 0,
55
                'average'    => 0,
56
                'title'      => $column_title,
57
            ];
58
        }
59
60
        return $stats;
61
    }
62
63
    /**
64
     * Calculate time spent for each tasks for each columns.
65
     *
66
     * @param array $stats
67
     * @param int   $project_id
68
     */
69
    private function processTasks(array &$stats, $project_id)
70
    {
71
        $tasks = $this->getTasks($project_id);
72
73
        foreach ($tasks as &$task) {
74
            foreach ($this->getTaskTimeByColumns($task) as $column_id => $time_spent) {
75
                if (isset($stats[$column_id])) {
76
                    $stats[$column_id]['count']++;
77
                    $stats[$column_id]['time_spent'] += $time_spent;
78
                }
79
            }
80
        }
81
    }
82
83
    /**
84
     * Calculate averages.
85
     *
86
     * @param array $stats
87
     */
88
    private function calculateAverage(array &$stats)
89
    {
90
        foreach ($stats as &$column) {
91
            $this->calculateColumnAverage($column);
92
        }
93
    }
94
95
    /**
96
     * Calculate column average.
97
     *
98
     * @param array $column
99
     */
100
    private function calculateColumnAverage(array &$column)
101
    {
102
        if ($column['count'] > 0) {
103
            $column['average'] = (int) ($column['time_spent'] / $column['count']);
104
        }
105
    }
106
107
    /**
108
     * Get time spent for each column for a given task.
109
     *
110
     * @param array $task
111
     *
112
     * @return array
113
     */
114
    private function getTaskTimeByColumns(array &$task)
115
    {
116
        $columns = $this->transitionModel->getTimeSpentByTask($task['id']);
0 ignored issues
show
Documentation introduced by
The property transitionModel does not exist on object<Jitamin\Analytic\...imeSpentColumnAnalytic>. 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...
117
118
        if (!isset($columns[$task['column_id']])) {
119
            $columns[$task['column_id']] = 0;
120
        }
121
122
        $columns[$task['column_id']] += $this->getTaskTimeSpentInCurrentColumn($task);
123
124
        return $columns;
125
    }
126
127
    /**
128
     * Calculate time spent of a task in the current column.
129
     *
130
     * @param array $task
131
     *
132
     * @return int
133
     */
134
    private function getTaskTimeSpentInCurrentColumn(array &$task)
135
    {
136
        $end = $task['date_completed'] ?: time();
137
138
        return $end - $task['date_moved'];
139
    }
140
141
    /**
142
     * Fetch the last 1000 tasks.
143
     *
144
     * @param int $project_id
145
     *
146
     * @return array
147
     */
148 View Code Duplication
    private function getTasks($project_id)
0 ignored issues
show
Duplication introduced by
This method 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...
149
    {
150
        return $this->db
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Analytic\...imeSpentColumnAnalytic>. 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...
151
            ->table(TaskModel::TABLE)
152
            ->columns('id', 'date_completed', 'date_moved', 'column_id')
153
            ->eq('project_id', $project_id)
154
            ->desc('id')
155
            ->limit(1000)
156
            ->findAll();
157
    }
158
}
159