ComponentFactory::create() - Code Metrics - Inspection of "Added a Form class and component interfaces" - amarkal/amarkal-ui - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7a8290...bcd23f )

by Askupa

created 2017-04-05 13:43 UTC

ComponentFactory::create() A

↳ Parent: ComponentFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	2
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0

<?php

namespace Amarkal\UI;

/**
 * Implements a factory for UI component objects. Can be used to register and 
 * create components.
 */
class ComponentFactory
{   

    /**
     * @var array A list of user-registered custom components
     */
    private static $registered_components = array();
    
    /**
     * Create a UI component instance.
     * 
     * @param string $type
     * @param array $props
     * @return AbstractComponent
     */
    public static function create( $type, array $props )
    {
        try {
            $component = self::create_registered_component($type, $props);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } catch (\RuntimeException $ex) {
            $component = self::create_core_component($type, $props);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        
        return $component;
    }
    
    /**
     * 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 static function register( $type, $class_name )

    {
        if( !in_array($type, self::$registered_components) )
        {
            self::$registered_components[$type] = $class_name;
        }
        else throw new \RuntimeException("A component of type '$type' has already been registered.");
    }
    
    /**
     * 
     * @param type $type
     * @param type $props
     * @throws \RuntimeException
     */
    private static 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 static function create_registered_component( $type, $props )

    {
        if(in_array($type, self::$registered_components))
        {
            $class_name = self::$registered_components[$type];
            return new $class_name($props);
        }
        
        throw new \RuntimeException("A component of type '$type' has not been registered.");
    }
    
    /**
     * Private constructor to prevent instantiation
     */
    private function __construct() {}
}

1		<?php
2
3		namespace Amarkal\UI;
4
5		/**
6		* Implements a factory for UI component objects. Can be used to register and
7		* create components.
8		*/
9		class ComponentFactory
10		{
		0 ignored issues – show Coding Style introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report The opening class brace should be on a newline by itself. Loading history...
11		/**
12		* @var array A list of user-registered custom components
13		*/
14		private static $registered_components = array();
15
16		/**
17		* Create a UI component instance.
18		*
19		* @param string $type
20		* @param array $props
21		* @return AbstractComponent
22		*/
23		public static function create( $type, array $props )
24		{
25		try {
26		$component = self::create_registered_component($type, $props);
		0 ignored issues – show Documentation introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report `$type` is of type `string`, 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... Documentation introduced 2017-04-05 13:47 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...
27		} catch (\RuntimeException $ex) {
28		$component = self::create_core_component($type, $props);
		0 ignored issues – show Documentation introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report `$type` is of type `string`, 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... Documentation introduced 2017-04-05 13:47 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...
29		}
30
31		return $component;
32		}
33
34		/**
35		* Register a custom component class. If the given component name is similar
36		* to the name of one of the core components, it will override it. If a
37		* custom component with a similar name has already been registered, an
38		* exception will be thrown.
39		*
40		* @param string $type
41		* @param string $class_name
42		* @throws \RuntimeException
43		*/
44	View Code Duplication	public static function register( $type, $class_name )
		0 ignored issues – show Duplication introduced 2017-04-05 13:47 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...
45		{
46		if( !in_array($type, self::$registered_components) )
47		{
48		self::$registered_components[$type] = $class_name;
49		}
50		else throw new \RuntimeException("A component of type '$type' has already been registered.");
51		}
52
53		/**
54		*
55		* @param type $type
56		* @param type $props
57		* @throws \RuntimeException
58		*/
59		private static function create_core_component( $type, $props )
60		{
61		$file_name = __DIR__."/components/$type/controller.php";
62		$class_name = 'Amarkal\\UI\\Component_'.$type;
63
64		// Load one of the core components
65		if(!class_exists($class_name))
66		{
67		if( file_exists( $file_name ) )
68		{
69		require_once $file_name;
70		}
71		else
72		{
73		throw new \RuntimeException("A component of type '$type' does not exist.");
74		}
75		}
76
77		return new $class_name($props);
78		}
79
80		/**
81		*
82		* @param type $type
83		* @param type $props
84		* @throws \RuntimeException
85		*/
86	View Code Duplication	private static function create_registered_component( $type, $props )
		0 ignored issues – show Duplication introduced 2017-04-05 13:47 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...
87		{
88		if(in_array($type, self::$registered_components))
89		{
90		$class_name = self::$registered_components[$type];
91		return new $class_name($props);
92		}
93
94		throw new \RuntimeException("A component of type '$type' has not been registered.");
95		}
96
97		/**
98		* Private constructor to prevent instantiation
99		*/
100		private function __construct() {}
101		}

amarkal / amarkal-ui

Push — master ( 7a8290...bcd23f )

ComponentFactory::create() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like