Carbon_Pagination

Complexity

Total Complexity

36

Size/Duplication

Total Lines	411
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	14
Bugs	0	Features	0

31 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	set()	0	8	3
A	get_pages()	0	3	1
A	set_pages()	0	8	2
A	get_current_page()	0	3	1
A	set_current_page()	0	13	3
A	get_total_pages()	0	3	1
A	set_total_pages()	0	9	2
A	get_enable_prev()	0	3	1
A	set_enable_prev()	0	3	1
A	get_enable_next()	0	3	1
A	set_enable_next()	0	3	1
A	get_enable_first()	0	3	1
A	set_enable_first()	0	3	1
A	get_enable_last()	0	3	1
A	set_enable_last()	0	3	1
A	get_enable_numbers()	0	3	1
A	set_enable_numbers()	0	3	1
A	get_enable_current_page_text()	0	3	1
A	set_enable_current_page_text()	0	3	1
A	get_number_limit()	0	3	1
A	set_number_limit()	0	3	1
A	get_large_page_number_limit()	0	3	1
A	set_large_page_number_limit()	0	3	1
A	get_large_page_number_interval()	0	3	1
A	set_large_page_number_interval()	0	3	1
A	get_collection()	0	3	1
A	set_collection()	0	3	1
A	get_renderer()	0	3	1
A	set_renderer()	0	3	1
	get_page_url()	0	1	?

<?php
/**
 * The Carbon Pagination base class.
 * Contains and manages all of the pagination settings.
 * Abstract, can be extended by all specific pagination types.
 *
 * @abstract
 */
abstract class Carbon_Pagination {
	
	/**
	 * @var array
	 * 
	 * Optional. Can be used if you want to loop through IDs instead of consecutive pages.
	 * If not defined, falls back to an array of all pages from 1 to $total_pages.
	 */
	protected $pages = array();

	/**
	 * @var int The total number of pages.
	 */
	protected $total_pages = 1;

	/**
	 * @var int The current page number.
	 */
	protected $current_page = 1;

	/**
	 * @var bool Whether the previous page link should be displayed.
	 */
	protected $enable_prev = true;

	/**
	 * @var bool Whether the next page link should be displayed.
	 */
	protected $enable_next = true;

	/**
	 * @var bool Whether the first page link should be displayed.
	 */
	protected $enable_first = false;

	/**
	 * @var bool Whether the last page link should be displayed.
	 */
	protected $enable_last = false;

	/**
	 * @var bool Whether the page number links should be displayed.
	 */
	protected $enable_numbers = false;

	/**
	 * @var bool Whether the current page text ("Page X of Y") should be displayed.
	 */
	protected $enable_current_page_text = false;

	/**
	 * @var int 
	 * 
	 * How much page number links should be displayed (on each side of the current page item).
	 * Using 0 means only the current page item will be displayed.
	 * Using -1 means no limit (all page number links will be displayed).
	 */
	protected $number_limit = -1;

	/**
	 * @var int 
	 * 
	 * How much larger page number links should be displayed.
	 * Larger page numbers can be: 10, 20, 30, etc.
	 * Using 0 means none (no larger page number links will be displayed).
	 */
	protected $large_page_number_limit = 0;

	/**
	 * @var int 
	 * 
	 * The interval between larger page number links.
	 * If set to 5, larger page numbers will be 5, 10, 15, 20, etc.
	 */
	protected $large_page_number_interval = 10;

	/**
	 * @var string The class name of the pagination collection object.
	 */
	protected $collection = 'Carbon_Pagination_Collection';

	/**
	 * @var string The class name of the pagination renderer object.
	 */
	protected $renderer = 'Carbon_Pagination_Renderer';

	/**
	 * @var array 
	 * 
	 * The default argument values. Can be declared in the inheriting classes.
	 * Will override the default configuration options in Carbon_Pagination::__construct
	 * but can be overriden by the $args parameter.
	 */
	public $default_args = array();

