CBreadcrumbs

$this->widget('zii.widgets.CBreadcrumbs', array(
    'links'=>array(
        'Sample post'=>array('post/view', 'id'=>12),
        'Edit',
    ),
));

$this->widget('zii.widgets.CBreadcrumbs', array(
    'links'=>$this->breadcrumbs,
));

Property Details

activeLinkTemplate property (available since v1.1.11)

public string $activeLinkTemplate;

String, specifies how each active item is rendered. Defaults to "{label}", where "{label}" will be replaced by the corresponding item label while "{url}" will be replaced by the URL of the item.

encodeLabel property

public boolean $encodeLabel;

whether to HTML encode the link labels. Defaults to true.

homeLink property

public string $homeLink;

the first hyperlink in the breadcrumbs (called home link). If this property is not set, it defaults to a link pointing to CWebApplication::homeUrl with label 'Home'. If this property is false, the home link will not be rendered.

htmlOptions property

public array $htmlOptions;

the HTML attributes for the breadcrumbs container tag.

inactiveLinkTemplate property (available since v1.1.11)

public string $inactiveLinkTemplate;

String, specifies how each inactive item is rendered. Defaults to "{label}", where "{label}" will be replaced by the corresponding item label. Note that inactive template does not have "{url}" parameter.

links property

public array $links;

list of hyperlinks to appear in the breadcrumbs. If this property is empty, the widget will not render anything. Each key-value pair in the array will be used to generate a hyperlink by calling CHtml::link(key, value). For this reason, the key refers to the label of the link while the value can be a string or an array (used to create a URL). For more details, please refer to CHtml::link. If an element's key is an integer, it means the element will be rendered as a label only (meaning the current page).

The following example will generate breadcrumbs as "Home > Sample post > Edit", where "Home" points to the homepage, "Sample post" points to the "index.php?r=post/view&id=12" page, and "Edit" is a label. Note that the "Home" link is specified via homeLink separately.

array(
    'Sample post'=>array('post/view', 'id'=>12),
    'Edit',
)

separator property

public string $separator;

the separator between links in the breadcrumbs. Defaults to ' » '.

tagName property

public string $tagName;

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

Method Details

run() method

public void run()

public function run()
{
    if(empty($this->links))
        return;

    $definedLinks = $this->links;

    echo CHtml::openTag($this->tagName,$this->htmlOptions)."\n";
    $links=array();
    if($this->homeLink===null)
        $definedLinks=array(Yii::t('zii','Home') => Yii::app()->homeUrl)+$definedLinks;
    elseif($this->homeLink!==false)
        $links[]=$this->homeLink;
    foreach($definedLinks as $label=>$url)
    {
        if(is_string($label) || is_array($url))
            $links[]=strtr($this->activeLinkTemplate,array(
                '{url}'=>CHtml::normalizeUrl($url),
                '{label}'=>$this->encodeLabel ? CHtml::encode($label) : $label,
            ));
        else
            $links[]=str_replace('{label}',$this->encodeLabel ? CHtml::encode($url) : $url,$this->inactiveLinkTemplate);
    }
    echo implode($this->separator,$links);
    echo CHtml::closeTag($this->tagName);
}

Renders the content of the portlet.