CPortlet

<?php $this->beginWidget('zii.widgets.CPortlet'); ?>
    ...insert content here...
<?php $this->endWidget(); ?>

Property Details

contentCssClass property

public string $contentCssClass;

the CSS class for the content container tag. Defaults to 'portlet-content'.

decorationCssClass property

public string $decorationCssClass;

the CSS class for the decoration container tag. Defaults to 'portlet-decoration'.

hideOnEmpty property (available since v1.1.4)

public boolean $hideOnEmpty;

whether to hide the portlet when the body content is empty. Defaults to true.

htmlOptions property

public array $htmlOptions;

the HTML attributes for the portlet container tag.

tagName property

public string $tagName;

the tag name for the portlet container tag. Defaults to 'div'.

title property

public string $title;

the title of the portlet. Defaults to null. When this is not set, Decoration will not be displayed. Note that the title will not be HTML-encoded when rendering.

titleCssClass property

public string $titleCssClass;

the CSS class for the portlet title tag. Defaults to 'portlet-title'.

Method Details

init() method

public void init()

public function init()
{
    ob_start();
    ob_implicit_flush(false);

    if(isset($this->htmlOptions['id']))
        $this->id=$this->htmlOptions['id'];
    else
        $this->htmlOptions['id']=$this->id;
    echo CHtml::openTag($this->tagName,$this->htmlOptions)."\n";
    $this->renderDecoration();
    echo "<div class=\"{$this->contentCssClass}\">\n";

    $this->_openTag=ob_get_contents();
    ob_clean();
}

Initializes the widget. This renders the open tags needed by the portlet. It also renders the decoration, if any.

renderContent() method

protected void renderContent()

protected function renderContent()
{
}

Renders the content of the portlet. Child classes should override this method to render the actual content.

renderDecoration() method

protected void renderDecoration()

protected function renderDecoration()
{
    if($this->title!==null)
    {
        echo "<div class=\"{$this->decorationCssClass}\">\n";
        echo "<div class=\"{$this->titleCssClass}\">{$this->title}</div>\n";
        echo "</div>\n";
    }
}

Renders the decoration for the portlet. The default implementation will render the title if it is set.

run() method

public void run()

public function run()
{
    $this->renderContent();
    $content=ob_get_clean();
    if($this->hideOnEmpty && trim($content)==='')
        return;
    echo $this->_openTag;
    echo $content;
    echo "</div>\n";
    echo CHtml::closeTag($this->tagName);
}

Renders the content of the portlet.