	/**
	 * Constructor. 
	 * Creates and configures a new pagination with the provided settings.
	 * 
	 * @param array $args Configuration options to modify the pagination settings.
	 */
	public function __construct( $args = array() ) {
		// allow default options to be filtered
		$defaults = apply_filters( 'carbon_pagination_default_options', $this->default_args, $this );

		// parse configuration options
		$args = wp_parse_args( $args, $defaults );

		// set configuration options & constraints
		$this->set( $args );
	}

	/**
	 * Bulk set certain configuration options & constraints.
	 * 
	 * @param array $args Configuration options
	 */
	public function set( $args ) {
		foreach ( $args as $arg_name => $arg_value ) {
			$method = 'set_' . $arg_name;
			if ( method_exists( $this, $method ) ) {
				call_user_func( array( $this, $method ), $arg_value );
			}
		}
	}

	/**
	 * Retrieve the pages array.
	 * 
	 * @return array $pages The pages array.
	 */
	public function get_pages() {
		return $this->pages;
	}

	/**
	 * Modify the pages array.
	 * Array keys are intentionally reset.
	 * 
	 * @param array $pages The new pages array.
	 */
	public function set_pages( $pages = array() ) {
		if ( ! is_array( $pages ) ) {
			$pages = array( $pages );
		}

		$this->pages = array_values( $pages );
		$this->total_pages = count( $pages );
	}

	/**
	 * Retrieve the current page number.
	 * 
	 * @return int $current_page The current page number.
	 */
	public function get_current_page() {
		return $this->current_page;
	}

	/**
	 * Modify the current page number, affecting $total_pages as well.
	 * 
	 * @param int $current_page The new current page number.
	 */
	public function set_current_page( $current_page = 1 ) {
		$current_page = intval( $current_page );
		if ( $current_page < 1 ) {
			$current_page = 1;
		}

		$total_pages = $this->get_total_pages();
		if ( $current_page > $total_pages ) {
			$current_page = $total_pages;
		}

		$this->current_page = $current_page;
	}

	/**
	 * Retrieve the total number of pages.
	 * 
	 * @return int $total_pages The total number of pages.
	 */
	public function get_total_pages() {
		return $this->total_pages;
	}

	/**
	 * Modify the total number of pages, affecting $pages as well.
	 * 
	 * @param int $total_pages The new total number of pages.
	 */
	public function set_total_pages( $total_pages ) {
		$total_pages = intval( $total_pages );
		if ( $total_pages < 1 ) {
			$total_pages = 1;
		}

		$this->total_pages = $total_pages;
		$this->pages = range( 1, $total_pages );
	}

	/**
	 * Whether the previous page link should be displayed.
	 * 
	 * @return bool $enable_prev Whether the previous page link should be displayed.
	 */
	public function get_enable_prev() {
		return $this->enable_prev;
	}

	/**
	 * Change whether the previous page link should be displayed.
	 * 
	 * @param bool $enable_prev Whether the previous page link should be displayed.
	 */
	public function set_enable_prev( $enable_prev ) {
		$this->enable_prev = (bool) $enable_prev;
	}

	/**
	 * Whether the next page link should be displayed.
	 * 
	 * @return bool $enable_next Whether the next page link should be displayed.
	 */
	public function get_enable_next() {
		return $this->enable_next;
	}

	/**
	 * Change whether the next page link should be displayed.
	 * 
	 * @param bool $enable_next Whether the next page link should be displayed.
	 */
	public function set_enable_next( $enable_next ) {
		$this->enable_next = (bool) $enable_next;
	}

	/**
	 * Whether the first page link should be displayed.
	 * 
	 * @return bool $enable_first Whether the first page link should be displayed.
	 */
	public function get_enable_first() {
		return $this->enable_first;
	}

	/**
	 * Change whether the first page link should be displayed.
	 * 
	 * @param bool $enable_first Whether the first page link should be displayed.
	 */
	public function set_enable_first( $enable_first ) {
		$this->enable_first = (bool) $enable_first;
	}

