1 关注者

类 yii\widgets\DetailView

继承关系yii\widgets\DetailView » yii\base\Widget » yii\base\Component » yii\base\BaseObject
实现接口yii\base\Configurable, yii\base\ViewContextInterface
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/widgets/DetailView.php

DetailView 用于显示单个数据 $model 的详细信息。

DetailView 最适合用于以常规格式显示模型(例如,每个模型属性都以表格中的一行显示)。模型可以是 yii\base\Model 的实例,也可以是关联数组。

DetailView 使用 $attributes 属性来确定应显示哪些模型属性以及如何格式化它们。

DetailView 的典型用法如下所示

echo DetailView::widget([
    'model' => $model,
    'attributes' => [
        'title',               // title attribute (in plain text)
        'description:html',    // description attribute in HTML
        [                      // the owner name of the model
            'label' => 'Owner',
            'value' => $model->owner->name,
        ],
        'created_at:datetime', // creation date formatted as datetime
    ],
]);

有关 DetailView 的更多详细信息和用法信息,请参阅 数据小部件指南文章

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$attributes array 要在详细视图中显示的属性列表。 yii\widgets\DetailView
$autoIdPrefix string 自动生成的部件 ID 的前缀。 yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$formatter array|yii\i18n\Formatter|null 用于将模型属性值格式化为可显示文本的格式化程序。 yii\widgets\DetailView
$id string|null 部件的 ID。 yii\base\Widget
$model array|object 要显示其详细信息的数据模型。 yii\widgets\DetailView
$options array|null 此部件的容器标签的 HTML 属性。 yii\widgets\DetailView
$template string|callable 用于渲染单个属性的模板。 yii\widgets\DetailView
$view yii\web\View 可用于渲染视图或视图文件的视图对象。 yii\base\Widget
$viewPath string 包含此部件的视图文件的目录。 yii\base\Widget

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后调用。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
afterRun() 此方法在部件执行后立即调用。 yii\base\Widget
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
beforeRun() 此方法在部件执行前立即调用。 yii\base\Widget
begin() 开始一个部件。 yii\base\Widget
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
end() 结束一个部件。 yii\base\Widget
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getId() 返回部件的 ID。 yii\base\Widget
getView() 返回可用于渲染视图或视图文件的视图对象。 yii\base\Widget
getViewPath() 返回包含此部件的视图文件的目录。 yii\base\Widget
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化详细视图。 yii\widgets\DetailView
off() 从此组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
render() 渲染视图。 yii\base\Widget
renderFile() 渲染视图文件。 yii\base\Widget
run() 渲染详细视图。 yii\widgets\DetailView
setId() 设置部件的 ID。 yii\base\Widget
setView() 设置此部件要使用的视图对象。 yii\base\Widget
trigger() 触发事件。 yii\base\Component
widget() 创建部件实例并运行它。 yii\base\Widget

受保护的方法

隐藏继承的方法

方法 描述 定义于
normalizeAttributes() 规范化属性规范。 yii\widgets\DetailView
renderAttribute() 渲染单个属性。 yii\widgets\DetailView

事件

隐藏继承的事件

事件 类型 描述 定义于
EVENT_AFTER_RUN yii\base\WidgetEvent 在执行部件后立即引发的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在执行部件前立即引发的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_INIT yii\base\Event 通过 init() 初始化部件时触发的事件。(自版本 2.0.11 起可用) yii\base\Widget

属性详情

隐藏继承的属性

$attributes 公共属性

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

属性可以以 attributeattribute:formatattribute:format:label 格式的字符串形式指定,其中 attribute 指的是属性名称,format 表示属性的格式。format 传递给 yii\i18n\Formatter::format() 方法,以将属性值格式化为可显示的文本。有关支持的类型,请参阅 yii\i18n\Formatter

属性也可以用包含以下元素的数组来指定

  • attribute:属性名称。如果未指定 labelvalue,则这是必需的。
  • label:与属性关联的标签。如果未指定,则将从属性名称生成。
  • value: 要显示的值。如果未指定,则将使用属性名称从 $model 中通过调用 yii\helpers\ArrayHelper::getValue() 获取。请注意,此值将根据 format 选项格式化为可显示的文本。从 2.0.11 版本开始,它可以定义为具有以下参数的闭包

    function ($model, $widget)
    

    $model 指的是显示的模型,$widgetDetailView 小部件的实例。

  • format: 值的类型,决定了值将如何格式化为可显示的文本。有关支持的类型,请参阅 yii\i18n\Formatter,有关如何指定此值,请参阅 yii\i18n\Formatter::format()
  • visible: 属性是否可见。如果设置为 false,则不会显示该属性。
  • contentOptions: 用于自定义值标签的 HTML 属性。例如:['class' => 'bg-red']。有关支持的语法,请参阅 yii\helpers\BaseHtml::renderTagAttributes()
  • captionOptions: 用于自定义标签标签的 HTML 属性。例如:['class' => 'bg-red']。有关支持的语法,请参阅 yii\helpers\BaseHtml::renderTagAttributes()
