Skip to content

Xajax Pagination

Derek Jones edited this page · 4 revisions
Clone this wiki locally

How to paginate a grid with xajax and codeigniter I take the pagination class that comes in the codeIgniter library and modify some lines to get it running with xajax. I hope this will useful for you, this works for me. Any improve will be welcomed.

1)Xajax_pagination Class (It is based on Pagination Class of CI)


<?php  if (!defined('BASEPATH')) exit('No direct script access allowed');
/**
* CodeIgniter
*
* An open source application development framework for PHP 4.3.2 or newer
*
* @package        CodeIgniter
* @author       ExpressionEngine Dev Team
* @copyright    Copyright (c) 2006, EllisLab, Inc.
* @license        http://codeigniter.com/user_guide/license.html
* @link        http://codeigniter.com
* @since        Version 1.0
* @filesource
*/

// ------------------------------------------------------------------------

/**
* Pagination Class
*
* @package        CodeIgniter
* @subpackage    Libraries
* @category    Pagination
* @author        ExpressionEngine Dev Team
* @link        http://codeigniter.com/user_guide/libraries/pagination.html
*/
class Xajax_pagination {

    //Added by !Z
    var $function_to_call   = ''; // The function registered by Xajax to call
    var $function_prefix    = 'xajax';

    var $total_rows         = ''; // Total number of items (database results)
    var $per_page           = 10; // Max number of items you want shown per page
    var $num_links          =  2; // Number of "digit" links to show before/after the currently viewed page
    var $cur_page           =  0; // The current page being viewed
    var $first_link         = '‹ First';
    var $next_link          = '>';
    var $prev_link          = '<';
    var $last_link          = 'Last &rsaquo;';
    var $uri_segment        = 3;
    var $full_tag_open      = '';
    var $full_tag_close     = '';
    var $first_tag_open     = '';
    var $first_tag_close    = '&nbsp;';
    var $last_tag_open      = '&nbsp;';
    var $last_tag_close     = '';
    var $cur_tag_open       = '&nbsp;<b>';
    var $cur_tag_close      = '</b>';
    var $next_tag_open      = '&nbsp;';
    var $next_tag_close     = '&nbsp;';
    var $prev_tag_open      = '&nbsp;';
    var $prev_tag_close     = '';
    var $num_tag_open       = '&nbsp;';
    var $num_tag_close      = '';
    //Added by !Z
    var $panel_to_update    = '';


    /**
     * Constructor
     *
     * @access    public
     * @param    array    initialization parameters
     */
    function Xajax_pagination($params = array())
    {
        if (count($params) > 0)
        {
            $this->initialize($params);        
        }
        log_message('debug', "Xajax Pagination Class Initialized");
    }

    // --------------------------------------------------------------------

    /**
     * Initialize Preferences
     *
     * @access    public
     * @param    array    initialization parameters
     * @return    void
     */
    function initialize($params = array())
    {
        if (count($params) > 0)
        {
            foreach ($params as $key => $val)
            {
                if (isset($this->$key))
                {
                    $this->$key = $val;
                }
            }        
        }
    }

    // --------------------------------------------------------------------

    /**
     * Generate the pagination links
     *
     * @access    public
     * @return    string
     */    
    function create_links($cur_page = 0)//Parameter Added by !Z
    {
        $this->cur_page = $cur_page;
        // If our item count or per-page total is zero there is no need to continue.
        if ($this->total_rows == 0 OR $this->per_page == 0)
        {
           return '';
        }

        // Calculate the total number of pages
        $num_pages = ceil($this->total_rows / $this->per_page);

        // Is there only one page? Hm... nothing more to do here then.
        if ($num_pages == 1)
        {
            return '';
        }

        // Determine the current page number.        
        $CI =& get_instance();


        if ($CI->uri->segment($this->uri_segment) != 0)
        {
            $this->cur_page = $CI->uri->segment($this->uri_segment);

            // Prep the current page - no funny business!
            $this->cur_page = (int) $this->cur_page;
        }


        $this->num_links = (int)$this->num_links;

        if ($this->num_links < 1)
        {
            show_error('Your number of links must be a positive number.');
        }

        if ( ! is_numeric($this->cur_page))
        {
            $this->cur_page = 0;
        }

        // Is the page number beyond the result range?
        // If so we show the last page
        if ($this->cur_page > $this->total_rows)
        {
            $this->cur_page = ($num_pages - 1) * $this->per_page;
        }

        $uri_page_number = $this->cur_page;
        $this->cur_page = floor(($this->cur_page/$this->per_page) + 1);

        // Calculate the start and end numbers. These determine
        // which number to start and end the digit links with
        $start = (($this->cur_page - $this->num_links) > 0) ? $this->cur_page - ($this->num_links - 1) : 1;
        $end   = (($this->cur_page + $this->num_links) < $num_pages) ? $this->cur_page + $this->num_links : $num_pages;

          // And here we go...
        $output = '';


        // Render the "First" link
        //Modified by !Z
        if  (($this->num_links - $this->cur_page) < 2 && $this->cur_page != 1)
        {
            //Modified by !Z

            $output .= $this->first_tag_open.$this->create_ajax_links($this->first_link,0).$this->first_tag_close;
        }

        // Render the "previous" link
        if  ($this->cur_page != 1)
        {

            $i = $uri_page_number - $this->per_page;
            //if ($i == 0) $i = '';
            //Modified by !Z
            $output .= $this->prev_tag_open.$this->create_ajax_links($this->prev_link,$i).$this->prev_tag_close;
        }

        // Write the digit links
        for ($loop = $start -1; $loop <= $end; $loop++)
        {
            $i = ($loop * $this->per_page) - $this->per_page;

            if ($i >= 0)
            {
                if ($this->cur_page == $loop)
                {
                    //Modified by !Z
                    $output .= $this->cur_tag_open.$this->create_ajax_links($loop).$this->cur_tag_close; // Current page
                }
                else
                {
                    //$n = ($i == 0) ? '' : $i;
                    //Modified by !Z
                    $output .= $this->num_tag_open.$this->create_ajax_links($loop,$i).$this->num_tag_close;
                    //$output .= $this->num_tag_open.'<a >base_url.$n.'">'.$loop.'</a>'.$this->num_tag_close;
                }
            }
        }

        // Render the "next" link
        if ($this->cur_page < $num_pages)
        {
            //Modified by !Z
            $output .= $this->next_tag_open.$this->create_ajax_links($this->next_link,($this->cur_page * $this->per_page)).$this->next_tag_close;
            //$output .= $this->next_tag_open.'<a >base_url.($this->cur_page * $this->per_page).'">'.$this->next_link.'</a>'.$this->next_tag_close;
        }

        // Render the "Last" link
        //Modified By !Z
        if (($this->cur_page) < $num_pages)
        {
            $i = (($num_pages * $this->per_page) - $this->per_page);
            $output .= $this->last_tag_open.$this->create_ajax_links($this->last_link,$i).$this->last_tag_close;
            //$output .= $this->last_tag_open.'<a >base_url.$i.'">'.$this->last_link.'</a>'.$this->last_tag_close;
        }

        // Kill double slashes.  Note: Sometimes we can end up with a double slash
        // in the penultimate link so we'll kill all double slashes.
        $output = preg_replace("#([^:])//+#", "\\1/", $output);

        // Add the wrapper HTML if exists
        $output = $this->full_tag_open.$output.$this->full_tag_close;

        return $output;        
    }

