Differences

This shows you the differences between two versions of the page.

--- v5:addons:addons_index [2016/02/02 01:38] – [The xmlrpc library] mnewnham
+++ v5:addons:addons_index [2023/05/12 19:12] (current) – [Paging & Scrolling with ADOdb Pager] move screenshot before code snippet dregad
@@ Line 177: / Line 177: @@
 ------------------------------
 ===== The xmlrpc library ======
-This addon provides an interface between the adodb recordset and the php xmlrpc library. [[v5:addons:xmlrpc|More Information]].
+This addon provides an interface between the adodb recordset and the php xmlrpc library. [[v5:addons:xmlrpc|More Information]]
+-----------------------------
+===== Paging & Scrolling with ADOdb Pager =====
+<WRAP right box>
+== Requires ==
+  adodb-pager.inc.php
+</WRAP>
+The following code snippet creates a very simple pager like the sample one shown below, allowing you to navigate between pages of a recordset.
+{{:v5:addons:adodb_pager_sample_output.png|Sample output from ADODB_Pager}}
+<WRAP clear/>
+<code php>
+include_once 'adodb/adodb.inc.php';
+include_once 'adodb/adodb-pager.inc.php';
+$db = ADONewConnection('mysqli');
+$db->connect('localhost', 'user', 'password', 'adodb');
+$sql = 'select * from adoxyz';
+$pager = new ADODB_Pager($db, $sql);
+$pager->render(5);
+</code>
+The number of rows to display at one time is controled by the //Render($rows)// method. If you do not pass any value to Render(), the Pager will default to 10 records per page.
+You can control the column titles by aliasing them in your SQL (supported by most databases):
+<code php>
+$sql = 'select id as "ID",
+       firstname as "First Name",
+       lastname as "Last Name",
+       created as "Date Created"
+       from adoxyz';
+</code>
+The ADODB_Pager code can be adapted by a programmer to improve the layout, e.g. replacing the text links by images, and the dull white background by more interesting colors.
+By default, special characters in the displayed data will be escaped to prevent execution of HTML code. If you wish to have them interpreted instead, before calling Render() you can set
+<code php>
+  $pager->htmlSpecialChars = false;
+</code>
+<WRAP important>
+This is a **security risk**, unescaped HTML will leave you vulnerable to Cross-site scripting (XSS) attacks.
+Use with caution, and only with trusted data.
+</WRAP>