Pagination - Zeanwork Framework PHP

Pagination

O helper pagination ajuda você a trabalhar com paginação de dados de um model.

Carregando o helper

Para você utilizar este helper, você prescisa definir que irá utiliza-lo. Veja mais em: Controllers > Carregando models, components, helpers e extensions.
O nome deste helper é pagination, este é o nome que você irá utilizar para carrega-lo.

Configurando as opções

$numbersOptions

Esta variável define as opções para a geração dos números.

Veja exemplo:

$this->pagination->numbersOptions = array(
		  'maxButtons' => 13 //Máximo de botões
		, 'separator' => ' ' //seperador
		, 'tag' => 'span' //Tipo da tag
		, 'current' => 'current' //Class para o botão selecionado
	);

$textDescription

Esta variável define os textos que será utilizado na função PaginationHelper::description().

Veja exemplo:

$this->pagination->textDescription = array(
		  'results' => 'Resultados'
		, 'of' => 'de'
		, 'pages' => 'Páginas'
	);

Definindo o model da paginação

model()

Este método define o model dos dados.

Parâmetros:

string $modelName

Nome do model.

Veja exemplo:

$this->pagination->model('posts');

Resgatando o números da página

getPage()

Este método retorna o número da página que esta sendo visualizada.

Retorno:

number

Número da página.

Veja exemplo:

echo $this->pagination->getPage();

Resgatando o total de páginas

getTotalPages()

Este método retorna o total de páginas.

Retorno:

number

Total de páginas.

Veja exemplo:

echo $this->pagination->getTotalPages();

Resgatando o total de registros

getTotalRecords()

Este método retorna o total de registros que resultou da consulta.

Retorno:

number

Total de registros.

Veja exemplo:

echo $this->pagination->getTotalRecords();

Resgatando o total de registros na página

getTotalRecordsInPage()

Este método retorna o total de registros que resultou para a página que esta sendo visualizada.

Retorno:

number

Total de registros na página.

Veja exemplo:

echo $this->pagination->getTotalRecordsInPage();

Resgatando o número do primeiro registro na página

getStartRecord()

Este método retorna o número do primeiro registro para a página que esta sendo visualizada.

Retorno:

number

Número do primeiro registro na página.

Veja exemplo:

echo $this->pagination->getStartRecord();

Verificando se tem próximas páginas

hasNext()

Este método verifica se existe uma página seguinte.

Retorno:

boolean

True se tiver e false se não.

Veja exemplo:

$this->pagination->hasNext();

Verificando se tem páginas anteriores

hasPrevious()

Este método verifica se existe uma página anterior.

Retorno:

boolean

True se tiver e false se não.

Veja exemplo:

$this->pagination->hasPrevious();

Próxima página

next()

Este método monta um link apontando para a próxima página, se existir.

Parâmetros:

string $text [opcional]

Texto a ser exibido no link

array $attr [opcional]

Atributos para o link.

Retorno:

string

String contendo o html.

Veja exemplo:

$this->pagination->next();

Página anterior

previous()

Este método monta um link apontando para a página anterior, se existir.

Parâmetros:

string $text [opcional]

Texto a ser exibido no link

array $attr [opcional]

Atributos para o link.

Retorno:

string

String contendo o html.

Veja exemplo:

$this->pagination->previous();

Primeira página

first()

Este método monta um link apontando para a primeira página.

Parâmetros:

string $text [opcional]

Texto a ser exibido no link

array $attr [opcional]

Atributos para o link.

Retorno:

string

String contendo o html.

Veja exemplo:

$this->pagination->first();

Última página

last()

Este método monta um link apontando para a última página.

Parâmetros:

string $text [opcional]

Texto a ser exibido no link

array $attr [opcional]

Atributos para o link.

Retorno:

string

String contendo o html.

Veja exemplo:

$this->pagination->last();

Gerando os números das páginas

numbers()

Este método retorna um HTML com a lista dos números com seus respectivos links.

Parâmetros:

array $options

Opções para a geração dos números, sobre escreve a configuração definida pela variável PaginationHelper::$numbersOptions.

Retorno:

string

String contendo o html.

Veja exemplo:

echo $this->pagination->numbers();

Descrição das páginas

description()

Este método monta uma descrição das páginas.

Parâmetros:

array $attr [opcional]

Atributos para a tag.

string $tag [opcional]

Nome da tag a ser utilizada.

array $text [opcional]

Textos a serem exibido, sobre escreve a configuração definida pela variável PaginationHelper::$textDescription.

string $separator [opcional]

Separador da primeira parte com a segunda.

Retorno:

string

String contendo o html.

Veja exemplo:

$this->pagination->description();

Gerando todas as opções

generateAll()

Este método gera os links para as páginas, contendo: Próximo, Anterior, Última, Primeira, Números e Descrição.

Retorno:

string

String contendo o html.

Veja exemplo:

echo $this->pagination->generateAll();