Skip to content

Commit 532534f

Browse files
committed
Updated docs
1 parent 23fb138 commit 532534f

6 files changed

Lines changed: 250 additions & 31 deletions

File tree

docs/Zebra_Pagination/Zebra_Pagination.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
</p>
5454
</div>
5555
</td>
56-
<td style="background: #FFF">
56+
<td style="background: #FFF; width: 100%">
5757
<div id="doc_content">
5858
<h2>Class: <strong>Zebra_Pagination</strong></h2>
5959
<h6><strong>source file:</strong> /Zebra_Pagination.php</h6>
@@ -65,15 +65,15 @@ <h4>Author(s):</h4>
6565
</ul>
6666
<h4>Version:</h4>
6767
<ul>
68-
<li>2.4.8 (last revision: June 19, 2024)<br>See <a href="https://github.com/stefangabos/Zebra_Pagination/blob/master/CHANGELOG.md" class="projects-homepage">CHANGELOG</a></li>
68+
<li>2.4.9 (last revision: February 09, 2026)<br>See <a href="https://github.com/stefangabos/Zebra_Pagination/blob/master/CHANGELOG.md" class="projects-homepage">CHANGELOG</a></li>
6969
</ul>
7070
<h4>License:</h4>
7171
<ul>
7272
<li><a href="https://www.gnu.org/licenses/lgpl-3.0.txt">GNU LESSER GENERAL PUBLIC LICENSE</a></li>
7373
</ul>
7474
<h4>Copyright:</h4>
7575
<ul>
76-
<li>© 2009 - 2024 Stefan Gabos</li>
76+
<li>© 2009 - 2026 Stefan Gabos</li>
7777
</ul>
7878
<div id="top" class="doc_toc">
7979
<div class="left">
@@ -143,7 +143,7 @@ <h5>Arguments</h5>
143143
<tr>
144144
<td><em>boolean</em></td>
145145
<td><strong>$status</strong></td>
146-
<td><p>(Optional) If set to <code>FALSE</code>, the <em>previous page</em> and <em>next page</em> links will only be shown if there are more pages than <a href="../Zebra_Pagination/Zebra_Pagination.html#methodselectable_pages">selectable pages</a>.</p><p>Default is <code>TRUE</code>.</p></td>
146+
<td><p><span class="optional">Optional</span> If set to <code>FALSE</code>, the <em>previous page</em> and <em>next page</em> links will only be shown if there are more pages than <a href="../Zebra_Pagination/Zebra_Pagination.html#methodselectable_pages">selectable pages</a>.</p><p>Default is <code>TRUE</code>.</p></td>
147147
</tr>
148148
</table>
149149
<h5>Tags</h5>
@@ -179,7 +179,7 @@ <h5>Arguments</h5>
179179
<tr>
180180
<td><em>boolean</em></td>
181181
<td><strong>$status</strong></td>
182-
<td><p>(Optional) If set to <code>FALSE</code>, the library will have for the first page (or last, if you are displaying links in <a href="../Zebra_Pagination/Zebra_Pagination.html#methodreverse">reverse</a> order) a different path than the one you have when you are accessing the page for the first (un-paginated) time.</p><p>Default is <code>TRUE</code>.</p></td>
182+
<td><p><span class="optional">Optional</span> If set to <code>FALSE</code>, the library will have for the first page (or last, if you are displaying links in <a href="../Zebra_Pagination/Zebra_Pagination.html#methodreverse">reverse</a> order) a different path than the one you have when you are accessing the page for the first (un-paginated) time.</p><p>Default is <code>TRUE</code>.</p></td>
183183
</tr>
184184
</table>
185185
<h5>Tags</h5>
@@ -220,12 +220,12 @@ <h5>Arguments</h5>
220220
<tr>
221221
<td><em>string</em></td>
222222
<td><strong>$base_url</strong></td>
223-
<td><p>(Optional) The base URL to be used when generating the navigation links</p><p>Defaults is whatever returned by <a href="https://www.php.net/manual/en/reserved.variables.server.php">$_SERVER['REQUEST_URI']</a></p></td>
223+
<td><p><span class="optional">Optional</span> The base URL to be used when generating the navigation links</p><p>Defaults is whatever returned by <a href="https://www.php.net/manual/en/reserved.variables.server.php">$_SERVER['REQUEST_URI']</a></p></td>
224224
</tr>
225225
<tr>
226226
<td><em>boolean</em></td>
227227
<td><strong>$preserve_query_string</strong></td>
228-
<td><p>(Optional) Indicates whether values in query strings, other than those set in <code>base_url</code>, should be preserved</p><p>Default is <code>TRUE</code></p></td>
228+
<td><p><span class="optional">Optional</span> Indicates whether values in query strings, other than those set in <code>base_url</code>, should be preserved</p><p>Default is <code>TRUE</code></p></td>
229229
</tr>
230230
</table>
231231
<a href="#top" class="top">top</a>
@@ -402,17 +402,17 @@ <h5>Arguments</h5>
402402
<tr>
403403
<td><em>string</em></td>
404404
<td><strong>$previous</strong></td>
405-
<td><p>(Optional) The label for the <em>previous page</em> link.</p><p>Default is <code>&amp;laquo;</code> (which looks like <code>«</code>)</p></td>
405+
<td><p><span class="optional">Optional</span> The label for the <em>previous page</em> link.</p><p>Default is <code>&amp;laquo;</code> (which looks like <code>«</code>)</p></td>
406406
</tr>
407407
<tr>
408408
<td><em>string</em></td>
409409
<td><strong>$next</strong></td>
410-
<td><p>(Optional) The label for the <em>next page</em> link.</p><p>Default is <code>&amp;raquo;</code> (which looks like <code>»</code>).</p></td>
410+
<td><p><span class="optional">Optional</span> The label for the <em>next page</em> link.</p><p>Default is <code>&amp;raquo;</code> (which looks like <code>»</code>).</p></td>
411411
</tr>
412412
<tr>
413413
<td><em>string</em></td>
414414
<td><strong>$progress</strong></td>
415-
<td><p>(Optional) The label for showing the current progress when in <a href="../Zebra_Pagination/Zebra_Pagination.html#methodcondensed">condensed</a> mode.</p><p>Default is <code>%d / %d</code></p><p>First <code>%d</code> will be replaced with the current page while the second one with the number of total pages.</p></td>
415+
<td><p><span class="optional">Optional</span> The label for showing the current progress when in <a href="../Zebra_Pagination/Zebra_Pagination.html#methodcondensed">condensed</a> mode.</p><p>Default is <code>%d / %d</code></p><p>First <code>%d</code> will be replaced with the current page while the second one with the number of total pages.</p></td>
416416
</tr>
417417
</table>
418418
<h5>Tags</h5>
@@ -448,7 +448,7 @@ <h5>Arguments</h5>
448448
<tr>
449449
<td><em>string</em></td>
450450
<td><strong>$method</strong></td>
451-
<td><p>(Optional) The method to be used for page propagation.</p><p>Valid values are:</p><p><ul><li><code>url</code> - page propagation is done in a SEO friendly way</li></ul><p> This method requires the <a href="https://httpd.apache.org/docs/current/mod/mod_rewrite.html">mod_rewrite</a> module to be enabled on your Apache server (or the equivalent for other web servers).</p><p>When using this method, the current page will be passed in the URL as</p><p><code>https://youwebsite.com/yourpage/[variable name][page number]/</code></p><p>where <code>variable name</code> is set through <a href="../Zebra_Pagination/Zebra_Pagination.html#methodvariable_name">variable_name</a> and <code>page number</code> represents the current page.</p><p><ul><li><code>get</code> - page propagation is done through <code>GET</code></li></ul><p> When using this method, the current page will be passed in the URL as</p><p><code>https://youwebsite.com/yourpage?[variable name]=[page number]</code></p><p>where <code>variable name</code> is set through <a href="../Zebra_Pagination/Zebra_Pagination.html#methodvariable_name">variable_name</a> and <code>page number</code> represents the current page.</p><p>Default is <code>get</code>.</p></td>
451+
<td><p><span class="optional">Optional</span> The method to be used for page propagation.</p><p>Valid values are:</p><p><ul><li><code>url</code> - page propagation is done in a SEO friendly way</li></ul><p> This method requires the <a href="https://httpd.apache.org/docs/current/mod/mod_rewrite.html">mod_rewrite</a> module to be enabled on your Apache server (or the equivalent for other web servers).</p><p>When using this method, the current page will be passed in the URL as</p><p><code>https://youwebsite.com/yourpage/[variable name][page number]/</code></p><p>where <code>variable name</code> is set through <a href="../Zebra_Pagination/Zebra_Pagination.html#methodvariable_name">variable_name</a> and <code>page number</code> represents the current page.</p><p><ul><li><code>get</code> - page propagation is done through <code>GET</code></li></ul><p> When using this method, the current page will be passed in the URL as</p><p><code>https://youwebsite.com/yourpage?[variable name]=[page number]</code></p><p>where <code>variable name</code> is set through <a href="../Zebra_Pagination/Zebra_Pagination.html#methodvariable_name">variable_name</a> and <code>page number</code> represents the current page.</p><p>Default is <code>get</code>.</p></td>
452452
</tr>
453453
</table>
454454
<a href="#top" class="top">top</a>
@@ -506,7 +506,7 @@ <h5>Arguments</h5>
506506
<tr>
507507
<td><em>boolean</em></td>
508508
<td><strong>$status</strong></td>
509-
<td><p>(Optional) Setting this property to <code>FALSE</code> will disable padding.</p><p>Default is <code>TRUE</code>.</p></td>
509+
<td><p><span class="optional">Optional</span> Setting this property to <code>FALSE</code> will disable padding.</p><p>Default is <code>TRUE</code>.</p></td>
510510
</tr>
511511
</table>
512512
<a href="#top" class="top">top</a>
@@ -586,7 +586,7 @@ <h5>Arguments</h5>
586586
<tr>
587587
<td><em>boolean</em></td>
588588
<td><strong>$return_output</strong></td>
589-
<td><p>(Optional) Setting this argument to <code>TRUE</code> will instruct the script to return the generated output rather than outputting it to the screen.</p><p>Default is <code>FALSE</code>.</p></td>
589+
<td><p><span class="optional">Optional</span> Setting this argument to <code>TRUE</code> will instruct the script to return the generated output rather than outputting it to the screen.</p><p>Default is <code>FALSE</code>.</p></td>
590590
</tr>
591591
</table>
592592
<a href="#top" class="top">top</a>
@@ -615,7 +615,7 @@ <h5>Arguments</h5>
615615
<tr>
616616
<td><em>boolean</em></td>
617617
<td><strong>$reverse</strong></td>
618-
<td><p>(Optional) Set it to <code>TRUE</code> to generate navigation links in reverse order.</p><p>Default is <code>FALSE</code>.</p></td>
618+
<td><p><span class="optional">Optional</span> Set it to <code>TRUE</code> to generate navigation links in reverse order.</p><p>Default is <code>FALSE</code>.</p></td>
619619
</tr>
620620
</table>
621621
<h5>Tags</h5>
@@ -701,7 +701,7 @@ <h5>Arguments</h5>
701701
<tr>
702702
<td><em>boolean</em></td>
703703
<td><strong>$status</strong></td>
704-
<td><p>(Optional) Setting this property to <code>FALSE</code> will disable trailing slashes on generated URLs when <a href="../Zebra_Pagination/Zebra_Pagination.html#methodmethod">method</a> is <code>url</code>.</p><p>Default is <code>TRUE</code> (trailing slashes are enabled by default).</p></td>
704+
<td><p><span class="optional">Optional</span> Setting this property to <code>FALSE</code> will disable trailing slashes on generated URLs when <a href="../Zebra_Pagination/Zebra_Pagination.html#methodmethod">method</a> is <code>url</code>.</p><p>Default is <code>TRUE</code> (trailing slashes are enabled by default).</p></td>
705705
</tr>
706706
</table>
707707
<a href="#top" class="top">top</a>
@@ -740,7 +740,7 @@ <h5>Arguments</h5>
740740
</tr>
741741
</table>
742742
<div id="doc_footer">
743-
Documentation generated on <span>Wed, 19 June 2024</span>
743+
Documentation generated on <span>Mon, 09 February 2026</span>
744744
</div>
745745
</div>
746746
<!-- Google tag (gtag.js) --><script async src="https://www.googletagmanager.com/gtag/js?id=G-0301ZD47Q7"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-0301ZD47Q7');</script></body>
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>Zebra Pagination - a generic, Twitter Bootstrap compatible, PHP pagination library that automatically generates navigation links - Docs for page Zebra_Pagination.php</title>
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<meta http-equiv="content-type" content="text/html;charset=UTF-8">
7+
<link rel="shortcut icon" href="/Zebra_Pagination/favicon.ico">
8+
<link rel="stylesheet" type="text/css" href="../media/reset.css">
9+
<link rel="stylesheet" type="text/css" href="../media/style.css">
10+
</head>
11+
<body>
12+
<div id="doc_header">
13+
<a href="https://github.com/stefangabos/Zebra_Pagination" class="projects-homepage">
14+
<img src="../media/zebra-logo.png" width="35" height="32" alt="Zebra_Pagination" >
15+
<a href="https://github.com/stefangabos/Zebra_Pagination" class="projects-homepage">Zebra Pagination</a>
16+
</a>
17+
<ul class="notype float">
18+
<!--
19+
<li><a href="../classtrees_Zebra_Pagination.html">class tree: Zebra_Pagination</a></li>
20+
-->
21+
<li><a href="../elementindex_Zebra_Pagination.html">Element index</a></li>
22+
<!--
23+
<li class="last"><a href="../elementindex.html">all elements</a></li>
24+
-->
25+
</ul>
26+
<div class="clear"></div>
27+
</div>
28+
<div id="phpdoc">
29+
<table class="stretch">
30+
<tr>
31+
<td class="sidebar">
32+
<div id="doc_sidebar">
33+
<p><strong>Project's homepage</strong></p>
34+
<ul>
35+
<li>
36+
<a href="https://github.com/stefangabos/Zebra_Pagination" class="projects-homepage">Zebra Pagination</a>
37+
</li>
38+
</ul>
39+
<p><strong>Classes:</strong></p>
40+
<ul>
41+
<li><a href="../Zebra_Pagination/Zebra_Pagination.html">Zebra_Pagination</a></li>
42+
</ul>
43+
<p class="hello-separator"></p>
44+
<p class="hello">
45+
<img src="https://avatars1.githubusercontent.com/u/741165?s=460&u=95c38afa1015f9ed705f3ad9848b3c2687b547db&v=4" width="131" alt="Stefan Gabos">
46+
Hi there!
47+
<br><br>
48+
That's me, Stefan Gabos, the author of this library.
49+
<br><br>
50+
If you like this project, please <a href="https://github.com/stefangabos/Zebra_Pagination" class="projects-homepage">star it on GitHub</a><strong>thank you</strong>!
51+
<br><br>
52+
I have a few other projects that you might be interested in — <a href="https://github.com/stefangabos">check them out</a> if you have the time.
53+
</p>
54+
</div>
55+
</td>
56+
<td style="background: #FFF; width: 100%">
57+
<div id="doc_content">
58+
<h2>File: <strong>Zebra_Pagination.php</strong></h2>
59+
<h6><strong>source file:</strong> /Zebra_Pagination.php</h6>
60+
<a name="top"></a>
61+
<h3>Classes:</h3>
62+
<dl>
63+
<dt><a href="../Zebra_Pagination/Zebra_Pagination.html">Zebra_Pagination</a></dt>
64+
<dd>A generic, Twitter Bootstrap compatible (versions 3, 4 and 5), pagination script that automatically generates navigation links as well as next/previous page links, given the total number of records and the number of records to be shown per page.</dd>
65+
</dl>
66+
</div>
67+
</td>
68+
</tr>
69+
</table>
70+
<div id="doc_footer">
71+
Documentation generated on <span>Mon, 09 February 2026</span>
72+
</div>
73+
</div>
74+
<!-- Google tag (gtag.js) --><script async src="https://www.googletagmanager.com/gtag/js?id=G-0301ZD47Q7"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-0301ZD47Q7');</script></body>
75+
</html>

