Amarkal\UI\Component_composite

Complexity

Total Complexity

25

Size/Duplication

Total Lines	187
Duplicated Lines	15.51 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__set()	0	9	2
A	set_value()	0	8	2
A	default_model()	0	13	1
A	required_arguments()	0	4	1
A	get_template_path()	0	4	1
A	parse_template()	0	7	1
A	get_name()	0	8	2
A	filter()	9	14	4
B	validation()	12	16	5
A	on_created()	0	7	2
A	create_component()	0	16	2
A	get_component()	8	8	2

<?php

namespace Amarkal\UI;

/**
 * Implements a Composite UI component.
 */
class Component_composite
extends AbstractComponent

The extends keyword must be on the same line as the class name

implements ValueComponentInterface, 

The implements keyword must be on the same line as the class name

The first item in a multi-line implements list must be on the line following the implements keyword

           DisableableComponentInterface,

Expected 4 spaces before interface name; 11 found

           FilterableComponentInterface,

Expected 4 spaces before interface name; 11 found

           ValidatableComponentInterface

Expected 4 spaces before interface name; 11 found

{
    /**
     * The list of child components.
     * 
     * @var UI\AbstractComponent[] 
     */
    private $components;
    
    public $component_type = 'composite';
    
    /**
     * The __set magic method is overridden here to apply value changes to 
     * child components.
     */
    public function __set( $name, $value )
    {
        parent::__set($name, $value);
        
        if( 'value' === $name )
        {
            $this->set_value($value);
        }
    }
    
    /**
     * Apply the value to each of the child components.
     * 
     * @param array $value
     */
    public function set_value( array $value )
    {
        foreach($value as $n => $v)
        {
            $component = $this->get_component($n);
            $component->value = $v;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function default_model() 
    {
        return array(
            'name'          => '',
            'parent_name'   => '',
            'id'            => '',
            'disabled'      => false,
            'template'      => null,
            'components'    => array(),
            'filter'        => array($this, 'filter'),
            'validation'    => array($this, 'validation'),
        );
    }
    
    /**
     * {@inheritdoc}
     */
    public function required_arguments()
    {
        return array('name','components','template');
    }
    
    /**
     * {@inheritdoc}
     */
    public function get_template_path() 
    {
        return __DIR__.'/template.phtml';
    }
    
    /**
     * Parse the template by converting the name tokens into UI components.
     * 
     * @return string The parsed template
     */
    public function parse_template()
    {
        return preg_replace_callback('/\{\{([a-zA-Z\d-_]+)\}\}/', function($a){
            $component = $this->get_component($a[1]);
            return $component->render();
        }, $this->model['template']);
    }
    
    /**
     * If this is the root composite component, this will return the component's 
     * name. If this is a child composite component, this will return the
     * component's name as a key in the parent's array, i.e 'parent_name[child_name]'
     * 
     * @return string
     */
    public function get_name()
    {
        if('' !== $this->parent_name)

The property parent_name does not exist on object<Amarkal\UI\Component_composite>. Since you implemented __get, maybe consider adding a @property annotation.

        {
            return "{$this->parent_name}[{$this->name}]";

The property parent_name does not exist on object<Amarkal\UI\Component_composite>. Since you implemented __get, maybe consider adding a @property annotation.

The property name does not exist on object<Amarkal\UI\Component_composite>. Since you implemented __get, maybe consider adding a @property annotation.

        }
        return $this->name;

The property name does not exist on object<Amarkal\UI\Component_composite>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function filter($v)
    {
        foreach($this->components as $component)

This code seems to be duplicated across your project.

        {
            if($component instanceof FilterableComponentInterface &&
               \is_callable($component->filter))
            {
                $n = $component->name;
                $v[$n] = $component->filter($v[$n]);
            }
        }
        
        return $v;
    }

    public function validation($v,&$e)
    {
        foreach($this->components as $component)

This code seems to be duplicated across your project.

        {
            if($component instanceof ValidatableComponentInterface &&
               \is_callable($component->validation))
            {
                $n = $component->name;
                if(!$component->validation($v[$n],$e))
                {
                    return false;
                }
            }
        }
        return true;
    }
    
    /**
     * Instantiate child UI components when created.
     */
    protected function on_created()
    {
        foreach( $this->model['components'] as $args )
        {
            $this->components[$args['name']] = $this->create_component($args);
        }
    }
    
    /**
     * 
     * @param type $args
     * @return type
     */
    private function create_component( $args )
    {
        $type = $args['type'];
        
        if('composite' === $type)
        {
            $args['parent_name'] = $this->get_name();
        }
        
        $c = \Amarkal\UI\ComponentFactory::create( $type, $args );
        
        // Apply the composite name template
        $c->name_template = str_replace('{{parent_name}}', $this->get_name(), $c->composite_name_template);
        
        return $c;
    }
    
    /**
     * Get a child component by name.
     * 
     * @param string $name
     * @return UI\AbstractComponent
     * @throws \RuntimeException If there's no child component corresponding to the given name
     */
    private function get_component( $name )

This method seems to be duplicated in your project.

    {
        if(!array_key_exists($name, $this->components))
        {
            throw new \RuntimeException("Composite sub-component not found with name $name");
        }
        return $this->components[$name];
    }
}