LinkSorter

API reference › yii › widgets › LinkSorter

class	`yii\widgets\LinkSorter`
Extends	`yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Since	2.0
Source	`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.

Properties

Property	Type	Description	Defined by
`$attributes`	`array\|null`	List of the attributes that support sorting. Default: `null`.	`LinkSorter`
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$linkOptions`	`array`	HTML attributes for the link in a sorter container tag which are passed to `Sort::link()`. Default: `[]`. Available since 2.0.6.	`LinkSorter`
`$options`	`array`	HTML attributes for the sorter container tag. Default: `['class' => 'sorter']`.	`LinkSorter`
`$sort`	`yii\data\Sort\|null`	The sort definition Default: `null`.	`LinkSorter`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Widget`
`$viewPath` read-only	`string`	The directory containing the view files for this widget.	`yii\base\Widget`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__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`
`__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()` static	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()` static	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()` static	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.	`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.	`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()` static	Creates a widget instance and runs it.	`yii\base\Widget`
`renderSortLinks()` protected	Renders the sort links.	`LinkSorter`

Events

Event	Type	Description	Defined by
`EVENT_INIT`	`yii\base\Event`	An event that is triggered when the widget is initialized via `init()`. Event name: `'init'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_BEFORE_RUN`	`yii\base\WidgetEvent`	An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_AFTER_RUN`	`yii\base\WidgetEvent`	An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11.	`yii\base\Widget`

Property details

$attributes

public array|null $attributes = null

List of the attributes that support sorting.

If not set, it will be determined using Sort::$attributes.

Method details

init()

public function init(): mixed

Initializes the sorter.

Returns

mixed

run()

public function run(): mixed

Executes the widget.

This method renders the sort links.

Returns

mixed

renderSortLinks()

protected function renderSortLinks(): string

Renders the sort links.

Returns

string: The rendering result