Class yii\widgets\Pjax

Inheritance	yii\widgets\Pjax » yii\base\Widget » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/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 yii\grid\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();

Public Properties

Property	Type	Description	Defined By
$autoIdPrefix	string	The prefix to the automatically generated widget IDs.	yii\widgets\Pjax
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$clientOptions	array	Additional options to be passed to the pjax JS plugin.	yii\widgets\Pjax
$counter	integer	A counter used to generate $id for widgets.	yii\widgets\Pjax
$enablePushState	boolean	Whether to enable push state.	yii\widgets\Pjax
$enableReplaceState	boolean	Whether to enable replace state.	yii\widgets\Pjax
$formSelector	string|false	The jQuery selector of the forms whose submissions should trigger pjax requests.	yii\widgets\Pjax
$id	string	ID of the widget.	yii\base\Widget
$linkSelector	string|false	The jQuery selector of the links that should trigger pjax requests.	yii\widgets\Pjax
$options	array	The HTML attributes for the widget container tag.	yii\widgets\Pjax
$scrollTo	boolean|integer	How to scroll the page when pjax response is received.	yii\widgets\Pjax
$stack	yii\base\Widget[]	The widgets that are currently being rendered (not ended).	yii\base\Widget
$submitEvent	string	The jQuery event that will trigger form handler.	yii\widgets\Pjax
$timeout	integer	Pjax timeout setting (in milliseconds).	yii\widgets\Pjax
$view	yii\web\View	The view object that can be used to render views or view files.	yii\base\Widget
$viewPath	string	The directory containing the view files for this widget.	yii\base\Widget

Public Methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\Object
__get()	Returns the value of an object property.	yii\base\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__unset()	Sets an object property to null.	yii\base\Object
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\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
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\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
init()	Initializes the object.	yii\widgets\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.	yii\widgets\Pjax
render()	Renders a view.	yii\base\Widget
renderFile()	Renders a view file.	yii\base\Widget
run()	Executes the widget.	yii\widgets\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()	Creates a widget instance and runs it.	yii\base\Widget

Protected Methods

Method	Description	Defined By
requiresPjax()		yii\widgets\Pjax

Events

Event	Type	Description	Defined 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

$autoIdPrefix public static property

The prefix to the automatically generated widget IDs.

public static string $autoIdPrefix = 'p'

$clientOptions public property

Additional options to be passed to the pjax JS plugin. Please refer to the pjax project page for available options.

public array $clientOptions = null

$counter public static property

A counter used to generate $id for widgets.

public static integer $counter = 0

$enablePushState public property

Whether to enable push state.

public boolean $enablePushState = true

$enableReplaceState public property

Whether to enable replace state.

public boolean $enableReplaceState = false

$formSelector public property

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.

public string|false $formSelector = null

$linkSelector public property

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.

public string|false $linkSelector = null

$options public property

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 yii\helpers\Html::tag().

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

public array $options = []

$scrollTo public property

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.

public boolean|integer $scrollTo = false

$submitEvent public property (available since version 2.0.9)

The jQuery event that will trigger form handler. Defaults to "submit".

public string $submitEvent = 'submit'

$timeout public property

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.

public integer $timeout = 1000

Method Details