docs/elementindex_Zebra_Pagination.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
</p>
5454
</div>
5555
</td>
56-
<td style="background: #FFF">
56+
<td style="background: #FFF; width: 100%">
5757
<div id="doc_content">
5858
<h2 id="top">Element index for <strong>Zebra_Pagination</strong></h2>
5959
<div id="doc_index">
@@ -219,7 +219,7 @@ <h3 id="z">z</h3>
219219
</tr>
220220
</table>
221221
<div id="doc_footer">
222-
Documentation generated on <span>Wed, 19 June 2024</span>
222+
Documentation generated on <span>Mon, 09 February 2026</span>
223223
</div>
224224
</div>
225225
<!-- Google tag (gtag.js) --><script async src="https://www.googletagmanager.com/gtag/js?id=G-0301ZD47Q7"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-0301ZD47Q7');</script></body>

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
</p>
5454
</div>
5555
</td>
56-
<td style="background: #FFF">
56+
<td style="background: #FFF; width: 100%">
5757
<div id="doc_content">
5858
<h2>Zebra Pagination - a generic, Twitter Bootstrap compatible, PHP pagination library that automatically generates navigation links</h2>
5959
<p>This is the documentation for <strong>Zebra_Pagination!</strong></p>
@@ -63,7 +63,7 @@ <h2>Zebra Pagination - a generic, Twitter Bootstrap compatible, PHP pagination l
6363
</tr>
6464
</table>
6565
<div id="doc_footer">
66-
Documentation generated on <span>Wed, 19 June 2024</span>
66+
Documentation generated on <span>Mon, 09 February 2026</span>
6767
</div>
6868
</div>
6969
<!-- Google tag (gtag.js) --><script async src="https://www.googletagmanager.com/gtag/js?id=G-0301ZD47Q7"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-0301ZD47Q7');</script></body>

