Class yii\widgets\LinkSorter

Inheritanceyii\widgets\LinkSorter » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/widgets/LinkSorter.php

LinkSorter renders a list of sort links for the given sort definition.

LinkSorter will generate a hyperlink for every attribute declared in $sort.

For more details and usage information on LinkSorter, see the guide article on sorting.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attributes array List of the attributes that support sorting. yii\widgets\LinkSorter
$autoIdPrefix string The prefix to the automatically generated widget IDs. yii\base\Widget
$counter integer A counter used to generate \yii\base\id for widgets. yii\base\Widget
$linkOptions array HTML attributes for the link in a sorter container tag which are passed to yii\data\Sort::link(). yii\widgets\LinkSorter
$options array HTML attributes for the sorter container tag. yii\widgets\LinkSorter
$sort yii\data\Sort The sort definition yii\widgets\LinkSorter
$stack yii\base\Widget[] The widgets that are currently being rendered (not ended). yii\base\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
afterRun() This method is invoked right after a widget is executed. yii\base\Widget
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeRun() This method is invoked right before the widget is executed. yii\base\Widget
begin() Begins a widget. yii\base\Widget
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
end() Ends a widget. yii\base\Widget
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getId() Returns the ID of the widget. yii\base\Widget
getView() Returns the view object that can be used to render views or view files. yii\base\Widget
getViewPath() Returns the directory containing the view files for this widget. yii\base\Widget
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the sorter. yii\widgets\LinkSorter
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
render() Renders a view. yii\base\Widget
renderFile() Renders a view file. yii\base\Widget
run() Executes the widget. yii\widgets\LinkSorter
setId() Sets the ID of the widget. yii\base\Widget
setView() Sets the view object to be used by this widget. yii\base\Widget
trigger() Triggers an event. yii\base\Component
widget() Creates a widget instance and runs it. yii\base\Widget

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
renderSortLinks() Renders the sort links. yii\widgets\LinkSorter

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_RUN yii\base\WidgetEvent An event raised right after executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent An event raised right before executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) yii\base\Widget

Property Details

$attributes public property

List of the attributes that support sorting. If not set, it will be determined using yii\data\Sort::$attributes.

public array $attributes null
$linkOptions public property (available since version 2.0.6)

HTML attributes for the link in a sorter container tag which are passed to yii\data\Sort::link().

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $linkOptions = []
$options public property

HTML attributes for the sorter container tag.

See also:

public array $options = ['class' => 'sorter']
$sort public property

The sort definition

public yii\data\Sort $sort null

Method Details

init() public method

Initializes the sorter.

public void init ( )
renderSortLinks() protected method

Renders the sort links.

protected string renderSortLinks ( )
return string

The rendering result

run() public method

Executes the widget.

This method renders the sort links.

public void run ( )