3 关注者

类 yii\widgets\Pjax

继承关系yii\widgets\Pjax » 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/Pjax.php

Pjax 是一个集成 pjax jQuery 插件的小部件。

Pjax 仅处理其 begin()end() 调用之间包含的内容,称为小部件的主体内容。默认情况下,主体内容中的任何链接点击或表单提交(对于具有data-pjax 属性的表单)都会触发 AJAX 请求。在响应 AJAX 请求时,Pjax 会将更新后的主体内容(基于 AJAX 请求)发送到客户端,该内容将替换旧内容。然后浏览器将使用 pushState 更新 URL。整个过程不需要重新加载布局或资源(js、css)。

您可以配置 $linkSelector 来指定哪些链接应该触发 pjax,并配置 $formSelector 来指定哪些表单提交可能会触发 pjax。

您可以在容器内为特定链接禁用 pjax,方法是在该链接中添加data-pjax="0" 属性。

以下示例演示了如何将 Pjax 与 yii\grid\GridView 小部件一起使用,以便可以通过 pjax 进行网格分页、排序和过滤。

use yii\widgets\Pjax;

Pjax::begin();
echo GridView::widget([...]);
Pjax::end();

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$autoIdPrefix 字符串 自动生成的窗口小部件 ID 的前缀。 yii\widgets\Pjax
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$clientOptions 数组 要传递给 pjax JS 插件的附加选项。 yii\widgets\Pjax
$enablePushState 布尔值 是否启用 push 状态。 yii\widgets\Pjax
$enableReplaceState 布尔值 是否启用替换状态。 yii\widgets\Pjax
$formSelector 字符串||布尔值 其提交应该触发 pjax 请求的表单的 jQuery 选择器。 yii\widgets\Pjax
$id 字符串| 窗口小部件的 ID。 yii\base\Widget
$linkSelector 字符串||布尔值 应该触发 pjax 请求的链接的 jQuery 选择器。 yii\widgets\Pjax
$options 数组 窗口小部件容器标签的 HTML 属性。 yii\widgets\Pjax
$scrollTo 布尔值|整数 收到 pjax 响应时如何滚动页面。 yii\widgets\Pjax
$submitEvent 字符串 将触发表单处理程序的 jQuery 事件。 yii\widgets\Pjax
$timeout 整数 Pjax 超时设置(以毫秒为单位)。 yii\widgets\Pjax
$view yii\web\View 可以用于渲染视图或视图文件的视图对象。 yii\base\Widget
$viewPath 字符串 包含此窗口小部件的视图文件的目录。 yii\base\Widget

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后被调用。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即定义且不为空。 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\Pjax
off() 从此组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
registerClientScript() 注册所需的 JavaScript。 yii\widgets\Pjax
render() 渲染视图。 yii\base\Widget
renderFile() 渲染视图文件。 yii\base\Widget
run() 执行小部件。 yii\widgets\Pjax
setId() 设置窗口小部件的 ID。 yii\base\Widget
setView() 设置要由此小部件使用的视图对象。 yii\base\Widget
trigger() 触发事件。 yii\base\Component
widget() 创建窗口小部件实例并运行它。 yii\base\Widget

保护方法

隐藏继承的方法

方法 描述 定义于
requiresPjax() yii\widgets\Pjax

事件

隐藏继承的事件

事件 类型 描述 定义于
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

属性详细信息

隐藏继承的属性

$autoIdPrefix 公共静态属性

自动生成的窗口小部件 ID 的前缀。

public static string $autoIdPrefix 'p'
$clientOptions 公共属性

传递给 pjax JS 插件的额外选项。请参阅 pjax 项目页面 以了解可用选项。

public array $clientOptions null
$enablePushState 公共属性

是否启用 push 状态。

public boolean $enablePushState true
$enableReplaceState 公共属性

是否启用替换状态。

$formSelector 公共属性

提交应触发 pjax 请求的表单的 jQuery 选择器。如果未设置,则 Pjax 包含内容内的所有带有 data-pjax 属性的表单将触发 pjax 请求。如果设置为 false,则不会注册任何代码来处理表单。请注意,如果对 pjax 请求的响应是完整页面,则将再次发送普通请求。

