ElggPage::getParentEntity() - Code Metrics - Inspection of "Merge pull request #11567 from mrclay/11563_routes" - Elgg/Elgg - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c0a3a7...3b84a4 )

by Jeroen

created 2018-01-08 10:08 UTC

ElggPage::getParentEntity() A

↳ Parent: ElggPage

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	3
nop	0
dl	0
loc	12
ccs	7
cts	7
cp	1
crap	3
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * Page class
 *
 * @since 3.0
 */
class ElggPage extends ElggObject {
	
	/**
	 * {@inheritDoc}
	 */
	protected function initializeAttributes() {
		parent::initializeAttributes();
		
		$this->attributes['subtype'] = 'page';
		
		// set default parent (this makes it a top page)
		$this->parent_guid = 0;

	}
	
	/**
	 * Is this a top page in the tree
	 *
	 * @return bool
	 *
	 * @since 3.0
	 */
	public function isTopPage() {
		return empty($this->parent_guid);
	}
	
	/**
	 * Get the parent entity of this page
	 *
	 * @return false|ElggPage
	 *
	 * @since 3.0
	 */
	public function getParentEntity() {
		
		if (empty($this->parent_guid)) {
			return false;
		}
		
		$parent = get_entity($this->parent_guid);
		if ($parent instanceof ElggPage) {
			return $parent;
		}
		
		return false;
	}
	
	/**
	 * Get the GUID of the parent entity
	 *
	 * @return int 0 if no parent
	 */
	public function getParentGUID() {
		return (int) $this->parent_guid;
	}
	
	/**
	 * Set a new parent entity from a GUID
	 *
	 * @param int $guid the GUID of an ElggPage or 0
	 *
	 * @return bool
	 *
	 * @since 3.0
	 */
	public function setParentByGUID($guid) {
		$guid = (int) $guid;
		
		if (empty($guid)) {
			$this->parent_guid = 0;

			return true;
		}
		
		$new_parent = get_entity($guid);
		return $this->setParentEntity($new_parent);
	}
	
	/**
	 * Set the new parent entity
	 *
	 * @param ElggPage|null $entity the new parent entity. Eighter an ElggPage or null
	 *
	 * @return bool
	 *
	 * @since 3.0
	 */
	public function setParentEntity($entity) {
		
		if (empty($entity)) {
			$this->parent_guid = 0;

			return true;
		}
		
		if (!$entity instanceof ElggPage || empty($entity->guid)) {
			return false;
		}
		
		$this->parent_guid = $entity->guid;
		return true;
	}
}


1		<?php
2
3		/**
4		* Page class
5		*
6		* @since 3.0
7		*/
8		class ElggPage extends ElggObject {
9
10		/**
11		* {@inheritDoc}
12		*/
13	6	protected function initializeAttributes() {
14	6	parent::initializeAttributes();
15
16	6	$this->attributes['subtype'] = 'page';
17
18		// set default parent (this makes it a top page)
19	6	$this->parent_guid = 0;
		0 ignored issues – show Bug Best Practice introduced 2017-11-09 12:28 UTC by Report Bug Copy Issue Report The property `parent_guid` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
20	6	}
21
22		/**
23		* Is this a top page in the tree
24		*
25		* @return bool
26		*
27		* @since 3.0
28		*/
29	1	public function isTopPage() {
30	1	return empty($this->parent_guid);
31		}
32
33		/**
34		* Get the parent entity of this page
35		*
36		* @return false\|ElggPage
37		*
38		* @since 3.0
39		*/
40	1	public function getParentEntity() {
41
42	1	if (empty($this->parent_guid)) {
43	1	return false;
44		}
45
46	1	$parent = get_entity($this->parent_guid);
47	1	if ($parent instanceof ElggPage) {
48	1	return $parent;
49		}
50
51	1	return false;
52		}
53
54		/**
55		* Get the GUID of the parent entity
56		*
57		* @return int 0 if no parent
58		*/
59	3	public function getParentGUID() {
60	3	return (int) $this->parent_guid;
61		}
62
63		/**
64		* Set a new parent entity from a GUID
65		*
66		* @param int $guid the GUID of an ElggPage or 0
67		*
68		* @return bool
69		*
70		* @since 3.0
71		*/
72	1	public function setParentByGUID($guid) {
73	1	$guid = (int) $guid;
74
75	1	if (empty($guid)) {
76	1	$this->parent_guid = 0;
		0 ignored issues – show Bug Best Practice introduced 2017-11-07 16:53 UTC by Report Bug Copy Issue Report The property `parent_guid` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
77	1	return true;
78		}
79
80	1	$new_parent = get_entity($guid);
81	1	return $this->setParentEntity($new_parent);
82		}
83
84		/**
85		* Set the new parent entity
86		*
87		* @param ElggPage\|null $entity the new parent entity. Eighter an ElggPage or null
88		*
89		* @return bool
90		*
91		* @since 3.0
92		*/
93	2	public function setParentEntity($entity) {
94
95	2	if (empty($entity)) {
96	1	$this->parent_guid = 0;
		0 ignored issues – show Bug Best Practice introduced 2017-11-07 16:53 UTC by Report Bug Copy Issue Report The property `parent_guid` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
97	1	return true;
98		}
99
100	2	if (!$entity instanceof ElggPage \|\| empty($entity->guid)) {
101	2	return false;
102		}
103
104	2	$this->parent_guid = $entity->guid;
105	2	return true;
106		}
107		}
108

Elgg / Elgg

Push — master ( c0a3a7...3b84a4 )

ElggPage::getParentEntity() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like