void __construct ()

Constructor of the class.

Initializes the class and the default properties.

void always_show_navigation ( [ boolean $status = true ] )

By default, the previous page and next page links are always shown.

By disabling this feature, the previous page and next page links will only be shown if there are more pages than selectable pages.

1. // show "previous page" / "next page" only if there are more pages
2. // than there are selectable pages
3. $pagination->always_show_navigation(false);

Arguments

Tags

void avoid_duplicate_content ( [ boolean $status = true ] )

From a search engine's point of view URL https://www.mywebsite.com/list points to a different place than where https://www.mywebsite.com/list?page=1 points to (because of the added query string in the second URL), but because both have the same content, your page will get an SEO penalization.

In order to avoid this, the library will have for the first page (or last, if you are displaying links in reverse order) the same path as you have for when you are accessing the page for the first (un-paginated) time.

If you want to disable this behavior call this method with its argument set to FALSE.

1. // don't avoid duplicate content
2. $pagination->avoid_duplicate_content(false);

Arguments

Tags

void base_url ( [ string $base_url = '' ] , [ boolean $preserve_query_string = true ] )

The base URL to be used when generating the navigation links.

This is helpful for the case when the URL where the records are paginated may have parameters that are not needed for subsequent requests generated by pagination.

For example, suppose some records are paginated at https://yourwebsite/mypage/. When a record from the list is updated, the URL could become something like https://youwebsite/mypage/?action=updated. Based on the value of action a message would be shown to the user.

Because of the way this script works, the pagination links would become

https://youwebsite/mypage/?action=updated&page=[page number]

when method is get and variable_name is page

https://youwebsite/mypage/page[page number]/?action=updated

when method is url and variable_name is page

As a result, whenever the user would paginate, the message would be shown to him again and again because action will be preserved in the URL!

The solution is to set the base_url to https://youwebsite/mypage/ and in this way, regardless of how the URL changes, the pagination links will always be in the form of

https://youwebsite/mypage/?page=[page number]

when method is get and variable_name is page

https://youwebsite/mypage/page[page number]/

when method is url and variable_name is page

Of course, you may still have query strings in the value of the base_url if you wish so, and these will be preserved when paginating.

If you need to preserve the hash in the URL, make sure to include the zebra_pagination.js file in your page!

Arguments

void condensed ( [ boolean $extra_condensed = false ] )

Removes pagination links leaving only the next and previous buttons, links to the first and last pages, as well as a label showing the current page and the total available pages.

Setting selectable pages to a value lower than 5 will automatically turn condensed mode on.

Arguments

Tags

void css_classes ( array $css_classes )

Allows defining of custom CSS class names to be applied to the HTML markup.

Arguments

int get_page ()

Returns the number of the currently selected page.

1. // echoes the current page
2. echo $pagination->get_page();

Tags

int get_pages ()

Returns the total number of available pages.

The value is computed based on the total number of records and the number of records to be shown per page.

1. // get the total number of pages
2. echo $pagination->get_pages();

Tags

void labels ( [ string $previous = '«' ] , [ string $next = '»' ] , [ string $progress = '%d / %d' ] )

Change the labels for the previous page and next page links as well as the label used to indicate progress when in condensed mode.

1. // change the default labels
2. $pagination->labels('Previous', 'Next', 'Page %d of %d pages');

Arguments

Tags

void method ( [ string $method = 'get' ] )

Sets the method to be used for page propagation.

1. // set the method to the SEO friendly way
2. $pagination->method('url');

Arguments

void navigation_position ( string $position )

Sets the position of the next and previous page, relative to the links to individual pages.

Arguments

Tags

void padding ( [ boolean $status = true ] )

Sets whether page numbers should be prefixed with zeros.

This is useful to keep the layout consistent by having the same number of characters for each page number.

1. // disable padding numbers with zeros
2. $pagination->padding(false);

Arguments

void records ( integer $records )

Defines the total number of records that need to be paginated.

Based on this and on the number of records to be shown per page, the script will know how many pages there are.

1. // tell the script that there are 100 total records
2. $pagination->records(100);

Arguments

void records_per_page ( integer $records_per_page )

Defines the number of records that are displayed on a single page.

Based on this and on the total number of records, the script will know how many pages there are.

1. // tell the class that there are 20 records displayed on one page
2. $pagination->records_per_page(20);

Arguments

mixed render ( [ boolean $return_output = false ] )

Generates and outputs or returns the HTML markup for the pagination.

1. // generate output
2. // don't echo it but return it instead
3. $output = $pagination->render(true);

If Twitter Bootstrap is not present on the page, make sure to load the default styles by including the zebra_pagination.css file.

Arguments

void reverse ( [ boolean $reverse = false ] )

By default, pagination links are shown in natural order, from 1 to the number of total pages.

Calling this method with the TRUE argument will generate links in reverse order, from the number of total pages down to 1.

1. // show pagination links in reverse order rather than in natural order
2. $pagination->reverse(true);

Arguments

Tags

void selectable_pages ( integer $selectable_pages )

Defines the number of pagination links to be displayed at once besides previous page and next page links.

1. // display links to 15 pages
2. $pagination->selectable_pages(15);

Arguments

void set_page ( integer $page )

Sets the current page.

1. // sets the fifth page as the current page
2. $pagination->set_page(5);

Arguments

void trailing_slash ( [ boolean $status = true ] )

Enables or disables trailing slash on the generated URLs when method is url.

From an SEO perspective, a page with trailing slash is considered different than the same page without the trailing slash. Read more on the subject at Google Webmaster's official blog.

1. // disables trailing slashes on generated URLs
2. $pagination->trailing_slash(false);

Arguments

void variable_name ( string $variable_name )

Sets the variable name to be used for page propagation.

1. // sets the variable name to "foo"
2. // now, in the URL, the current page will be passed either as
3. // "foo=[page number]" (if method is "get") or as
4. // "/foo[page number]" (if method is "url")
5. $pagination->variable_name('foo');

Arguments