libraries/Pagination.php

   1 <?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');\r
   2 /**\r
   3  * CodeIgniter\r
   4  *\r
   5  * An open source application development framework for PHP 4.3.2 or newer\r
   6  *\r
   7  * @package             CodeIgniter\r
   8  * @author              ExpressionEngine Dev Team\r
   9  * @copyright   Copyright (c) 2008, EllisLab, Inc.\r
  10  * @license             http://codeigniter.com/user_guide/license.html\r
  11  * @link                http://codeigniter.com\r
  12  * @since               Version 1.0\r
  13  * @filesource\r
  14  */\r
  15 \r
  16 // ------------------------------------------------------------------------\r
  17 \r
  18 /**\r
  19  * Pagination Class\r
  20  *\r
  21  * @package             CodeIgniter\r
  22  * @subpackage  Libraries\r
  23  * @category    Pagination\r
  24  * @author              ExpressionEngine Dev Team\r
  25  * @link                http://codeigniter.com/user_guide/libraries/pagination.html\r
  26  */\r
  27 class CI_Pagination {\r
  28 \r
  29         var $base_url                   = ''; // The page we are linking to\r
  30         var $total_rows                 = ''; // Total number of items (database results)\r
  31         var $per_page                   = 10; // Max number of items you want shown per page\r
  32         var $num_links                  =  2; // Number of "digit" links to show before/after the currently viewed page\r
  33         var $cur_page                   =  0; // The current page being viewed\r
  34         var $first_link                 = '&lsaquo; First';\r
  35         var $next_link                  = '&gt;';\r
  36         var $prev_link                  = '&lt;';\r
  37         var $last_link                  = 'Last &rsaquo;';\r
  38         var $uri_segment                = 3;\r
  39         var $full_tag_open              = '';\r
  40         var $full_tag_close             = '';\r
  41         var $first_tag_open             = '';\r
  42         var $first_tag_close    = '&nbsp;';\r
  43         var $last_tag_open              = '&nbsp;';\r
  44         var $last_tag_close             = '';\r
  45         var $cur_tag_open               = '&nbsp;<b>';\r
  46         var $cur_tag_close              = '</b>';\r
  47         var $next_tag_open              = '&nbsp;';\r
  48         var $next_tag_close             = '&nbsp;';\r
  49         var $prev_tag_open              = '&nbsp;';\r
  50         var $prev_tag_close             = '';\r
  51         var $num_tag_open               = '&nbsp;';\r
  52         var $num_tag_close              = '';\r
  53         var $page_query_string  = FALSE;\r
  54         var $query_string_segment = 'per_page';\r
  55 \r
  56         /**\r
  57          * Constructor\r
  58          *\r
  59          * @access      public\r
  60          * @param       array   initialization parameters\r
  61          */\r
  62         function CI_Pagination($params = array())\r
  63         {\r
  64                 if (count($params) > 0)\r
  65                 {\r
  66                         $this->initialize($params);             \r
  67                 }\r
  68                 \r
  69                 log_message('debug', "Pagination Class Initialized");\r
  70         }\r
  71         \r
  72         // --------------------------------------------------------------------\r
  73         \r
  74         /**\r
  75          * Initialize Preferences\r
  76          *\r
  77          * @access      public\r
  78          * @param       array   initialization parameters\r
  79          * @return      void\r
  80          */\r
  81         function initialize($params = array())\r
  82         {\r
  83                 if (count($params) > 0)\r
  84                 {\r
  85                         foreach ($params as $key => $val)\r
  86                         {\r
  87                                 if (isset($this->$key))\r
  88                                 {\r
  89                                         $this->$key = $val;\r
  90                                 }\r
  91                         }\r
  92                 }\r
  93         }\r
  94         \r
  95         // --------------------------------------------------------------------\r
  96         \r
  97         /**\r
  98          * Generate the pagination links\r
  99          *\r
 100          * @access      public\r
 101          * @return      string\r
 102          */     \r
 103         function create_links()\r
 104         {\r
 105                 // If our item count or per-page total is zero there is no need to continue.\r
 106                 if ($this->total_rows == 0 OR $this->per_page == 0)\r
 107                 {\r
 108                    return '';\r
 109                 }\r
 110 \r
 111                 // Calculate the total number of pages\r
 112                 $num_pages = ceil($this->total_rows / $this->per_page);\r
 113 \r
 114                 // Is there only one page? Hm... nothing more to do here then.\r
 115                 if ($num_pages == 1)\r
 116                 {\r
 117                         return '';\r
 118                 }\r
 119 \r
 120                 // Determine the current page number.           \r
 121                 $CI =& get_instance();\r
 122                 \r
 123                 if ($CI->config->item('enable_query_strings') === TRUE OR $this->page_query_string === TRUE)\r
 124                 {\r
 125                         if ($CI->input->get($this->query_string_segment) != 0)\r
 126                         {\r
 127                                 $this->cur_page = $CI->input->get($this->query_string_segment);\r
 128                                 \r
 129                                 // Prep the current page - no funny business!\r
 130                                 $this->cur_page = (int) $this->cur_page;\r
 131                         }\r
 132                 }\r
 133                 else\r
 134                 {\r
 135                         if ($CI->uri->segment($this->uri_segment) != 0)\r
 136                         {\r
 137                                 $this->cur_page = $CI->uri->segment($this->uri_segment);\r
 138                                 \r
 139                                 // Prep the current page - no funny business!\r
 140                                 $this->cur_page = (int) $this->cur_page;\r
 141                         }\r
 142                 }\r
 143 \r
 144                 $this->num_links = (int)$this->num_links;\r
 145                 \r
 146                 if ($this->num_links < 1)\r
 147                 {\r
 148                         show_error('Your number of links must be a positive number.');\r
 149                 }\r
 150                                 \r
 151                 if ( ! is_numeric($this->cur_page))\r
 152                 {\r
 153                         $this->cur_page = 0;\r
 154                 }\r
 155                 \r
 156                 // Is the page number beyond the result range?\r
 157                 // If so we show the last page\r
 158                 if ($this->cur_page > $this->total_rows)\r
 159                 {\r
 160                         $this->cur_page = ($num_pages - 1) * $this->per_page;\r
 161                 }\r
 162                 \r
 163                 $uri_page_number = $this->cur_page;\r
 164                 $this->cur_page = floor(($this->cur_page/$this->per_page) + 1);\r
 165 \r
 166                 // Calculate the start and end numbers. These determine\r
 167                 // which number to start and end the digit links with\r
 168                 $start = (($this->cur_page - $this->num_links) > 0) ? $this->cur_page - ($this->num_links - 1) : 1;\r
 169                 $end   = (($this->cur_page + $this->num_links) < $num_pages) ? $this->cur_page + $this->num_links : $num_pages;\r
 170 \r
 171                 // Is pagination being used over GET or POST?  If get, add a per_page query\r
 172                 // string. If post, add a trailing slash to the base URL if needed\r
 173                 if ($CI->config->item('enable_query_strings') === TRUE OR $this->page_query_string === TRUE)\r
 174                 {\r
 175                         $this->base_url = rtrim($this->base_url).'&amp;'.$this->query_string_segment.'=';\r
 176                 }\r
 177                 else\r
 178                 {\r
 179                         $this->base_url = rtrim($this->base_url, '/') .'/';\r
 180                 }\r
 181 \r
 182                 // And here we go...\r
 183                 $output = '';\r
 184 \r
 185                 // Render the "First" link\r
 186                 if  ($this->cur_page > ($this->num_links + 1))\r
 187                 {\r
 188                         $output .= $this->first_tag_open.'<a href="'.$this->base_url.'">'.$this->first_link.'</a>'.$this->first_tag_close;\r
 189                 }\r
 190 \r
 191                 // Render the "previous" link\r
 192                 if  ($this->cur_page != 1)\r
 193                 {\r
 194                         $i = $uri_page_number - $this->per_page;\r
 195                         if ($i == 0) $i = '';\r
 196                         $output .= $this->prev_tag_open.'<a href="'.$this->base_url.$i.'">'.$this->prev_link.'</a>'.$this->prev_tag_close;\r
 197                 }\r
 198 \r
 199                 // Write the digit links\r
 200                 for ($loop = $start -1; $loop <= $end; $loop++)\r
 201                 {\r
 202                         $i = ($loop * $this->per_page) - $this->per_page;\r
 203                                         \r
 204                         if ($i >= 0)\r
 205                         {\r
 206                                 if ($this->cur_page == $loop)\r
 207                                 {\r
 208                                         $output .= $this->cur_tag_open.$loop.$this->cur_tag_close; // Current page\r
 209                                 }\r
 210                                 else\r
 211                                 {\r
 212                                         $n = ($i == 0) ? '' : $i;\r
 213                                         $output .= $this->num_tag_open.'<a href="'.$this->base_url.$n.'">'.$loop.'</a>'.$this->num_tag_close;\r
 214                                 }\r
 215                         }\r
 216                 }\r
 217 \r
 218                 // Render the "next" link\r
 219                 if ($this->cur_page < $num_pages)\r
 220                 {\r
 221                         $output .= $this->next_tag_open.'<a href="'.$this->base_url.($this->cur_page * $this->per_page).'">'.$this->next_link.'</a>'.$this->next_tag_close;\r
 222                 }\r
 223 \r
 224                 // Render the "Last" link\r
 225                 if (($this->cur_page + $this->num_links) < $num_pages)\r
 226                 {\r
 227                         $i = (($num_pages * $this->per_page) - $this->per_page);\r
 228                         $output .= $this->last_tag_open.'<a href="'.$this->base_url.$i.'">'.$this->last_link.'</a>'.$this->last_tag_close;\r
 229                 }\r
 230 \r
 231                 // Kill double slashes.  Note: Sometimes we can end up with a double slash\r
 232                 // in the penultimate link so we'll kill all double slashes.\r
 233                 $output = preg_replace("#([^:])//+#", "\\1/", $output);\r
 234 \r
 235                 // Add the wrapper HTML if exists\r
 236                 $output = $this->full_tag_open.$output.$this->full_tag_close;\r
 237                 \r
 238                 return $output;         \r
 239         }\r
 240 }\r
 241 // END Pagination Class\r
 242 \r
 243 /* End of file Pagination.php */\r
 244 /* Location: ./system/libraries/Pagination.php */