1 关注者

类 yii\widgets\LinkPager

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

LinkPager 显示一个超链接列表,这些链接指向目标的不同页面。

LinkPager 与一个 yii\data\Pagination 对象一起工作,该对象指定页面的总数和当前页码。

请注意,LinkPager 仅生成必要的 HTML 标记。为了使其看起来像一个真正的分页器,您应该为其提供一些 CSS 样式。使用默认配置,LinkPager 应该可以使用 Twitter Bootstrap CSS 框架很好地显示。

有关 LinkPager 的更多详细信息和使用信息,请参阅 分页指南文章

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$activePageCssClass string 活动(当前选定)页面按钮的 CSS 类。 yii\widgets\LinkPager
$autoIdPrefix string 自动生成的部件 ID 的前缀。 yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$disableCurrentPageButton boolean 是否将当前页面按钮呈现为禁用状态。 yii\widgets\LinkPager
$disabledListItemSubTagOptions array 将在禁用的列表元素内生成的禁用标签的选项。 yii\widgets\LinkPager
$disabledPageCssClass string 禁用页面按钮的 CSS 类。 yii\widgets\LinkPager
$firstPageCssClass string “第一”页面按钮的 CSS 类。 yii\widgets\LinkPager
$firstPageLabel string|boolean “第一”页面按钮的文本标签。 yii\widgets\LinkPager
$hideOnSinglePage boolean 当只有一页时隐藏部件。 yii\widgets\LinkPager
$id string|null 部件的 ID。 yii\base\Widget
$lastPageCssClass string “最后”页面按钮的 CSS 类。 yii\widgets\LinkPager
$lastPageLabel string|boolean “最后”页面按钮的文本标签。 yii\widgets\LinkPager
$linkContainerOptions array 将应用于所有链接容器的 HTML 属性 yii\widgets\LinkPager
$linkOptions array 分页器容器标签中链接的 HTML 属性。 yii\widgets\LinkPager
$maxButtonCount integer 可以显示的页面按钮的最大数量。 yii\widgets\LinkPager
$nextPageCssClass string “下一页”按钮的 CSS 类。 yii\widgets\LinkPager
$nextPageLabel string|boolean “下一页”按钮的标签。 yii\widgets\LinkPager
$options array 分页器容器标签的 HTML 属性。 yii\widgets\LinkPager
$pageCssClass string 每个页面按钮的 CSS 类。 yii\widgets\LinkPager
$pagination yii\data\Pagination 此分页器关联的分页对象。 yii\widgets\LinkPager
$prevPageCssClass string “上一页”按钮的 CSS 类。 yii\widgets\LinkPager
$prevPageLabel string|boolean “上一页”按钮的文本标签。 yii\widgets\LinkPager
$registerLinkTags boolean 是否在 HTML 头部注册上一页、下一页、第一页和最后一页的链接标签。 yii\widgets\LinkPager
$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\LinkPager
off() 从此组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
render() 渲染视图。 yii\base\Widget
renderFile() 渲染视图文件。 yii\base\Widget
run() 执行部件。 yii\widgets\LinkPager
setId() 设置部件的 ID。 yii\base\Widget
setView() 设置此部件要使用的视图对象。 yii\base\Widget
trigger() 触发事件。 yii\base\Component
widget() 创建部件实例并运行它。 yii\base\Widget

受保护的方法

隐藏继承的方法

方法 描述 定义于
getPageRange() yii\widgets\LinkPager
registerLinkTags() 在 html 头部为上一页、下一页、第一页和最后一页注册关系链接标签。 yii\widgets\LinkPager
renderPageButton() 渲染页面按钮。 yii\widgets\LinkPager
renderPageButtons() 渲染页面按钮。 yii\widgets\LinkPager

事件

隐藏继承的事件

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

属性详情

隐藏继承的属性

$activePageCssClass 公共属性

活动(当前选定)页面按钮的 CSS 类。

public string $activePageCssClass 'active'
$disableCurrentPageButton 公共属性 (自版本 2.0.12 起可用)

是否将当前页面按钮呈现为禁用状态。

$disabledListItemSubTagOptions 公共属性 (自版本 2.0.11 起可用)

禁用列表元素内生成禁用标签的选项。为了自定义 html 标签,请使用 tag 键。

$disabledListItemSubTagOptions = ['tag' => 'div', 'class' => 'disabled-div'];
$disabledPageCssClass 公共属性

