-
Notifications
You must be signed in to change notification settings - Fork 2
/
Helper.php
556 lines (481 loc) · 15.8 KB
/
Helper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
<?php
/**
* @link http://pagination.ru/
* @author Vasiliy Makogon, [email protected]
*/
class Krugozor_Pagination_Helper
{
/**
* Ñòàíäàðòíûé âèä ïàãèíàöèè:
* ««« «« « 1 2 3 4 5 6 7 8 9 10 » »» »»»
*
* @var int
*/
const PAGINATION_NORMAL_TYPE = 1;
/**
* Âèä èíòåðâàëüíîé äåêðåìåíòíîé ïàãèíàöèè:
* ««« «« « 50-41 40-31 30-21 20-11 10-1 » »» »»»
*
* @var int
*/
const PAGINATION_DECREMENT_TYPE = 2;
/**
* Âèä èíòåðâàëüíîé èíêðåìåíòíîé ïàãèíàöèè:
* ««« «« « 1-10 11-20 21-30 31-40 41-50 » »» »»»
*
* @var int
*/
const PAGINATION_INCREMENT_TYPE = 3;
/**
* @var Krugozor_Pagination_Manager
*/
private $manager;
/**
* Õðàíèëèùå CSS-êëàññîâ äëÿ êàæäîãî <a> ýëåìåíòà ïàãèíàòîðà.
*
* @var array
*/
private $styles = array();
/**
* Õðàíèëèùå ïàð êëþ÷=>çíà÷åíèå äëÿ ïîäñòàíîâêè â QUERY_STRING
* ãèïåðññûëîê ïàãèíàòîðà.
*
* @var array
*/
private $request_uri_params = array();
/**
* ßêîðÿ è title äëÿ âñåõ ýëåìåíòîâ <a> ïàãèíàòîðà.
*
* @var array
*/
private $html = array
(
'first_page_anchor' => '«««',
'previous_block_anchor' => '««',
'previous_page_anchor' => '«',
'next_page_anchor' => '»',
'next_block_anchor' => '»»',
'last_page_anchor' => '»»»',
'first_page_title' => 'Íà ïåðâóþ ñòðàíèöó',
'previous_block_title' => 'Ïðåäûäóùèå ñòðàíèöû',
'previous_page_title' => 'Ïðåäûäóùàÿ ñòðàíèöà',
'next_page_title' => 'Ñëåäóþùàÿ ñòðàíèöà',
'next_block_title' => 'Ñëåäóþùèå ñòðàíèöû',
'last_page_title' => 'Íà ïîñëåäíþþ ñòðàíèöó',
);
/**
* Ïîêàçûâàòü ëè ýëåìåíò <a> '«««'.
*
* @var bool
*/
private $view_first_page_label = true;
/**
* Ïîêàçûâàòü ëè ýëåìåíò <a> '»»»'.
*
* @var bool
*/
private $view_last_page_label = true;
/**
* Ïîêàçûâàòü ëè ýëåìåíò <a> '««'.
*
* @var bool
*/
private $view_previous_block_label = true;
/**
* Ïîêàçûâàòü ëè ýëåìåíò <a> '»»'.
*
* @var bool
*/
private $view_next_block_label = true;
/**
* Èäåíòèôèêàòîð ôðàãìåíòà (#primer), ññûëàþùèéñÿ íà íåêîòîðóþ ÷àñòü îòêðûâàåìîãî äîêóìåíòà.
*
* @var string
*/
private $fragment_identifier;
/**
* Òèï èíòåðôåéñà ïàãèíàòîðà (ñì. êîíñòàíòû êëàññà PAGINATION_*_TYPE).
*
* @var int
*/
private $pagination_type;
/**
* @param Krugozor_Pagination_Manager $manager
*/
public function __construct(Krugozor_Pagination_Manager $manager)
{
$this->manager = $manager;
}
/**
* Âîçâðàùàåò îáúåêò Krugozor_Pagination_Manager
*
* @param void
* @return Krugozor_Pagination_Manager
*/
public function getPagination()
{
return $this->manager;
}
/**
* Óñòàíàâëèâàåò òèï èíòåðôåéñà ïàãèíàòîðà.
*
* @param int
* @return Krugozor_Pagination_Helper
*/
public function setPaginationType($pagination_type)
{
$this->pagination_type = (int) $pagination_type;
return $this;
}
/**
* Óñòàíàâëèâàåò î÷åðåäíîé ïàðàìåòð äëÿ QUERY_STRING
* ãèïåðññûëîê ïàãèíàòîðà.
*
* @param string $key
* @param string $value
* @return Krugozor_Pagination_Helper
*/
public function setRequestUriParameter($key, $value)
{
$this->request_uri_params[$key] = (string) $value;
return $this;
}
/**
* Óñòàíàâëèâàåò, ïîêàçûâàòü ëè ýëåìåíò <a> '«««'.
*
* @param bool $value
* @return Krugozor_Pagination_Helper
*/
public function setViewFirstPageLabel($value)
{
$this->view_first_page_label = (bool) $value;
return $this;
}
/**
* Óñòàíàâëèâàåò, ïîêàçûâàòü ëè ýëåìåíò <a> '»»»'.
*
* @param bool $value
* @return Krugozor_Pagination_Helper
*/
public function setViewLastPageLabel($value)
{
$this->view_last_page_label = (bool) $value;
return $this;
}
/**
* Óñòàíàâëèâàåò, ïîêàçûâàòü ëè ýëåìåíò <a> '««'.
*
* @param bool $value
* @return Krugozor_Pagination_Helper
*/
public function setViewPreviousBlockLabel($value)
{
$this->view_previous_block_label = (bool) $value;
return $this;
}
/**
* Óñòàíàâëèâàåò, ïîêàçûâàòü ëè ýëåìåíò <a> '»»'.
*
* @param bool $value
* @return Krugozor_Pagination_Helper
*/
public function setViewNextBlockLabel($value)
{
$this->view_next_block_label = (bool) $value;
return $this;
}
/**
* Óñòàíàâëèâàåò èäåíòèôèêàòîð ôðàãìåíòà (#primer) ãèïåðññûëîê ïàãèíàòîðà.
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setFragmentIdentifier($fragment_identifier)
{
$this->fragment_identifier = trim((string) $fragment_identifier, ' #');
return $this;
}
/**
* Óñòàíàâëèâàåò CSS-êëàññ êàæäîãî ýëåìåíòà <a> â èíòåðôåéñå ïàãèíàòîðà.
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setCssNormalLinkClass($class)
{
$this->styles['normal_link_class'] = (string) $class;
return $this;
}
/**
* Óñòàíàâëèâàåò CSS-êëàññ ýëåìåíòà <span> â èíòåðôåéñå ïàãèíàòîðà,
* ñòðàíèöà êîòîðîãî îòêðûòà â òåêóùèé ìîìåíò.
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setCssActiveLinkClass($class)
{
$this->styles['active_link_class'] = (string) $class;
return $this;
}
/**
* Óñòàíàâëèâàåò CSS-êëàññ ýëåìåíòà <a> '«««'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setCssFirstPageClass($class)
{
$this->styles['first_page_class'] = (string) $class;
return $this;
}
/**
* Óñòàíàâëèâàåò CSS-êëàññ ýëåìåíòà <a> '»»»'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setCssLastPageClass($class)
{
$this->styles['last_page_class'] = (string) $class;
return $this;
}
/**
* Óñòàíàâëèâàåò CSS-êëàññ ýëåìåíòà <a> '««'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setCssPreviousBlockClass($class)
{
$this->styles['previous_block_class'] = (string) $class;
return $this;
}
/**
* Óñòàíàâëèâàåò CSS-êëàññ ýëåìåíòà <a> '»»'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setCssNextBlockClass($class)
{
$this->styles['next_block_class'] = (string) $class;
return $this;
}
/**
* Óñòàíàâëèâàåò CSS-êëàññ ýëåìåíòà <a> '«'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setCssPreviousPageClass($class)
{
$this->styles['previous_page_class'] = (string) $class;
return $this;
}
/**
* Óñòàíàâëèâàåò CSS-êëàññ ýëåìåíòà <a> '»'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setCssNextPageClass($class)
{
$this->styles['next_page_class'] = (string) $class;
return $this;
}
/**
* Óñòàíàâëèâàåò ÿêîðü äëÿ ýëåìåíòà <a> '«««'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setFirstPageAnchor($anchor)
{
$this->html['first_page_anchor'] = (string) $anchor;
return $this;
}
/**
* Óñòàíàâëèâàåò ÿêîðü äëÿ ýëåìåíòà <a> '»»»'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setLastPageAnchor($anchor)
{
$this->html['last_page_anchor'] = (string) $anchor;
return $this;
}
/**
* Óñòàíàâëèâàåò ÿêîðü äëÿ ýëåìåíòà <a> '««'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setPreviousBlockAnchor($anchor)
{
$this->html['previous_block_anchor'] = (string) $anchor;
return $this;
}
/**
* Óñòàíàâëèâàåò ÿêîðü äëÿ ýëåìåíòà <a> '»»'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setNextBlockAnchor($anchor)
{
$this->html['next_block_anchor'] = (string) $anchor;
return $this;
}
/**
* Óñòàíàâëèâàåò ÿêîðü äëÿ ýëåìåíòà <a> '«'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setPreviousPageAnchor($anchor)
{
$this->html['previous_page_anchor'] = (string) $anchor;
return $this;
}
/**
* Óñòàíàâëèâàåò ÿêîðü äëÿ ýëåìåíòà <a> '»'
*
* @param string
* @return Krugozor_Pagination_Helper
*/
public function setNextPageAnchor($anchor)
{
$this->html['next_page_anchor'] = (string) $anchor;
return $this;
}
/**
* Ôîðìèðóåò è âîçâðàùàåò HTML-êîä ñòðîêè íàâèãàöèè.
*
* @param void
* @return string
*/
public function getHtml()
{
ob_start();
$self_uri = $this->createRequestUri();
$qs = $this->createQueryString();
?>
<? if ($this->view_first_page_label && $this->manager->getCurrentSeparator() && $this->manager->getCurrentSeparator() != 1): ?>
<a<?=$this->createInlineCssClassDeclaration('first_page_class', 'normal_link_class')?> title="<?=$this->html['first_page_title']?>" href="<?=$self_uri?>?<?=$qs?><?=$this->manager->getPageName()?>=<?=$this->manager->getFirstPage()?>&<?=$this->manager->getSeparatorName()?>=1<?=$this->createFragmentIdentifier()?>"><?=$this->html['first_page_anchor']?></a>
<? endif; ?>
<? if ($this->view_previous_block_label && $this->manager->getPreviousBlockSeparator()): ?>
<a<?=$this->createInlineCssClassDeclaration('previous_block_class', 'normal_link_class')?> title="<?=$this->html['previous_block_title']?>" href="<?=$self_uri?>?<?=$qs?><?=$this->manager->getPageName()?>=<?=$this->manager->getPageForPreviousBlock()?>&<?=$this->manager->getSeparatorName()?>=<?=$this->manager->getPreviousBlockSeparator()?><?=$this->createFragmentIdentifier()?>"><?=$this->html['previous_block_anchor']?></a>
<? endif; ?>
<? if($this->manager->getPreviousPageSeparator() && $this->manager->getPreviousPage()): ?>
<a<?=$this->createInlineCssClassDeclaration('previous_page_class', 'normal_link_class')?> title="<?=$this->html['previous_page_title']?>" href="<?=$self_uri?>?<?=$qs?><?=$this->manager->getPageName()?>=<?=$this->manager->getPreviousPage()?>&<?=$this->manager->getSeparatorName()?>=<?=$this->manager->getPreviousPageSeparator()?><?=$this->createFragmentIdentifier()?>"><?=$this->html['previous_page_anchor']?></a>
<? endif; ?>
<? foreach($this->manager->getTemplateData() as $row): ?>
<? if($this->manager->getCurrentPage() == $row["page"]): ?>
<span<?=$this->createInlineCssClassDeclaration('active_link_class')?>><?=$this->createHyperlinkAnchor($row)?></span>
<? else: ?>
<a<?=$this->createInlineCssClassDeclaration('normal_link_class')?> href="<?=$self_uri?>?<?=$qs?><?=$this->manager->getSeparatorName()?>=<?=$row["separator"]?>&<?=$this->manager->getPageName()?>=<?=$row["page"]?><?=$this->createFragmentIdentifier()?>"><?=$this->createHyperlinkAnchor($row)?></a>
<? endif; ?>
<? endforeach; ?>
<? if($this->manager->getNextPageSeparator() && $this->manager->getNextPage()): ?>
<a<?=$this->createInlineCssClassDeclaration('next_page_class', 'normal_link_class')?> title="<?=$this->html['next_page_title']?>" href="<?=$self_uri?>?<?=$qs?><?=$this->manager->getPageName()?>=<?=$this->manager->getNextPage()?>&<?=$this->manager->getSeparatorName()?>=<?=$this->manager->getNextPageSeparator()?><?=$this->createFragmentIdentifier()?>"><?=$this->html['next_page_anchor']?></a>
<? endif; ?>
<? if($this->view_next_block_label && $this->manager->getNextBlockSeparator()): ?>
<a<?=$this->createInlineCssClassDeclaration('next_block_class', 'normal_link_class')?> title="<?=$this->html['next_block_title']?>" href="<?=$self_uri?>?<?=$qs?><?=$this->manager->getSeparatorName()?>=<?=$this->manager->getNextBlockSeparator()?><?=$this->createFragmentIdentifier()?>"><?=$this->html['next_block_anchor']?></a>
<? endif; ?>
<? if ($this->view_last_page_label && $this->manager->getLastSeparator() && $this->manager->getCurrentSeparator() != $this->manager->getLastSeparator()): ?>
<a<?=$this->createInlineCssClassDeclaration('last_page_class', 'normal_link_class')?> title="<?=$this->html['last_page_title']?>" href="<?=$self_uri?>?<?=$qs?><?=$this->manager->getPageName()?>=<?=$this->manager->getLastPage()?>&<?=$this->manager->getSeparatorName()?>=<?=$this->manager->getLastSeparator()?><?=$this->createFragmentIdentifier()?>"><?=$this->html['last_page_anchor']?></a>
<? endif; ?>
<?php
$str = ob_get_contents();
ob_end_clean();
return $str;
}
/**
* Ñîçäà¸ò ÿêîðü äëÿ ýëåìåíòà <a> â çàâèñèìîñòè îò òèïà $this->pagination_type.
*
* @param array $params
* @return string
*/
private function createHyperlinkAnchor(array $params)
{
switch ($this->pagination_type)
{
case self::PAGINATION_DECREMENT_TYPE:
return $params['decrement_anhor'];
case self::PAGINATION_INCREMENT_TYPE:
return $params['increment_anhor'];
case self::PAGINATION_NORMAL_TYPE:
default:
return $params['page'];
}
}
/**
* Âîçâðàùàåò ñòðîêó âèäà `class="class_name"` åñëè $class_name îáúÿâëåí è
* îïèñàí â $this->styles[$class_name].
*  îáðàòíîì ñëó÷àå âîçâðàùàåò ñòðîêó âèäà `class="replacement_class_name"`,
* åñëè $replacement_class_name îáúÿâëåí â êà÷åñòâå àðãóìåíòà ìåòîäà è
* îïèñàí â $this->styles[$replacement_class_name].
* Åñëè $replacement_class_name íå îáúÿâëåí, âîçâðàùàåòñÿ ïóñòàÿ ñòðîêà.
*
* @param string èìÿ CSS-êëàññà
* @param string èìÿ CSS-êëàññà
* @return string
*/
private function createInlineCssClassDeclaration($class_name, $replacement_class_name=null)
{
return !empty($this->styles[$class_name])
? ' class="' . $this->styles[$class_name] . '"'
: ($replacement_class_name === null
? ''
: call_user_func_array(array($this, __METHOD__), array($replacement_class_name))
);
}
/**
* Âîçâðàùàåò èäåíòèôèêàòîð ôðàãìåíòà ñ ñèìâîëîì #
* äëÿ ïîäñòàíîâêè íåïîñðåäñòâåííî â URL-àäðåñ.
*
* @param void
* @return string
*/
private function createFragmentIdentifier()
{
return !empty($this->fragment_identifier) ? '#' . $this->fragment_identifier : '';
}
/**
* Âîçâðàùàåò REQUEST_URI áåç QUERY_STRING.
*
* @param void
* @return string
*/
private function createRequestUri()
{
if (strpos($_SERVER["REQUEST_URI"], '?') !== false)
{
return substr($_SERVER["REQUEST_URI"], 0, strpos($_SERVER["REQUEST_URI"], '?'));
}
else
{
return $_SERVER["REQUEST_URI"];
}
}
/**
* Ñîçäàåò ñòðîêó QUERY_STRING èç ìàññèâà ïàðàìåòðîâ $this->request_uri_params.
*
* @param void
* @return string
*/
private function createQueryString()
{
$query_string = '';
foreach ($this->request_uri_params as $key => $value)
{
if ((string) $value !== '')
{
$query_string .= $key . '=' . htmlentities(urlencode($value)) . '&';
}
}
return $query_string;
}
}