Renderer::create_core_component() - Code Metrics - Inspection of "Changed function names to reflect changes to amark..." - amarkal/amarkal-ui - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2212b7...5b826e )

by Askupa

created 2017-03-23 20:59 UTC

Renderer::create_core_component() A

↳ Parent: Renderer

Complexity

Conditions	3
Paths	3

Size

Total Lines	20
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	9
nc	3
nop	2
dl	0
loc	20
rs	9.4285
c	0
b	0
f	0

<?php

namespace Amarkal\UI;

class Renderer
{
    /**
     * @var Singleton The reference to *Singleton* instance of this class
     */
    private static $instance;
    
    private $registered_components = 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;
    }
}
    }

    public function render_component( $type, array $props = array() )
    {
        $component = $this->create_component( $type, $props );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        return $component->render();
    }

    
    /**
     * Register a custom component class. If the given component name is similar
     * to the name of one of the core components, it will override it. If a 
     * custom component with a similar name has already been registered, an 
     * exception will be thrown.
     * 
     * @param string $type
     * @param string $class_name
     * @throws \RuntimeException
     */
    public function register_component( $type, $class_name )

    {
        if( !in_array($type, $this->registered_components) )
        {
            $this->registered_components[$type] = $class_name;
        }
        else throw new \RuntimeException("A component of type '$type' has already been registered.");
    }
    
    /**
     * 
     * @param type $type
     * @param type $props
     * @return type
     */
    private function create_component( $type, $props )
    {
        try {
            $component = $this->create_registered_component ($type, $props );
        } catch (\RuntimeException $ex) {
            $component = $this->create_core_component ($type, $props );
        }
        
        return $component;
    }
    
    /**
     * 
     * @param type $type
     * @param type $props
     * @throws \RuntimeException
     */
    private function create_core_component( $type, $props )
    {
        $file_name  = __DIR__."/components/$type/controller.php";
        $class_name = 'Amarkal\\UI\\Component_'.$type;
        
        // Load one of the core components
        if(!class_exists($class_name))
        {
            if( file_exists( $file_name ) ) 
            {
                require_once $file_name;
            }
            else 
            {
                throw new \RuntimeException("A component of type '$type' does not exist.");
            }
        }
        
        return new $class_name($props);
    }
    
    /**
     * 
     * @param type $type
     * @param type $props
     * @throws \RuntimeException
     */
    private function create_registered_component( $type, $props )

    {
        if(in_array($type, $this->registered_components))
        {
            $class_name = $this->registered_components[$type];
            return new $class_name($props);
        }
        
        throw new \RuntimeException("A component of type '$type' has not been registered.");
    }
}

1		<?php
2
3		namespace Amarkal\UI;
4
5		class Renderer
6		{
7		/**
8		* @var Singleton The reference to Singleton instance of this class
9		*/
10		private static $instance;
11
12		private $registered_components = array();
13
14		/**
15		* Returns the Singleton instance of this class.
16		*
17		* @return Singleton The Singleton instance.
18		*/
19		public static function get_instance()
20		{
21		if( null === static::$instance )
		0 ignored issues – show Bug introduced 2017-03-21 17:41 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...
22		{
23		static::$instance = new static();
		0 ignored issues – show Bug introduced 2017-03-21 17:41 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-03-21 17:41 UTC by Report Bug Copy Issue Report It seems like `new static()` of type `this<Amarkal\UI\Renderer>` is incompatible with the declared type `object<Amarkal\UI\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...
24		}
25		return static::$instance;
		0 ignored issues – show Bug introduced 2017-03-21 17:41 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-03-21 17:41 UTC by Report Bug Copy Issue Report The expression `static::$instance;` of type `Amarkal\UI\Renderer\|Amarkal\UI\Singleton` adds the type `Amarkal\UI\Renderer` to the return on line 25 which is incompatible with the return type documented by `Amarkal\UI\Renderer::get_instance` of type `Amarkal\UI\Singleton`. Loading history...
26		}
27
28		public function render_component( $type, array $props = array() )
29		{
30		$component = $this->create_component( $type, $props );
		0 ignored issues – show Documentation introduced 2017-03-21 17:41 UTC by Report Bug Copy Issue Report `$props` is of type `array`, but the function expects a `object<Amarkal\UI\type>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
31		return $component->render();
32		}
33
34
35		/**
36		* Register a custom component class. If the given component name is similar
37		* to the name of one of the core components, it will override it. If a
38		* custom component with a similar name has already been registered, an
39		* exception will be thrown.
40		*
41		* @param string $type
42		* @param string $class_name
43		* @throws \RuntimeException
44		*/
45	View Code Duplication	public function register_component( $type, $class_name )
		0 ignored issues – show Duplication introduced 2017-03-21 17:41 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
46		{
47		if( !in_array($type, $this->registered_components) )
48		{
49		$this->registered_components[$type] = $class_name;
50		}
51		else throw new \RuntimeException("A component of type '$type' has already been registered.");
52		}
53
54		/**
55		*
56		* @param type $type
57		* @param type $props
58		* @return type
59		*/
60		private function create_component( $type, $props )
61		{
62		try {
63		$component = $this->create_registered_component ($type, $props );
64		} catch (\RuntimeException $ex) {
65		$component = $this->create_core_component ($type, $props );
66		}
67
68		return $component;
69		}
70
71		/**
72		*
73		* @param type $type
74		* @param type $props
75		* @throws \RuntimeException
76		*/
77		private function create_core_component( $type, $props )
78		{
79		$file_name = __DIR__."/components/$type/controller.php";
80		$class_name = 'Amarkal\\UI\\Component_'.$type;
81
82		// Load one of the core components
83		if(!class_exists($class_name))
84		{
85		if( file_exists( $file_name ) )
86		{
87		require_once $file_name;
88		}
89		else
90		{
91		throw new \RuntimeException("A component of type '$type' does not exist.");
92		}
93		}
94
95		return new $class_name($props);
96		}
97
98		/**
99		*
100		* @param type $type
101		* @param type $props
102		* @throws \RuntimeException
103		*/
104	View Code Duplication	private function create_registered_component( $type, $props )
		0 ignored issues – show Duplication introduced 2017-03-21 17:41 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
105		{
106		if(in_array($type, $this->registered_components))
107		{
108		$class_name = $this->registered_components[$type];
109		return new $class_name($props);
110		}
111
112		throw new \RuntimeException("A component of type '$type' has not been registered.");
113		}
114		}

amarkal / amarkal-ui

Push — master ( 2212b7...5b826e )

Renderer::create_core_component() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like