PHP OO Paginador: Aporte y también pido consejo para mejorarlo

[guardarmicorreo]

He creado una clase para paginar resultados. Me ha llevado varios días hacerla porque he partido desde cero, ya que todos los ejemplos que he encontrado no me gustaban en la forma que solucionaban la paginación. Tenía que encontrar una manera fácil, clara y completa para paginar y este ha sido el resultado.

Pido que la examinéis y me digais qué cosas están mal, qué cosas se deberían o podrían mejorar y qué cosas le implementaríais o quitaríais.

Por supuesto, cualquiera es libre de modificar el código a su gusto y utilizarlo para lo que quiera.

Por favor, absténganse de recomendar frameworks u otros medios para poder resolver la paginación, la intención de esta clase era y es aprender a resolver este problema, a-p-r-e-n-d-e-r.

Código PHP:

<?php
 
//  ==========================
//  = Realiza calculos para paginar resultados = 
//  ==========================
 
/*
 * By [email protected]
 */
 
 /*
  * sistema que consiste en una paginación partiendo desde la pagina 0
  * 
  * crea un array que consta de los valores para la pagina actual, valores para botones circundantes anteriores a la pagina actual,
  * valores para los botones circundantes posteriores a la pagina actual,
  * un valor para el boton anterior a la pagina actual y un valor para un boton posterior a la pagina actual.
  * 
  * tambien incluye el metodo currentPages por si el developer quisiera mostrar el conjunto de resultados
  * que esta utilizando el usuario.
  * 
  * ejemplo de resultado final con la configuracion por defecto
  * 
  *     surround_before     before_button       page       after_button     surround_after     total_pages     current_pages
  *     0 1 2 3 4                 4                           5             6                       6 7 8 9 10              10                  (a partir del registro) 500 
  */
 
class Paginator
{
    /*
     * propiedades
     */
      
    //resultados totales
    private $totalResultsSet;
     
    //numero de resultados por pagina
    private $resultsPage = 100;
     
    //numero de pagina actual
    private $page;
    
    //registro actual que esta usando el usuario
    private $currentPages;
    
    //numero de paginas totales
    private $totalPages;
     
    //numero de paginas anteriores
    private $pagesBefore    =   5;
     
    //numero de pagina siguiente
    private $pagesAfter =   5;
    
    //pagina anterior
    private $beforeButton;
    
    //pagina siguiente
    private $afterButton;
    
    //botones circundantes anteriores
    private $surroundBefore   =   array();
    
    //botones circundantes posteriores
    private $surroundAfter  =   array();
         
    //resultado de un metodo
    private $result =   array();
    
    /*
     * para crear tanto las propiedades como para iniciar los calculos basicos para toda la clase
     */
    function    __construct($totalResultsSet, $page)
    {
        $this->totalResultsSet    =   $totalResultsSet;
        
        $this->page =   $page;
        
        $this->totalPages   =   $this->calcTotalPages($totalResultsSet, $this->resultsPage);
        
        $this->currentPage  =   $this->currentPages($page, $this->resultsPage);
    }
    
    /*
     * calcula las paginas totales
     */
    function    calcTotalPages($totalResultsSet, $resultsPage)
    {
        //divide los resultados totales entre los resultados a mostrar por pagina
        return  $this->totalPages   =  ceil($totalResultsSet    /   $resultsPage);
    }
    
    /*
     * calcula el conjunto de registros que esta empleando el usuario 
     */
    function    currentPages($page, $resultsPage)
    {
        //multiplica la pagina actual por los resultados por pagina
        return  $this->currentPages  =   ceil($page   *   $resultsPage);
    }
    
    /*
     * calcula las paginas circundantes anteriores
     */
    function    surroundPagesBefore()
    {  
        //resta la pagina menos el numero de paginas anteriores en el centro
        $pagesBefore  =   $this->page   -   $this->pagesBefore;
        
        //comienza a crear botones hasta llegar a la pagina actual
        for($i=$pagesBefore; $i < $this->page; $i++)
        {
            if($i>=0)
            {
                array_push($this->surroundBefore,$i);
            }
        }
        
        //sino retorna false para que no muestre el boton anterior
        if(empty($this->surroundBefore))
        {
            $this->surroundBefore   =   FALSE;
        }
        
        return  $this->surroundBefore;
    }
    
