FVSPlugin::get_secure_menu_entries() - Code Metrics - Inspection of "Add vim control line" - BurningFlipside/VolunteerSystem - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 44002c...26807d )

by Patrick

created 2020-02-05 18:31 UTC

FVSPlugin::get_secure_menu_entries() A

↳ Parent: FVSPlugin

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	2
nop	2
dl	0
loc	11
rs	9.9
c	0
b	0
f	0

<?php
class FVSPlugin extends SecurePlugin
{
    function get_secure_menu_entries($page, $user)

    {
        $ret = array(
          'Volunteer' => $page->secure_root.'fvs/index.php'
        );
        if($user !== null && $user->isInGroupNamed('VolunteerAdmins'))
        {
            $ret['Volunteer System Admin']=$page->secure_root.'fvs/_admin/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(
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());
}
          'name'=>'Volunteer',
          'link' => 'fvs/index.php'
        );
    }
}


1			<?php
2			class FVSPlugin extends SecurePlugin
3			{
4			function get_secure_menu_entries($page, $user)
			0 ignored issues – show Best Practice introduced 2016-06-15 03:23 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(
7			'Volunteer' => $page->secure_root.'fvs/index.php'
8			);
9			if($user !== null && $user->isInGroupNamed('VolunteerAdmins'))
10			{
11			$ret['Volunteer System Admin']=$page->secure_root.'fvs/_admin/index.php';
12			}
13			return $ret;
			0 ignored issues – show Bug Best Practice introduced 2020-02-04 21:09 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...
14			}
15
16			function get_plugin_entry_point()
			0 ignored issues – show Best Practice introduced 2016-06-15 03:23 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...
17			{
18			return array(
			0 ignored issues – show Bug Best Practice introduced 2017-02-24 00:19 UTC by Report Bug Copy Issue Report The return type of `return array('name' => '...k' => 'fvs/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...
19			'name'=>'Volunteer',
20			'link' => 'fvs/index.php'
21			);
22			}
23			}
24

BurningFlipside / VolunteerSystem

Push — master ( 44002c...26807d )

FVSPlugin::get_secure_menu_entries() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like