ElggAnnotation::canEdit() - Code Metrics - gctools-outilsgc/gcconnex - Measure and Improve Code Quality continuously with Scrutinizer

ElggAnnotation::canEdit() B
last analyzed 2021-05-27 17:40 UTC

↳ Parent: ElggAnnotation

Complexity

Conditions	7
Paths	11

Size

Total Lines

Duplication

Lines	9
Ratio	30 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

Metric	Value
cc	7
nc	11
nop	1
dl	9
loc	30
ccs	0
cts	23
cp	0
crap	56
rs	8.5066
c	0
b	0
f	0

<?php
/**
 * Elgg Annotations
 *
 * Annotations allow you to attach bits of information to entities. They are
 * essentially the same as metadata, but with additional helper functions for
 * performing calculations.
 *
 * @note Internal: Annotations are stored in the annotations table.
 *
 * @package    Elgg.Core
 * @subpackage DataModel.Annotations
 */
class ElggAnnotation extends \ElggExtender {

	/**
	 * (non-PHPdoc)
	 *
	 * @see \ElggData::initializeAttributes()
	 *
	 * @return void
	 */
	protected function initializeAttributes() {
		parent::initializeAttributes();

		$this->attributes['type'] = 'annotation';
	}

	/**
	 * Construct a new annotation object
	 *
	 * Plugin developers will probably never use the constructor.
	 * See \ElggEntity for its API for adding annotations.
	 *
	 * @param \stdClass $row Database row as \stdClass object
	 */
	public function __construct($row = null) {

		$this->initializeAttributes();

		if (!empty($row)) {
			// Create from db row
			if ($row instanceof \stdClass) {
				$annotation = $row;

				$objarray = (array) $annotation;
				foreach ($objarray as $key => $value) {
					$this->attributes[$key] = $value;
				}
			} else {
				// get an \ElggAnnotation object and copy its attributes
				elgg_deprecated_notice('Passing an ID to constructor is deprecated. Use elgg_get_annotation_from_id()', 1.9);
				$annotation = elgg_get_annotation_from_id($row);
				$this->attributes = $annotation->attributes;
			}
		}
	}

	/**
	 * Save this instance
	 *
	 * @return int an object id
	 *
	 * @throws IOException
	 */
	public function save() {

		if ($this->id > 0) {
			return update_annotation($this->id, $this->name, $this->value, $this->value_type,

				$this->owner_guid, $this->access_id);
		} else {
			$this->id = create_annotation($this->entity_guid, $this->name, $this->value,
				$this->value_type, $this->owner_guid, $this->access_id);

			if (!$this->id) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
				throw new \IOException("Unable to save new " . get_class());
			}
			return $this->id;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
		}
	}

	/**
	 * Delete the annotation.
	 *
	 * @return bool
	 */
	public function delete() {
		$result = _elgg_delete_metastring_based_object_by_id($this->id, 'annotation');
		if ($result) {
			elgg_delete_river(array('annotation_id' => $this->id));
		}

		return $result;
	}

	/**
	 * Disable the annotation.
	 *
	 * @return bool
	 * @since 1.8
	 */
	public function disable() {
		return _elgg_set_metastring_based_object_enabled_by_id($this->id, 'no', 'annotations');
	}

	/**
	 * Enable the annotation.
	 *
	 * @return bool
	 * @since 1.8
	 */
	public function enable() {
		return _elgg_set_metastring_based_object_enabled_by_id($this->id, 'yes', 'annotations');
	}

	/**
	 * Determines whether or not the user can edit this annotation
	 *
	 * @param int $user_guid The GUID of the user (defaults to currently logged in user)
	 *
	 * @return bool
	 * @see elgg_set_ignore_access()
	 */
	public function canEdit($user_guid = 0) {

		if ($user_guid) {
			$user = get_user($user_guid);
			if (!$user) {
				return false;
			}
		} else {
			$user = _elgg_services()->session->getLoggedInUser();
			$user_guid = _elgg_services()->session->getLoggedInUserGuid();
		}

		$result = false;
		if ($user) {
			// If the owner of annotation is the specified user, they can edit.
			if ($this->getOwnerGUID() == $user_guid) {
				$result = true;
			}

			// If the user can edit the entity this is attached to, they can edit.
			$entity = $this->getEntity();
			if ($result == false && $entity->canEdit($user->getGUID())) {

				$result = true;
			}
		}

		// Trigger plugin hook - note that $user may be null
		$params = array('entity' => $entity, 'user' => $user, 'annotation' => $this);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
		return _elgg_services()->hooks->trigger('permissions_check', 'annotation', $params, $result);
	}

	// SYSTEM LOG INTERFACE

	/**
	 * For a given ID, return the object associated with it.
	 * This is used by the river functionality primarily.
	 * This is useful for checking access permissions etc on objects.
	 *
	 * @param int $id An annotation ID.
	 *
	 * @return \ElggAnnotation
	 */
	public function getObjectFromID($id) {
		return elgg_get_annotation_from_id($id);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}
}


