org_openpsa_projects_task_dba::get_label() - Code Metrics - Inspection of "Move hour cache handling to o.o.expenses" - flack/openpsa - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4060b7...c5bdc7 )

by Andreas

created 2021-06-07 15:38 UTC

org_openpsa_projects_task_dba::get_label() A

↳ Parent: org_openpsa_projects_task_dba

Complexity

Conditions	2
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	7
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	10
ccs	7
cts	7
cp	1
crap	2
rs	10

<?php
/**
 * @package org.openpsa.projects
 * @author Nemein Oy http://www.nemein.com/
 * @copyright Nemein Oy http://www.nemein.com/
 * @license http://www.gnu.org/licenses/gpl.html GNU General Public License
 */

/**
 * MidCOM wrapped access to the MgdSchema class, keep logic here
 *
 * @property integer $up
 * @property integer $project
 * @property integer $start
 * @property integer $end
 * @property string $title
 * @property string $description
 * @property float $plannedHours
 * @property integer $status cache of last status
 * @property integer $agreement
 * @property integer $customer
 * @property integer $manager
 * @property float $reportedHours
 * @property float $invoicedHours
 * @property float $invoiceableHours
 * @property boolean $hoursInvoiceableDefault Are hours invoiceable by default ?
 * @property integer $priority
 * @property integer $orgOpenpsaAccesstype Shortcut for various ACL scenarios
 * @property string $orgOpenpsaOwnerWg The "owner" workgroup of this object
 * @package org.openpsa.projects
 */
class org_openpsa_projects_task_dba extends midcom_core_dbaobject
{
    public $__midcom_class_name__ = __CLASS__;
    public $__mgdschema_class_name__ = 'org_openpsa_task';

    public $autodelete_dependents = [
        org_openpsa_projects_task_status_dba::class => 'task',
        org_openpsa_projects_task_resource_dba::class => 'task',
    ];

    public $contacts = []; //Shorthand access for contact members
    public $resources = []; // --''--
    public $_skip_acl_refresh = false;
    public $_skip_parent_refresh = false;
    private $_status;

    /**
     * Deny midgard:read by default
     */
    public function get_class_magic_default_privileges()
    {
        $privileges = parent::get_class_magic_default_privileges();
        $privileges['EVERYONE']['midgard:read'] = MIDCOM_PRIVILEGE_DENY;
        return $privileges;
    }

    public function _on_creating() : bool
    {
        if (!$this->manager) {
            $this->manager = midcom_connection::get_user();
        }
        return $this->_prepare_save();
    }

    public function _on_loaded()
    {
        if ($this->title == "") {
            $this->title = "Task #{$this->id}";
        }

        if (!$this->status) {
            //Default to proposed if no status is set
            $this->status = org_openpsa_projects_task_status_dba::PROPOSED;
        }
    }

    public function refresh() : bool
    {
        $this->contacts = [];
        $this->resources = [];
        $this->_status = null;
        return parent::refresh();
    }

    public function __get($property)
    {
        if ($property == 'status_type') {
            return org_openpsa_projects_workflow::get_status_type($this->status);
        }
        if (in_array($property, ['status_comment', 'status_time'])) {
            if ($this->_status === null) {
                $this->refresh_status();
            }
            return $this->_status[$property];
        }
        return parent::__get($property);
    }

    public function _on_updating() : bool
    {
        return $this->_prepare_save();
    }

    public function _on_updated()
    {
        // Sync the object's ACL properties into MidCOM ACL system
        if (   !$this->_skip_acl_refresh) {
            if ($this->orgOpenpsaAccesstype && $this->orgOpenpsaOwnerWg) {
                debug_add("Synchronizing task ACLs to MidCOM");
                $sync = new org_openpsa_core_acl_synchronizer();
                $sync->write_acls($this, $this->orgOpenpsaOwnerWg, $this->orgOpenpsaAccesstype);
            }

            //Ensure manager can do stuff
            if ($this->manager) {
                $manager_person = midcom::get()->auth->get_user($this->manager);
                $this->set_privilege('midgard:read', $manager_person->id, MIDCOM_PRIVILEGE_ALLOW);
                $this->set_privilege('midgard:create', $manager_person->id, MIDCOM_PRIVILEGE_ALLOW);
                $this->set_privilege('midgard:delete', $manager_person->id, MIDCOM_PRIVILEGE_ALLOW);
                $this->set_privilege('midgard:update', $manager_person->id, MIDCOM_PRIVILEGE_ALLOW);
            }
        }

        $this->_update_parent();
    }

