CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 5.0 Chiffon API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 5.0
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
      • Exception
      • Locator
      • Paging
        • Exception
    • Error
    • Event
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • TestSuite
    • Utility
    • Validation
    • View

Class PaginatedResultSet

Paginated resultset.

Namespace: Cake\Datasource\Paging

Property Summary

  • $params protected
    array

    Paging params.

Method Summary

  • __construct() public

    Constructor

  • count() public
  • currentPage() public

    Get current page number.

  • hasNextPage() public

    Get whether there's a next page.

  • hasPrevPage() public

    Get whether there's a previous page.

  • items() public

    Get paginated items.

  • jsonSerialize() public

    Provide data which should be serialized to JSON.

  • pageCount() public

    Get total page count.

  • pagingParam() public

    Get paging param.

  • pagingParams() public

    Get all paging params.

  • perPage() public

    Get items per page.

  • totalCount() public

    Get Total items counts.

Method Detail

__construct() ¶ public

__construct(Traversable<T> $results, array $params)

Constructor

Parameters
Traversable<T> $results

Resultset instance.

array $params

Paging params.

count() ¶ public

count(): int
Returns
int

currentPage() ¶ public

currentPage(): int

Get current page number.

Returns
int

hasNextPage() ¶ public

hasNextPage(): bool

Get whether there's a next page.

Returns
bool

hasPrevPage() ¶ public

hasPrevPage(): bool

Get whether there's a previous page.

Returns
bool

items() ¶ public

items(): Traversable<T>

Get paginated items.

Returns
Traversable<T>

jsonSerialize() ¶ public

jsonSerialize(): array

Provide data which should be serialized to JSON.

Returns
array

pageCount() ¶ public

pageCount(): int|null

Get total page count.

Returns
int|null

pagingParam() ¶ public

pagingParam(string $name): mixed

Get paging param.

Parameters
string $name
Returns
mixed

pagingParams() ¶ public

pagingParams(): array

Get all paging params.

Returns
array

perPage() ¶ public

perPage(): int

Get items per page.

Returns
int

totalCount() ¶ public

totalCount(): int|null

Get Total items counts.

Returns
int|null

Property Detail

$params ¶ protected

Paging params.

Type
array
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs