Clase Paginador para PHP

Bueno hoy les voy a dejar una clase, que digamos la resucite, la tenia olvidada en algún directorio dentro de mis proyectos y como en varios foros pude observar que se preguntaba de como realizar un paginador o utilizar uno existente, la actualice un poco y hoy se los dejo aquí. Si bien es una clase su utilización es sencilla.

Entre sus características le podemos configurar los comentarios de ir a la primera pagina, ultima etc y también dispone de un paso de bloque siguiente o anterior.

<?php /** * Clase Paginador. * Su responsabilidad es realizarnos el paginado de una consulta, es decir * proporcionar datos para realizar la barra de navegacion de la paginacion. * @package varias creado en el projecto opet * @copyright 2010 - ObjetivoPHP * @license Gratuito (Free) http://www.opensource.org/licenses/gpl-license.html * @author Marcelo Castro (ObjetivoPHP) * @link objetivophp@gmail.com * @version 2.0.0 (16/06/2008 - 27/08/2010) */ class Paginador { /** * Contiene los titulos que se mostraran en la barra de navegacion. O sea * primera, anteriror, .... , ultima, siguiente etc... * @var array */ private $_titulos = array('primero' => array('vista' => '| Primero ...', 'title' => 'Ir a la primera Pagina'), 'bloqueAnterior' => array('vista' => '<<', 'title' => 'Bloque Anterior'), 'anterior' => array('vista' => '<', 'title' => 'Pagina Anterior'), 'siguiente' => array('vista' => '>', 'title' => 'Pagina Siguiente'), 'bloqueSiguiente' => array('vista' => '>>', 'title' => 'Bloque Siguiente'), 'ultimo' => array('vista' => '... Ultimo |', 'title' => 'Ir a la Ultima Pagina'), 'numero' => array('vista' => null, 'title' => 'Ir a la pagina '), 'actual' => array('vista' => null, 'title' => 'Estas viendo esta pagina') ); /** * Contiene los marcadores que van antes y despues de la pagina actual, * para identificarla visualmente en la barra de navegacion del paginador. * @var array */ private $_marcador = array('antes' => '|', 'despues' => '|'); /** * Guarda el resultado de la paginacion por si es requrido mas tarde. * Formato array('vista' => 'primero', 'numero' => 0). * @var array */ private $_paginacion = array(); /** * Es la cantidad de registros, filas de la tabla que se mostraran por cada * pantalla. * @var integer */ private $_cantidadDeRegistrosPorPagina = 10; /** * Es la cantidad de Enlaces o vinculos que contendra el paginador, sin contar * los especiales como ser primero, ultimo etc.. * @var integer */ private $_cantidadDeEnlacesDelPaginador = 10; /** * Contiene la cantidad total de paginas del paginador. * @var integer */ private $_cantidadPaginas; /** * Metodo __construct. * Crea el objeto Paginador. * @param integer $crpp Cantidad de Registros a desplegarse en cada Pagina. * @param integer $cepp Cantidad de enlaces del paginador, sin especiales. * @return void */ public function __construct($crpp = 10, $cep = 10) { $this->_cantidadDeRegistrosPorPagina = ((int)$crpp > 0)? $crpp : 10; $this->_cantidadDeEnlacesDelPaginador = ((int)$cep > 0)? $cep : 10; } /** * Metodo setCantidadRegistros. * Configura la cantidad de registros que se desplegan en la pantalla. * @param integer $cantidad Cantidad de Registros por pagina. * @return void */ public function setCantidadRegistros($cantidad = 10) { $this->_cantidadDeRegistrosPorPagina = ((int)$cantidad > 0)? $cantidad : 10; } /** * Metodo setCantidadEnlaces. * Configura la cantidad de enlaces que contendra el paginador sin considerar los * enlaces especiales. * @param integer $cantidad Cantidad de Enlaces que se quieren mostrar. * @return void */ public function setCantidadEnlaces($cantidad = 10) { $this->_cantidadDeEnlacesDelPaginador = ((int)$cantidad > 0)? $cantidad : 10; } /** * Metodo paginar. * Realiza el paginado, generando todos los bloques. * @param integer $pagina Contiene desde que pagina se desplegara. * @param integer $cantidadDeResultados total de resutados de la consulta. * @return array */ public function paginar($pagina,$cantidadDeResultados) { $pagina = ((int)$pagina < 0)? 0 : $pagina; if ($cantidadDeResultados < 1) { // No hay resultados que paginar return false; } // Aqui significa que tenemos resultados y vamos a paginar // Preparo las variables que se utilizaran $paginaInicial = $paginaFinal = 0; $paginacion = array(); $totalPaginas = ceil($cantidadDeResultados / $this->_cantidadDeRegistrosPorPagina); if ($totalPaginas < 2) { // Si es menor a 2 es una pagina por lo tanto no pagino. $this->_cantidadPaginas = 1; return false; } if ($totalPaginas <= $this->_cantidadDeEnlacesDelPaginador) { $paginaInicial = 1; $paginaFinal = $totalPaginas; } else { $centroPaginador = floor($this->_cantidadDeEnlacesDelPaginador / 2); $paginaInicial = ($pagina+1) - $centroPaginador; $paginaFinal = $paginaInicial + $this->_cantidadDeEnlacesDelPaginador - 1; if ($paginaFinal > $totalPaginas) { $paginaFinal = $totalPaginas; $paginaInicial = $paginaFinal - ($this->_cantidadDeEnlacesDelPaginador -1); } if ($paginaInicial < 1) { $paginaInicial = 1; $paginaFinal = $this->_cantidadDeEnlacesDelPaginador; } } $ajuste = floor($this->_cantidadDeEnlacesDelPaginador / 2); $ajuste2 = 1 - ($this->_cantidadDeEnlacesDelPaginador % 2); $blockInicio = $paginaInicial - $this->_cantidadDeEnlacesDelPaginador + $ajuste - 1; $blockFinal = $paginaFinal + $this->_cantidadDeEnlacesDelPaginador - $ajuste + $ajuste2; $paginaInicial = $paginaInicial - 1; $paginaFinal = $paginaFinal - 1; if ($totalPaginas > 1) { if ($paginaInicial != 0) { $paginacion[] = array('numero' => 0, 'vista' => $this->_titulos['primero']['vista'], 'title' => $this->_titulos['primero']['title']); } } /* Configurar Block de Inicio */ if ($blockInicio > $ajuste) { $paginacion[] = array('numero' => $blockInicio, 'vista' => $this->_titulos['bloqueAnterior']['vista'], 'title' => $this->_titulos['bloqueAnterior']['title']); } /* Configurar anterior */ if($pagina > 0) { $paginacion[] = array('numero' => $pagina-1, 'vista' => $this->_titulos['anterior']['vista'], 'title' => $this->_titulos['anterior']['title']); } /* Inicio Block Central */ for ( $f = $paginaInicial; $f <= $paginaFinal; $f++) { if ($f != $pagina) { $paginacion[]= array('numero' => $f, 'vista' => $f+1, 'title' => $this->_titulos['numero']['title'] . ($f+1)); } else { $paginacion[]= array('numero' => $f, 'vista' => $this->_marcador['antes'] . ($f+1) . $this->_marcador['despues'], 'title' => $this->_titulos['actual']['title']); } } /* Fin block Central */ /* Configurar siguiente */ if ($pagina < ($totalPaginas-1)) { $paginacion[] = array('numero' => $pagina+1, 'vista' => $this->_titulos['siguiente']['vista'], 'title' => $this->_titulos['siguiente']['title']); } /* Fin block siguiente */ /* Configurar Block de Final */ if ($paginaFinal < ($totalPaginas - $this->_cantidadDeEnlacesDelPaginador - 1)) { $paginacion[] = array('numero' => $blockFinal-1, 'vista' => $this->_titulos['bloqueSiguiente']['vista'], 'title' => $this->_titulos['bloqueSiguiente']['title']); } /* Fin block Final */ if ( $paginaFinal != ($totalPaginas - 1)) { $paginacion[] = array('numero' => $totalPaginas-1, 'vista' => $this->_titulos['ultimo']['vista'], 'title' => $this->_titulos['ultimo']['title']); } $this->_paginacion = $paginacion; $this->_cantidadPaginas = $totalPaginas; return $paginacion; } /** * Metodo setTitulosVista. * Configura los simbolos que se usaran para el enunciado de bloques, * primero, ultimo, anterior, siguiente etc... * @param string $titulo Titulo que se desea cambiar. primero, ultimo etc. * @param string $valor Valor que tendra la etiqueta. * @return void */ public function setTitulosVista($titulo, $valor) { if (array_key_exists($titulo, $this->_titulos)) { echo 'sda'; $this->_titulos[$titulo]['vista'] = $valor; } } /** * Metodo setTitulosTitle. * @param string $titulo Etiqueta a la que se desea cambiar la propiedad title. * @param string $valor Valor que tendra la etiqueta. * @return void */ public function setTitulosTitle($titulo, $valor) { if (array_key_exists($titulo, $this->_titulos)) { $this->_titulos[$titulo]['title'] = $valor; } } /** * Metodo setMarcador. * @param string $antes Simbolo que va antes del enlace de pagina actual. * @param string $despues Simbolo que va despues del enlace de la pagina actual. * @return void */ public function setMarcador($antes, $despues) { $this->_marcador['antes'] = $antes; $this->_marcador['despues'] = $despues; } /** * Metodo getPaginacion. * Nos retorna el arreglo de paginacion. * @return array */ public function getPaginacion() { return $this->_paginacion; } /** * Metodo getCantidadPaginas. * Nos retorna la cantidad de paginas que tiene el paginador. * @return integer */ public function getCantidadPaginas() { return $this->_cantidadPaginas; } }

Bueno pasemos a mostrar el código para utilizar la clase.
Como siempre debemos incluir el archivo de la clase y para ello utilizamos requiere_once, una vez realizado esto, les comento que debemos haber realizado la consulta MySQL y tener la cantidad total de resultados que nos retorna la consulta. Bueno comencemos con el código….

<?php // Suponemos que cantidad de registros es // el total que nos retorno la consulta mysql. $cantRegistros = 1100; //$pgnActual contiene en que posicion nos queremos ubicar de la barra de navegacion //y sirve tambien para realizar la proxima consulta MySQL con el limit. $pgnActual = $_GET['pgn']; // Instanciamos la clase Paginador $pag = new Paginador(); // Y mandamos a paginar desde la pagina actual y le pasamos tambien el total // de registros de la consulta mysql. $datos = $pag->paginar($pgnActual, $cantRegistros); // Preguntamos si retorno algo, si retorno paginamos con los datos que nos da el // paginador que es un arreglo. if ($datos) { echo 'Pagina: ' . ($_GET['pgn'] + 1) . ' de ' . $pag->getCantidadPaginas() . '<br />'; foreach ($datos as $enlace) { ?> <a href="?pgn=<?php echo $enlace['numero']; ?>" title="<?php echo $enlace['title']; ?>" style="text-decoration:none;"><?php echo $enlace['vista']; ?></a> <?php } }

Esa es la forma de utilización básica de la clase. Antes de seguir con la personalización de los resultados veremos como es el arreglo de resultados, que nos retorna la clase.

array(15) { [0]=> array(3) { ["numero"]=> int(0) ["vista"]=> string(13) "| Primero ..." ["title"]=> string(22) "Ir a la primera Pagina" } [1]=> .....

El arreglo contiene por cada enlace 3 datos, numero, vista y title. Numero es el numero de pagina para realizar la consulta con el limit y presentar la nueva barra de navegacion y es el que se deber pasar por url u otro medio, en el caso del ejemplo la pasamos por url en el parametro pgn.Vista es lo que vera el usuario por pantalla, por ejemplo 1 2 3 5 .. ultima pagina ect. Title es el comentario que se pondrá cuando el usuario se posa sobre uno de los enlaces de la barra de navegación.

Ahora un poco de personalización. Es básica y es para mostrar los distintos tipos de comentarios, aclaramos que los comandos de personalización deberán estar después de la instancia de la clase o sea $pag = new Paginador(); y antes de la llamada a paginar $datos = $pag->paginar($pgnActual, $cantRegistros);.

<?php // Configuramos la cantidad de registros por pagina, por defecto son 10. // Debe de estar coordinado con la cantidad de registros traídos con la consulta MySQL. $pag->setCantidadRegistros(20); // Configurar la cantidad de enlaces en la barra de navegación (por defecto son 10). $pag->setCantidadEnlaces(20); // Configurar entre que caracteres aparece la pagina que estamos viendo. por defecto |. $pag->setMarcador('(', ')'); // Configurar la propiedad title y vista para ir a la primera pagina... $pag->setTitulosTitle('primero', 'Pagina Inicial'); $pag->setTitulosVista('primero', 'inicio'); El resto de las opciones son bloqueAnterior, anterior, siguiente, bloqueSiguiente, ultimo, numero y actual.

Bueno esto es todo para esta clase.

Saludos