ThemePlugin - Code Metrics - Inspection of "Merge branch 'master' of gitlab.com:BurningFlipsid..." - BurningFlipside/SecureFramework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f480bf...21d5d4 )

by Patrick

created 2017-02-08 20:13 UTC

ThemePlugin A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	13
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	13
rs	10
c	0
b	0
f	0
wmc	2
lcom	0
cbo	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	get_secure_menu_entries()	0	5	1
A	get_plugin_entry_point()	0	4	1

<?php
class ThemePlugin extends SecurePlugin
namespace YourVendor;

class YourClass { }
{
    function get_secure_menu_entries($page, $user)

    {
        $ret = array('Themes'=>$page->secure_root.'themes/index.php');
        return $ret;
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());
}
    }

    function get_plugin_entry_point()

    {
        return array('name'=>'Theme Registration', 'link'=>'themes/index.php');
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			class ThemePlugin extends SecurePlugin
			0 ignored issues – show Coding Style Compatibility introduced 2017-02-08 20:17 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
3			{
4			function get_secure_menu_entries($page, $user)
			0 ignored issues – show Best Practice introduced 2017-02-08 20:17 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
5			{
6			$ret = array('Themes'=>$page->secure_root.'themes/index.php');
7			return $ret;
			0 ignored issues – show Bug Best Practice introduced 2017-02-08 20:17 UTC by Report Bug Copy Issue Report The return type of `return $ret;` (`array<string,string>`) is incompatible with the return type of the parent method `SecurePlugin::get_secure_menu_entries` 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...
8			}
9
10			function get_plugin_entry_point()
			0 ignored issues – show Best Practice introduced 2017-02-08 20:17 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
11			{
12			return array('name'=>'Theme Registration', 'link'=>'themes/index.php');
			0 ignored issues – show Bug Best Practice introduced 2017-02-08 20:17 UTC by Report Bug Copy Issue Report The return type of `return array('name' => '...=> 'themes/index.php');` (`array<string,string>`) is incompatible with the return type of the parent method `SecurePlugin::get_plugin_entry_point` 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...
13			}
14			}
15			?>
			0 ignored issues – show Best Practice introduced 2017-02-08 20:17 UTC by Report Bug Copy Issue Report It is not recommended to use PHP's closing tag `?>` in files other than templates. Using a closing tag in PHP files that only contain PHP code is not recommended as you might accidentally add whitespace after the closing tag which would then be output by PHP. This can cause severe problems, for example headers cannot be sent anymore. A simple precaution is to leave off the closing tag as it is not required, and it also has no negative effects whatsoever. Loading history...
16

BurningFlipside / SecureFramework

Push — master ( f480bf...21d5d4 )

ThemePlugin A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like