forked from NEKOGET/FuelPHP_docs_jp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpagination.html
964 lines (918 loc) · 35.4 KB
/
pagination.html
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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
<!doctype html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./../assets/css/combined.css">
<link rel="shortcut icon" href="./../favicon.ico" />
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
var path = './../';
var class_prefix = "Pagination::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Pagination - クラス - FuelPHP ドキュメント</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<h1>
<a href="http://fuelphp.com"><img height="37px" width="147px" src="./../assets/img/fuel.png" /></a>
<strong>Documentation</strong>
</h1>
<form id="google_search">
<p>
<span id="search_clear"> </span>
<input type="submit" name="search_submit" id="search_submit" value="検索" />
<input type="text" value="" id="search_input" name="search_input" />
</p>
</form>
</div>
<nav>
<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">目次</a>
<div class="clear"></div>
</header>
<div id="cse">
<div id="cse_point"></div>
<div id="cse_content"></div>
</div>
<div id="main">
<h2>Pagination クラス</h2>
<p>pagination クラスは、表示したいレコードのページネーションを簡単に設定することができます。</p>
<section>
<p>Pagination クラスの分かりやすい使用方法の例。コントローラのアクションメソッドへ書くことができます。</p>
<h3 id="how_to_query_builder">Query Builder を使ったページネーションの方法</h3>
<pre class="php"><code>$config = array(
'pagination_url' => 'http://localhost/fuel/welcome/index/',
'total_items' => 10,
'per_page' => 5,
'uri_segment' => 3,
// もしくは、クエリ文字列によるページネーションがよいのであれば
//'uri_segment' => 'page',
);
// 'mypagination' という名前の pagination インスタンスを作る
$pagination = Pagination::forge('mypagination', $config);
$data['example_data'] = DB::select('id', 'value')
->from('pagination')
->limit($pagination->per_page)
->offset($pagination->offset)
->execute()
->as_array();
// オブジェクトを渡し、ビューの中に echo で出力される時に表示される
$data['pagination'] = $pagination;
// ビューを返す
return \View::forge('welcome/index', $data);</code></pre>
<h3 id="how_to_orm">ORM を使ったページネーションの方法</h3>
<pre class="php"><code>$config = array(
'pagination_url' => 'http://localhost/fuel/posts/index/',
'total_items' => Model_Post::count(),
'per_page' => 10,
'uri_segment' => 3,
// もしくは、クエリ文字列によるページネーションがよいのであれば
//'uri_segment' => 'page',
);
$pagination = Pagination::forge('mypagination', $config);
$data['example_data'] = Model_Post::query()
->rows_offset($pagination->offset)
->rows_limit($pagination->per_page)
->get();
// オブジェクトを渡し、ビューの中に echo で出力される時に表示される
$data['pagination'] = $pagination;
// ビューを返す
return \View::forge('posts/index', $data);</code></pre>
</section>
<section>
<h3 id="configuration">設定</h3>
<p>
pagination インスタンスは、いくつかの方法で設定することができます。
インスタンスを <kbd>forge</kbd> するときに設定を配列で渡すこともできますし、インスタンスのプロパティを直接更新することもできます。
</p>
<p>次の設定項目を定義することができます。</p>
<table class="config">
<tbody>
<tr class="header">
<th>パラメータ</th>
<th>型</th>
<th>デフォルト</th>
<th>説明</th>
</tr>
<tr>
<th>pagination_url</th>
<td>string</td>
<td><pre class="php"><code>null</code></pre></td>
<td>
ページネーションがあるページの URL 。null の場合、現在の URL から自動で検出します。
</td>
</tr>
<tr>
<th>uri_segment</th>
<td>integer|string</td>
<td><pre class="php"><code>3</code></pre></td>
<td>
(整数のとき) URI セグメントがページ番号を持っています。(文字列のとき) クエリ文字列のフィールドがページ番号を持っています。
</td>
</tr>
<tr>
<th>num_links</th>
<td>integer</td>
<td><pre class="php"><code>5</code></pre></td>
<td>
表示するリンクの総数。
</td>
</tr>
<tr>
<th>total_items</th>
<td>integer</td>
<td><pre class="php"><code>0</code></pre></td>
<td>
アイテムの総数。通常は、 count() クエリの結果です。
</td>
</tr>
<tr>
<th>per_page</th>
<td>integer</td>
<td><pre class="php"><code>10</code></pre></td>
<td>
1 ページあたりのアイテム数。
</td>
</tr>
<tr>
<th>current_page</th>
<td>integer</td>
<td><pre class="php"><code>null</code></pre></td>
<td>
URI 中にページ番号が示されていなかった場合に読み込むページ。指定されなかったときのデフォルトは 1 。
</td>
</tr>
<tr>
<th>show_first</th>
<td>bool</td>
<td><pre class="php"><code>false</code></pre></td>
<td>
true かつ最初のページではない場合に '最初のページヘ' のリンクを生成します。
</td>
</tr>
<tr>
<th>show_last</th>
<td>bool</td>
<td><pre class="php"><code>false</code></pre></td>
<td>
true かつ最後のページではない場合に '最後のページヘ' のリンクを生成します。
</td>
</tr>
<tr>
<th>link_offset</th>
<td>int / float</td>
<td><pre class="php"><code>0.50</code></pre></td>
<td>
ページネーションブロックの中でアクティブなリンクのオフセット量、小数で 0 から 1 までの間または整数 (パーセンテージ) で 0 から 100 までの間のどちらか。
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="linkoffsets">リンクのオフセット量</h3>
<p>
デフォルトで、 Pagination クラスはページネーションブロックの中央に ("現在のページ" の)
アクティブなリンクを配置します。
</p>
<p>
設定にある <kbd>link_offset</kbd> の値を使うことで、この振舞いをコントロールすることができます。
この値は、float の 0 から 1 までの間か integer の 0 から 100 までの間 (パーセンテージのように) のどちらかで定義することができます。この値はデフォルトで <code>0.5</code> (= 50%) にセットされています。
この値を小さくした場合、アクティブなリンクは左へ移動し、
大きくした場合、アクティブなリンクは右へ移動します。
</p>
<h5 id="linkoffsetexample">例</h5>
<p>
ここで、表示できるページが全部で 20 ページあると仮定してみましょう。 <kbd>num_links</kbd> は 5 にセットされていて、表示されるリンクは全部で 5 ページとなります、
同様に "前" と "次" のリンクも表示されています。現在選択しているページは 6 ページ目となります。
</p>
<ul>
<li>
デフォルトの設定である <kbd>0.5</kbd> では、 <blockquote><code>«</code> <code>4</code> <code>5</code> 6 <code>7</code> <code>8</code> <code>»</code></blockquote> と表示されます、
選択しているページの 6 がブロックの中央部分にうまくキープされています。
</li>
<li>
設定を <kbd>0</kbd> に変更した場合、 Pagination は常にアクティブなリンクを最初のリンクとします。このケースでは、
<blockquote><code>«</code> 6 <code>7</code> <code>8</code> <code>9</code> <code>10</code> <code>»</code></blockquote>
と表示されます、選択しているページの 6 がブロックの最初のリンクになっています。
</li>
<li>
設定を <kbd>1</kbd> に変更した場合、 Pagination は常にアクティブなリンクを最後のリンクにします。このケースでは、
<blockquote><code>«</code> <code>2</code> <code>3</code> <code>4</code> <code>5</code> 6 <code>»</code></blockquote>
と表示されます。
</li>
</ul>
<p>
アクティブの焦点を左や右へ徐々に移動させるために、範囲の中で任意の値を取ることができます。
当然ですが、表示したいリンクがあればあるほど、焦点の移動をするための粒度は細かくなっていきます。
</p>
<p class="note">
これは十分なページがある場合に限って動作します。もしも、たったの 5 ページしかなくて、 5 つのリンクを表示したい、そして 3 ページ目が "現在のページ" の場合、
"前" と "次" のリンクは表示されませんし、 <kbd>link_offset</kbd> がどんな設定であっても "現在のページ" は中央となります。
これは単純に "現在のページ" のリンクを左や右へ移動できるほどの十分なページがないからです。
</p>
</section>
<section>
<h3 id="templating">テンプレート</h3>
<p>
全ての pagination インスタンスは、ページネーションのマークアップを作成するために HTML を生成するテンプレートを用います。
<em>config/pagination.php</em> ファイルに標準のテンプレートとして保存することができます。
変更を加える前に、コア設定フォルダからアプリケーション設定フォルダにファイルをコピーしてください。
デフォルトの設定ファイルとして、FuelPHP のデフォルトと Twitter Bootstrap v2 に適合するテンプレートの 3 つのテンプレートが付属しています。
</p>
<p>次のテンプレートのエントリを定義する必要があります。</p>
<table class="config">
<tbody>
<tr>
<th>wrapper</th>
<td>string</td>
<td><pre class="html"><code><div class="pagination">\n\t{pagination}\n</div>\n</code></pre></td>
<td>
生成されたページネーションのマークアップを囲むマークアップ。
</td>
</tr>
<tr>
<th>first</th>
<td>string</td>
<td><pre class="html"><code><span class="first">\n\t{link}\n</span>\n</code></pre></td>
<td>
"最初のページ" のマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>first-inactive</th>
<td>string</td>
<td>なし</td>
<td>
このページが最初かシングルのとき、"最初のページ" のマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>first-inactive-link</th>
<td>string</td>
<td>なし</td>
<td>
このページが最初かシングルのとき、"最初のページ" のリンクを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>first-marker</th>
<td>string</td>
<td><pre class="html"><code>&laquo;&laquo;</code></pre></td>
<td>
"最初のページ" のマーカーを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>first-link</th>
<td>string</td>
<td><pre class="html"><code>\t\t<a href="{uri}">{page}</a>\n</code></pre></td>
<td>
"最初のページ" のリンクを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>previous</th>
<td>string</td>
<td><pre class="html"><code><span class="previous">\n\t{link}\n</span>\n</code></pre></td>
<td>
"前のページ" のマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>previous-marker</th>
<td>string</td>
<td><pre class="html"><code>&laquo;</code></pre></td>
<td>
"前のページ" のマーカーを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>previous-link</th>
<td>string</td>
<td><pre class="html"><code>\t\t<a href="{uri}" rel="prev">{page}</a>\n</code></pre></td>
<td>
"前のページ" のリンクを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>previous-inactive</th>
<td>string</td>
<td><pre class="html"><code><span class="previous-inactive">\n\t{link}\n</span>\n</code></pre></td>
<td>
非アクティブなリンクとして "前のページ" のマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>previous-inactive-link</th>
<td>string</td>
<td><pre class="html"><code>\t\t<a href="{uri}" rel="prev">{page}</a>\n</code></pre></td>
<td>
非アクティブなリンクとして "前のページ" のリンクを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>regular</th>
<td>string</td>
<td><pre class="html"><code><span>\n\t{link}\n</span>\n</code></pre></td>
<td>
"その他ページ" のマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>regular-link</th>
<td>string</td>
<td><pre class="html"><code>\t\t<a href="{uri}">{page}</a>\n</code></pre></td>
<td>
"その他ページ" のリンクのマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>active</th>
<td>string</td>
<td><pre class="html"><code><span class="active">\n\t{link}\n</span>\n</code></pre></td>
<td>
"現在のページ" のマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>active-link</th>
<td>string</td>
<td><pre class="html"><code>\t\t<a href="{uri}">{page}</a>\n</code></pre></td>
<td>
"現在のページ" のリンクのマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>next</th>
<td>string</td>
<td><pre class="html"><code><span class="next">\n\t{link}\n</span>\n</code></pre></td>
<td>
"次のページ" のマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>next-marker</th>
<td>string</td>
<td><pre class="html"><code>&raquo;</code></pre></td>
<td>
"次のページ" のマーカーを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>next-link</th>
<td>string</td>
<td><pre class="html"><code>\t\t<a href="{uri}" rel="next">{page}</a>\n</code></pre></td>
<td>
"次のページ" のリンクを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>next-inactive</th>
<td>string</td>
<td><pre class="html"><code><span class="next-inactive">\n\t{link}\n</span>\n</code></pre></td>
<td>
非アクティブなリンクとして "次のページ" のマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>next-inactive-link</th>
<td>string</td>
<td><pre class="html"><code>\t\t<a href="{uri}" rel="next">{page}</a>\n</code></pre></td>
<td>
非アクティブなリンクとして "次のページ" のリンクを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>last</th>
<td>string</td>
<td><pre class="html"><code><span class="last">\n\t{link}\n</span>\n</code></pre></td>
<td>
"最後のページ" のマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>last-marker</th>
<td>string</td>
<td><pre class="html"><code>&raquo;&raquo;</code></pre></td>
<td>
"最後のページ" のマーカーを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>last-link</th>
<td>string</td>
<td><pre class="html"><code>\t\t<a href="{uri}">{page}</a>\n</code></pre></td>
<td>
"最後のページ" のリンクを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>last-inactive</th>
<td>string</td>
<td>なし</td>
<td>
このページが最後かシングルのとき、"最後のページ" のマークアップを生成するために使われるマークアップ。
</td>
</tr>
<tr>
<th>last-inactive-link</th>
<td>string</td>
<td>なし</td>
<td>
このページが最後かシングルのとき、"最後のページ" のリンクを生成するために使われるマークアップ。
</td>
</tr>
</tbody>
</table>
<p>
テンプレートの中で、<strong>{uri}</strong> は生成されたページネーションのリンク (非アクティブなときは <strong>#</strong>) に置き換えられます。
同様に、<strong>{page}</strong> はページ番号もしくは "前" や "次" のマーカーに置き換わります。
マーカーに画像を使用したいときは、
テンプレートの中にある該当するリンクの定義を <strong>{page}</strong> から画像のマークアップへ置き換えるだけで修正できます。
</p>
<p class="note">
pagination インスタンスを forge するときに渡す設定は、設定ファイルで定義されているデフォルトのテンプレートとマージされます。
これは、あなたが上書きしたい値だけを渡せばよいということです。
設定ファイルのテンプレートが完全ではない場合、
上記に記載したデフォルト値が使われます。
</p>
</section>
<section>
<article>
<h4 class="method" id="method_forge">forge($name = 'default', $config = array())</h4>
<p><strong>forge</strong> メソッドは、新しい pagination インスタンスを作成し、配列を渡すことで設定ができます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$name</kbd></th>
<td><i>必須</i></td>
<td>作られるインスタンスの名前。名前が指定されていない場合は、'default' インスタンスが作られます。</td>
</tr>
<tr>
<th><kbd>$config</kbd></th>
<td><pre class="php"><code>array()</code></pre></td>
<td>設定の配列。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>Pagination</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// pagination インスタンスを作る
$pagination = Pagination::forge('mypagination', array(
'pagination_url' => 'http://docs.fuelphp.com/',
'uri_segment' => 2,
'total_items' => 10,
'per_page' => 20,
));</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_instance">instance($name = null)</h4>
<p><strong>instance</strong> メソッドは、予め forge されたインスタンスを取得することができます。名前が指定されなかった場合は、default インスタンスを返します。 </p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$name</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>返されるインスタンスの名前。名前が指定されていない場合は、'default' インスタンスが作られます。 </td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>mixed 。Pagination オブジェクト、または要求したインスタンスが存在しない場合は false 。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 予め forge されたインスタンスを取ってくる
$pagination = Pagination::instance('mypagination');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_render">render($raw = false)</h4>
<p><strong>render</strong> メソッドは、ビューの中で表示するページネーションのリンクのマークアップを生成します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$raw</kbd></th>
<td><pre class="php"><code>false</code></pre></td>
<td>true の場合、ページネーションのマークアップを表示する代わりに生の pagination データを配列として返す。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 予め forge されたインスタンスを取ってきて、表示する
echo Pagination::instance('mypagination')->render();</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note">
Pagination オブジェクトは、オブジェクトを echo で出力する時に render() メソッドを呼ぶ、
または文字列にキャストする __toString() メソッドを持っています。
</p>
</article>
<article>
<h4 class="method" id="method_first">first($marker = null)</h4>
<p>
<strong>first</strong> メソッドは、ページネーションで "最初のページ" のリンクを表示するマークアップを生成します。
マーカーとして使用する文字列が与えられなかった場合、テンプレートから "first-marker" の値が使われます。
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$marker</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>リンクの中に表示されるテキスト。デフォルトは、テンプレートの 'first-marker' の値。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 予め forge されたインスタンスを取ってきて、"最初のページ" のリンクを表示する
echo Pagination::instance('mypagination')->first();</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note">
"最初のページ" のリンクは、最初のページが存在し、(このページが) 最初のページではない場合のみ表示されます。
デフォルトでは、'最初' の非アクティブなリンクは提供されません。
</p>
</article>
<article>
<h4 class="method" id="method_previous">previous($marker = null)</h4>
<p>
<strong>previous</strong> メソッドは、ページネーションで "前のページ" のリンクを表示するマークアップを生成します。
マーカーとして使用する文字列が与えられなかった場合、テンプレートから "previous-marker" の値が使われます。
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$marker</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>リンクの中に表示されるテキスト。デフォルトは、テンプレートの 'previous-marker' の値。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 予め forge されたインスタンスを取ってきて、"前のページ" のリンクを表示する
echo Pagination::instance('mypagination')->previous();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_next">next($marker = null)</h4>
<p>
<strong>next</strong> メソッドは、ページネーションで "次のページ" のリンクを表示するマークアップを生成します。
マーカーとして使用する文字列が与えられなかった場合、テンプレートから "next-marker" の値が使われます。
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$marker</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>リンクの中に表示されるテキスト。デフォルトは、 テンプレートの 'next-marker' の値。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 予め forge されたインスタンスを取ってきて、"次のページ" のリンクを表示する
echo Pagination::instance('mypagination')->next();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_last">last($marker = null)</h4>
<p>
<strong>last</strong> メソッドは、ページネーションで "最後のページ" のリンクを表示するマークアップを生成します。
マーカーとして使用する文字列が与えられなかった場合、テンプレートから "last-marker" の値が使われます。
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$marker</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>リンクの中に表示されるテキスト。デフォルトは、 テンプレートの 'last-marker' の値。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 予め forge されたインスタンスを取ってきて、"最後のページ" のリンクを表示する
echo Pagination::instance('mypagination')->last();</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note">
"最後のページ" のリンクは、最後のページが存在し、(このページが) 最後のページではない場合のみ表示されます。
デフォルトでは、 '最後' の非アクティブなリンクは提供されません。
</p>
</article>
<article>
<h4 class="method" id="method_pages_render">pages_render()</h4>
<p><strong>pages_render</strong> メソッドは、ページネーションで "前" と "次" のリンクの間にある "ページ" のリンクを表示するマークアップを生成します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>パラメータ</th>
<td>なし</td>
</tr>
<tr>
<th>返り値</th>
<td>mixed</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 予め forge されたインスタンスを取ってきて、"ページ" のリンクを表示する
echo Pagination::instance('mypagination')->pages_render();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</section>
<section>
<h3 id="static">静的インターフェイス</h3>
<p>
便宜のため、
Pagination クラスは default インスタンスのみを扱う静的インターフェースを持っています。
</p>
<article>
<h4 class="method" id="method_get">get($name)</h4>
<p><strong>get</strong> メソッドは、default インスタンスの構成アイテムを取得できます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$name</kbd></th>
<td>必須</td>
<td>取ってくるプロパティの名前。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>mixed 。プロパティ値、またはプロパティが存在しない場合は <kbd>null</kbd> 。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 現在のページ番号を取ってくる
$page_number = Pagination::get('current_page');
// これは下記の別名
$page_number = Pagination::instance()->current_page;</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_set">set($name, $value)</h4>
<p><strong>set</strong> メソッドは、default インスタンスの構成アイテムを指定した値で設定できます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$name</kbd></th>
<td>必須</td>
<td>設定するプロパティの名前。</td>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td>必須</td>
<td>プロパティに設定する値。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>void</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 列の総数を設定する
$page_number = Pagination::set('total_items', 610);
// これは下記の別名
Pagination::instance()->total_items = 610;</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<p class="note">
下位互換性のため、<kbd>set_config()</kbd>、<kbd>create_links()</kbd>、<kbd>next_link()</kbd> や <kbd>prev_link()</kbd> の静的メソッドは、
既存の FuelPHP v1.4 以降のアプリケーションをアップグレードするときの移行にかかる影響を最小限に抑えるために、
default インスタンスとしてエミュレートされます。
</p>
<p>今のところ、静的クラスのプロパティへの直接アクセスをエミュレートする方法がないことに注意してください。
アプリケーションでそのようなことを行いたいときは、それらを変更する必要があります。</p>
<pre class="php"><code>// v1.4 より前の使用法:
Pagination::$per_page = 10;
// 新しい使用法:
Pagination::set('per_page', 10);
// v1.4 より前の使用法:
Model_Article::find()
->order_by('date', 'ASC')
->rows_offset(\Pagination::$offset)
->rows_limit(\Pagination::$per_page)
->get();
// 新しい使用法:
Model_Article::query()
->order_by('date', 'ASC')
->rows_offset(\Pagination::get('offset'))
->rows_limit(\Pagination::get('per_page'))
->get();
</code></pre>
</section>
</div>
<footer>
<p>
© FuelPHP Development Team 2010-2016 - <a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.
[ <a href="https://github.com/fuel/docs/commits/1.8/develop/classes/pagination.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.8/develop_japanese/classes/pagination.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.8/develop_japanese/classes/pagination.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>