AbstractPIMObject::hasPermission() - Code Metrics - owncloud/contacts - Measure and Improve Code Quality continuously with Scrutinizer

AbstractPIMObject::hasPermission() A
last analyzed 2016-02-29 12:21 UTC

↳ Parent: AbstractPIMObject

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Metric	Value
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php
/**
 * ownCloud - Interface for PIM object
 *
 * @author Thomas Tanghus
 * @copyright 2012-2014 Thomas Tanghus ([email protected])
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\Contacts;

/**
 * Subclass this class or implement IPIMObject interface for PIM objects.
 */

abstract class AbstractPIMObject implements IPIMObject {

	/**
	 * If this object is part of a collection return a reference
	 * to the parent object, otherwise return null.
	 * @return IPIMObject|null
	 */
	public function getParent() {
	}

	/**
	 * @param integer $permission
	 * @return integer
	 */
	public function hasPermission($permission) {
		return $this->getPermissions() & $permission;
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		* ownCloud - Interface for PIM object
4		*
5		* @author Thomas Tanghus
6		* @copyright 2012-2014 Thomas Tanghus ([email protected])
7		*
8		* This library is free software; you can redistribute it and/or
9		* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
10		* License as published by the Free Software Foundation; either
11		* version 3 of the License, or any later version.
12		*
13		* This library is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16		* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
17		*
18		* You should have received a copy of the GNU Affero General Public
19		* License along with this library. If not, see <http://www.gnu.org/licenses/>.
20		*
21		*/
22
23		namespace OCA\Contacts;
24
25		/**
26		* Subclass this class or implement IPIMObject interface for PIM objects.
27		*/
28
29		abstract class AbstractPIMObject implements IPIMObject {
30
31		/**
32		* If this object is part of a collection return a reference
33		* to the parent object, otherwise return null.
34		* @return IPIMObject\|null
35		*/
36		public function getParent() {
37		}
38
39		/**
40		* @param integer $permission
41		* @return integer
42		*/
43	11	public function hasPermission($permission) {
44	11	return $this->getPermissions() & $permission;
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report The return type of `return $this->getPermissions() & $permission;` (`integer`) is incompatible with the return type declared by the interface `OCA\Contacts\IPIMObject::hasPermission` 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...
45		}
46
47		}

owncloud / contacts

AbstractPIMObject::hasPermission() A last analyzed 2016-02-29 12:21 UTC

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like

AbstractPIMObject::hasPermission() A
last analyzed 2016-02-29 12:21 UTC