    function create_ajax_links($text,$page=""){
        if($this->function_prefix != 'xajax')
            $html = "<a >function_prefix."_".$this->function_to_call."('".$page."');return false;\" />$text</a>";       
        else
            $html = "<a >function_to_call."('".$page."');return false;\" />$text</a>";
        return $html;
    }
}
// END Pagination Class

/* End of file xajax_pagination.php */
/* Location: ./application/libraries/xajax_pagination.php */

2)Contoller


&lt;?php
class Users extends Controller {
     var $customConfig;
    function Usuarios(){
        parent::Controller();
      //you must have this to run xajax_pagination see the xajax perfect setup in the wiki section of CI
       $this->load->library("xajax"); 
       $this->xajax->registerFunction(array("paginar",&$this,"paginar"));
       $this->xajax->processRequest();
                      $this->load->library("xajax_pagination");
    }

function Index(){
        $this->configPag();
        $data['xajax_js'] = $this->xajax->getJavascript(base_url()); 
        $data["usuarios_list"] = $this->users_model-> GetAllUsers($this->customConfig["per_page"],0);
        $data["links_pager"] = $this->xajax_pagination->create_links();
       //This view is only the grid so we handle this like a control.
        $data["users_grid"] = $this->load->view("administration/users_grid",$data,true); 
        $this->load->view("administration/users_view",$data);
    }

// this function is because xajax do not execute the constructor.
   function configPag(){
         $this->customConfig['first_link'] = 'Primero';
        $this->customConfig['last_link'] = 'Ultimo'; 
        $this->customConfig['next_link'] = 'Siguiente'; 
        $this->customConfig['prev_link'] = 'Anterior'; 
        $this->customConfig['panel_to_update'] = 'grid'; //Div to update
        $this->customConfig['function_to_call'] = "paginar";
        $this->customConfig['total_rows'] = $this->usuarios_model->GetNumRows();
        $this->customConfig['per_page'] = 2;
        $this->xajax_pagination->initialize($this->customConfig);
   }
function paginar($offset){
         $objResponse = new xajaxResponse();
        $this->configPag();
        $ci =& get_instance();
        $data["links_pager"] = $ci->xajax_pagination->create_links($offset);
        //$objResponse->alert&#40;print_r($data,true&#41;);
        //return $objResponse;
        $data["usuarios_list"] = $this->usuarios_model->GetAllUsuarios($this->customConfig["per_page"],$offset);
        $objResponse->assign($this->customConfig["panel_to_update"],"innerHTML",$this->load->view("administracion/usuarios_grid",$data,true));
        return $objResponse;
 }
}

3)Views users_view


<div class="grid" id="grid">
          &lt;?php echo $usuarios_grid; ?&gt;
</div>

users_grid


<table cellpadding="4" cellspacing="0" border="0" width="100%">
    <tr class="header">
        <th>First Name</th>
        <th>Last Name</th>
        <th>E-Mail</th>
        <th>User</th>
        <th></th>
    </tr>
    &lt;?php foreach($usuarios_list as $usuario): ?&gt;
    <tr>
        <td>&lt;?php echo $user->FName; ?&gt;</td>
        <td>&lt;?php echo $user->LName; ?&gt;</td>
        <td>&lt;?php echo $user->EMail; ?&gt;</td>
        <td>&lt;?php echo $user->Username; ?&gt;</td>
        <td>
    <!any function like edit, delete, etc --&gt;
        </td>
    </tr>
    &lt;?php endforeach; ?&gt;
</table>
<div id="paginador">
&lt;?php echo $links_pager; ?&gt;
</div>

I wrote this very quickly maybe you can found some typo issues.

Thanks ;)

Something went wrong with that request. Please try again.