Класс yii\widgets\Pjax

Pjax — это виджет, интегрирующий плагин jQuery pjax.

Pjax работает только с содержимым, заключённым между вызовами begin() и end(), называемым содержимым тела виджета. По умолчанию, любой клик по ссылке или отправка формы (для форм с атрибутом data-pjax ) внутри содержимого тела будет запускать AJAX-запрос. В ответ на AJAX-запрос Pjax отправит обновлённое содержимое тела (на основе AJAX-запроса) клиенту, который заменит старое содержимое новым. Адрес браузера затем будет обновлён с помощью pushState. Весь процесс не требует перезагрузки макета или ресурсов (js, css).

Вы можете настроить $linkSelector для указания, какие ссылки должны запускать pjax, и настроить $formSelector для указания, какая отправка форм может запускать pjax.

Вы можете отключить pjax для определённой ссылки внутри контейнера, добавив атрибут data-pjax="0" к этой ссылке.

Следующий пример показывает, как использовать Pjax с виджетом yii\grid\GridView, чтобы постраничная навигация, сортировка и фильтрация грида могли выполняться с помощью pjax:

use yii\widgets\Pjax;

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

Публичные свойства

Публичные методы

Защищенные методы

События

Подробное описание свойств

$autoIdPrefix общедоступное статическое свойство

Префикс для автоматически сгенерированных идентификаторов виджетов.

public static string $autoIdPrefix = 'p'

$clientOptions общедоступное свойство

Дополнительные параметры, которые нужно передать в плагин pjax JS. Обратитесь к странице проекта pjax для получения доступных параметров.

public array $clientOptions = null

$counter общедоступное статическое свойство

Счётчик, используемый для генерации $id для виджетов.

public static integer $counter = 0

$enablePushState общедоступное свойство

Включить ли push state.

public boolean $enablePushState = true

$enableReplaceState общедоступное свойство

Включить ли replace state.

public boolean $enableReplaceState = false

$formSelector общедоступное свойство

Селектор jQuery форм, отправка которых должна вызывать запросы pjax. Если не задано, все формы с data-pjax атрибутом внутри содержащегося контента Pjax будут вызывать запросы pjax. Если установлено в false, никакой код не будет зарегистрирован для обработки форм. Обратите внимание, что если ответ на запрос pjax является полной страницей, то нормальный запрос будет отправлен снова.

public string|false $formSelector = null

$linkSelector общедоступное свойство

Выборщик jQuery для ссылок, которые должны вызывать запросы pjax. Если не задано, все ссылки внутри заключенного содержимого Pjax будут вызывать запросы pjax. Если установлено в false, никакой код не будет зарегистрирован для обработки ссылок. Обратите внимание, что если ответ на запрос pjax — полная страница, то будет отправлен обычный запрос.

public string|false $linkSelector = null

$options общественное свойство

Атрибуты HTML для тега контейнера виджета. Распознаются следующие специальные опции:

• tag: строка, имя тега для контейнера. По умолчанию div Эта опция доступна начиная с версии 2.0.7. См. также yii\helpers\Html::tag().

См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.

public array $options = []

$scrollTo общественное свойство

Способ прокрутки страницы при получении ответа pjax. Если false, прокрутка страницы не будет выполнена. Используйте число, если нужно прокрутить до определённого места.

public boolean|integer $scrollTo = false

$submitEvent общественное свойство (доступно начиная с версии 2.0.9)

Событие jQuery, которое будет запускать обработчик формы. По умолчанию "submit".

public string $submitEvent = 'submit'

$timeout общественное свойство

Настройка таймаута pjax (в миллисекундах). Этот таймаут используется при выполнении AJAX-запросов. Используйте большее число, если ваш сервер медленный. Если сервер не отвечает в течение таймаута, будет выполнена полная загрузка страницы.

public integer $timeout = 1000

Подробное описание методов