    /*
     * calcula las paginas circundantes posteriores
     */
    function    surroundPagesAfter()
    {  
        //suma a la pagina actual las paginas configuradas para mostrar despues
        $pagesAfter  =   $this->page   +   $this->pagesAfter;
        
        //comienza a crear tantos botones como paginas sean posibles o menor que la suma anterior
        for($i=$this->page; $i <= $this->totalPages; $i++)
        {
            if($i>$this->page)
            {
                array_push($this->surroundAfter,   $i);
            }
        }
        
        //asigna false para que no muestre botones posteriores
        if(empty($this->surroundAfter))
        {
            $this->surroundAfter   =   FALSE;
        }
        
        return  $this->surroundAfter;
    }
    
    /*
     * crea el boton anterior
     */
    function    beforeButtons()
    {
        //resta 1 a la pagina actual
        $pageBefore  =   ceil($this->page  -   1);
        
        //si el resultado anterior indica que no da un valor negativo
        if($pageBefore >=0)
        {
            $this->beforeButton  =   $pageBefore;
        }
        
        //sino asigna false para no mostrar boton anterior
        else
      {
            $this->beforeButton  =   FALSE;
        }
      
        return $this->beforeButton;
    }
    
    /*
     * crea el boton siguiente
     */
    function    afterButtons()
    {  
        //suma a la pagina actual 1
        $afterButton    =   $this->page   +   1;
        
        //si el resultado anterior es menor o igual a las paginas totales posibles
        if($afterButton <=  $this->totalPages)
        {
            $this->afterButton  =   $afterButton;
        }
        else
        {
            $this->afterButton  =   FALSE;
        }
        
        return  $this->afterButton;
    }
    
    /*
     * crea el array definitivo con todos los valores necesarios para todos los botones
     */
    function    paginator()
    {
        //comprueba que la pagina que ha enviado el usuario no sea mayor que el total de resultados posibles
        //tampoco que sea inferior a 0
        if($this->page  <=  $this->totalPages   AND $this->page>=0)
        {
            array_push($this->result, array(
                                                                    'page'=>$this->page,
                                                                    'surround_before'   =>$this->surroundPagesBefore(),
                                                                    'surround_after'    =>$this->surroundPagesAfter(),
                                                                    'before_button' =>$this->beforeButtons(),
                                                                    'after_button'  =>$this->afterButtons(),
                                                                    'total_pages'   =>$this->totalPages,
                                                                    'current_pages' =>$this->currentPages
                                                                )
                                                                                
                                );  
        }
        
        //si el usuario intentara romper el paginado poniendo páginas falsas entonces asigna FALSE
        else
      {
            $this->result   =   FALSE;
        }
        
        return  $this->result;
    }
}
?>
 

Gracias por su colaboración!!! :D

[jonni09lo]

Por defecto estás asignado todos los métodos como públicos y considero de que en esa clase la podrías manejar con métodos protected y private. Una funcionalidad interesante podría ser implementar Singleton para que unicamente con una llamada al paginador, obtengas los resultados deseados:

Código PHP:

$paginador = Paginator::getInstance($totalResultsSet, $page);
 

Y ya $paginador tendría el array completo con las funcionalidades

Saludos

[guardarmicorreo]

mmm pues tienes razón! :D

voy a aplicarlo ahora mismo. gracias!!! te daría un punto pero el sistema no me deja, entre otros errores que me da desde hace tiempo :S

[jonni09lo]

Una observación adicional (ya que no pude editar el mensaje )

Si es bueno minimizar los pasos para obtener el paginador, pero el patrón Singleton en este caso podría ser contraproducente en páginas que requieran múltiples paginadores... Se podría seguir manejando la llamada a un método estático, pero que no preserve la instancia si ya existe si no que la sobreescriba (esto ya no sería Singleton).

Saludos

[guardarmicorreo]