public array $attributes null
$formatter 公共属性

用于将模型属性值格式化为可显示文本的格式化程序。这可以是 yii\i18n\Formatter 的实例,也可以是用于创建 yii\i18n\Formatter 实例的配置数组。如果未设置此属性,则将使用 formatter 应用程序组件。

$model 公共属性

要显示其详细信息的数据模型。这可以是 yii\base\Model 实例、关联数组、实现 yii\base\Arrayable 接口的对象,或者只是一个具有定义的公共访问非静态属性的对象。

public array|object $model null
$options 公共属性

此小部件的容器标签的 HTML 属性。tag 选项指定应使用哪个容器标签。如果未设置,则默认为 table

另请参阅 yii\helpers\Html::renderTagAttributes(),了解有关如何渲染属性的详细信息。

public array|null $options = [
    
'class' => 'table table-striped table-bordered detail-view',
]
$template 公共属性

用于渲染单个属性的模板。如果为字符串,则令牌 {label}{value} 将分别替换为相应属性的标签和值。如果为回调(例如匿名函数),则签名必须如下所示

function ($attribute, $index, $widget)

其中 $attribute 指的是正在渲染的属性的规范,$index 是属性在 $attributes 数组中的从零开始的索引,$widget 指的是此小部件实例。

从 2.0.10 版本开始,可以使用令牌 {captionOptions}{contentOptions},它们将表示标签和值的 HTML 容器元素的 HTML 属性。

public string|callable $template '<tr><th{captionOptions}>{label}</th><td{contentOptions}>{value}</td></tr>'

方法详情

隐藏继承的方法

__call() 公共方法

定义于: yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查任何附加的行为是否具有命名方法,如果可用,则将执行它。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用。

public mixed __call ( $name, $params )
$name string

方法名称

$params array

方法参数

返回值 mixed

方法返回值

抛出 yii\base\UnknownMethodException

调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后调用。

它删除所有行为,因为它们附加到旧对象。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法

定义于: yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()

如果在子类中重写此方法,建议

  • 构造函数的最后一个参数是配置数组,如这里的 $config
  • 在构造函数的末尾调用父实现。
public void __construct ( $config = [] )
$config array

将用于初始化对象属性的名称-值对

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地采取行动

  • 由 getter 定义的属性:返回 getter 结果
  • 行为的属性:返回行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $value = $component->property; 时会隐式调用。

另请参阅 __set()

public mixed __get ( $name )
$name string

属性名称

返回值 mixed

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性是只写属性。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公共方法

定义于: yii\base\Component::__isset()

检查属性是否已设置,即定义且不为 null。

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性,返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 isset($component->property) 时会被隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.isset.php

public 布尔型 __isset ( $name )
$name string

属性名称或事件名称

返回值 布尔型

命名属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性:设置属性值
  • 格式为“on xyz”的事件:将处理程序附加到事件“xyz”
  • 格式为“as xyz”的行为:附加名为“xyz”的行为
  • 行为的属性:设置行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $component->property = $value; 时会被隐式调用。

另请参阅 __get()

public void __set ( $name, $value )
$name string

属性名称或事件名称

$value mixed

属性值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性是只读的。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($component->property) 时会被隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.unset.php

public void __unset ( $name )
$name string

属性名称

抛出 yii\base\InvalidCallException

如果属性是只读的。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
afterRun() 公共方法 (自版本 2.0.11 起可用)

定义于: yii\base\Widget::afterRun()

此方法在部件执行后立即调用。

此方法将触发 EVENT_AFTER_RUN 事件。此方法的返回值将用作小部件的返回值。

如果覆盖此方法,则代码应如下所示

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}
public 混合型 afterRun ( $result )
$result mixed

小部件返回结果。

返回值 mixed

已处理的小部件结果。

                public function afterRun($result)
{
    $event = new WidgetEvent();
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_RUN, $event);
    return $event->result;
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另请参阅 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior 字符串|数组|yii\base\Behavior

行为配置。可以是以下之一:

返回值 yii\base\Behavior

行为对象

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公共方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都由其名称索引,并且应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串或一个用于创建行为的配置数组。

另请参阅 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeRun() 公共方法 (自版本 2.0.11 起可用)

定义于: yii\base\Widget::beforeRun()

此方法在部件执行前立即调用。

此方法将触发 EVENT_BEFORE_RUN 事件。此方法的返回值将确定小部件是否应继续运行。

覆盖此方法时,请确保调用父实现,如下所示

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}
public 布尔型 beforeRun ( )
返回值 布尔型

小部件是否应继续执行。

                public function beforeRun()
{
    $event = new WidgetEvent();
    $this->trigger(self::EVENT_BEFORE_RUN, $event);
    return $event->isValid;
}

            
begin() 公共静态方法

定义于: yii\base\Widget::begin()

开始一个部件。

此方法创建调用类的实例。它会将配置应用于创建的实例。稍后应调用匹配的 end() 调用。由于某些小部件可能使用输出缓冲,因此应在同一视图中进行 end() 调用,以避免破坏输出缓冲的嵌套。

另请参阅 end()

public static 静态 begin ( $config = [] )
$config array

将用于初始化对象属性的名称-值对

返回值 yii\base\Widget

新创建的小部件实例

                public static function begin($config = [])
{
    $config['class'] = get_called_class();
    /* @var $widget Widget */
    $widget = Yii::createObject($config);
    self::$stack[] = $widget;
    return $widget;
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以覆盖此方法以指定它们希望表现为的行为。

此方法的返回值应是一个行为对象或配置数组,由行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意,行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当使用名称作为数组键时,使用此名称,行为稍后可以使用 getBehavior() 检索,或使用 detachBehavior() 分离。匿名行为无法检索或分离。

在此方法中声明的行为将自动(按需)附加到组件。

public array behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

定义于: yii\base\Component::canGetProperty()

返回一个值,指示是否可以读取属性。

如果属性可读,则:

  • 该类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars 布尔型

是否将成员变量视为属性

$checkBehaviors 布尔型

是否将行为的属性视为此组件的属性

返回值 布尔型

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公共方法

定义于: yii\base\Component::canSetProperty()

返回一个值,指示是否可以设置属性。

如果属性可写,则:

  • 该类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars 布尔型

是否将成员变量视为属性

$checkBehaviors 布尔型

是否将行为的属性视为此组件的属性

返回值 布尔型

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >=5.5 中,请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() 公共方法

定义于: yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|null

分离的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公共方法

定义于: yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
end() 公共静态方法

定义于: yii\base\Widget::end()

结束一个部件。

请注意,小部件的渲染结果将直接输出。

另请参阅 begin()

public static static end ( )
返回值 yii\base\Widget

结束的小部件实例。

抛出 yii\base\InvalidCallException

如果 begin()end() 调用未正确嵌套

                public static function end()
{
    if (!empty(self::$stack)) {
        $widget = array_pop(self::$stack);
        $calledClass = get_called_class();
        if (Yii::$container->has($calledClass) && isset(Yii::$container->getDefinitions()[$calledClass]['class'])) {
            $calledClass = Yii::$container->getDefinitions()[$calledClass]['class'];
        }
        if (get_class($widget) === $calledClass) {
            /* @var $widget Widget */
            if ($widget->beforeRun()) {
                $result = $widget->run();
                $result = $widget->afterRun($result);
                echo $result;
            }
            return $widget;
        }
        throw new InvalidCallException('Expecting end() of ' . get_class($widget) . ', found ' . get_called_class());
    }
    throw new InvalidCallException('Unexpected ' . get_called_class() . '::end() call. A matching begin() is not found.');
}

            
ensureBehaviors() 公共方法

定义于: yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为已附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公共方法

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getId() 公共方法

定义于: yii\base\Widget::getId()

返回部件的 ID。

public string|null getId ( $autoGenerate true )
$autoGenerate 布尔型

是否在之前未设置 ID 时生成 ID

返回值 string|null

部件的 ID。

                public function getId($autoGenerate = true)
{
    if ($autoGenerate && $this->_id === null) {
        $this->_id = static::$autoIdPrefix . static::$counter++;
    }
    return $this->_id;
}

            
getView() 公共方法

定义于: yii\base\Widget::getView()

返回可用于渲染视图或视图文件的视图对象。

render()renderFile() 方法将使用此视图对象来实现实际的视图渲染。如果未设置,则默认为“view”应用程序组件。

public yii\web\View getView ( )
返回值 yii\web\View

可用于渲染视图或视图文件的视图对象。

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = Yii::$app->getView();
    }
    return $this->_view;
}

            
getViewPath() 公共方法