1		<?php
2		/**
3		* Elgg Annotations
4		*
5		* Annotations allow you to attach bits of information to entities. They are
6		* essentially the same as metadata, but with additional helper functions for
7		* performing calculations.
8		*
9		* @note Internal: Annotations are stored in the annotations table.
10		*
11		* @package Elgg.Core
12		* @subpackage DataModel.Annotations
13		*/
14		class ElggAnnotation extends \ElggExtender {
15
16		/**
17		* (non-PHPdoc)
18		*
19		* @see \ElggData::initializeAttributes()
20		*
21		* @return void
22		*/
23		protected function initializeAttributes() {
24		parent::initializeAttributes();
25
26		$this->attributes['type'] = 'annotation';
27		}
28
29		/**
30		* Construct a new annotation object
31		*
32		* Plugin developers will probably never use the constructor.
33		* See \ElggEntity for its API for adding annotations.
34		*
35		* @param \stdClass $row Database row as \stdClass object
36		*/
37	View Code Duplication	public function __construct($row = null) {
		0 ignored issues – show Duplication introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report 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...
38		$this->initializeAttributes();
39
40		if (!empty($row)) {
41		// Create from db row
42		if ($row instanceof \stdClass) {
43		$annotation = $row;
44
45		$objarray = (array) $annotation;
46		foreach ($objarray as $key => $value) {
47		$this->attributes[$key] = $value;
48		}
49		} else {
50		// get an \ElggAnnotation object and copy its attributes
51		elgg_deprecated_notice('Passing an ID to constructor is deprecated. Use elgg_get_annotation_from_id()', 1.9);
52		$annotation = elgg_get_annotation_from_id($row);
53		$this->attributes = $annotation->attributes;
54		}
55		}
56		}
57
58		/**
59		* Save this instance
60		*
61		* @return int an object id
62		*
63		* @throws IOException
64		*/
65	View Code Duplication	public function save() {
		0 ignored issues – show Duplication introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report 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...
66		if ($this->id > 0) {
67		return update_annotation($this->id, $this->name, $this->value, $this->value_type,
		0 ignored issues – show Bug Compatibility introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report The expression `update_annotation($this-...uid, $this->access_id);` of type `integer\|boolean` adds the type `integer` to the return on line 67 which is incompatible with the return type declared by the abstract method `ElggData::save` of type `boolean`. Loading history...
68		$this->owner_guid, $this->access_id);
69		} else {
70		$this->id = create_annotation($this->entity_guid, $this->name, $this->value,
71		$this->value_type, $this->owner_guid, $this->access_id);
72
73		if (!$this->id) {
		0 ignored issues – show Bug Best Practice introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report The expression `$this->id` of type `false\|integer` is loosely compared to `false`; this is ambiguous if the integer can be zero. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
74		throw new \IOException("Unable to save new " . get_class());
75		}
76		return $this->id;
		0 ignored issues – show Bug Best Practice introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report The return type of `return $this->id;` (`integer`) is incompatible with the return type declared by the abstract method `ElggData::save` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
77		}
78		}
79
80		/**
81		* Delete the annotation.
82		*
83		* @return bool
84		*/
85		public function delete() {
86		$result = _elgg_delete_metastring_based_object_by_id($this->id, 'annotation');
87		if ($result) {
88		elgg_delete_river(array('annotation_id' => $this->id));
89		}
90
91		return $result;
92		}
93
94		/**
95		* Disable the annotation.
96		*
97		* @return bool
98		* @since 1.8
99		*/
100		public function disable() {
101		return _elgg_set_metastring_based_object_enabled_by_id($this->id, 'no', 'annotations');
102		}
103
104		/**
105		* Enable the annotation.
106		*
107		* @return bool
108		* @since 1.8
109		*/
110		public function enable() {
111		return _elgg_set_metastring_based_object_enabled_by_id($this->id, 'yes', 'annotations');
112		}
113
114		/**
115		* Determines whether or not the user can edit this annotation
116		*
117		* @param int $user_guid The GUID of the user (defaults to currently logged in user)
118		*
119		* @return bool
120		* @see elgg_set_ignore_access()
121		*/
122		public function canEdit($user_guid = 0) {
123
124	View Code Duplication	if ($user_guid) {
125		$user = get_user($user_guid);
126		if (!$user) {
127		return false;
128		}
129		} else {
130		$user = _elgg_services()->session->getLoggedInUser();
131		$user_guid = _elgg_services()->session->getLoggedInUserGuid();
132		}
133
134		$result = false;
135		if ($user) {
136		// If the owner of annotation is the specified user, they can edit.
137		if ($this->getOwnerGUID() == $user_guid) {
138		$result = true;
139		}
140
141		// If the user can edit the entity this is attached to, they can edit.
142		$entity = $this->getEntity();
143		if ($result == false && $entity->canEdit($user->getGUID())) {
		0 ignored issues – show Coding Style Best Practice introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
144		$result = true;
145		}
146		}
147
148		// Trigger plugin hook - note that $user may be null
149		$params = array('entity' => $entity, 'user' => $user, 'annotation' => $this);
		0 ignored issues – show Bug introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report The variable `$entity` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
150		return _elgg_services()->hooks->trigger('permissions_check', 'annotation', $params, $result);
151		}
152
153		// SYSTEM LOG INTERFACE
154
155		/**
156		* For a given ID, return the object associated with it.
157		* This is used by the river functionality primarily.
158		* This is useful for checking access permissions etc on objects.
159		*
160		* @param int $id An annotation ID.
161		*
162		* @return \ElggAnnotation
163		*/
164		public function getObjectFromID($id) {
165		return elgg_get_annotation_from_id($id);
		0 ignored issues – show Bug Best Practice introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report The return type of `return elgg_get_annotation_from_id($id);` (`ElggExtender`) is incompatible with the return type declared by the interface `Loggable::getObjectFromID` of type `ElggEntity`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
166		}
167		}
168

gctools-outilsgc / gcconnex

ElggAnnotation::canEdit() B last analyzed 2021-05-27 17:40 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

ElggAnnotation::canEdit() B
last analyzed 2021-05-27 17:40 UTC