    /**
     * Generate a user-readable label for the task using the task/project hierarchy
     */
    public function get_label() : string
    {
        $label_elements = [];
        $task = $this;
        do {
            $label_elements[] = $task->title;
        } while ($task = $task->get_parent());

        $label = implode(' / ', array_reverse($label_elements));
        return trim($label);
    }

    public function get_icon() : string
    {
        return 'calendar-check-o';
    }

    /**
     * Populates contacts as resources lists
     */
    public function get_members()
    {
        if ($this->id) {
            $mc = org_openpsa_projects_task_resource_dba::new_collector('task', $this->id);
            $ret = $mc->get_rows(['orgOpenpsaObtype', 'person']);

            foreach ($ret as $data) {
                if ($data['orgOpenpsaObtype'] == org_openpsa_projects_task_resource_dba::CONTACT) {
                    $this->contacts[$data['person']] = true;
                } else {
                    $this->resources[$data['person']] = true;
                }
            }
        }
    }

    /**
     * Adds new contacts or resources
     */
    public function add_members(string $property, array $ids)
    {
        if ($property === 'contacts') {
            $type = org_openpsa_projects_task_resource_dba::CONTACT;
        } elseif ($property === 'resources') {
            $type = org_openpsa_projects_task_resource_dba::RESOURCE;
        } else {
            return;
        }

        foreach ($ids as $id) {
            $resource = new org_openpsa_projects_task_resource_dba();
            $resource->orgOpenpsaObtype = $type;
            $resource->task = $this->id;
            $resource->person = (int) $id;
            if ($resource->create()) {
                $this->{$property}[$id] = true;
            }
        }
    }

    private function _prepare_save() : bool
    {
        //Make sure we have end
        if (!$this->end || $this->end == -1) {
            $this->end = time();
        }
        //Make sure we have start
        if (!$this->start) {
            $this->start = min(time(), $this->end - 1);
        }

        // Reset start and end to start/end of day
        $this->start = strtotime('today', $this->start);
        $this->end = strtotime('tomorrow', $this->end) - 1;

        if ($this->start > $this->end) {
            debug_add("start ({$this->start}) is greater than end ({$this->end}), aborting", MIDCOM_LOG_ERROR);
            return false;
        }

        if ($agreement = $this->get_agreement()) {
            // Get customer company into cache from agreement's sales project
            if (!$this->customer) {
                try {
                    $agreement = org_openpsa_sales_salesproject_deliverable_dba::get_cached($agreement);
                    $salesproject = org_openpsa_sales_salesproject_dba::get_cached($agreement->salesproject);

                    $this->customer = $salesproject->customer;

                }
                catch (midcom_error $e) {}

            }
        } else {
            // No agreement, we can't be invoiceable
            $this->hoursInvoiceableDefault = false;
        }

        return true;
    }

    public function get_agreement() : int
    {
        if ($this->up) {
            do {
                $parent = $this->get_parent();
            } while ($parent->up);

            return $parent->agreement;

        }
        return $this->agreement;
    }

    private function _update_parent()
    {
        if (!$this->_skip_parent_refresh) {
            $project = new org_openpsa_projects_project($this->project);
            $project->refresh_from_tasks();
        }
        try {
            $agreement = new org_openpsa_sales_salesproject_deliverable_dba($this->get_agreement());
            $agreement->update_units();
        } catch (midcom_error $e) {}

    }