para páginas que requieran múltiples paginadores ¿no se podría iniciar y cerrar tantas instancias como se necesiten? es más, tendría que ser así, ya que cada paginación es distinta de las demás, debido sobre todo a que cada paginación tiene un result set distinto, es decir, cada paginación tiene distinto número de resultados. para ello habría que iniciar y cerrar instancia a la clase, no hay otra manera ¿no?

[jonni09lo]

Bueno creo que eso depende de lo que quieras lograr, por ejemplo si lo que deseas que es $paginador tenga de una vez el diseño de como se vería el paginador puedes intentarlo trabajar de esta manera

Código PHP:

class Paginator
{
    //resto de propiedades de la clase
    private static $design = '';
    
    private function __construct($totalResultsSet, $page){
        //do stuff
        self::$design = $this->getDesign();
    }
    
    public static function getInstance($totalResultsSet, $page){
        $instancia = new self($totalResultsSet, $page);
        return self::$design;
    }
    //resto de los metodos de la clase
    protected function getDesign(){
        //some actions
        return "<ul><li></li></ul>";
    }
}
 
 
$paginador = Paginator::getInstance($totalResultsSet, $page);
 

En este caso $paginador tendría el diseño del paginador (es un ejemplo al vuelo, cabe aclarar)

Pero si quieres hacer mas cosas con el paginador (cosa que puede o no ser necesaria) simplemente lo sigues manejando de la misma manera (creando la instancia), pero tratando siempre de disminuir los pasos que se deben de hacer para obtener el resultado.

Saludos

[guardarmicorreo]

sí es cierto, creo que la manera de acceder a la clase sería según lo que necesites y pretendas lograr. por ejemplo en mi caso lo hice así porque es la mejor manera que encontré de hacerlo y es la que necesito, ya que yo no utilizo clases para imprimir/graficar los datos. otra persona que utilice clases, como parece que es tu ejemplo, sí necesitaría hacerlo de otra manera más fácil.

una persona que tuviera varias paginaciones en una misma presentación tendría que utilizar otra menera que más se adecúe a lo que necesita.

muchas gracias!! la verdad es que lo de singleton ni se me había ocurrido :D

[jonni09lo]

Claro, pero si tu lo deseas puedes dejar definidos los métodos que trabajen con las clases y que ya dependa del usuario quien lo use si quiere usarlos o no. De esa manera considero que se volvería mas usable. Así que por defecto puedes retornar los valores, pero tengas métodos que permitan manejar el diseño del paginador.

Otra cosa adicional que puedes en cuestión del diseño (si vas a trabajarle esa parte) es permitir el manejo de como se verán los botones. Por ejemplo hay paginadores que tienen << >> como indicativos de último y primero y < > de anterior y siguiente (por poner un ejemplo).

Como ves el paginador tiene muchas funcionalidades que aún no has explorado y si quieres seguirle trabajando allí ya tienes buenos puntos en que trabajar

Saludos

[guardarmicorreo]

Debido a la petición de jonni09lo paso a dejar el código del paginador tal y como lo tengo actualmente. Le he realizado algunos cambios. El código tal y como lo muestro funciona perfectamente. Más adelante le incorporaré métodos para que realice cálculos de botones de atajo (ir a la primera página, retroceder 50, 100, 1000, etc. páginas avanzar 50, 100, 1000, etc. páginas) para poder lograr un paginador lo más completo posible.

Tengo que partir el documento en dos debido a la limitación de caracteres por post.

Código PHP:

<?php
 
//  ==========================
//  = Realiza calculos para paginar resultados = 
//  ==========================
 
/*
 * By [email protected]
 */
 
 /*
  * sistema que consiste en una paginación partiendo desde la pagina 0
  * 
  * crea un array que consta de los valores para la pagina actual, valores para botones circundantes anteriores a la pagina actual,
  * valores para los botones circundantes posteriores a la pagina actual,
  * un valor para el boton anterior a la pagina actual y un valor para un boton posterior a la pagina actual.
  * 
  * tambien incluye el metodo currentPages por si el developer quisiera mostrar el conjunto de resultados
  * que esta utilizando el usuario.
  * 
  * ejemplo de resultado final con la configuracion por defecto
  * 
  *     surround_before     before_button       page       after_button     surround_after     total_pages     current_pages
  *     0 1 2 3 4                 4                           5             6                       6 7 8 9 10              10                  (a partir del registro) 500 
  */
 
