Pagination Class
- -CodeIgniter's Pagination class is very easy to use, and it is 100% customizable, either dynamically or via stored preferences.
- -If you are not familiar with the term "pagination", it refers to links that allows you to navigate from page to page, like this:
- -« First < 1 2 3 4 5 > Last »
-
-Example
- -Here is a simple example showing how to create pagination in one of your controller functions:
- -
-$this->load->library('pagination');
-$config['base_url'] = 'http://example.com/index.php/test/page/';
-$config['total_rows'] = 200;
-$config['per_page'] = 20;
-
-$this->pagination->initialize($config);
-
-
-echo $this->pagination->create_links();
-
-Notes:
- -The $config array contains your configuration variables. It is passed to the $this->pagination->initialize function as shown above. Although there are some twenty items you can configure, at -minimum you need the three shown. Here is a description of what those items represent:
- --
-
- base_url This is the full URL to the controller class/function containing your pagination. In the example - above, it is pointing to a controller called "Test" and a function called "page". Keep in mind that you can - re-route your URI if you need a different structure. -
- total_rows This number represents the total rows in the result set you are creating pagination for. - Typically this number will be the total rows that your database query returned. - -
- per_page The number of items you intend to show per page. In the above example, you would be showing 20 items per page. -
The create_links() function returns an empty string when there is no pagination to show.
- - -Setting preferences in a config file
- -If you prefer not to set preferences using the above method, you can instead put them into a config file. -Simply create a new file called pagination.php, add the $config -array in that file. Then save the file in: config/pagination.php and it will be used automatically. You -will NOT need to use the $this->pagination->initialize function if you save your preferences in a config file.
- - -Customizing the Pagination
- -The following is a list of all the preferences you can pass to the initialization function to tailor the display.
- - -$config['uri_segment'] = 3;
- -The pagination function automatically determines which segment of your URI contains the page number. If you need -something different you can specify it.
- -$config['num_links'] = 2;
- -The number of "digit" links you would like before and after the selected page number. For example, the number 2 - will place two digits on either side, as in the example links at the very top of this page.
- -$config['use_page_numbers'] = TRUE;
-By default, the URI segment will use the starting index for the items you are paginating. If you prefer to show the the actual page number, set this to TRUE.
- -$config['page_query_string'] = TRUE;
-By default, the pagination library assume you are using URI Segments, and constructs your links something like
-http://example.com/index.php/test/page/20
If you have $config['enable_query_strings'] set to TRUE your links will automatically be re-written using Query Strings. This option can also be explictly set. Using $config['page_query_string'] set to TRUE, the pagination link will become.
-http://example.com/index.php?c=test&m=page&per_page=20
Note that "per_page" is the default query string passed, however can be configured using $config['query_string_segment'] = 'your_string'
-Adding Enclosing Markup
- -If you would like to surround the entire pagination with some markup you can do it with these two prefs:
- -$config['full_tag_open'] = '<p>';
-The opening tag placed on the left side of the entire result.
- -$config['full_tag_close'] = '</p>';
-The closing tag placed on the right side of the entire result.
- - -Customizing the First Link
- -$config['first_link'] = 'First';
-The text you would like shown in the "first" link on the left. If you do not want this link rendered, you can set its value to FALSE.
- -$config['first_tag_open'] = '<div>';
-The opening tag for the "first" link.
- -$config['first_tag_close'] = '</div>';
-The closing tag for the "first" link.
- -Customizing the Last Link
- -$config['last_link'] = 'Last';
-The text you would like shown in the "last" link on the right. If you do not want this link rendered, you can set its value to FALSE.
- -$config['last_tag_open'] = '<div>';
-The opening tag for the "last" link.
- -$config['last_tag_close'] = '</div>';
-The closing tag for the "last" link.
- -Customizing the "Next" Link
- -$config['next_link'] = '>';
-The text you would like shown in the "next" page link. If you do not want this link rendered, you can set its value to FALSE.
- -$config['next_tag_open'] = '<div>';
-The opening tag for the "next" link.
- -$config['next_tag_close'] = '</div>';
-The closing tag for the "next" link.
- -Customizing the "Previous" Link
- -$config['prev_link'] = '<';
-The text you would like shown in the "previous" page link. If you do not want this link rendered, you can set its value to FALSE.
- -$config['prev_tag_open'] = '<div>';
-The opening tag for the "previous" link.
- -$config['prev_tag_close'] = '</div>';
-The closing tag for the "previous" link.
- -Customizing the "Current Page" Link
- -$config['cur_tag_open'] = '<b>';
-The opening tag for the "current" link.
- -$config['cur_tag_close'] = '</b>';
-The closing tag for the "current" link.
- - -Customizing the "Digit" Link
- -$config['num_tag_open'] = '<div>';
-The opening tag for the "digit" link.
- -$config['num_tag_close'] = '</div>';
-The closing tag for the "digit" link.
- -Hiding the Pages
- -If you wanted to not list the specific pages (for example, you only want "next" and "previous" links), you can suppress their rendering by adding:
- -
-$config['display_pages'] = FALSE;
-
-
-
-Adding a class to every anchor
- -If you want to add a class attribute to every link rendered by the pagination class, you can set the config "anchor_class" equal to the classname you want.
- -