Back to Pagination class

Method getPaginationPages

public array
getPaginationPages
()
Create and return the pagination pages list, ie. Previous, Next, 1 2 3 ... x.
Returns
  • array Pagination pages list.
Since
  • 3.3
Class: Pagination
Project: Joomla

Method getPaginationPages - Source code

/**
 * Create and return the pagination pages list, ie. Previous, Next, 1 2 3 ... x.
 *
 * @return  array  Pagination pages list.
 *
 * @since   3.3
 */
public function getPaginationPages()
{
    $list = array();
    if ($this->total > $this->limit) {
        // Build the page navigation list.
        $data = $this->_buildDataObject();
        // All
        $list['all']['active'] = $data->all->base !== null;
        $list['all']['data'] = $data->all;
        // Start
        $list['start']['active'] = $data->start->base !== null;
        $list['start']['data'] = $data->start;
        // Previous link
        $list['previous']['active'] = $data->previous->base !== null;
        $list['previous']['data'] = $data->previous;
        // Make sure it exists
        $list['pages'] = array();
        foreach ($data->pages as $i => $page) {
            $list['pages'][$i]['active'] = $page->base !== null;
            $list['pages'][$i]['data'] = $page;
        }
        $list['next']['active'] = $data->next->base !== null;
        $list['next']['data'] = $data->next;
        $list['end']['active'] = $data->end->base !== null;
        $list['end']['data'] = $data->end;
    }
    return $list;
}