Overview

Namespaces

  • Charcoal
    • Loader
    • Model
      • Service
      • ServiceProvider
    • Source
      • Database
    • Validator

Classes

  • AbstractSource
  • DatabaseSource
  • DatabaseSourceConfig
  • Filter
  • Order
  • Pagination
  • SourceConfig

Interfaces

  • DatabaseSourceInterface
  • FilterInterface
  • OrderInterface
  • PaginationInterface
  • SourceInterface
  • StorableInterface

Traits

  • StorableTrait
  • Overview
  • Namespace
  • Class

Interface PaginationInterface

Pagination Interface.

Direct known implementers

Charcoal\Source\Pagination

Indirect known implementers

Charcoal\Source\Database\DatabasePagination
Namespace: Charcoal\Source
Located at Charcoal/Source/PaginationInterface.php
Methods summary
public Charcoal\Source\Pagination
# setData( array $data )

Parameters

$data
The pagination data (page, num_per_page).

Returns

Charcoal\Source\Pagination
Chainable
public Charcoal\Source\Pagination
# setPage( integer $page )

Parameters

$page
The current page. Starts at 0.

Returns

Charcoal\Source\Pagination
(Chainable)
public integer
# page( )

Returns

integer
public Charcoal\Source\Pagination
# setNumPerPage( integer $num )

Parameters

$num
The number ot item to retrieve per page.

Returns

Charcoal\Source\Pagination
(Chainable)

Throws

InvalidArgumentException
If the parameter is not numeric or < 0.
public integer
# numPerPage( )

Returns

integer
public integer
# first( )

Returns

integer
public integer
# last( )

Can be greater than the actual number of items to retrieve.

Can be greater than the actual number of items to retrieve.

Returns

integer
API documentation generated by ApiGen