CContentDecorator

$this->beginContent('path/to/view');
// ... content to be decorated
$this->endContent();

Property Details

data property

public array $data;

the variables (name=>value) to be extracted and made available in the decorative view.

view property

public mixed $view;

the name of the view that will be used to decorate the captured content. If this property is null (default value), the default layout will be used as the decorative view. Note that if the current controller does not belong to any module, the default layout refers to the application's default layout; If the controller belongs to a module, the default layout refers to the module's default layout.

Method Details

decorate() method

protected string decorate(string $content)

protected function decorate($content)
{
    $owner=$this->getOwner();
    if($this->view===null)
        $viewFile=Yii::app()->getController()->getLayoutFile(null);
    else
        $viewFile=$owner->getViewFile($this->view);
    if($viewFile!==false)
    {
        $data=$this->data;
        $data['content']=$content;
        return $owner->renderFile($viewFile,$data,true);
    }
    else
        return $content;
}

Decorates the content by rendering a view and embedding the content in it. The content being embedded can be accessed in the view using variable $content The decorated content will be displayed directly.

processOutput() method

public void processOutput(string $output)

public function processOutput($output)
{
    $output=$this->decorate($output);
    parent::processOutput($output);
}

Processes the captured output. This method decorates the output with the specified view.