定义于: yii\base\Widget::getViewPath()

返回包含此部件的视图文件的目录。

默认实现返回包含小部件类文件的目录下的“views”子目录。

public string getViewPath ( )
返回值 string

包含此部件的视图文件的目录。

                public function getViewPath()
{
    $class = new ReflectionClass($this);
    return dirname($class->getFileName()) . DIRECTORY_SEPARATOR . 'views';
}

            
hasEventHandlers() 公共方法

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名的事件。

public boolean hasEventHandlers ( $name )
$name string

事件名称

返回值 布尔型

是否存在任何附加到事件的处理程序。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() 公共方法

定义于: yii\base\Component::hasMethod()

返回一个值,指示方法是否已定义。

如果定义了方法

  • 该类具有指定名称的方法
  • 附加的行为具有给定名称的方法(当$checkBehaviors为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名称

$checkBehaviors 布尔型

是否将行为的方法视为此组件的方法

返回值 布尔型

方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() 公共方法

定义于: yii\base\Component::hasProperty()

返回一个值,指示是否为此组件定义了属性。

如果定义了属性

  • 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当$checkBehaviors为 true 时)。

另请参阅

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars 布尔型

是否将成员变量视为属性

$checkBehaviors 布尔型

是否将行为的属性视为此组件的属性

返回值 布尔型

属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() 公共方法

初始化详细视图。

此方法将初始化所需的属性值。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->model === null) {
        throw new InvalidConfigException('Please specify the "model" property.');
    }
    if ($this->formatter === null) {
        $this->formatter = Yii::$app->getFormatter();
    } elseif (is_array($this->formatter)) {
        $this->formatter = Yii::createObject($this->formatter);
    }
    if (!$this->formatter instanceof Formatter) {
        throw new InvalidConfigException('The "formatter" property must be either a Format object or a configuration array.');
    }
    $this->normalizeAttributes();
    if (!isset($this->options['id'])) {
        $this->options['id'] = $this->getId();
    }
}

            
normalizeAttributes() 受保护方法

规范化属性规范。

protected void normalizeAttributes ( )
抛出 yii\base\InvalidConfigException

                protected function normalizeAttributes()
{
    if ($this->attributes === null) {
        if ($this->model instanceof Model) {
            $this->attributes = $this->model->attributes();
        } elseif (is_object($this->model)) {
            $this->attributes = $this->model instanceof Arrayable ? array_keys($this->model->toArray()) : array_keys(get_object_vars($this->model));
        } elseif (is_array($this->model)) {
            $this->attributes = array_keys($this->model);
        } else {
            throw new InvalidConfigException('The "model" property must be either an array or an object.');
        }
        sort($this->attributes);
    }
    foreach ($this->attributes as $i => $attribute) {
        if (is_string($attribute)) {
            if (!preg_match('/^([^:]+)(:(\w*))?(:(.*))?$/', $attribute, $matches)) {
                throw new InvalidConfigException('The attribute must be specified in the format of "attribute", "attribute:format" or "attribute:format:label"');
            }
            $attribute = [
                'attribute' => $matches[1],
                'format' => isset($matches[3]) ? $matches[3] : 'text',
                'label' => isset($matches[5]) ? $matches[5] : null,
            ];
        }
        if (!is_array($attribute)) {
            throw new InvalidConfigException('The attribute configuration must be an array.');
        }
        if (isset($attribute['visible']) && !$attribute['visible']) {
            unset($this->attributes[$i]);
            continue;
        }
        if (!isset($attribute['format'])) {
            $attribute['format'] = 'text';
        }
        if (isset($attribute['attribute'])) {
            $attributeName = $attribute['attribute'];
            if (!isset($attribute['label'])) {
                $attribute['label'] = $this->model instanceof Model ? $this->model->getAttributeLabel($attributeName) : Inflector::camel2words($attributeName, true);
            }
            if (!array_key_exists('value', $attribute)) {
                $attribute['value'] = ArrayHelper::getValue($this->model, $attributeName);
            }
        } elseif (!isset($attribute['label']) || !array_key_exists('value', $attribute)) {
            throw new InvalidConfigException('The attribute configuration requires the "attribute" element to determine the value and display label.');
        }
        if ($attribute['value'] instanceof \Closure) {
            $attribute['value'] = call_user_func($attribute['value'], $this->model, $this);
        }
        $this->attributes[$i] = $attribute;
    }
}

            
off() 公共方法

