Criando paginação de resultados com Zend

Muitas vezes nos deparamos com a necessidade de criar uma paginação de resultado, devido a grande quantidade de informações e que acaba muitas vezes prejudicando a performance da aplicação. Para evitar este tipo de problemas incluímos uma paginação, para dividir a exibição de uma grande quantidade de dados em pequenas partes.

Para os profissionais que não utilizam um framework resta a tarefa de desenvolver uma classe de paginação (que não é difícil) ou procurar no Oraculo algo pronto e que atenda a sua necessidade. Já para os programadores que utilizam o Zend Framework como base de seus projetos, podem utilizar o componente Zend_Paginator, que é um componente flexível para paginar coleções de dados e apresentar estes dados para os usuários.

Vamos agora entender um pouco do funcionamento deste componente.

Vamos iniciar pelo Controller, pois o mesmo será o passo inicial para que todo o resto funcione. No Controller iremos obter os registros do banco de dados, lembrando que não necessariamente as informações a serem paginadas devem vir de um banco de dados, pode ser informado um array contendo as informações. Tendo os registros iremos obter o objeto Zend_Paginator informando a ele os dados a serem paginados assim como as definições como, por exemplo, quantidade de registros por paginas e página atual.

Segue o exemplo do Controller:

<?php
class UsuariosController extends Zend_Controller_Action {

public function init() {
$this->db = Zend_Registry::get('db');
}

public function indexAction() {

$pagina = intval($this->_getParam('pagina', 1));

$select = $this->db->select()->from('usuarios');
$dados = $select->query()->fetchAll();

$paginator = Zend_Paginator::factory($dados);
// Seta a quantidade de registros por página
$paginator->setItemCountPerPage(10);
// numero de paginas que serão exibidas
$paginator->setPageRange(7);
// Seta a página atual
$paginator->setCurrentPageNumber($pagina);
// Passa o paginator para a view
$this->view->paginator = $paginator;
}
}

Como podemos observar no exemplo acima que o Zend_Paginator nos fornece alguns métodos para configuração da paginação, como por exemplo:

setItemCountPerPage – Número máximo de registro a serem exibidos por página, por padrão o Zend utiliza 10;
setPageRange – Número de páginas a serem exibidas no menu de navegação, o padrão também é 10 itens;
setCurrentPageNumber – Informa o número da página atual, caso não seja informado o Zend assume a primeira página a ser exibida.

Seguindo o processo, vamos dar uma analisada na view, onde iremos fazer a listagem dos dados e onde será exibido o menu de paginação.

Segue o exemplo da View:

<?php foreach ($this->paginator as $dados): ?>
<p>
<?php echo 'Nome: ' . $dados['nome'] . ' - Usuário: ' . $dados['usuario']; ?>
</p>
<?php endforeach; ?>

<?php echo $this->paginationControl($this->paginator, 'Sliding', 'pagination.phtml'); ?>

Vamos ter um foreach para percorrer os dados, algo bem simples, nada de muito complexo neste trecho. E para exibir a paginação iremos utilizar o Zend_View_Helper paginationControl que é o responsável em controlar a paginação.

Tendo como primeiro parâmetro a instância do paginador;

O segundo parâmetro é o estilo de nossa paginação existe as opções:

All – Será exibidas todas as páginas;
Elastic – Parecida com a paginação do Google, conforme o usuário vai navegando através da paginação ela vai expandindo ou encolhendo;
Jumping – Conforme vai navegando através da paginação ao chegar ao final do número das paginas exibidas, inicia com uma nova sequencia de números;
Sliding – Este é o estilo que utilizo por padrão em meus projetos, pois o mesmo posiciona sempre a pagina atual ao centro, ou o mais próximo dela. É o estilo que podemos observar na grande maioria das classes de paginação;

O terceiro parâmetro é o nosso modelo, template ou ainda uma visão parcial da paginação, sendo que a estrutura HTML de nossa paginação será baseada neste arquivo de template.

Segue o exemplo do template:

<div class="pagination">

<?php if (isset($this->previous)): ?>
<a title="Primeira Página" href="<?php echo $this->url(array('pagina' => $this->first)); ?>">« Primeira</a>|
<?php else: ?>
<a class="current" title="Primeira Página" href="<?php echo $this->url(array('pagina' => $this->first)); ?>">« Primeira</a>|
<?php endif; ?>


<?php if (isset($this->previous)): ?>
<a title="Página Anterior" href="<?php echo $this->url(array('pagina' => $this->previous)); ?>">« Anterior</a>|
<?php else: ?>
<a class="current" title="Página Anterior" href="<?php echo $this->url(array('pagina' => $this->previous)); ?>">« Anterior</a>|
<?php endif; ?>


<?php foreach ($this->pagesInRange as $page): ?>
<?php if ($page != $this->current): ?>
<a title="<?php echo $page; ?>" href="<?php echo $this->url(array('pagina' => $page)); ?>"><?php echo $page; ?></a>|
<?php else: ?>
<a class="current" title="<?php echo $page; ?>" href="<?php echo $this->url(array('pagina' => $page)); ?>"><?php echo $page; ?></a>|
<?php endif; ?>
<?php endforeach; ?>


<?php if (isset($this->next)): ?>
<a title="Próxima Página" href="<?php echo $this->url(array('pagina' => $this->next)); ?>">Próxima »</a>|
<?php else: ?>
<a class="current" title="Próxima Página" href="<?php echo $this->url(array('pagina' => $this->next)); ?>">Próxima »</a>|
<?php endif; ?>


<?php if (isset($this->next)): ?>
<a title="Última Página" href="<?php echo $this->url(array('pagina' => $this->last)); ?>">Última »</a>
<?php else: ?>
<a class="current" title="Última Página" href="<?php echo $this->url(array('pagina' => $this->last)); ?>">Última »</a>
<?php endif; ?>
</div>

Por padrão deixo este arquivo dentro do diretório scripts para que o mesmo esteja disponível para todas as views do projeto.

/application/views/scripts/pagination.phtml

Segue uma descrição das propriedades utilizadas e disponíveis:

first – Número da primeira página;
firstItemNumber – Número absoluto do primeiro item nesta página;
firstPageInRanger – Primeira página no intervalo retornada pelo estilo;
current – Número da página atual;
currentItemCount – Número de itens nesta página;
last – Número da última página;
lastItemNumber – Número absoluto do último item nesta página;
lastPageInRange – Última página no intervalo retornado pelo estilo;
next – Número da próxima página;
pageCount – Número de páginas;
pagesInRange – Array de páginas retornado pelo estilo;
previous – Número da página anterior;
totalItemCount – Número total de itens;