Manager   A
last analyzed

Complexity

Total Complexity 9

Size/Duplication

Total Lines 89
Duplicated Lines 0 %

Coupling/Cohesion

Components 2
Dependencies 3

Importance

Changes 0
Metric Value
dl 0
loc 89
rs 10
c 0
b 0
f 0
wmc 9
lcom 2
cbo 3

6 Methods

Rating   Name   Duplication   Size   Complexity  
A get_instance() 0 8 2
A add_settings_page() 0 11 2
A get_settings_page() 0 8 2
A register_scripts() 0 5 1
A __construct() 0 4 1
A init() 0 7 1
1
<?php
2
3
namespace Amarkal\Settings;
4
5
class Manager
6
{
7
    /**
8
     * @var Singleton The reference to *Singleton* instance of this class
9
     */
10
    private static $instance;
11
        
12
    /**
13
     * @var array The list of registered settings pages
14
     */
15
    private $settings_pages = array();
16
    
17
    /**
18
     * Returns the *Singleton* instance of this class.
19
     *
20
     * @return Singleton The *Singleton* instance.
21
     */
22
    public static function get_instance()
23
    {
24
        if( null === static::$instance ) 
0 ignored issues
show
Bug introduced by
Since $instance is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $instance to at least protected.

Let’s assume you have a class which uses late-static binding:

class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the getSomeVariable() on that sub-class, you will receive a runtime error:

class YourSubClass extends YourClass { }

YourSubClass::getSomeVariable(); // Will cause an access error.

In the case above, it makes sense to update SomeClass to use self instead:

class SomeClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return self::$someVariable; // self works fine with private.
    }
}
Loading history...
25
        {
26
            static::$instance = new static();
0 ignored issues
show
Bug introduced by
Since $instance is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $instance to at least protected.

Let’s assume you have a class which uses late-static binding:

class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the getSomeVariable() on that sub-class, you will receive a runtime error:

class YourSubClass extends YourClass { }

YourSubClass::getSomeVariable(); // Will cause an access error.

In the case above, it makes sense to update SomeClass to use self instead:

class SomeClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return self::$someVariable; // self works fine with private.
    }
}
Loading history...
Documentation Bug introduced by
It seems like new static() of type this<Amarkal\Settings\Manager> is incompatible with the declared type object<Amarkal\Settings\Singleton> of property $instance.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
27
        }
28
        return static::$instance;
0 ignored issues
show
Bug introduced by
Since $instance is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $instance to at least protected.

Let’s assume you have a class which uses late-static binding:

class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the getSomeVariable() on that sub-class, you will receive a runtime error:

class YourSubClass extends YourClass { }

YourSubClass::getSomeVariable(); // Will cause an access error.

In the case above, it makes sense to update SomeClass to use self instead:

class SomeClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return self::$someVariable; // self works fine with private.
    }
}
Loading history...
Bug Compatibility introduced by
The expression static::$instance; of type Amarkal\Settings\Manager...rkal\Settings\Singleton adds the type Amarkal\Settings\Manager to the return on line 28 which is incompatible with the return type documented by Amarkal\Settings\Manager::get_instance of type Amarkal\Settings\Singleton.
Loading history...
29
    }
30
    
31
    /**
32
     * Add a page to the admin menu.
33
     * 
34
     * @param array $args
35
     * @throws \RuntimeException
36
     */
37
    public function add_settings_page( $args )
38
    {
39
        $slug = $args['slug'];
40
        if(array_key_exists($slug,$this->settings_pages))
41
        {
42
            throw new \RuntimeException("A settings page with slug '$slug' has already been registered");
43
        }
44
        $page = new SettingsPage($args);
45
        $this->settings_pages[$slug] = $page;
46
        return $page;
47
    }
48
    
49
    /**
50
     * Get a settings page from the list of registered settings pages.
51
     * 
52
     * @param string $slug
53
     * @param string $parent_slug
0 ignored issues
show
Bug introduced by
There is no parameter named $parent_slug. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
54
     * @return SettingsPage
55
     * @throws \RuntimeException If no settings page was found for the given slug/parent_slug
56
     */
57
    public function get_settings_page( $slug )
58
    {
59
        if(!array_key_exists($slug, $this->settings_pages))
60
        {
61
            throw new \RuntimeException("The settings page '$slug' does not exist");
62
        }
63
        return $this->settings_pages[$slug];
64
    }
65
    
66
    /**
67
     * Register styles & scripts to be enqueued by settings pages
68
     */
69
    public function register_scripts()
70
    {
71
        \wp_register_style('amarkal-settings', \Amarkal\Core\Utility::path_to_url(__DIR__.'/assets/css/dist/amarkal-settings.min.css'));
72
        \wp_register_script('amarkal-settings',\Amarkal\Core\Utility::path_to_url(__DIR__.'/assets/js/dist/amarkal-settings.min.js'),array('amarkal-ui'));
73
    }
74
    
75
    /**
76
     * Private constructor to prevent instantiation
77
     */
78
    private function __construct() 
79
    {
80
        $this->init();
81
    }
82
    
83
    /**
84
     * Register scripts and initiate the request handler.
85
     */
86
    private function init()
87
    {
88
        \add_action('admin_init',array($this,'register_scripts'));
89
        
90
        $rh = RequestHandler::get_instance();
91
        $rh->init();
92
    }
93
}