	/**
	 * Whether the last page link should be displayed.
	 * 
	 * @return bool $enable_last Whether the last page link should be displayed.
	 */
	public function get_enable_last() {
		return $this->enable_last;
	}

	/**
	 * Change whether the last page link should be displayed.
	 * 
	 * @param bool $enable_last Whether the last page link should be displayed.
	 */
	public function set_enable_last( $enable_last ) {
		$this->enable_last = (bool) $enable_last;
	}

	/**
	 * Whether the page number links should be displayed.
	 * 
	 * @return bool $enable_numbers Whether the page number links should be displayed.
	 */
	public function get_enable_numbers() {
		return $this->enable_numbers;
	}

	/**
	 * Change whether the page number links should be displayed.
	 * 
	 * @param bool $enable_numbers Whether the page number links should be displayed.
	 */
	public function set_enable_numbers( $enable_numbers ) {
		$this->enable_numbers = (bool) $enable_numbers;
	}

	/**
	 * Whether the current page text should be displayed.
	 * 
	 * @return bool $enable_current_page_text Whether the current page text should be displayed.
	 */
	public function get_enable_current_page_text() {
		return $this->enable_current_page_text;
	}

	/**
	 * Change whether the current page text should be displayed.
	 * 
	 * @param bool $enable_current_page_text Whether the current page text should be displayed.
	 */
	public function set_enable_current_page_text( $enable_current_page_text ) {
		$this->enable_current_page_text = (bool) $enable_current_page_text;
	}

	/**
	 * Retrieve the page number links limit.
	 * 
	 * @return int $number_limit The page number links limit.
	 */
	public function get_number_limit() {
		return $this->number_limit;
	}

	/**
	 * Modify the page number links limit.
	 * 
	 * @param int $number_limit The new page number links limit.
	 */
	public function set_number_limit( $number_limit ) {
		$this->number_limit = intval( $number_limit );
	}

	/**
	 * Retrieve the large page number links limit.
	 * 
	 * @return int $large_page_number_limit The large page number links limit.
	 */
	public function get_large_page_number_limit() {
		return $this->large_page_number_limit;
	}

	/**
	 * Modify the large page number links limit.
	 * 
	 * @param int $large_page_number_limit The new large page number links limit.
	 */
	public function set_large_page_number_limit( $large_page_number_limit ) {
		$this->large_page_number_limit = absint( $large_page_number_limit );
	}

	/**
	 * Retrieve the large page number links interval.
	 * 
	 * @return int $large_page_number_interval The large page number links interval.
	 */
	public function get_large_page_number_interval() {
		return $this->large_page_number_interval;
	}

	/**
	 * Modify the large page number links interval.
	 * 
	 * @param int $large_page_number_interval The new large page number links interval.
	 */
	public function set_large_page_number_interval( $large_page_number_interval ) {
		$this->large_page_number_interval = absint( $large_page_number_interval );
	}

	/**
	 * Retrieve the collection object class name.
	 * 
	 * @return string $collection The collection object class name.
	 */
	public function get_collection() {
		return $this->collection;
	}

	/**
	 * Modify the collection object class name.
	 * 
	 * @param string $collection The new collection object class name.
	 */
	public function set_collection( $collection ) {
		$this->collection = $collection;
	}

	/**
	 * Retrieve the renderer object class name.
	 * 
	 * @return string $renderer The renderer object class name.
	 */
	public function get_renderer() {
		return $this->renderer;
	}

	/**
	 * Modify the renderer object class name.
	 * 
	 * @param string $renderer The new renderer object class name.
	 */
	public function set_renderer( $renderer ) {
		$this->renderer = $renderer;
	}

	/**
	 * Get the URL to a certain page.
	 *
	 * @abstract
	 * @param int $page_number The page number.
	 * @param string $old_url Optional. The URL to add the page number to.
	 * @return string $url The URL to the page number.
	 */
	abstract public function get_page_url( $page_number, $old_url = '' );

}