Class: Pager

Pager Pager( [integer $offset = 0], [integer $limit = 20], [integer $total = 0], [integer $maxPages = 5])

Constructor method.

1     <?php
2     
3      loader_import ('saf.GUI.Pager');
4     
5      $pg = new Pager (
6          cgi_param ('offset'),
7          10 // limit
8      );
9      if (! $pg->query ('select * from some_table')) {
10         die ($pg->error);
11     }
12    
13     $pg->url = '/index/myapp-somelist-action';
14    
15     $template = '<!-- use one of the built-in pager templates -->
16         <p id="pager">{spt PAGER_TEMPLATE_PAGE_LIST}</p>
17         {alt #eee #fff}
18         <table border="0" cellpadding="3">
19             {filter ucwords}
20                 <tr style="background-color: {alt/next}">
21                     <th>#</th>
22                     {loop array_keys (get_object_vars (pager.results[0]))}
23                     <th>{loop/_value}</th>
24                     {end loop}
25                 </tr>
26             {end filter}
27         {loop pager.results}
28         <tr style="background-color: {alt/next}">
29             <td>{loop/_index}</td>
30             {loop loop._properties}
31             <td>{loop/_value}</td>
32             {end loop}
33         </tr>
34         {end loop}
35     </table>';
36    
37     template_simple_register ('pager', $pg);
38     echo template_simple ($template);
39    
40     ? >

Parameters:

array getInfo( )

Calculates the pager info and returns it as an associative array.

Also stores it internally as properties of the object, for use in the included simple templates.

Tags:

array getPages( [mixed $max = true])

Creates a two-dimensional array of pages to be displayed. The inner arrays contain the following keys:

• page (page number)
• offset (offset of this page)
• separator (boolean, whether to display a separator next to this page or not)
• current (boolean, whether this is the currently active page)

array query( string $sql, [mixed $bind = false])

Returns a database query's results, limited by Pager's current $limit and $offset settings. Also sets the $total property and calls getInfo().

Tags:

Parameters:

void setData( array &$data)

This method allows you to set external data instead of using the query() method. Note that you must set $total and call update() yourself after calling this method.

Parameters:

void setUrl( string $url, mixed 1)

Special setter for the $url property. Accepts a variable number

of arguments, the first of which is the format string (the URL itself with %s as placeholders for values). The arguments to pass to the format string (uses vsprintf() to do so) can be specified in one of three ways:

• by passing an array as the 2nd parameter
• by passing an object as the 2nd parameter (which is then cast into an array for you)
• by passing an arbitrary number of additional parameters separately.

The benefit here is that the arguments are sent through the urlencode() function before being inserted into the URL string, which adds some extra semi-automatic security pour tous.

Parameters:

array update( )

Alias for getInfo().

Tags: