1 | <?php |
||
2 | /** |
||
3 | * @link https://www.yiiframework.com/ |
||
4 | * @copyright Copyright (c) 2008 Yii Software LLC |
||
5 | * @license https://www.yiiframework.com/license/ |
||
6 | */ |
||
7 | |||
8 | namespace yii\widgets; |
||
9 | |||
10 | use Yii; |
||
11 | use yii\base\Widget; |
||
12 | use yii\helpers\ArrayHelper; |
||
13 | use yii\helpers\Html; |
||
14 | use yii\helpers\Json; |
||
15 | use yii\web\Response; |
||
16 | |||
17 | /** |
||
18 | * Pjax is a widget integrating the [pjax](https://github.com/yiisoft/jquery-pjax) jQuery plugin. |
||
19 | * |
||
20 | * Pjax only deals with the content enclosed between its [[begin()]] and [[end()]] calls, called the *body content* of the widget. |
||
21 | * By default, any link click or form submission (for those forms with `data-pjax` attribute) within the body content |
||
22 | * will trigger an AJAX request. In responding to the AJAX request, Pjax will send the updated body content (based |
||
23 | * on the AJAX request) to the client which will replace the old content with the new one. The browser's URL will then |
||
24 | * be updated using pushState. The whole process requires no reloading of the layout or resources (js, css). |
||
25 | * |
||
26 | * You may configure [[linkSelector]] to specify which links should trigger pjax, and configure [[formSelector]] |
||
27 | * to specify which form submission may trigger pjax. |
||
28 | * |
||
29 | * You may disable pjax for a specific link inside the container by adding `data-pjax="0"` attribute to this link. |
||
30 | * |
||
31 | * The following example shows how to use Pjax with the [[\yii\grid\GridView]] widget so that the grid pagination, |
||
32 | * sorting and filtering can be done via pjax: |
||
33 | * |
||
34 | * ```php |
||
35 | * use yii\widgets\Pjax; |
||
36 | * |
||
37 | * Pjax::begin(); |
||
38 | * echo GridView::widget([...]); |
||
39 | * Pjax::end(); |
||
40 | * ``` |
||
41 | * |
||
42 | * @author Qiang Xue <[email protected]> |
||
43 | * @since 2.0 |
||
44 | */ |
||
45 | class Pjax extends Widget |
||
46 | { |
||
47 | /** |
||
48 | * @var array the HTML attributes for the widget container tag. The following special options are recognized: |
||
49 | * |
||
50 | * - `tag`: string, the tag name for the container. Defaults to `div` |
||
51 | * This option is available since version 2.0.7. |
||
52 | * See also [[\yii\helpers\Html::tag()]]. |
||
53 | * |
||
54 | * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered. |
||
55 | */ |
||
56 | public $options = []; |
||
57 | /** |
||
58 | * @var string|null|false the jQuery selector of the links that should trigger pjax requests. |
||
59 | * If not set, all links within the enclosed content of Pjax will trigger pjax requests. |
||
60 | * If set to false, no code will be registered to handle links. |
||
61 | * Note that if the response to the pjax request is a full page, a normal request will be sent again. |
||
62 | */ |
||
63 | public $linkSelector; |
||
64 | /** |
||
65 | * @var string|null|false the jQuery selector of the forms whose submissions should trigger pjax requests. |
||
66 | * If not set, all forms with `data-pjax` attribute within the enclosed content of Pjax will trigger pjax requests. |
||
67 | * If set to false, no code will be registered to handle forms. |
||
68 | * Note that if the response to the pjax request is a full page, a normal request will be sent again. |
||
69 | */ |
||
70 | public $formSelector; |
||
71 | /** |
||
72 | * @var string The jQuery event that will trigger form handler. Defaults to "submit". |
||
73 | * @since 2.0.9 |
||
74 | */ |
||
75 | public $submitEvent = 'submit'; |
||
76 | /** |
||
77 | * @var bool whether to enable push state. |
||
78 | */ |
||
79 | public $enablePushState = true; |
||
80 | /** |
||
81 | * @var bool whether to enable replace state. |
||
82 | */ |
||
83 | public $enableReplaceState = false; |
||
84 | /** |
||
85 | * @var int pjax timeout setting (in milliseconds). This timeout is used when making AJAX requests. |
||
86 | * Use a bigger number if your server is slow. If the server does not respond within the timeout, |
||
87 | * a full page load will be triggered. |
||
88 | */ |
||
89 | public $timeout = 1000; |
||
90 | /** |
||
91 | * @var bool|int how to scroll the page when pjax response is received. If false, no page scroll will be made. |
||
92 | * Use a number if you want to scroll to a particular place. |
||
93 | */ |
||
94 | public $scrollTo = false; |
||
95 | /** |
||
96 | * @var array additional options to be passed to the pjax JS plugin. Please refer to the |
||
97 | * [pjax project page](https://github.com/yiisoft/jquery-pjax) for available options. |
||
98 | */ |
||
99 | public $clientOptions; |
||
100 | /** |
||
101 | * {@inheritdoc} |
||
102 | * @internal |
||
103 | */ |
||
104 | public static $counter = 0; |
||
105 | /** |
||
106 | * {@inheritdoc} |
||
107 | */ |
||
108 | public static $autoIdPrefix = 'p'; |
||
109 | |||
110 | |||
111 | /** |
||
112 | * {@inheritdoc} |
||
113 | */ |
||
114 | 2 | public function init() |
|
115 | { |
||
116 | 2 | parent::init(); |
|
117 | 2 | if (!isset($this->options['id'])) { |
|
118 | 2 | $this->options['id'] = $this->getId(); |
|
119 | } |
||
120 | |||
121 | 2 | if ($this->requiresPjax()) { |
|
122 | ob_start(); |
||
123 | ob_implicit_flush(false); |
||
124 | $view = $this->getView(); |
||
125 | $view->clear(); |
||
126 | $view->beginPage(); |
||
127 | $view->head(); |
||
128 | $view->beginBody(); |
||
129 | if ($view->title !== null) { |
||
130 | echo Html::tag('title', Html::encode($view->title)); |
||
131 | } |
||
132 | } else { |
||
133 | 2 | $options = $this->options; |
|
134 | 2 | $tag = ArrayHelper::remove($options, 'tag', 'div'); |
|
135 | 2 | echo Html::beginTag($tag, array_merge([ |
|
136 | 2 | 'data-pjax-container' => '', |
|
137 | 2 | 'data-pjax-push-state' => $this->enablePushState, |
|
138 | 2 | 'data-pjax-replace-state' => $this->enableReplaceState, |
|
139 | 2 | 'data-pjax-timeout' => $this->timeout, |
|
140 | 2 | 'data-pjax-scrollto' => $this->scrollTo, |
|
141 | 2 | ], $options)); |
|
142 | } |
||
143 | } |
||
144 | |||
145 | /** |
||
146 | * {@inheritdoc} |
||
147 | */ |
||
148 | public function run() |
||
149 | { |
||
150 | if (!$this->requiresPjax()) { |
||
151 | echo Html::endTag(ArrayHelper::remove($this->options, 'tag', 'div')); |
||
152 | $this->registerClientScript(); |
||
153 | |||
154 | return; |
||
155 | } |
||
156 | |||
157 | $view = $this->getView(); |
||
158 | $view->endBody(); |
||
159 | |||
160 | $view->endPage(true); |
||
161 | |||
162 | $content = ob_get_clean(); |
||
163 | |||
164 | // only need the content enclosed within this widget |
||
165 | $response = Yii::$app->getResponse(); |
||
166 | $response->clearOutputBuffers(); |
||
167 | $response->setStatusCode(200); |
||
168 | $response->format = Response::FORMAT_HTML; |
||
0 ignored issues
–
show
Bug
Best Practice
introduced
by
Loading history...
|
|||
169 | $response->content = $content; |
||
0 ignored issues
–
show
The property
content does not exist on yii\console\Response . Since you implemented __set , consider adding a @property annotation.
Loading history...
|
|||
170 | $response->headers->setDefault('X-Pjax-Url', Yii::$app->request->url); |
||
0 ignored issues
–
show
The property
headers does not exist on yii\console\Response . Since you implemented __get , consider adding a @property annotation.
Loading history...
The property
url does not exist on yii\console\Request . Since you implemented __get , consider adding a @property annotation.
Loading history...
|
|||
171 | |||
172 | Yii::$app->end(); |
||
173 | } |
||
174 | |||
175 | /** |
||
176 | * @return bool whether the current request requires pjax response from this widget |
||
177 | */ |
||
178 | 2 | protected function requiresPjax() |
|
179 | { |
||
180 | 2 | $headers = Yii::$app->getRequest()->getHeaders(); |
|
181 | |||
182 | 2 | return $headers->get('X-Pjax') && explode(' ', $headers->get('X-Pjax-Container'))[0] === '#' . $this->options['id']; |
|
183 | } |
||
184 | |||
185 | /** |
||
186 | * Registers the needed JavaScript. |
||
187 | */ |
||
188 | public function registerClientScript() |
||
189 | { |
||
190 | $id = $this->options['id']; |
||
191 | $this->clientOptions['push'] = $this->enablePushState; |
||
192 | $this->clientOptions['replace'] = $this->enableReplaceState; |
||
193 | $this->clientOptions['timeout'] = $this->timeout; |
||
194 | $this->clientOptions['scrollTo'] = $this->scrollTo; |
||
195 | if (!isset($this->clientOptions['container'])) { |
||
196 | $this->clientOptions['container'] = "#$id"; |
||
197 | } |
||
198 | $options = Json::htmlEncode($this->clientOptions); |
||
199 | $js = ''; |
||
200 | if ($this->linkSelector !== false) { |
||
201 | $linkSelector = Json::htmlEncode($this->linkSelector !== null ? $this->linkSelector : '#' . $id . ' a'); |
||
202 | $js .= "jQuery(document).pjax($linkSelector, $options);"; |
||
203 | } |
||
204 | if ($this->formSelector !== false) { |
||
205 | $formSelector = Json::htmlEncode($this->formSelector !== null ? $this->formSelector : '#' . $id . ' form[data-pjax]'); |
||
206 | $submitEvent = Json::htmlEncode($this->submitEvent); |
||
207 | $js .= "\njQuery(document).off($submitEvent, $formSelector).on($submitEvent, $formSelector, function (event) {jQuery.pjax.submit(event, $options);});"; |
||
208 | } |
||
209 | $view = $this->getView(); |
||
210 | PjaxAsset::register($view); |
||
211 | |||
212 | if ($js !== '') { |
||
213 | $view->registerJs($js); |
||
214 | } |
||
215 | } |
||
216 | } |
||
217 |