class Paginator
{
    /*
     * propiedades
     */
      
    //resultados totales
    private $totalResultsSet;
     
    //numero de resultados por pagina
    private $resultsPage = 10;
     
    //numero de pagina actual
    private $page;
    
    //registro actual que esta usando el usuario
    private $currentPages;
    
    //numero de paginas totales
    private $totalPages;
     
    //numero de paginas anteriores
    private $pagesBefore    =   5;
     
    //numero de pagina siguiente
    private $pagesAfter =   5;
    
    //pagina anterior
    private $beforeButton;
    
    //pagina siguiente
    private $afterButton;
    
    //botones circundantes anteriores
    private $surroundBefore   =   array();
    
    //botones circundantes posteriores
    private $surroundAfter  =   array();
         
    //resultado de un metodo
    private $result =   array();
    
    // action URL, para los botones del paginador
    private $url;
    
    //identificador, identifica el objeto que esta paginando
    private    $id;
    
    /*
     * para crear tanto las propiedades como para iniciar los calculos basicos para toda la clase
     */
    function    __construct($totalResultsSet, $page, $url, $id)
    {
        $this->totalResultsSet    =   $totalResultsSet;
        
        $this->page =   $page;
        
        $this->totalPages   =   $this->calcTotalPages($totalResultsSet, $this->resultsPage);
        
        $this->currentPage  =   $this->currentPages($page, $this->resultsPage);
        
        $this->url  =   $url;
        
        $this->id   =   $id;
    }
    
    /*
     * calcula las paginas totales
     */
    public  function    calcTotalPages($totalResultsSet, $resultsPage)
    {
        //divide los resultados totales entre los resultados a mostrar por pagina
        return  $this->totalPages   =  ceil($totalResultsSet    /   $resultsPage);
    }
    
    /*
     * calcula el conjunto de registros que esta empleando el usuario 
     */
    public  function    currentPages($page, $resultsPage)
    {
        //multiplica la pagina actual por los resultados por pagina
        return  $this->currentPages  =   ceil($page   *   $resultsPage);
    }
    
    /*
     * calcula las paginas circundantes anteriores
     */
    public  function    surroundPagesBefore()
    {  
        //resta la pagina menos el numero de paginas anteriores en el centro
        $pagesBefore  =   $this->page   -   $this->pagesBefore;
        
        //comienza a crear botones hasta llegar a la pagina actual
        for($i=$pagesBefore; $i < $this->page; $i++)
        {
            if($i>=0)
            {
                array_push($this->surroundBefore,   array(
                                                                                        'page'  =>$i,
                                                                                        'url'      =>$this->createURL($this->url, $this->id, $i)
                                                                                        ));
            }
        }
        
        //sino retorna false para que no muestre el boton anterior
        if(empty($this->surroundBefore))
        {
            $this->surroundBefore   =   FALSE;
        }
        
        return  $this->surroundBefore;
    }
    
    /*
     * calcula las paginas circundantes posteriores
     */
    public  function    surroundPagesAfter()
    {  
        //suma a la pagina actual las paginas configuradas para mostrar despues
        $pagesAfter  =   $this->page   +   $this->pagesAfter;
        
        //comienza a crear tantos botones como paginas sean posibles o menor que la suma anterior
        for($i=$this->page; $i < $this->totalPages; $i++)
        {
            if($i>$this->page)
            {
                array_push($this->surroundAfter,   array(
                                                                                        'page'  =>$i,
                                                                                        'url'      =>$this->createURL($this->url, $this->id, $i)
                                                                                     ));
            }
        }
        
        //asigna false para que no muestre botones posteriores
        if(empty($this->surroundAfter))
        {
            $this->surroundAfter   =   FALSE;
        }
        
        return  $this->surroundAfter;
    }
 

[guardarmicorreo]

Debido a la petición de jonni09lo paso a dejar el código del paginador tal y como lo tengo actualmente. Le he realizado algunos cambios. El código tal y como lo muestro funciona perfectamente. Más adelante le incorporaré métodos para que realice cálculos de botones de atajo (ir a la primera página, retroceder 50, 100, 1000, etc. páginas avanzar 50, 100, 1000, etc. páginas) para poder lograr un paginador lo más completo posible.

Tengo que partir el documento en dos debido a la limitación de caracteres por post.

Código PHP:

<?php
 
//  ==========================
//  = Realiza calculos para paginar resultados = 
//  ==========================
 
/*
 * By [email protected]
 */
 
