Aura\Input\AbstractInput

Complexity

Total Complexity

6

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	read()	0	3	1
A	get()	0	3	1
A	getFullName()	0	7	2
A	setNamePrefix()	0	4	1
A	setName()	0	4	1

<?php
/**
 * 
 * This file is part of the Aura project for PHP.
 * 
 * @package Aura.Input
 * 
 * @license http://opensource.org/licenses/MIT-license.php MIT
 * 
 */
namespace Aura\Input;

/**
 * 
 * An abstract input class; serves as the base for Fields, Fieldsets, and
 * Collections.
 * 
 * @package Aura.Input
 * 
 */
abstract class AbstractInput
{
    /**
     * 
     * The name for the input.
     * 
     * @var string
     * 
     */
    protected $name;
    
    /**
     * 
     * The prefix for the name, typically composed of the parent input names.
     * 
     * @var string
     * 
     */
    protected $name_prefix;
    
    /**
     * 
     * Sets the name for the input.
     * 
     * @param string $name The input name.
     * 
     * @return self
     * 
     */
    public function setName($name)
    {
        $this->name = $name;
        return $this;
    }
    
    /**
     * 
     * Sets the name prefix for the input, typically composed of the parent
     * input names.
     * 
     * @param string $name_prefix The name prefix.
     * 
     * @return self
     * 
     */
    public function setNamePrefix($name_prefix)
    {
        $this->name_prefix = $name_prefix;
        return $this;
    }
    
    /**
     * 
     * Returns the full name for this input, incuding the prefix (if any).
     * 
     * @return string
     * 
     */
    public function getFullName()
    {
        $name = $this->name;
        if ($this->name_prefix) {
            $name = $this->name_prefix . "[{$name}]";
        }
        return $name;
    }
    
    /**
     * 
     * Support for this input when addressed via Fieldset::__get().
     * 
     * @return self
     * 
     */
    public function read()
    {
        return $this;
    }
    
    /**
     * 
     * Returns this input for the presentation layer.
     * 
     * @return self
     * 
     */
    public function get()
    {
        return $this;
    }
    
    /**
     * 
     * Returns the value of this input for use in arrays.
     * 
     * @return mixed
     * 
     */
    abstract public function getValue();
}