禁用页面按钮的 CSS 类。

public string $disabledPageCssClass 'disabled'
$firstPageCssClass 公共属性

“第一”页面按钮的 CSS 类。

public string $firstPageCssClass 'first'
$firstPageLabel 公共属性

"首页" 按钮的文本标签。请注意,这将不会进行 HTML 编码。如果将其指定为 true,则页面号将用作标签。默认为 false,这意味着不会显示“首页”按钮。

$hideOnSinglePage 公共属性

当只有一页时隐藏部件。

public boolean $hideOnSinglePage true
$lastPageCssClass 公共属性

“最后”页面按钮的 CSS 类。

public string $lastPageCssClass 'last'
$lastPageLabel 公共属性

"末页" 按钮的文本标签。请注意,这将不会进行 HTML 编码。如果将其指定为 true,则页面号将用作标签。默认为 false,这意味着不会显示“末页”按钮。

public string|boolean $lastPageLabel false
$linkContainerOptions 公共属性 (自版本 2.0.13 起可用)

将应用于所有链接容器的 HTML 属性

$linkOptions 公共属性

分页器容器标签中链接的 HTML 属性。

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

public array $linkOptions = []
$maxButtonCount 公共属性

可以显示的页面按钮的最大数量。默认为 10。

$nextPageCssClass 公共属性

“下一页”按钮的 CSS 类。

public string $nextPageCssClass 'next'
$nextPageLabel 公共属性

"下一页" 按钮的标签。请注意,这将不会进行 HTML 编码。如果此属性为 false,则不会显示“下一页”按钮。

public string|boolean $nextPageLabel '»'
$options 公共属性

分页器容器标签的 HTML 属性。

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

public array $options = [
    
'class' => 'pagination',
]

$pageCssClass 公共属性 (自版本 2.0.7 起可用)

每个页面按钮的 CSS 类。

public string $pageCssClass null
$pagination 公共属性

此分页器关联的分页对象。您必须设置此属性才能使 LinkPager 工作。

$prevPageCssClass 公共属性

“上一页”按钮的 CSS 类。

public string $prevPageCssClass 'prev'
$prevPageLabel 公共属性

"上一页"按钮的文本标签。请注意,这将不会进行 HTML 编码。如果此属性为 false,则不会显示“上一页”按钮。

public string|boolean $prevPageLabel '«'
$registerLinkTags 公共属性

是否在 HTML 头部注册上一页、下一页、首页和最后一页的链接标签。默认为 false 以避免在同一页面上使用多个分页器时发生冲突。

另请参阅

public boolean $registerLinkTags false

方法详情

隐藏继承的方法

__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 boolean __isset ( $name )
$name string

属性名称或事件名称

返回值 boolean

命名属性是否已设置

                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 mixed 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 ( )
返回值 boolean

小部件是否应该继续执行。

                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 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 数组 behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

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

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

如果满足以下条件,则可以读取属性

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

另请参阅 canSetProperty()

public 布尔值 canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

返回值 boolean

属性是否可读

                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 布尔值 canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

返回值 boolean

属性是否可写

                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 boolean

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

返回值 string|null

部件的 ID。

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

            
getPageRange() 受保护方法

protected array getPageRange ( )
返回值 array

需要显示的开始和结束页码。

                protected function getPageRange()
{
    $currentPage = $this->pagination->getPage();
    $pageCount = $this->pagination->getPageCount();
    $beginPage = max(0, $currentPage - (int) ($this->maxButtonCount / 2));
    if (($endPage = $beginPage + $this->maxButtonCount - 1) >= $pageCount) {
        $endPage = $pageCount - 1;
        $beginPage = max(0, $endPage - $this->maxButtonCount + 1);
    }
    return [$beginPage, $endPage];
}

            
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

事件名称

返回值 boolean

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

                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 boolean

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

返回值 boolean

方法是否已定义

                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 boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

返回值 boolean

属性是否已定义

                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->pagination === null) {
        throw new InvalidConfigException('The "pagination" property must be set.');
    }
}

            
off() 公共方法

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

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

此方法与 on() 相反。

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

另请参阅 on()

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

事件名称

$handler callable|null

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

返回值 boolean

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

                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 boolean

是否将新的事件处理程序附加到现有处理程序列表的末尾。如果为 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]);
    }
}

            
registerLinkTags() 受保护方法

在 html 头部为上一页、下一页、第一页和最后一页注册关系链接标签。

