CFormElement

Property Details

attributes property

public array $attributes;

list of attributes (name=>value) for the HTML element represented by this object.

parent property read-only

public mixed getParent()

the direct parent of this element. This could be either a CForm object or a CBaseController object (a controller or a widget).

visible property

public boolean getVisible()
public void setVisible(boolean $value)

Returns a value indicating whether this element is visible and should be rendered. This method will call evaluateVisible to determine the visibility of this element.

Method Details

__construct() method

public void __construct(mixed $config, mixed $parent)

public function __construct($config,$parent)
{
    $this->configure($config);
    $this->_parent=$parent;
}

Constructor.

__get() method

public mixed __get(string $name)

public function __get($name)
{
    $getter='get'.$name;
    if(method_exists($this,$getter))
        return $this->$getter();
    elseif(isset($this->attributes[$name]))
        return $this->attributes[$name];
    else
        throw new CException(Yii::t('yii','Property "{class}.{property}" is not defined.',
            array('{class}'=>get_class($this), '{property}'=>$name)));
}

Returns a property value or an attribute value. Do not call this method. This is a PHP magic method that we override to allow using the following syntax to read a property or attribute:

$value=$element->propertyName;
$value=$element->attributeName;

__isset() method

public boolean __isset(string $name)

public function __isset($name)
{
    $getter='get'.$name;
    if(method_exists($this,$getter))
        return $this->$getter()!==null;
    elseif(isset($this->attributes[$name]))
        return isset($this->attributes[$name]);
    else
        return false;
}

Checks a property value or an attribute value on existence or not null Do not call this method. This is a PHP magic method that we override to allow using the following syntax to read a property or attribute:

isset($element->propertyName);

__set() method

public void __set(string $name, mixed $value)

public function __set($name,$value)
{
    $setter='set'.$name;
    if(method_exists($this,$setter))
        $this->$setter($value);
    else
        $this->attributes[$name]=$value;
}

Sets value of a property or attribute. Do not call this method. This is a PHP magic method that we override to allow using the following syntax to set a property or attribute.

$this->propertyName=$value;
$this->attributeName=$value;

__toString() method

public string __toString()

public function __toString()
{
    return $this->render();
}

Converts the object to a string. This is a PHP magic method. The default implementation simply calls render and return the rendering result.

configure() method

public void configure(mixed $config)

public function configure($config)
{
    if(is_string($config))
        $config=require(Yii::getPathOfAlias($config).'.php');
    if(is_array($config))
    {
        foreach($config as $name=>$value)
            $this->$name=$value;
    }
}

Configures this object with property initial values.

evaluateVisible() method

protected boolean evaluateVisible()

protected function evaluateVisible()
{
    return true;
}

Evaluates the visibility of this element. Child classes should override this method to implement the actual algorithm for determining the visibility.

getParent() method

public mixed getParent()

public function getParent()
{
    return $this->_parent;
}

getVisible() method

public boolean getVisible()

public function getVisible()
{
    if($this->_visible===null)
        $this->_visible=$this->evaluateVisible();
    return $this->_visible;
}

Returns a value indicating whether this element is visible and should be rendered. This method will call evaluateVisible to determine the visibility of this element.

render() method

abstract public string render()

abstract function render();

Renders this element.

setVisible() method

public void setVisible(boolean $value)

public function setVisible($value)
{
    $this->_visible=$value;
}