    /**
     * Queries status objects
     */
    public function get_status() : array
    {
        //Simplistic approach
        $mc = org_openpsa_projects_task_status_dba::new_collector('task', $this->id);
        if ($this->status > org_openpsa_projects_task_status_dba::PROPOSED) {
            //Only get proposed status objects here if are not over that phase
            $mc->add_constraint('type', '<>', org_openpsa_projects_task_status_dba::PROPOSED);
        }
        if (!empty($this->resources)) {
            //Do not ever set status to declined if we still have resources left
            $mc->add_constraint('type', '<>', org_openpsa_projects_task_status_dba::DECLINED);
        }
        $mc->add_order('id', 'DESC');
        $mc->set_limit(1);
        return $mc->get_rows(['type', 'comment', 'metadata_created']);
    }

    public function refresh_status()
    {
        $this->_status = [
            'status_comment' => '',
            'status_time' => false,
        ];

        $ret = $this->get_status();
        if (empty($ret)) {
            //Failure to get status object
            debug_add('Could not find any status objects, defaulting to previous status');
            return;
        }
        $status = current($ret);

        //Update the status cache if necessary
        if ($this->status != $status['type']) {
            $this->status = $status['type'];
            $this->update();
        }

        //TODO: Check various combinations of accept/decline etc etc
        $this->_status['status_comment'] = $status['comment'];
        $this->_status['status_time'] = (int) $status['created']->format('U');
    }
}


