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

Class Pagination

Implementation, as concrete class, of the PaginationInterface.

Charcoal\Source\Pagination implements Charcoal\Source\PaginationInterface

Direct known subclasses

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

Parameters

$data
The pagination data (page, num_per_page).

Returns

Charcoal\Source\Pagination
Chainable

Implementation of

Charcoal\Source\PaginationInterface::setData()
public Charcoal\Source\Pagination
# setPage( integer $page )

Parameters

$page
The current page. Start at 0.

Returns

Charcoal\Source\Pagination
(Chainable)

Throws

InvalidArgumentException
If the parameter is not numeric or < 0.

Implementation of

Charcoal\Source\PaginationInterface::setPage()
public integer
# page( )

Returns

integer

Implementation of

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

Parameters

$num
The number of results to retrieve, per page.

Returns

Charcoal\Source\Pagination
(Chainable)

Throws

InvalidArgumentException
If the parameter is not numeric or < 0.

Implementation of

Charcoal\Source\PaginationInterface::setNumPerPage()
public integer
# numPerPage( )

Returns

integer

Implementation of

Charcoal\Source\PaginationInterface::numPerPage()
public integer
# first( )

Returns

integer

Implementation of

Charcoal\Source\PaginationInterface::first()
public integer
# last( )

Can be greater than the actual number of items in Storage

Can be greater than the actual number of items in Storage

Returns

integer

Implementation of

Charcoal\Source\PaginationInterface::last()
Constants summary
integer DEFAULT_PAGE
# 0
integer DEFAULT_NUM_PER_PAGE
# 0
Properties summary
protected integer $page

$page

$page

# Charcoal\Source\Pagination::DEFAULT_PAGE
protected integer $numPerPage

$numPerPage

$numPerPage

# Charcoal\Source\Pagination::DEFAULT_NUM_PER_PAGE
API documentation generated by ApiGen