定义于: yii\base\Component::off()

从此组件分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果为事件名称传递通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()

public boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|null

要删除的事件处理程序。如果为 null,则将删除附加到命名事件的所有处理程序。

返回值 布尔型

如果找到并分离了处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() 公共方法

定义于: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中$event是包含与事件关联的参数的 yii\base\Event 对象。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参阅 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler callable

事件处理程序

$data mixed

触发事件时要传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append 布尔型

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 false,则新的处理程序将插入到现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
render() 公共方法

定义于: yii\base\Widget::render()

渲染视图。

要呈现的视图可以使用以下格式之一指定

  • 路径别名(例如“@app/views/site/index”);
  • 应用程序内的绝对路径(例如“//site/index”):视图名称以双斜杠开头。实际的视图文件将在应用程序的 视图路径 下查找。
  • 模块内的绝对路径(例如“/site/index”):视图名称以单个斜杠开头。实际的视图文件将在当前活动模块的 视图路径 下查找。
  • 相对路径(例如“index”):实际的视图文件将在 $viewPath 下查找。

如果视图名称不包含文件扩展名,则将使用默认扩展名.php

public string render ( $view, $params = [] )
$view string

视图名称。

$params array

应在视图中提供的参数(名称-值对)。

返回值 string

渲染结果。

抛出 yii\base\InvalidArgumentException

如果视图文件不存在。

                public function render($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
renderAttribute() 受保护方法

渲染单个属性。

protected string renderAttribute ( $attribute, $index )
$attribute array

要呈现的属性的规范。

$index integer

属性在 $attributes 数组中的从零开始的索引

返回值 string

渲染结果

                protected function renderAttribute($attribute, $index)
{
    if (is_string($this->template)) {
        $captionOptions = Html::renderTagAttributes(ArrayHelper::getValue($attribute, 'captionOptions', []));
        $contentOptions = Html::renderTagAttributes(ArrayHelper::getValue($attribute, 'contentOptions', []));
        return strtr($this->template, [
            '{label}' => $attribute['label'],
            '{value}' => $this->formatter->format($attribute['value'], $attribute['format']),
            '{captionOptions}' => $captionOptions,
            '{contentOptions}' => $contentOptions,
        ]);
    }
    return call_user_func($this->template, $attribute, $index, $this);
}

            
renderFile() 公共方法

定义于: yii\base\Widget::renderFile()

渲染视图文件。

public 字符串 renderFile ( $file, $params = [] )
$file string

要渲染的视图文件。这可以是文件路径或路径别名

$params array

应在视图中提供的参数(名称-值对)。

返回值 string

渲染结果。

抛出 yii\base\InvalidArgumentException

如果视图文件不存在。

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
run() 公共方法

渲染详细视图。

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

public void run ( )

                public function run()
{
    $rows = [];
    $i = 0;
    foreach ($this->attributes as $attribute) {
        $rows[] = $this->renderAttribute($attribute, $i++);
    }
    $options = $this->options;
    $tag = ArrayHelper::remove($options, 'tag', 'table');
    echo Html::tag($tag, implode("\n", $rows), $options);
}

            
setId() 公共方法

定义于: yii\base\Widget::setId()

设置部件的 ID。

public void setId ( $value )
$value string

小部件的ID。

                public function setId($value)
{
    $this->_id = $value;
}

            
setView() 公共方法

定义于: yii\base\Widget::setView()

设置此部件要使用的视图对象。

public void setView ( $view )
$view yii\base\View

可用于渲染视图或视图文件的视图对象。

                public function setView($view)
{
    $this->_view = $view;
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级处理程序。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。如果未设置,将创建一个默认的yii\base\Event对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
widget() 公共静态方法

定义于: yii\base\Widget::widget()

创建部件实例并运行它。

小部件渲染结果由此方法返回。

public static 字符串 widget ( $config = [] )
$config array

将用于初始化对象属性的名称-值对

返回值 string

小部件的渲染结果。

抛出 Throwable

                public static function widget($config = [])
{
    ob_start();
    ob_implicit_flush(false);
    try {
        /* @var $widget Widget */
        $config['class'] = get_called_class();
        $widget = Yii::createObject($config);
        $out = '';
        if ($widget->beforeRun()) {
            $result = $widget->run();
            $out = $widget->afterRun($result);
        }
    } catch (\Exception $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    } catch (\Throwable $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    }
    return ob_get_clean() . $out;
}