1		<?php
2		/**
3		* @package org.openpsa.projects
4		* @author Nemein Oy http://www.nemein.com/
5		* @copyright Nemein Oy http://www.nemein.com/
6		* @license http://www.gnu.org/licenses/gpl.html GNU General Public License
7		*/
8
9		/**
10		* MidCOM wrapped access to the MgdSchema class, keep logic here
11		*
12		* @property integer $up
13		* @property integer $project
14		* @property integer $start
15		* @property integer $end
16		* @property string $title
17		* @property string $description
18		* @property float $plannedHours
19		* @property integer $status cache of last status
20		* @property integer $agreement
21		* @property integer $customer
22		* @property integer $manager
23		* @property float $reportedHours
24		* @property float $invoicedHours
25		* @property float $invoiceableHours
26		* @property boolean $hoursInvoiceableDefault Are hours invoiceable by default ?
27		* @property integer $priority
28		* @property integer $orgOpenpsaAccesstype Shortcut for various ACL scenarios
29		* @property string $orgOpenpsaOwnerWg The "owner" workgroup of this object
30		* @package org.openpsa.projects
31		*/
32		class org_openpsa_projects_task_dba extends midcom_core_dbaobject
33		{
34		public $__midcom_class_name__ = __CLASS__;
35		public $__mgdschema_class_name__ = 'org_openpsa_task';
36
37		public $autodelete_dependents = [
38		org_openpsa_projects_task_status_dba::class => 'task',
39		org_openpsa_projects_task_resource_dba::class => 'task',
40		];
41
42		public $contacts = []; //Shorthand access for contact members
43		public $resources = []; // --''--
44		public $_skip_acl_refresh = false;
45		public $_skip_parent_refresh = false;
46		private $_status;
47
48		/**
49		* Deny midgard:read by default
50		*/
51	1	public function get_class_magic_default_privileges()
52		{
53	1	$privileges = parent::get_class_magic_default_privileges();
54	1	$privileges['EVERYONE']['midgard:read'] = MIDCOM_PRIVILEGE_DENY;
55	1	return $privileges;
56		}
57
58	20	public function _on_creating() : bool
59		{
60	20	if (!$this->manager) {
61	19	$this->manager = midcom_connection::get_user();
62		}
63	20	return $this->_prepare_save();
64		}
65
66	41	public function _on_loaded()
67		{
68	41	if ($this->title == "") {
69	19	$this->title = "Task #{$this->id}";
70		}
71
72	41	if (!$this->status) {
73		//Default to proposed if no status is set
74	33	$this->status = org_openpsa_projects_task_status_dba::PROPOSED;
75		}
76	41	}
77
78	30	public function refresh() : bool
79		{
80	30	$this->contacts = [];
81	30	$this->resources = [];
82	30	$this->_status = null;
83	30	return parent::refresh();
84		}
85
86	49	public function __get($property)
87		{
88	49	if ($property == 'status_type') {
89	32	return org_openpsa_projects_workflow::get_status_type($this->status);
90		}
91	49	if (in_array($property, ['status_comment', 'status_time'])) {
92	6	if ($this->_status === null) {
93	6	$this->refresh_status();
94		}
95	6	return $this->_status[$property];
96		}
97	49	return parent::__get($property);
98		}
99
100	32	public function _on_updating() : bool
101		{
102	32	return $this->_prepare_save();
103		}
104
105	32	public function _on_updated()
106		{
107		// Sync the object's ACL properties into MidCOM ACL system
108	32	if ( !$this->_skip_acl_refresh) {
109	13	if ($this->orgOpenpsaAccesstype && $this->orgOpenpsaOwnerWg) {
110		debug_add("Synchronizing task ACLs to MidCOM");
111		$sync = new org_openpsa_core_acl_synchronizer();
112		$sync->write_acls($this, $this->orgOpenpsaOwnerWg, $this->orgOpenpsaAccesstype);
113		}
114
115		//Ensure manager can do stuff
116	13	if ($this->manager) {
117	10	$manager_person = midcom::get()->auth->get_user($this->manager);
118	10	$this->set_privilege('midgard:read', $manager_person->id, MIDCOM_PRIVILEGE_ALLOW);
119	10	$this->set_privilege('midgard:create', $manager_person->id, MIDCOM_PRIVILEGE_ALLOW);
120	10	$this->set_privilege('midgard:delete', $manager_person->id, MIDCOM_PRIVILEGE_ALLOW);
121	10	$this->set_privilege('midgard:update', $manager_person->id, MIDCOM_PRIVILEGE_ALLOW);
122		}
123		}
124
125	32	$this->_update_parent();
126	32	}
127
128		/**
129		* Generate a user-readable label for the task using the task/project hierarchy
130		*/
131	3	public function get_label() : string
132		{
133	3	$label_elements = [];
134	3	$task = $this;
135		do {
136	3	$label_elements[] = $task->title;
137	3	} while ($task = $task->get_parent());
138
139	3	$label = implode(' / ', array_reverse($label_elements));
140	3	return trim($label);
141		}
142
143		public function get_icon() : string
144		{
145		return 'calendar-check-o';
146		}
147
148		/**
149		* Populates contacts as resources lists
150		*/
151	19	public function get_members()
152		{
153	19	if ($this->id) {
154	19	$mc = org_openpsa_projects_task_resource_dba::new_collector('task', $this->id);
155	19	$ret = $mc->get_rows(['orgOpenpsaObtype', 'person']);
156
157	19	foreach ($ret as $data) {
158	3	if ($data['orgOpenpsaObtype'] == org_openpsa_projects_task_resource_dba::CONTACT) {
159	1	$this->contacts[$data['person']] = true;
160		} else {
161	3	$this->resources[$data['person']] = true;
162		}
163		}
164		}
165	19	}
166
167		/**
168		* Adds new contacts or resources
169		*/
170	17	public function add_members(string $property, array $ids)
171		{
172	17	if ($property === 'contacts') {
173	4	$type = org_openpsa_projects_task_resource_dba::CONTACT;
174	17	} elseif ($property === 'resources') {
175	17	$type = org_openpsa_projects_task_resource_dba::RESOURCE;
176		} else {
177		return;
178		}
179
180	17	foreach ($ids as $id) {
181	17	$resource = new org_openpsa_projects_task_resource_dba();
182	17	$resource->orgOpenpsaObtype = $type;
183	17	$resource->task = $this->id;
184	17	$resource->person = (int) $id;
185	17	if ($resource->create()) {
186	17	$this->{$property}[$id] = true;
187		}
188		}
189	17	}
190
191	33	private function _prepare_save() : bool
192		{
193		//Make sure we have end
194	33	if (!$this->end \|\| $this->end == -1) {
195	19	$this->end = time();
196		}
197		//Make sure we have start
198	33	if (!$this->start) {
199	19	$this->start = min(time(), $this->end - 1);
200		}
201
202		// Reset start and end to start/end of day
203	33	$this->start = strtotime('today', $this->start);
204	33	$this->end = strtotime('tomorrow', $this->end) - 1;
205
206	33	if ($this->start > $this->end) {
207		debug_add("start ({$this->start}) is greater than end ({$this->end}), aborting", MIDCOM_LOG_ERROR);
208		return false;
209		}
210
211	33	if ($agreement = $this->get_agreement()) {
212		// Get customer company into cache from agreement's sales project
213	12	if (!$this->customer) {
214		try {
215	11	$agreement = org_openpsa_sales_salesproject_deliverable_dba::get_cached($agreement);
216	11	$salesproject = org_openpsa_sales_salesproject_dba::get_cached($agreement->salesproject);
		0 ignored issues – show Bug Best Practice introduced 2018-01-08 16:22 UTC by Report Bug Copy Issue Report The property `salesproject` does not exist on `midcom_core_dbaobject`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
217	11	$this->customer = $salesproject->customer;
		0 ignored issues – show Bug Best Practice introduced 2018-01-08 16:22 UTC by Report Bug Copy Issue Report The property `customer` does not exist on `midcom_core_dbaobject`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
218		}
219	12	catch (midcom_error $e) {}
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-01-08 16:22 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
220		}
221		} else {
222		// No agreement, we can't be invoiceable
223	23	$this->hoursInvoiceableDefault = false;
224		}
225
226	33	return true;
227		}
228
229	34	public function get_agreement() : int
230		{
231	34	if ($this->up) {
232		do {
233		$parent = $this->get_parent();
234		} while ($parent->up);
		0 ignored issues – show Bug Best Practice introduced 2019-04-09 14:08 UTC by Report Bug Copy Issue Report The property `up` does not exist on `midcom_core_dbaobject`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
235		return $parent->agreement;
		0 ignored issues – show Bug Best Practice introduced 2018-01-08 16:22 UTC by Report Bug Copy Issue Report The property `agreement` does not exist on `midcom_core_dbaobject`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
236		}
237	34	return $this->agreement;
238		}
239
240	32	private function _update_parent()
241		{
242	32	if (!$this->_skip_parent_refresh) {
243	28	$project = new org_openpsa_projects_project($this->project);
244	28	$project->refresh_from_tasks();
245		}
246		try {
247	32	$agreement = new org_openpsa_sales_salesproject_deliverable_dba($this->get_agreement());
248	12	$agreement->update_units();
249	29	} catch (midcom_error $e) {}
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-01-08 16:22 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
250	32	}
251
252		/**
253		* Queries status objects
254		*/
255	7	public function get_status() : array
256		{
257		//Simplistic approach
258	7	$mc = org_openpsa_projects_task_status_dba::new_collector('task', $this->id);
259	7	if ($this->status > org_openpsa_projects_task_status_dba::PROPOSED) {
260		//Only get proposed status objects here if are not over that phase
261	5	$mc->add_constraint('type', '<>', org_openpsa_projects_task_status_dba::PROPOSED);
262		}
263	7	if (!empty($this->resources)) {
264		//Do not ever set status to declined if we still have resources left
265		$mc->add_constraint('type', '<>', org_openpsa_projects_task_status_dba::DECLINED);
266		}
267	7	$mc->add_order('id', 'DESC');
268	7	$mc->set_limit(1);
269	7	return $mc->get_rows(['type', 'comment', 'metadata_created']);
270		}
271
272	6	public function refresh_status()
273		{
274	6	$this->_status = [
275		'status_comment' => '',
276		'status_time' => false,
277		];
278
279	6	$ret = $this->get_status();
280	6	if (empty($ret)) {
281		//Failure to get status object
282		debug_add('Could not find any status objects, defaulting to previous status');
283		return;
284		}
285	6	$status = current($ret);
286
287		//Update the status cache if necessary
288	6	if ($this->status != $status['type']) {
289		$this->status = $status['type'];
290		$this->update();
291		}
292
293		//TODO: Check various combinations of accept/decline etc etc
294	6	$this->_status['status_comment'] = $status['comment'];
295	6	$this->_status['status_time'] = (int) $status['created']->format('U');
296	6	}
297		}
298

flack / openpsa

Push — master ( 4060b7...c5bdc7 )

org_openpsa_projects_task_dba::get_label() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like