CI_Pagination Class Reference

List of all members.

Public Member Functions
	CI_Pagination ($params=array())
	Constructor.
	initialize ($params=array())
	Initialize Preferences.
	create_links ()
	Generate the pagination links.
Public Attributes
	$base_url = ''
	$total_rows = ''
	$per_page = 10
	$num_links = 2
	$cur_page = 0
	$first_link = '‹ First'
	$next_link = '>'
	$prev_link = '<'
	$last_link = 'Last ›'
	$uri_segment = 3
	$full_tag_open = ''
	$full_tag_close = ''
	$first_tag_open = ''
	$first_tag_close = ' '
	$last_tag_open = ' '
	$last_tag_close = ''
	$cur_tag_open = '&nbsp;<b>'
	$cur_tag_close = '</b>'
	$next_tag_open = '&nbsp;'
	$next_tag_close = '&nbsp;'
	$prev_tag_open = '&nbsp;'
	$prev_tag_close = ''
	$num_tag_open = '&nbsp;'
	$num_tag_close = ''
	$page_query_string = FALSE
	$query_string_segment = 'per_page'

---

Detailed Description

Definition at line 27 of file Pagination.php.

---

Member Function Documentation

CI_Pagination::CI_Pagination

(

$

params = array()

)

Constructor.

public

Parameters:

array

initialization parameters

Definition at line 62 of file Pagination.php.

References initialize(), and log_message().

        {
                if (count($params) > 0)
                {
                        $this->initialize($params);             
                }
                
                log_message('debug', "Pagination Class Initialized");
        }

Here is the call graph for this function:

CI_Pagination::create_links

(

)

Generate the pagination links.

public

Returns:

string

Definition at line 103 of file Pagination.php.

References $CI, get_instance(), and show_error().

        {
                // 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->config->item('enable_query_strings') === TRUE OR $this->page_query_string === TRUE)
                {
                        if ($CI->input->get($this->query_string_segment) != 0)
                        {
                                $this->cur_page = $CI->input->get($this->query_string_segment);
                                
                                // Prep the current page - no funny business!
                                $this->cur_page = (int) $this->cur_page;
                        }
                }
                else
                {
                        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;

                // Is pagination being used over GET or POST?  If get, add a per_page query
                // string. If post, add a trailing slash to the base URL if needed
                if ($CI->config->item('enable_query_strings') === TRUE OR $this->page_query_string === TRUE)
                {
                        $this->base_url = rtrim($this->base_url).AMP.$this->query_string_segment.'=';
                }
                else
                {
                        $this->base_url = rtrim($this->base_url, '/') .'/';
                }

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

                // Render the "First" link
                if  ($this->cur_page > $this->num_links)
                {
                        $output .= $this->first_tag_open.'<a href="'.$this->base_url.'">'.$this->first_link.'</a>'.$this->first_tag_close;
                }

                // Render the "previous" link
                if  ($this->cur_page != 1)
                {
                        $i = $uri_page_number - $this->per_page;
                        if ($i == 0) $i = '';
                        $output .= $this->prev_tag_open.'<a href="'.$this->base_url.$i.'">'.$this->prev_link.'</a>'.$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)
                                {
                                        $output .= $this->cur_tag_open.$loop.$this->cur_tag_close; // Current page
                                }
                                else
                                {
                                        $n = ($i == 0) ? '' : $i;
                                        $output .= $this->num_tag_open.'<a href="'.$this->base_url.$n.'">'.$loop.'</a>'.$this->num_tag_close;
                                }
                        }
                }

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

                // Render the "Last" link
                if (($this->cur_page + $this->num_links) < $num_pages)
                {
                        $i = (($num_pages * $this->per_page) - $this->per_page);
                        $output .= $this->last_tag_open.'<a href="'.$this->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;         
        }

Here is the call graph for this function:

CI_Pagination::initialize

(

$

params = array()

)

Initialize Preferences.

public

Parameters:

array

initialization parameters

Returns:

void

Definition at line 81 of file Pagination.php.

Referenced by CI_Pagination().

        {
                if (count($params) > 0)
                {
                        foreach ($params as $key => $val)
                        {
                                if (isset($this->$key))
                                {
                                        $this->$key = $val;
                                }
                        }               
                }
        }

Here is the caller graph for this function:

---

Member Data Documentation

CI_Pagination::$base_url = ''

Definition at line 29 of file Pagination.php.

CI_Pagination::$cur_page = 0

Definition at line 33 of file Pagination.php.

CI_Pagination::$cur_tag_close = '</b>'

Definition at line 46 of file Pagination.php.

CI_Pagination::$cur_tag_open = '&nbsp;<b>'

Definition at line 45 of file Pagination.php.

CI_Pagination::$first_link = '‹ First'

Definition at line 34 of file Pagination.php.

CI_Pagination::$first_tag_close = ' '

Definition at line 42 of file Pagination.php.

CI_Pagination::$first_tag_open = ''

Definition at line 41 of file Pagination.php.

CI_Pagination::$full_tag_close = ''

Definition at line 40 of file Pagination.php.

CI_Pagination::$full_tag_open = ''

Definition at line 39 of file Pagination.php.

CI_Pagination::$last_link = 'Last ›'

Definition at line 37 of file Pagination.php.

CI_Pagination::$last_tag_close = ''

Definition at line 44 of file Pagination.php.

CI_Pagination::$last_tag_open = ' '

Definition at line 43 of file Pagination.php.

CI_Pagination::$next_link = '>'

Definition at line 35 of file Pagination.php.

CI_Pagination::$next_tag_close = ' '

Definition at line 48 of file Pagination.php.

CI_Pagination::$next_tag_open = ' '

Definition at line 47 of file Pagination.php.

CI_Pagination::$num_links = 2

Definition at line 32 of file Pagination.php.

CI_Pagination::$num_tag_close = ''

Definition at line 52 of file Pagination.php.

CI_Pagination::$num_tag_open = ' '

Definition at line 51 of file Pagination.php.

CI_Pagination::$page_query_string = FALSE

Definition at line 53 of file Pagination.php.

CI_Pagination::$per_page = 10

Definition at line 31 of file Pagination.php.

CI_Pagination::$prev_link = '<'

Definition at line 36 of file Pagination.php.

CI_Pagination::$prev_tag_close = ''

Definition at line 50 of file Pagination.php.

CI_Pagination::$prev_tag_open = ' '

Definition at line 49 of file Pagination.php.

CI_Pagination::$query_string_segment = 'per_page'

Definition at line 54 of file Pagination.php.

CI_Pagination::$total_rows = ''

Definition at line 30 of file Pagination.php.

CI_Pagination::$uri_segment = 3

Definition at line 38 of file Pagination.php.

---

The documentation for this class was generated from the following file:

• Pagination.php