$linkSelector 公共属性

应触发 pjax 请求的链接的 jQuery 选择器。如果未设置,则 Pjax 包含内容内的所有链接将触发 pjax 请求。如果设置为 false,则不会注册任何代码来处理链接。请注意,如果对 pjax 请求的响应是完整页面,则将再次发送普通请求。

$options 公共属性

小部件容器标签的 HTML 属性。识别以下特殊选项

  • tag: string,容器的标签名称。默认为 div 此选项从版本 2.0.7 开始可用。另见 yii\helpers\Html::tag()

另见 yii\helpers\Html::renderTagAttributes() 以了解属性是如何呈现的。

public array $options = []
$scrollTo 公共属性

当接收到 pjax 响应时如何滚动页面。如果为 false,则不会进行页面滚动。如果要滚动到特定位置,请使用数字。

public boolean|integer $scrollTo false
$submitEvent 公共属性 (从版本 2.0.9 开始可用)

将触发表单处理程序的 jQuery 事件。默认为 "submit"。

public string $submitEvent 'submit'
$timeout 公共属性

Pjax 超时设置(以毫秒为单位)。此超时用于进行 AJAX 请求。如果您的服务器速度很慢,请使用更大的数字。如果服务器在超时时间内没有响应,将触发完整页面加载。

public integer $timeout 1000

方法详细信息

隐藏继承的方法

__call() 公共方法

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

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

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

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

public mixed __call ( $name, $params )
$name 字符串

方法名称

$params 数组

方法参数

return mixed

方法返回值

throws 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 数组

将用于初始化对象属性的键值对

                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 字符串

属性名称

return mixed

属性值或行为属性的值

throws yii\base\UnknownPropertyException

如果属性未定义

throws 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()

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

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

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

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

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

public boolean __isset ( $name )
$name 字符串

属性名称或事件名称

return 布尔值

命名的属性是否已设置

                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 字符串

属性名称或事件名称

$value mixed

属性值

throws yii\base\UnknownPropertyException

如果属性未定义

throws 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 字符串

属性名称

throws 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 mixed afterRun ( $result )
$result mixed

小部件返回结果。

return 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 字符串

行为的名称。

$behavior string|array|yii\base\Behavior

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

return 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 数组

要附加到组件的行为列表

                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 boolean beforeRun ( )
return 布尔值

小部件是否应继续执行。

                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 static begin ( $config = [] )
$config 数组

将用于初始化对象属性的键值对

return 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 ( )
return 数组

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

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

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

如果属性可以读取,则

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

另见 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name 字符串

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

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

return 布尔值

该属性是否可读

                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 字符串

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

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

return 布尔值

该属性是否可写

                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 ( )
return 字符串

此类的完全限定名称。

                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 字符串

行为的名称。

return 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 ( )
return yii\base\Widget

结束的小部件实例。

throws 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 字符串

行为名称

return 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 ( )
return 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

return 字符串|

窗口小部件的 ID。

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

            
getView() public method

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

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

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

public yii\web\View getView ( )
return yii\web\View

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

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

            
getViewPath() public method

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

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

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

public string getViewPath ( )
return 字符串

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

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

            
hasEventHandlers() public method

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

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

public boolean hasEventHandlers ( $name )
$name 字符串

事件名称

return 布尔值

是否有任何处理程序附加到事件。

                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() public method

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

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

方法定义在

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

属性名称

$checkBehaviors 布尔值

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

return 布尔值

方法是否定义

                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() public method

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

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

属性定义在

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

另见

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name 字符串

属性名称

$checkVars 布尔值

是否将成员变量视为属性

$checkBehaviors 布尔值

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

return 布尔值

属性是否定义

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

            
init() public method

初始化对象。

此方法在构造函数结束时调用。 默认实现将触发 EVENT_INIT 事件。