这些链接是使用 yii\data\Pagination::getLinks() 生成的。

另请参阅 https://www.w3.org/TR/html401/struct/links.html#h-12.1.2

protected void registerLinkTags ( )

                protected function registerLinkTags()
{
    $view = $this->getView();
    foreach ($this->pagination->getLinks() as $rel => $href) {
        $view->registerLinkTag(['rel' => $rel, 'href' => $href], $rel);
    }
}

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

            
renderFile() 公共方法

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

渲染视图文件。

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

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

$params array

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

返回值 string

渲染结果。

抛出异常 yii\base\InvalidArgumentException

如果视图文件不存在。

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

            
renderPageButton() 受保护方法

渲染页面按钮。

您可以覆盖此方法来自定义页面按钮的生成。

protected string renderPageButton ( $label, $page, $class, $disabled, $active )
$label string

按钮的文本标签

$page integer

页码

$class string

页面按钮的 CSS 类。

$disabled boolean

此页面按钮是否已禁用

$active boolean

此页面按钮是否处于活动状态

返回值 string

渲染结果

                protected function renderPageButton($label, $page, $class, $disabled, $active)
{
    $options = $this->linkContainerOptions;
    $linkWrapTag = ArrayHelper::remove($options, 'tag', 'li');
    Html::addCssClass($options, empty($class) ? $this->pageCssClass : $class);
    if ($active) {
        Html::addCssClass($options, $this->activePageCssClass);
    }
    if ($disabled) {
        Html::addCssClass($options, $this->disabledPageCssClass);
        $disabledItemOptions = $this->disabledListItemSubTagOptions;
        $tag = ArrayHelper::remove($disabledItemOptions, 'tag', 'span');
        return Html::tag($linkWrapTag, Html::tag($tag, $label, $disabledItemOptions), $options);
    }
    $linkOptions = $this->linkOptions;
    $linkOptions['data-page'] = $page;
    return Html::tag($linkWrapTag, Html::a($label, $this->pagination->createUrl($page), $linkOptions), $options);
}

            
renderPageButtons() 受保护方法

渲染页面按钮。

protected string renderPageButtons ( )
返回值 string

渲染结果

                protected function renderPageButtons()
{
    $pageCount = $this->pagination->getPageCount();
    if ($pageCount < 2 && $this->hideOnSinglePage) {
        return '';
    }
    $buttons = [];
    $currentPage = $this->pagination->getPage();
    // first page
    $firstPageLabel = $this->firstPageLabel === true ? '1' : $this->firstPageLabel;
    if ($firstPageLabel !== false) {
        $buttons[] = $this->renderPageButton($firstPageLabel, 0, $this->firstPageCssClass, $currentPage <= 0, false);
    }
    // prev page
    if ($this->prevPageLabel !== false) {
        if (($page = $currentPage - 1) < 0) {
            $page = 0;
        }
        $buttons[] = $this->renderPageButton($this->prevPageLabel, $page, $this->prevPageCssClass, $currentPage <= 0, false);
    }
    // internal pages
    list($beginPage, $endPage) = $this->getPageRange();
    for ($i = $beginPage; $i <= $endPage; ++$i) {
        $buttons[] = $this->renderPageButton($i + 1, $i, null, $this->disableCurrentPageButton && $i == $currentPage, $i == $currentPage);
    }
    // next page
    if ($this->nextPageLabel !== false) {
        if (($page = $currentPage + 1) >= $pageCount - 1) {
            $page = $pageCount - 1;
        }
        $buttons[] = $this->renderPageButton($this->nextPageLabel, $page, $this->nextPageCssClass, $currentPage >= $pageCount - 1, false);
    }
    // last page
    $lastPageLabel = $this->lastPageLabel === true ? $pageCount : $this->lastPageLabel;
    if ($lastPageLabel !== false) {
        $buttons[] = $this->renderPageButton($lastPageLabel, $pageCount - 1, $this->lastPageCssClass, $currentPage >= $pageCount - 1, false);
    }
    $options = $this->options;
    $tag = ArrayHelper::remove($options, 'tag', 'ul');
    return Html::tag($tag, implode("\n", $buttons), $options);
}

            
run() 公共方法

执行部件。

此方法覆盖了父实现,方法是显示生成的页面按钮。

public void run ( )

                public function run()
{
    if ($this->registerLinkTags) {
        $this->registerLinkTags();
    }
    echo $this->renderPageButtons();
}

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