CDetailView

所有包 | 属性 | 方法

包	zii.widgets
继承	class CDetailView » CWidget » CBaseController » CComponent
源自	1.1
版本	$Id: CDetailView.php 3427 2011-10-25 00:03:52Z alexander.makarow $
源码	framework/zii/widgets/CDetailView.php

CDetailView显示单个数据模型的详细内容。

CDetailView非常适合用来用规则的格式显示一个模型（例如，每一个模型的属性被显示为表格的一行。） 该模型可以是CModel 的实例或相关的数组。

CDetailView使用attributes属性确定哪个模型属性 应该被显示和它们应该怎样被格式化。

CDetailView的一个典型用法如下：

$this->widget('zii.widgets.CDetailView', array(  'data'=>$model,  'attributes'=>array(      'title',             // title attribute (in plain text)      'owner.name',        // an attribute of the related object "owner"      'description:html',  // description attribute in HTML      array(               // related city displayed as a link          'label'=>'City',          'type'=>'raw',          'value'=>CHtml::link(CHtml::encode($model->city->name),                               array('city/view','id'=>$model->city->id)),      ),  ),
));

公共属性

隐藏继承属性

属性	类型	描述	定义在
actionPrefix	string	actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。	CWidget
attributes	array	要详细视图中要显示的一系列属性。 每个数组元素代表显示一个特定的属性规范。 一个属性可以被指定为一个字符串，使用格式"Name:Type:Label"。 "Type"和"Label"是可选的。 "Name" refers to the attribute name.	CDetailView
baseScriptUrl	string	the base script URL for all detail view resources (e.	CDetailView
controller	CController	返回此微件所属的控制器。	CWidget
cssFile	string	这个详细视图使用的CSS文件的URL。默认为null， 意味着使用集成的CSS文件。如果这个设置为false，你应该负责的明确的包含需要的CSS文件在你的页中。	CDetailView
data	mixed	the data model whose details are to be displayed.	CDetailView
formatter	CFormatter	格式化实例。默认‘format’应用程序组件。	CDetailView
htmlOptions	array	被用于tagName的HTML选项	CDetailView
id	string	返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。	CWidget
itemCssClass	array	the CSS class names for the items displaying attribute values.	CDetailView
itemTemplate	string	the template used to render a single attribute.	CDetailView
nullDisplay	string	the text to be displayed when an attribute value is null.	CDetailView
owner	CBaseController	返回此微件的所有者或创建者。	CWidget
skin	mixed	微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。	CWidget
tagName	string	the name of the tag for rendering the detail view.	CDetailView
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
getFormatter()	返回格式化实例。默认‘format’应用程序组件。	CDetailView
getId()	返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。	CWidget
getOwner()	返回此微件的所有者或创建者。	CWidget
getViewFile()	根据视图名查找视图文件。	CWidget
getViewPath()	返回包含此微件所需的视图文件的路径。	CWidget
hasEvent()	确定一个事件是否定义。	CComponent
hasEventHandler()	检查事件是否有附加的处理程序。	CComponent
hasProperty()	确定属性是否被定义。	CComponent
init()	初始化详细视图。	CDetailView
raiseEvent()	发起一个事件。	CComponent
render()	渲染一个视图。	CWidget
renderFile()	Renders a view file.	CBaseController
renderInternal()	Renders a view file.	CBaseController
run()	渲染详细视图。	CDetailView
setFormatter()	设置格式化实例	CDetailView
setId()	设置此微件的ID。	CWidget
widget()	Creates a widget and executes it.	CBaseController

属性详细

attributes 属性 public array $attributes;

要详细视图中要显示的一系列属性。 每个数组元素代表显示一个特定的属性规范。

一个属性可以被指定为一个字符串，使用格式"Name:Type:Label"。 "Type"和"Label"是可选的。

"Name" refers to the attribute name. It can be either a property (e.g. "title") or a sub-property (e.g. "owner.username").

"Label" represents the label for the attribute display. If it is not given, "Name" will be used to generate the appropriate label.

"Type" represents the type of the attribute. It determines how the attribute value should be formatted and displayed. It is defaulted to be 'text'. "Type" should be recognizable by the formatter. In particular, if "Type" is "xyz", then the "formatXyz" method of formatter will be invoked to format the attribute value for display. By default when CFormatter is used, these "Type" values are valid: raw, text, ntext, html, date, time, datetime, boolean, number, email, image, url. For more details about these types, please refer to CFormatter.

一个属性在相应的数组中指定，它有如下元素：

• label: the label associated with the attribute. If this is not specified, the following "name" element will be used to generate an appropriate label.
• name: the name of the attribute. This can be either a property or a sub-property of the model. If the below "value" element is specified, this will be ignored.
• value: the value to be displayed. If this is not specified, the above "name" element will be used to retrieve the corresponding attribute value for display. Note that this value will be formatted according to the "type" option as described below.
• type: the type of the attribute that determines how the attribute value would be formatted. Please see above for possible values.
• cssClass: the CSS class to be used for this item. This option is available since version 1.1.3.
• template: the template used to render the attribute. If this is not specified, itemTemplate will be used instead. For more details on how to set this option, please refer to itemTemplate. This option is available since version 1.1.1.
• visible: whether the attribute is visible. If set to false, the table row for the attribute will not be rendered. This option is available since version 1.1.5.

baseScriptUrl 属性 public string $baseScriptUrl;

the base script URL for all detail view resources (e.g. javascript, CSS file, images). Defaults to null, meaning using the integrated detail view resources (which are published as assets).

cssFile 属性 public string $cssFile;

这个详细视图使用的CSS文件的URL。默认为null， 意味着使用集成的CSS文件。如果这个设置为false，你应该负责的明确的包含需要的CSS文件在你的页中。

data 属性 public mixed $data;

the data model whose details are to be displayed. This can be either a CModel instance (e.g. a CActiveRecord object or a CFormModel object) or an associative array.

formatter 属性 public CFormatter getFormatter()
public void setFormatter(CFormatter $value)

格式化实例。默认‘format’应用程序组件。

htmlOptions 属性 public array $htmlOptions;

被用于tagName的HTML选项

itemCssClass 属性 public array $itemCssClass;

the CSS class names for the items displaying attribute values. If multiple CSS class names are given, they will be assigned to the items sequentially and repeatedly. Defaults to array('odd', 'even').

itemTemplate 属性 public string $itemTemplate;

the template used to render a single attribute. Defaults to a table row. These tokens are recognized: "{class}", "{label}" and "{value}". They will be replaced with the CSS class name for the item, the label and the attribute value, respectively.

参见

• itemCssClass

nullDisplay 属性 public string $nullDisplay;

the text to be displayed when an attribute value is null. Defaults to "Not set".

tagName 属性 public string $tagName;

the name of the tag for rendering the detail view. Defaults to 'table'.

参见

• itemTemplate

方法详细

getFormatter() 方法

public CFormatter getFormatter()
{return}	CFormatter	格式化实例。默认‘format’应用程序组件。

源码： framework/zii/widgets/CDetailView.php#228 (显示) publicfunctiongetFormatter()
{
if($this->_formatter===null)
$this->_formatter=Yii::app()->format;
return$this->_formatter;
} init() 方法

public void init()

源码： framework/zii/widgets/CDetailView.php#134 (显示) publicfunctioninit()
{
if($this->data===null)
thrownewCException(Yii::t('zii','Pleasespecifythe"data"property.'));
if($this->attributes===null)
{
if($this->datainstanceofCModel)
$this->attributes=$this->data->attributeNames();
elseif(is_array($this->data))
$this->attributes=array_keys($this->data);
else
thrownewCException(Yii::t('zii','Pleasespecifythe"attributes"property.'));
}
if($this->nullDisplay===null)
$this->nullDisplay='<spanclass="null">'.Yii::t('zii','Notset').'</span>';
$this->htmlOptions['id']=$this->getId();

if($this->baseScriptUrl===null)
$this->baseScriptUrl=Yii::app()->getAssetManager()->publish(Yii::getPathOfAlias('zii.widgets.assets')).'/detailview';

if($this->cssFile!==false)
{
if($this->cssFile===null)
$this->cssFile=$this->baseScriptUrl.'/styles.css';
Yii::app()->getClientScript()->registerCssFile($this->cssFile);
}
}

初始化详细视图。 这个方法将初始化必需的属性值。

run() 方法

public void run()

源码： framework/zii/widgets/CDetailView.php#166 (显示) publicfunctionrun()
{
$formatter=$this->getFormatter();
echoCHtml::openTag($this->tagName,$this->htmlOptions);

$i=0;
$n=is_array($this->itemCssClass)?count($this->itemCssClass):0;

foreach($this->attributesas$attribute)
{
if(is_string($attribute))
{
if(!preg_match('/^([w.]+)(:(w*))?(:(.*))?$/',$attribute,$matches))
thrownewCException(Yii::t('zii','Theattributemustbespecifiedintheformatof"Name:Type:Label",where"Type"and"Label"areoptional.'));
$attribute=array(
'name'=>$matches[1],
'type'=>isset($matches[3])?$matches[3]:'text',
);
if(isset($matches[5]))
$attribute['label']=$matches[5];
}

if(isset($attribute['visible'])&&!$attribute['visible'])
continue;

$tr=array('{label}'=>'','{class}'=>$n?$this->itemCssClass[$i%$n]:'');
if(isset($attribute['cssClass']))
$tr['{class}']=$attribute['cssClass'].''.($n?$tr['{class}']:'');

if(isset($attribute['label']))
$tr['{label}']=$attribute['label'];
elseif(isset($attribute['name']))
{
if($this->datainstanceofCModel)
$tr['{label}']=$this->data->getAttributeLabel($attribute['name']);
else
$tr['{label}']=ucwords(trim(strtolower(str_replace(array('-','_','.'),'',preg_replace('/(?<![A-Z])[A-Z]/','',$attribute['name'])))));
}

if(!isset($attribute['type']))
$attribute['type']='text';
if(isset($attribute['value']))
$value=$attribute['value'];
elseif(isset($attribute['name']))
$value=CHtml::value($this->data,$attribute['name']);
else
$value=null;

$tr['{value}']=$value===null?$this->nullDisplay:$formatter->format($value,$attribute['type']);

echostrtr(isset($attribute['template'])?$attribute['template']:$this->itemTemplate,$tr);

$i++;

}

echoCHtml::closeTag($this->tagName);
}

渲染详细视图。 这个整个详细视图渲染的主要入口。

setFormatter() 方法

public void setFormatter(CFormatter $value)
$value	CFormatter	格式化实例

源码： framework/zii/widgets/CDetailView.php#238 (显示) publicfunctionsetFormatter($value)
{
$this->_formatter=$value;
}