Pjax

API reference › yii › widgets › Pjax

class	`yii\widgets\Pjax`
Extends	`yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/widgets/Pjax.php`

Pjax is a widget integrating the pjax jQuery plugin.

Pjax only deals with the content enclosed between its begin() and end() calls, called the body content of the widget. By default, any link click or form submission (for those forms with data-pjax attribute) within the body content will trigger an AJAX request. In responding to the AJAX request, Pjax will send the updated body content (based on the AJAX request) to the client which will replace the old content with the new one. The browser’s URL will then be updated using pushState. The whole process requires no reloading of the layout or resources (js, css).

You may configure $linkSelector to specify which links should trigger pjax, and configure $formSelector to specify which form submission may trigger pjax.

You may disable pjax for a specific link inside the container by adding data-pjax="0" attribute to this link.

The following example shows how to use Pjax with the GridView widget so that the grid pagination, sorting and filtering can be done via pjax:

use yii\widgets\Pjax;

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

Properties

Property	Type	Description	Defined by
`$autoIdPrefix` static	`string`	Default: `'p'`.	`Pjax`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$clientOptions`	`array`	Additional options to be passed to the pjax JS plugin. Default: `null`.	`Pjax`
`$enablePushState`	`bool`	Whether to enable push state. Default: `true`.	`Pjax`
`$enableReplaceState`	`bool`	Whether to enable replace state. Default: `false`.	`Pjax`
`$formSelector`	`string\|null\|false`	The jQuery selector of the forms whose submissions should trigger pjax requests. Default: `null`.	`Pjax`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$linkSelector`	`string\|null\|false`	The jQuery selector of the links that should trigger pjax requests. Default: `null`.	`Pjax`
`$options`	`array`	The HTML attributes for the widget container tag. Default: `[]`.	`Pjax`
`$scrollTo`	`bool\|int`	How to scroll the page when pjax response is received. Default: `false`.	`Pjax`
`$submitEvent`	`string`	The jQuery event that will trigger form handler. Default: `'submit'`. Available since 2.0.9.	`Pjax`
`$timeout`	`int`	Pjax timeout setting (in milliseconds). Default: `1000`.	`Pjax`
`$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 object.	`Pjax`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`registerClientScript()`	Registers the needed JavaScript.	`Pjax`
`render()`	Renders a view.	`yii\base\Widget`
`renderFile()`	Renders a view file.	`yii\base\Widget`
`run()`	Executes the widget.	`Pjax`
`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`
`requiresPjax()` protected		`Pjax`

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

$clientOptions

public array $clientOptions = null

Additional options to be passed to the pjax JS plugin.

Please refer to the pjax project page for available options.

$formSelector

public string|null|false $formSelector = null

The jQuery selector of the forms whose submissions should trigger pjax requests.

If not set, all forms with data-pjax attribute within the enclosed content of Pjax will trigger pjax requests. If set to false, no code will be registered to handle forms. Note that if the response to the pjax request is a full page, a normal request will be sent again.

$linkSelector

public string|null|false $linkSelector = null

The jQuery selector of the links that should trigger pjax requests.

If not set, all links within the enclosed content of Pjax will trigger pjax requests. If set to false, no code will be registered to handle links. Note that if the response to the pjax request is a full page, a normal request will be sent again.

$options

public array $options = []

The HTML attributes for the widget container tag.

The following special options are recognized:

tag: string, the tag name for the container. Defaults to div This option is available since version 2.0.7. See also Html::tag().

$scrollTo

public bool|int $scrollTo = false

How to scroll the page when pjax response is received.

If false, no page scroll will be made. Use a number if you want to scroll to a particular place.

$submitEvent

public string $submitEvent = 'submit'

The jQuery event that will trigger form handler.

Defaults to “submit”.

Since

2.0.9

$timeout

public int $timeout = 1000

Pjax timeout setting (in milliseconds).

This timeout is used when making AJAX requests. Use a bigger number if your server is slow. If the server does not respond within the timeout, a full page load will be triggered.

Method details

init()

public function init(): mixed

Initializes the object.

This method is called at the end of the constructor. The default implementation will trigger an EVENT_INIT event.

Returns

mixed

registerClientScript()

public function registerClientScript(): mixed

Registers the needed JavaScript.

Returns

mixed

run()

public function run(): string|void

Executes the widget.

Returns

string|void: The rendering result may be directly “echoed” or returned as a string

requiresPjax()

protected function requiresPjax(): bool

Returns

bool: Whether the current request requires pjax response from this widget