How to create custom pagination in CakePHP?

CakePHP is a powerful PHP framework that provides developers with many useful tools and features. One of them is pagination, which helps us divide large amounts of data into several pages, making browsing and manipulation easier.

By default, CakePHP provides some basic pagination methods, but sometimes you may need to create some custom pagination methods. This article will show you how to create custom pagination in CakePHP.

Step 1: Create a custom paging class

First, we need to create a custom paging class. This class will be responsible for handling all paging related logic. Create a new file named CustomPaginator.php in the app/Lib/Utility directory and add the following code to the file:

    <?php
    App::uses('PaginatorComponent', 'Controller/Component');

    class CustomPaginator extends PaginatorComponent {
    
        // Override the default method to customize the pagination logic
        public function paginate($object = null, $scope = array(), $whitelist = array()) {
    
            // Get the current page number
            $page = isset($this->Controller->request->params['named']['page']) ? $this->Controller->request->params['named']['page'] : 1;
    
            // Set the default pagination values
            $perPage = 10;
            $start = ($page - 1) * $perPage;
    
            // Get the total count of records
            $count = $object->find('count', array('conditions' => $scope));
    
            // Build the pagination data
            $result = array(
                'count' => $count,
                'perPage' => $perPage,
                'page' => $page,
                'totalPages' => ceil($count / $perPage),
                'start' => $start,
                'end' => ($start + $perPage) > $count ? $count : ($start + $perPage - 1),
                'hasPrevPage' => $page > 1,
                'hasNextPage' => ($start + $perPage) < $count
            );
    
            // Set the pagination data in the controller
            $this->Controller->set('paging', $result);
    
            // Return the paginated records
            return $object->find('all', array('conditions' => $scope, 'limit' => $perPage, 'offset' => $start));
        }
    }

This custom pagination class is based on CakePHP’s default paginator class PaginatorComponent. We overridden the paginate() method to implement custom pagination logic. It takes the following parameters:

• $object: The model object to be paginated.
• $scope: Query conditions, used to filter records to be paginated.
• $whitelist: Whitelist array, used to allow or deny specific query parameters

In our implementation, we first get the number of the current page, and then set the default per page Number of records and starting record number. Next, we use the find() method to get the total number of records, and then calculate the total number of pages and the number of ending records. Finally, we set all the paging data to the controller's 'paging' variable and return the paginated records.

Step 2: Instantiate the custom paging class

Now that we have created the custom paging class, we need to instantiate it in the controller. To do this, we need to add the following code to our controller:

    <?php
    App::uses('AppController', 'Controller');
    App::uses('CustomPaginator', 'Lib/Utility');
    
    class UsersController extends AppController {
    
        public $components = array('CustomPaginator');
        public $paginate = array('CustomPaginator');
    
        public function index() {
            // Get all users
            $this->set('users', $this->CustomPaginator->paginate($this->User));
        }
    }

We use App::uses() to load the custom pagination class and then instantiate it in the controller. We also added the custom pagination class to the controller using the $components and $paginate attributes.

In our index() action, we call $CustomPaginator->paginate() and pass our User model object to it. We then set the paginated user data into view variables.

Step 3: Create a paginated view

Finally, we need to create a view to display the paginated data. Add the following code in the 'views/users/index.ctp' file:

    <h1> Users </h1>
    
    <ul>
    <?php foreach ($users as $user): ?>
        <li> <?php echo $user['User']['name']; ?> </li>
    <?php endforeach; ?>
    </ul>
    
    <div class="pagination">
        <?php
        echo $this->Paginator->prev('<< ' . __('Previous'), array(), null, array('class' => 'disabled'));
        echo $this->Paginator->numbers();
        echo $this->Paginator->next(__('Next') . ' >>', array(), null, array('class' => 'disabled'));
        ?>
    </div>

This view is just a simple list of Users and then displays paginated navigation links.

We use the prev(), numbers() and next() methods of PaginatorHelper to generate navigation links. These methods will generate links based on the '$CustomPaginator' component we defined in the controller.

Conclusion

Custom pagination can give you greater control and flexibility to meet your specific needs. In this article, we show you how to create custom pagination in CakePHP. Now you can apply this knowledge to develop more customized applications.

The above is the detailed content of How to create custom pagination in CakePHP?. For more information, please follow other related articles on the PHP Chinese website!