 /*
  * sistema que consiste en una paginación partiendo desde la pagina 0
  * 
  * crea un array que consta de los valores para la pagina actual, valores para botones circundantes anteriores a la pagina actual,
  * valores para los botones circundantes posteriores a la pagina actual,
  * un valor para el boton anterior a la pagina actual y un valor para un boton posterior a la pagina actual.
  * 
  * tambien incluye el metodo currentPages por si el developer quisiera mostrar el conjunto de resultados
  * que esta utilizando el usuario.
  * 
  * ejemplo de resultado final con la configuracion por defecto
  * 
  *     surround_before     before_button       page       after_button     surround_after     total_pages     current_pages
  *     0 1 2 3 4                 4                           5             6                       6 7 8 9 10              10                  (a partir del registro) 500 
  */
 
class Paginator
{
    /*
     * propiedades
     */
      
    //resultados totales
    private $totalResultsSet;
     
    //numero de resultados por pagina
    private $resultsPage = 10;
     
    //numero de pagina actual
    private $page;
    
    //registro actual que esta usando el usuario
    private $currentPages;
    
    //numero de paginas totales
    private $totalPages;
     
    //numero de paginas anteriores
    private $pagesBefore    =   5;
     
    //numero de pagina siguiente
    private $pagesAfter =   5;
    
    //pagina anterior
    private $beforeButton;
    
    //pagina siguiente
    private $afterButton;
    
    //botones circundantes anteriores
    private $surroundBefore   =   array();
    
    //botones circundantes posteriores
    private $surroundAfter  =   array();
         
    //resultado de un metodo
    private $result =   array();
    
    // action URL, para los botones del paginador
    private $url;
    
    //identificador, identifica el objeto que esta paginando
    private    $id;
    
    /*
     * para crear tanto las propiedades como para iniciar los calculos basicos para toda la clase
     */
    function    __construct($totalResultsSet, $page, $url, $id)
    {
        $this->totalResultsSet    =   $totalResultsSet;
        
        $this->page =   $page;
        
        $this->totalPages   =   $this->calcTotalPages($totalResultsSet, $this->resultsPage);
        
        $this->currentPage  =   $this->currentPages($page, $this->resultsPage);
        
        $this->url  =   $url;
        
        $this->id   =   $id;
    }
    
    /*
     * calcula las paginas totales
     */
    public  function    calcTotalPages($totalResultsSet, $resultsPage)
    {
        //divide los resultados totales entre los resultados a mostrar por pagina
        return  $this->totalPages   =  ceil($totalResultsSet    /   $resultsPage);
    }
    
    /*
     * calcula el conjunto de registros que esta empleando el usuario 
     */
    public  function    currentPages($page, $resultsPage)
    {
        //multiplica la pagina actual por los resultados por pagina
        return  $this->currentPages  =   ceil($page   *   $resultsPage);
    }
    
    /*
     * calcula las paginas circundantes anteriores
     */
    public  function    surroundPagesBefore()
    {  
        //resta la pagina menos el numero de paginas anteriores en el centro
        $pagesBefore  =   $this->page   -   $this->pagesBefore;
        
        //comienza a crear botones hasta llegar a la pagina actual
        for($i=$pagesBefore; $i < $this->page; $i++)
        {
            if($i>=0)
            {
                array_push($this->surroundBefore,   array(
                                                                                        'page'  =>$i,
                                                                                        'url'      =>$this->createURL($this->url, $this->id, $i)
                                                                                        ));
            }
        }
        
        //sino retorna false para que no muestre el boton anterior
        if(empty($this->surroundBefore))
        {
            $this->surroundBefore   =   FALSE;
        }
        
        return  $this->surroundBefore;
    }
    
