AbstractComponent::required_arguments() - 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

AbstractComponent::required_arguments() A

↳ Parent: AbstractComponent

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Amarkal\UI;

/**
 * Defines an abstract UI component
 */
abstract class AbstractComponent
extends AbstractController

{
    /**
     * Constructor
     * 
     * @param array $model
     */
    public function __construct( array $model = array() ) 
    {
        parent::__construct($model);
        $this->on_created();
    }
    
    /**
     * The default model to use when none is provided to the constructor.
     * This method should be overriden by child class to define the default
     * model.
     * 
     * @return array
     */
    public function default_model()
    {
        return array();
    }
    
    /**
     * The list of required model arguments.
     * This method should be overriden by child class to specify required model
     * arguments.
     * 
     * @return array
     */
    public function required_arguments()
    {
        return array();
    }
    
    /**
     * Set the model data for this component.
     * 
     * @return array
     */
    public function set_model( $model )
    {
        // Check that the required arguments are provided.
        foreach( $this->required_arguments() as $key )
        {
            if ( !isset($model[$key]) )
            {
                throw new \RuntimeException('The required argument "'.$key.'" was not provided for '.get_called_class());
            }
        }
        
        // Assign the name of the component as the id if no id was specified
        if( !isset($model['id']) )
        {
            $model['id'] = $model['name'];
        }
        
        $this->model = array_merge( $this->default_model(), $model );
    }
    
    /**
     * A hook that is called once the component has been created.
     */
    protected function on_created() {}
}

1			<?php
2
3			namespace Amarkal\UI;
4
5			/**
6			* Defines an abstract UI component
7			*/
8			abstract class AbstractComponent
9			extends AbstractController
			0 ignored issues – show Coding Style introduced 2017-03-23 21:00 UTC by Report Bug Copy Issue Report The extends keyword must be on the same line as the class name Loading history...
10			{
11			/**
12			* Constructor
13			*
14			* @param array $model
15			*/
16			public function __construct( array $model = array() )
17			{
18			parent::__construct($model);
19			$this->on_created();
20			}
21
22			/**
23			* The default model to use when none is provided to the constructor.
24			* This method should be overriden by child class to define the default
25			* model.
26			*
27			* @return array
28			*/
29			public function default_model()
30			{
31			return array();
32			}
33
34			/**
35			* The list of required model arguments.
36			* This method should be overriden by child class to specify required model
37			* arguments.
38			*
39			* @return array
40			*/
41			public function required_arguments()
42			{
43			return array();
44			}
45
46			/**
47			* Set the model data for this component.
48			*
49			* @return array
50			*/
51			public function set_model( $model )
52			{
53			// Check that the required arguments are provided.
54			foreach( $this->required_arguments() as $key )
55			{
56			if ( !isset($model[$key]) )
57			{
58			throw new \RuntimeException('The required argument "'.$key.'" was not provided for '.get_called_class());
59			}
60			}
61
62			// Assign the name of the component as the id if no id was specified
63			if( !isset($model['id']) )
64			{
65			$model['id'] = $model['name'];
66			}
67
68			$this->model = array_merge( $this->default_model(), $model );
69			}
70
71			/**
72			* A hook that is called once the component has been created.
73			*/
74			protected function on_created() {}
75			}

amarkal / amarkal-ui

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

AbstractComponent::required_arguments() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like