Issues in ElggAnnotation.php - All Issues - Inspection of "Merge pull request #13095 from jdalsem/likes-popup" - Elgg/Elgg - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.3 ( 5fced4...d53524 )

by Jerome

created 2020-02-06 13:51 UTC

engine/classes/ElggAnnotation.php (1 issue)

Labels

Severity

Major 1

<?php

/**
 * Entity Annotation
 *
 * Annotations allow you to attach bits of information to entities.
 * Unlike entity metadata, annotation is access controlled and has owners.
 */
class ElggAnnotation extends \ElggExtender {

	/**
	 * {@inheritdoc}
	 */
	protected function initializeAttributes() {
		parent::initializeAttributes();

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

	/**
	 * Constructor
	 *
	 * @param stdClass $row Database row
	 */
	public function __construct(stdClass $row = null) {
		$this->initializeAttributes();

		if ($row) {
			foreach ((array) $row as $key => $value) {
				$this->$key = $value;
			}
		}
	}

	/**
	 * Save this instance and returns an annotation ID
	 *
	 * @return int|bool
	 */
	public function save() {
		if (!isset($this->access_id)) {
			$this->access_id = ACCESS_PRIVATE;
		}

		if (!isset($this->owner_guid)) {
			$this->owner_guid = _elgg_services()->session->getLoggedInUserGuid();
		}

		if ($this->id) {
			return _elgg_services()->annotationsTable->update($this);
		}

		$entity = get_entity($this->entity_guid);
		if (!$entity) {
			return false;
		}

		if (_elgg_services()->annotationsTable->create($this, $entity)) {
			return $this->id;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
		}

		return false;
	}

	/**
	 * Delete the annotation.
	 *
	 * @return bool
	 */
	public function delete() {
		return _elgg_services()->annotationsTable->delete($this);
	}

	/**
	 * Disable the annotation.
	 *
	 * @return bool
	 * @since 1.8
	 */
	public function disable() {
		return _elgg_services()->annotationsTable->disable($this);
	}

	/**
	 * Enable the annotation.
	 *
	 * @return bool
	 * @since 1.8
	 */
	public function enable() {
		return _elgg_services()->annotationsTable->enable($this);
	}

	/**
	 * 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
	 */
	public function canEdit($user_guid = 0) {
		$entity = $this->getEntity();

		return _elgg_services()->userCapabilities->canEditAnnotation($entity, $user_guid, $this);
	}

	/**
	 * {@inheritdoc}
	 */
	public function getObjectFromID($id) {
		return elgg_get_annotation_from_id($id);
	}
}


1			<?php
2
3			/**
4			* Entity Annotation
5			*
6			* Annotations allow you to attach bits of information to entities.
7			* Unlike entity metadata, annotation is access controlled and has owners.
8			*/
9			class ElggAnnotation extends \ElggExtender {
10
11			/**
12			* {@inheritdoc}
13			*/
14			protected function initializeAttributes() {
15			parent::initializeAttributes();
16
17			$this->attributes['type'] = 'annotation';
18			}
19
20			/**
21			* Constructor
22			*
23			* @param stdClass $row Database row
24			*/
25			public function __construct(stdClass $row = null) {
26			$this->initializeAttributes();
27
28			if ($row) {
29			foreach ((array) $row as $key => $value) {
30			$this->$key = $value;
31			}
32			}
33			}
34
35			/**
36			* Save this instance and returns an annotation ID
37			*
38			* @return int\|bool
39			*/
40			public function save() {
41			if (!isset($this->access_id)) {
42			$this->access_id = ACCESS_PRIVATE;
43			}
44
45			if (!isset($this->owner_guid)) {
46			$this->owner_guid = _elgg_services()->session->getLoggedInUserGuid();
47			}
48
49			if ($this->id) {
50			return _elgg_services()->annotationsTable->update($this);
51			}
52
53			$entity = get_entity($this->entity_guid);
54			if (!$entity) {
55			return false;
56			}
57
58			if (_elgg_services()->annotationsTable->create($this, $entity)) {
59			return $this->id;
			0 ignored issues – show Bug Best Practice introduced 2017-11-26 23:18 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `return $this->id` returns the type `integer` which is incompatible with the return type mandated by `ElggData::save()` of `boolean`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
60			}
61
62			return false;
63			}
64
65			/**
66			* Delete the annotation.
67			*
68			* @return bool
69			*/
70			public function delete() {
71			return _elgg_services()->annotationsTable->delete($this);
72			}
73
74			/**
75			* Disable the annotation.
76			*
77			* @return bool
78			* @since 1.8
79			*/
80			public function disable() {
81			return _elgg_services()->annotationsTable->disable($this);
82			}
83
84			/**
85			* Enable the annotation.
86			*
87			* @return bool
88			* @since 1.8
89			*/
90			public function enable() {
91			return _elgg_services()->annotationsTable->enable($this);
92			}
93
94			/**
95			* Determines whether or not the user can edit this annotation
96			*
97			* @param int $user_guid The GUID of the user (defaults to currently logged in user)
98			*
99			* @return bool
100			*/
101			public function canEdit($user_guid = 0) {
102			$entity = $this->getEntity();
103
104			return _elgg_services()->userCapabilities->canEditAnnotation($entity, $user_guid, $this);
105			}
106
107			/**
108			* {@inheritdoc}
109			*/
110			public function getObjectFromID($id) {
111			return elgg_get_annotation_from_id($id);
112			}
113			}
114

Elgg / Elgg

Push — 3.3 ( 5fced4...d53524 )

engine/classes/ElggAnnotation.php (1 issue)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like