Manager - Code Metrics - Inspection of "Added support for sections" - amarkal/amarkal-settings - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bc1ad9...b87221 )

by Askupa

created 2017-08-18 16:10 UTC

Manager A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes

Metric	Value
dl	0
loc	106
rs	10
c	0
b	0
f	0
wmc	10
lcom	2
cbo	3

7 Methods

Rating	Name	Size	Complexity
A	get_instance()	8	2
A	add_settings_page()	11	2
A	get_settings_page()	8	2
A	get_field_value()	8	1
A	register_scripts()	5	1
A	__construct()	4	1
A	init()	7	1

<?php

namespace Amarkal\Settings;

class Manager
{
    /**
     * @var Singleton The reference to *Singleton* instance of this class
     */
    private static $instance;
        
    /**
     * @var array The list of registered settings pages
     */
    private $settings_pages = array();
    
    /**
     * Returns the *Singleton* instance of this class.
     *
     * @return Singleton The *Singleton* instance.
     */
    public static function get_instance()
    {
        if( null === static::$instance ) 
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
        {
            static::$instance = new static();
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
        }
        return static::$instance;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
    }
    
    /**
     * Add a page to the admin menu.
     * 
     * @param array $args
     * @throws \RuntimeException
     */
    public function add_settings_page( $args )
    {
        $slug = $args['slug'];
        if(array_key_exists($slug,$this->settings_pages))
        {
            throw new \RuntimeException("A settings page with slug '$slug' has already been registered");
        }
        $page = new SettingsPage($args);
        $this->settings_pages[$slug] = $page;
        return $page;
    }
    
    /**
     * Get a settings page from the list of registered settings pages.
     * 
     * @param string $slug
     * @param string $parent_slug
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return SettingsPage
     * @throws \RuntimeException If no settings page was found for the given slug/parent_slug
     */
    public function get_settings_page( $slug )
    {
        if(!array_key_exists($slug, $this->settings_pages))
        {
            throw new \RuntimeException("The settings page '$slug' does not exist");
        }
        return $this->settings_pages[$slug];
    }

    /**
     * Get the value of a field within a given settings page.
     *
     * @param [string] $slug

     * @param [string] $field_name

     * @throws RuntimeException if no field was found with the given name
     * @return mixed
     */
    public function get_field_value($slug, $field_name)
    {
        $sp = $this->settings_pages[$slug];
        
        $component = $sp->get_component($field_name);
        $value = \get_option($field_name, $component->default);
        return $value;
    }
    
    /**
     * Register styles & scripts to be enqueued by settings pages
     */
    public function register_scripts()
    {
        \wp_register_style('amarkal-settings', \Amarkal\Core\Utility::path_to_url(__DIR__.'/assets/css/dist/amarkal-settings.min.css'));
        \wp_register_script('amarkal-settings',\Amarkal\Core\Utility::path_to_url(__DIR__.'/assets/js/dist/amarkal-settings.min.js'),array('amarkal-ui'));
    }
    
    /**
     * Private constructor to prevent instantiation
     */
    private function __construct() 
    {
        $this->init();
    }
    
    /**
     * Register scripts and initiate the request handler.
     */
    private function init()
    {
        \add_action('admin_init',array($this,'register_scripts'));
        
        $rh = RequestHandler::get_instance();
        $rh->init();
    }
}

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 2017-05-01 19:09 UTC by Report Bug Copy Issue Report 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 2017-05-01 19:09 UTC by Report Bug Copy Issue Report 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 2017-04-17 00:18 UTC by Report Bug Copy Issue Report 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 2017-05-01 19:09 UTC by Report Bug Copy Issue Report 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 2017-05-01 19:09 UTC by Report Bug Copy Issue Report 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 2017-08-18 16:12 UTC by Report Bug Copy Issue Report 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			* Get the value of a field within a given settings page.
68			*
69			* @param [string] $slug
			0 ignored issues – show Documentation introduced 2017-08-18 16:12 UTC by Report Bug Copy Issue Report The doc-type `[string]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
70			* @param [string] $field_name
			0 ignored issues – show Documentation introduced 2017-07-16 17:05 UTC by Report Bug Copy Issue Report The doc-type `[string]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
71			* @throws RuntimeException if no field was found with the given name
72			* @return mixed
73			*/
74			public function get_field_value($slug, $field_name)
75			{
76			$sp = $this->settings_pages[$slug];
77
78			$component = $sp->get_component($field_name);
79			$value = \get_option($field_name, $component->default);
80			return $value;
81			}
82
83			/**
84			* Register styles & scripts to be enqueued by settings pages
85			*/
86			public function register_scripts()
87			{
88			\wp_register_style('amarkal-settings', \Amarkal\Core\Utility::path_to_url(__DIR__.'/assets/css/dist/amarkal-settings.min.css'));
89			\wp_register_script('amarkal-settings',\Amarkal\Core\Utility::path_to_url(__DIR__.'/assets/js/dist/amarkal-settings.min.js'),array('amarkal-ui'));
90			}
91
92			/**
93			* Private constructor to prevent instantiation
94			*/
95			private function __construct()
96			{
97			$this->init();
98			}
99
100			/**
101			* Register scripts and initiate the request handler.
102			*/
103			private function init()
104			{
105			\add_action('admin_init',array($this,'register_scripts'));
106
107			$rh = RequestHandler::get_instance();
108			$rh->init();
109			}
110			}

amarkal / amarkal-settings

Push — master ( bc1ad9...b87221 )

Manager A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Duplication Side-by-Side

Filter issues like