    /*
     * calcula las paginas circundantes posteriores
     */
    public  function    surroundPagesAfter()
    {  
        //suma a la pagina actual las paginas configuradas para mostrar despues
        $pagesAfter  =   $this->page   +   $this->pagesAfter;
        
        //comienza a crear tantos botones como paginas sean posibles o menor que la suma anterior
        for($i=$this->page; $i < $this->totalPages; $i++)
        {
            if($i>$this->page)
            {
                array_push($this->surroundAfter,   array(
                                                                                        'page'  =>$i,
                                                                                        'url'      =>$this->createURL($this->url, $this->id, $i)
                                                                                     ));
            }
        }
        
        //asigna false para que no muestre botones posteriores
        if(empty($this->surroundAfter))
        {
            $this->surroundAfter   =   FALSE;
        }
        
        return  $this->surroundAfter;
    }
 

[guardarmicorreo]

Código PHP:

/*
     * crea el boton anterior
     */
    public  function    beforeButtons()
    {
        //resta 1 a la pagina actual
        $pageBefore  =   ceil($this->page  -   1);
        
        //si el resultado anterior indica que no da un valor negativo
        if($pageBefore >=0)
        {
            $this->beforeButton  =   array(
                                                                'page'  =>$pageBefore,
                                                                'url'      =>$this->createURL($this->url, $this->id, $pageBefore)
                                                               );
        }
        
        //sino asigna false para no mostrar boton anterior
        else
      {
            $this->beforeButton  =   FALSE;
        }
      
        return $this->beforeButton;
    }
    
    /*
     * crea el boton siguiente
     */
    public  function    afterButtons()
    {  
        //suma a la pagina actual 1
        $afterButton    =   $this->page   +   1;
        
        //si el resultado anterior es menor o igual a las paginas totales posibles
        if($afterButton <  $this->totalPages)
        {
            $this->afterButton  =   array(
                                                             'page'  =>$afterButton,
                                                             'url'      =>$this->createURL($this->url, $this->id, $afterButton)
                                                            );
        }
        else
        {
            $this->afterButton  =   FALSE;
        }
        
        return  $this->afterButton;
    }
    
    /*
     * crea el array definitivo con todos los valores necesarios para todos los botones
     */
    public  function    paginator()
    {
        //comprueba que la pagina que ha enviado el usuario no sea mayor que el total de resultados posibles
        //tampoco que sea inferior a 0
        if($this->page  <=  $this->totalPages   AND $this->page>=0)
        {
            $this->result   =   array(
                                                        'page'=>$this->page,
                                                        'surround_before'   =>$this->surroundPagesBefore(),
                                                        'surround_after'    =>$this->surroundPagesAfter(),
                                                        'before_button' =>$this->beforeButtons(),
                                                        'after_button'  =>$this->afterButtons(),
                                                        'total_pages'   =>$this->totalPages,
                                                        'current_pages' =>$this->currentPages,
                                                        'limit_since' =>$this->currentPages,
                                                        'limit_result_set'  =>$this->resultsPage
                                                    );
                                                                                
        }
        
        //si el usuario intentara romper el paginado poniendo páginas falsas entonces asigna FALSE
        else
      {
            $this->result   =   FALSE;
        }
        
        return  $this->result;
    }
 
    /*
     * busca y sustituye un patron dentro de una URL para
     * eliminar ese patron y sustituirlo para crear una nueva URL
     * evitando repetir el patron en la URL
     * 
     * por ejemplo evitar::          ?page=1&page=2&page=3
     */
    public  function    createURL($url, $id, $page)
    {
        //si el identificador no se encuentra en la url
        if(substr_count($url, $id)  ==0)
        {
            //agrega al final de la url el identificador y el valor que le corresponde
            $url  =   $url."&".$id."=".$page;
        }
        
        //sino busca y reemplaza el identificador en la url por su nuevo valor
        else
      {
            $url  =   preg_replace("/(".$id."=[[:digit:]])/i", $id."=".$page, $url);
        }
        
        return  $url;
    }
}
?>