CBreadcrumbs

所有包 | 属性 | 方法

包	zii.widgets
继承	class CBreadcrumbs » CWidget » CBaseController » CComponent
源自	1.1
版本	$Id: CBreadcrumbs.php 2799 2011-01-01 19:31:13Z qiang.xue $
源码	framework/zii/widgets/CBreadcrumbs.php

CBreadcrumbs显示一个由当前页面在网站中的位置组成的链接列表。

例如，像这样“Home > Sample Post > Edit” 意思是用户正在访问 “Sample Post”下的“edit”页面。他可以点击“Sample Post”访问“Sample Post”页面或点击“Home”返回“Home”页面。

使用 CBreadcrumbs 时需要设置links属性来配置显示的链接，例如，

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

因为breadcrumbs一般在每个页面都会显示，所以我们最后把它放在布局（layout）文件中. 我们可以将“breadcrumbs”属性定义在控制器的基类中，然后在布局（layout）文件的widget中调用，如下：

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

然后在每个视图中只需定义“breadcrumbs”就可以了。

公共属性

隐藏继承属性

属性	类型	描述	定义在
actionPrefix	string	actions的ID的前缀。当微件在CController::actions中声明了动作提供者，可以为其动作的ID指定前缀以区别于别的微件或控制器。当微件用于控制器的视图中时，必须配置同样的前缀。	CWidget
controller	CController	返回此微件所属的控制器。	CWidget
encodeLabel	boolean	是否对链接的文字进行HTML编码。默认为true。	CBreadcrumbs
homeLink	string	breadcrumbs中的第一个链接（一般为主页链接）。如果没有设置，默认链接为“Home”指向CWebApplication::homeUrl。如果属性为false，则不会渲染主页链接。	CBreadcrumbs
htmlOptions	array	容器的HTML属性。	CBreadcrumbs
id	string	返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。	CWidget
links	array	显示在breadcrumbs中的所有链接。为空时则不会渲染任何内容。在此数组中的每个key-value对都会使用 CHtml::link(key, value)生成链接。 key表示链接的文字，value可以为string或array类型（用来生成URL）。更多请查看CHtml::link。 $links中key为整型则表示只渲染链接文字（表示当前页）。下面的例子展示了怎么生成像“Home > Sample post > Edit”一样的链接，其中“Home”指向主页， “Sample post”指向“index.	CBreadcrumbs
owner	CBaseController	返回此微件的所有者或创建者。	CWidget
separator	string	breadcrumbs中链接之间的分隔符。默认是‘ » ’。	CBreadcrumbs
skin	mixed	微件使用的皮肤的名称。默认为“default”。如果此属性设置为false，微件将不会有皮肤被使用。	CWidget
tagName	string	容器的标签。默认为‘div’。	CBreadcrumbs
viewPath	string	返回包含此微件所需的视图文件的路径。	CWidget

公共方法

隐藏继承方法

方法	描述	定义在
__call()	如果类中没有调的方法名，则调用这个方法。	CComponent
__construct()	构造器。	CWidget
__get()	返回一个属性值、一个事件处理程序列表或一个行为名称。	CComponent
__isset()	检查一个属性是否为null。	CComponent
__set()	设置一个组件的属性值。	CComponent
__unset()	设置一个组件的属性为null。	CComponent
actions()	返回此widget使用的动作的列表。	CWidget
asa()	返回这个名字的行为对象。	CComponent
attachBehavior()	附加一个行为到组件。	CComponent
attachBehaviors()	附加一个行为列表到组件。	CComponent
attachEventHandler()	为事件附加一个事件处理程序。	CComponent
beginCache()	Begins fragment caching.	CBaseController
beginClip()	Begins recording a clip.	CBaseController
beginContent()	Begins the rendering of content that is to be decorated by the specified view.	CBaseController
beginWidget()	Creates a widget and executes it.	CBaseController
canGetProperty()	确定属性是否可读。	CComponent
canSetProperty()	确定属性是否可写。	CComponent
createWidget()	Creates a widget and initializes it.	CBaseController
detachBehavior()	从组件中分离一个行为。	CComponent
detachBehaviors()	从组件中分离所有行为。	CComponent
detachEventHandler()	分离一个存在的事件处理程序。	CComponent
disableBehavior()	禁用一个附加行为。	CComponent
disableBehaviors()	禁用组件附加的所有行为。	CComponent
enableBehavior()	启用一个附加行为。	CComponent
enableBehaviors()	启用组件附加的所有行为。	CComponent
endCache()	Ends fragment caching.	CBaseController
endClip()	Ends recording a clip.	CBaseController
endContent()	Ends the rendering of content.	CBaseController
endWidget()	Ends the execution of the named widget.	CBaseController
evaluateExpression()	计算一个PHP表达式，或根据组件上下文执行回调。	CComponent
getController()	返回此微件所属的控制器。	CWidget
getEventHandlers()	返回一个事件的附加处理程序列表。	CComponent
getId()	返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。	CWidget
getOwner()	返回此微件的所有者或创建者。	CWidget
getViewFile()	根据视图名查找视图文件。	CWidget
getViewPath()	返回包含此微件所需的视图文件的路径。	CWidget
hasEvent()	确定一个事件是否定义。	CComponent
hasEventHandler()	检查事件是否有附加的处理程序。	CComponent
hasProperty()	确定属性是否被定义。	CComponent
init()	初始化此微件。	CWidget
raiseEvent()	发起一个事件。	CComponent
render()	渲染一个视图。	CWidget
renderFile()	Renders a view file.	CBaseController
renderInternal()	Renders a view file.	CBaseController
run()	渲染部件的内容。	CBreadcrumbs
setId()	设置此微件的ID。	CWidget
widget()	Creates a widget and executes it.	CBaseController

属性详细

encodeLabel 属性

public boolean $encodeLabel;

是否对链接的文字进行HTML编码。默认为true。

homeLink 属性

public string $homeLink;

breadcrumbs中的第一个链接（一般为主页链接）。如果没有设置，默认链接为“Home”指向CWebApplication::homeUrl。如果属性为false，则不会渲染主页链接。

htmlOptions 属性

public array $htmlOptions;

容器的HTML属性。

links 属性

public array $links;

显示在breadcrumbs中的所有链接。为空时则不会渲染任何内容。在此数组中的每个key-value对都会使用 CHtml::link(key, value)生成链接。 key表示链接的文字，value可以为string或array类型（用来生成URL）。更多请查看CHtml::link。 $links中key为整型则表示只渲染链接文字（表示当前页）。

下面的例子展示了怎么生成像“Home > Sample post > Edit”一样的链接，其中“Home”指向主页， “Sample post”指向“index.php?r=post/view&id=12”页面，“Edit”表示当前页。注意“Home” 是通过homeLink指定的链接。

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

separator 属性

public string $separator;

breadcrumbs中链接之间的分隔符。默认是‘ » ’。

tagName 属性

public string $tagName;

容器的标签。默认为‘div’。

方法详细

run() 方法

public void run()

源码： framework/zii/widgets/CBreadcrumbs.php#95 (显示)


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

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

渲染部件的内容。