public void init ( )

                public function init()
{
    parent::init();
    if (!isset($this->options['id'])) {
        $this->options['id'] = $this->getId();
    }
    if ($this->requiresPjax()) {
        ob_start();
        ob_implicit_flush(false);
        $view = $this->getView();
        $view->clear();
        $view->beginPage();
        $view->head();
        $view->beginBody();
        if ($view->title !== null) {
            echo Html::tag('title', Html::encode($view->title));
        }
    } else {
        $options = $this->options;
        $tag = ArrayHelper::remove($options, 'tag', 'div');
        echo Html::beginTag($tag, array_merge([
            'data-pjax-container' => '',
            'data-pjax-push-state' => $this->enablePushState,
            'data-pjax-replace-state' => $this->enableReplaceState,
            'data-pjax-timeout' => $this->timeout,
            'data-pjax-scrollto' => $this->scrollTo,
        ], $options));
    }
}

            
off() public method

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

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

此方法与 on() 相反。

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

另见 on().

public boolean off ( $name, $handler null )
$name 字符串

事件名称

$handler callable|null

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

return 布尔值

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

                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() public method

定义于: 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 字符串

事件名称

$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]);
    }
}

            
registerClientScript() public method

注册所需的 JavaScript。

public void registerClientScript ( )

                public function registerClientScript()
{
    $id = $this->options['id'];
    $this->clientOptions['push'] = $this->enablePushState;
    $this->clientOptions['replace'] = $this->enableReplaceState;
    $this->clientOptions['timeout'] = $this->timeout;
    $this->clientOptions['scrollTo'] = $this->scrollTo;
    if (!isset($this->clientOptions['container'])) {
        $this->clientOptions['container'] = "#$id";
    }
    $options = Json::htmlEncode($this->clientOptions);
    $js = '';
    if ($this->linkSelector !== false) {
        $linkSelector = Json::htmlEncode($this->linkSelector !== null ? $this->linkSelector : '#' . $id . ' a');
        $js .= "jQuery(document).pjax($linkSelector, $options);";
    }
    if ($this->formSelector !== false) {
        $formSelector = Json::htmlEncode($this->formSelector !== null ? $this->formSelector : '#' . $id . ' form[data-pjax]');
        $submitEvent = Json::htmlEncode($this->submitEvent);
        $js .= "\njQuery(document).off($submitEvent, $formSelector).on($submitEvent, $formSelector, function (event) {jQuery.pjax.submit(event, $options);});";
    }
    $view = $this->getView();
    PjaxAsset::register($view);
    if ($js !== '') {
        $view->registerJs($js);
    }
}

            
render() public method

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

渲染视图。

要渲染的视图可以以下列格式之一指定

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

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

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

视图名称。

$params 数组

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

return 字符串

渲染结果。

throws yii\base\InvalidArgumentException

如果视图文件不存在。

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

            
renderFile() 公共方法

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

渲染视图文件。

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

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

$params 数组

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

return 字符串

渲染结果。

throws yii\base\InvalidArgumentException

如果视图文件不存在。

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

            
requiresPjax() 受保护方法

protected boolean requiresPjax ( )
return 布尔值

当前请求是否需要此小部件的 pjax 响应

                protected function requiresPjax()
{
    $headers = Yii::$app->getRequest()->getHeaders();
    return $headers->get('X-Pjax') && explode(' ', $headers->get('X-Pjax-Container'))[0] === '#' . $this->options['id'];
}

            
run() 公共方法

执行小部件。

public string|void run ( )
return string|void

渲染结果可以直接“回显”或作为字符串返回

                public function run()
{
    if (!$this->requiresPjax()) {
        echo Html::endTag(ArrayHelper::remove($this->options, 'tag', 'div'));
        $this->registerClientScript();
        return;
    }
    $view = $this->getView();
    $view->endBody();
    $view->endPage(true);
    $content = ob_get_clean();
    // only need the content enclosed within this widget
    $response = Yii::$app->getResponse();
    $response->clearOutputBuffers();
    $response->setStatusCode(200);
    $response->format = Response::FORMAT_HTML;
    $response->content = $content;
    $response->headers->setDefault('X-Pjax-Url', Yii::$app->request->url);
    Yii::$app->end();
}

            
setId() 公共方法

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

设置窗口小部件的 ID。

public void setId ( $value )
$value 字符串

小部件的 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 字符串

事件名称

$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 string widget ( $config = [] )
$config 数组

将用于初始化对象属性的键值对

return 字符串

小部件的渲染结果。

throws 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;
}