docs/li_Zebra_Pagination.html

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>Zebra Pagination - a generic, Twitter Bootstrap compatible, PHP pagination library that automatically generates navigation links - Zebra Pagination - a generic, Twitter Bootstrap compatible, PHP pagination library that automatically generates navigation links</title>
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<meta http-equiv="content-type" content="text/html;charset=UTF-8">
7+
<link rel="shortcut icon" href="/Zebra_Pagination/favicon.ico">
8+
<link rel="stylesheet" type="text/css" href="media/reset.css">
9+
<link rel="stylesheet" type="text/css" href="media/style.css">
10+
</head>
11+
<body>
12+
<div id="doc_header">
13+
<a href="https://github.com/stefangabos/Zebra_Pagination" class="projects-homepage">
14+
<img src="media/zebra-logo.png" width="35" height="32" alt="Zebra_Pagination" >
15+
<a href="https://github.com/stefangabos/Zebra_Pagination" class="projects-homepage">Zebra Pagination</a>
16+
</a>
17+
<ul class="notype float">
18+
<!--
19+
<li><a href="classtrees_Zebra_Pagination.html">class tree: Zebra_Pagination</a></li>
20+
-->
21+
<li><a href="elementindex_Zebra_Pagination.html">Element index</a></li>
22+
<!--
23+
<li class="last"><a href="elementindex.html">all elements</a></li>
24+
-->
25+
</ul>
26+
<div class="clear"></div>
27+
</div>
28+
<div id="phpdoc">
29+
<table class="stretch">
30+
<tr>
31+
<td class="sidebar">
32+
<div id="doc_sidebar">
33+
<p><strong>Project's homepage</strong></p>
34+
<ul>
35+
<li>
36+
<a href="https://github.com/stefangabos/Zebra_Pagination" class="projects-homepage">Zebra Pagination</a>
37+
</li>
38+
</ul>
39+
<p><strong>Classes:</strong></p>
40+
<ul>
41+
<li><a href="Zebra_Pagination/Zebra_Pagination.html">Zebra_Pagination</a></li>
42+
</ul>
43+
<p class="hello-separator"></p>
44+
<p class="hello">
45+
<img src="https://avatars1.githubusercontent.com/u/741165?s=460&u=95c38afa1015f9ed705f3ad9848b3c2687b547db&v=4" width="131" alt="Stefan Gabos">
46+
Hi there!
47+
<br><br>
48+
That's me, Stefan Gabos, the author of this library.
49+
<br><br>
50+
If you like this project, please <a href="https://github.com/stefangabos/Zebra_Pagination" class="projects-homepage">star it on GitHub</a><strong>thank you</strong>!
51+
<br><br>
52+
I have a few other projects that you might be interested in — <a href="https://github.com/stefangabos">check them out</a> if you have the time.
53+
</p>
54+
</div>
55+
</td>
56+
<td style="background: #FFF; width: 100%">
57+
<div id="doc_content">
58+
<h2>Zebra Pagination - a generic, Twitter Bootstrap compatible, PHP pagination library that automatically generates navigation links</h2>
59+
<p>This is the documentation for <strong>Zebra_Pagination!</strong></p>
60+
<p>Use the links in the left sidebar to browse through the documentation.</p>
61+
</div>
62+
</td>
63+
</tr>
64+
</table>
65+
<div id="doc_footer">
66+
Documentation generated on <span>Mon, 09 February 2026</span>
67+
</div>
68+
</div>
69+
<!-- Google tag (gtag.js) --><script async src="https://www.googletagmanager.com/gtag/js?id=G-0301ZD47Q7"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-0301ZD47Q7');</script></body>
70+
</html>

0 commit comments

Comments
 (0)