CFormButtonElement

Property Details

coreTypes property

public static array $coreTypes;

Core button types (alias=>CHtml method name)

label property

public string $label;

the label of this button. This property is ignored when a widget is used to generate the button.

name property

public string $name;

name of this button

on property

public string getOn()
public void setOn(string $value)

Returns a value indicating under which scenarios this button is visible. If the value is empty, it means the button is visible under all scenarios. Otherwise, only when the model is in the scenario whose name can be found in this value, will the button be visible. See CModel::scenario for more information about model scenarios.

type property

public string $type;

the type of this button. This can be a class name, a path alias of a class name, or a button type alias (submit, button, image, reset, link, htmlButton, htmlSubmit, htmlReset).

Method Details

evaluateVisible() method

protected boolean evaluateVisible()

protected function evaluateVisible()
{
    return empty($this->_on) || in_array($this->getParent()->getModel()->getScenario(),$this->_on);
}

Evaluates the visibility of this element. This method will check the on property to see if the model is in a scenario that should have this string displayed.

getOn() method

public string getOn()

public function getOn()
{
    return $this->_on;
}

Returns a value indicating under which scenarios this button is visible. If the value is empty, it means the button is visible under all scenarios. Otherwise, only when the model is in the scenario whose name can be found in this value, will the button be visible. See CModel::scenario for more information about model scenarios.

render() method

public string render()

public function render()
{
    $attributes=$this->attributes;
    if(isset(self::$coreTypes[$this->type]))
    {
        $method=self::$coreTypes[$this->type];
        if($method==='linkButton')
        {
            if(!isset($attributes['params'][$this->name]))
                $attributes['params'][$this->name]=1;
        }
        elseif($method==='htmlButton')
        {
            $attributes['type']=$this->type==='htmlSubmit' ? 'submit' : ($this->type==='htmlReset' ? 'reset' : 'button');
            $attributes['name']=$this->name;
        }
        else
            $attributes['name']=$this->name;
        if($method==='imageButton')
            return CHtml::imageButton(isset($attributes['src']) ? $attributes['src'] : '',$attributes);
        else
            return CHtml::$method($this->label,$attributes);
    }
    else
    {
        $attributes['name']=$this->name;
        ob_start();
        $this->getParent()->getOwner()->widget($this->type, $attributes);
        return ob_get_clean();
    }
}

Returns this button.

setOn() method

public void setOn(string $value)

public function setOn($value)
{
    $this->_on=preg_split('/[\s,]+/',$value,-1,PREG_SPLIT_NO_EMPTY);
}