CFormStringElement

Property Details

content property

public string $content;

the string content

on property

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

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

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 string is visible. If the value is empty, it means the string is visible under all scenarios. Otherwise, only when the model is in the scenario whose name can be found in this value, will the string be visible. See CModel::scenario for more information about model scenarios.

render() method

public string render()

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

Renders this element. The default implementation simply returns content.

setOn() method

public void setOn(string $value)

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