Source for file object.php

Documentation is available at object.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Pagination
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. /**
  13.  * Pagination object representing a particular item in the pagination lists.
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Pagination
  17.  * @since       1.5
  18.  */
  19. class JPaginationObject
  20. {
  21.     /**
  22.      * @var    string  The link text.
  23.      * @since  1.5
  24.      */
  25.     public $text;
  26.  
  27.     /**
  28.      * @var    integer  The number of rows as a base offset.
  29.      * @since  1.5
  30.      */
  31.     public $base;
  32.  
  33.     /**
  34.      * @var    string  The link URL.
  35.      * @since  1.5
  36.      */
  37.     public $link;
  38.  
  39.     /**
  40.      * @var    integer  The prefix used for request variables.
  41.      * @since  1.6
  42.      */
  43.     public $prefix;
  44.  
  45.     /**
  46.      * @var    boolean  Flag whether the object is the 'active' page
  47.      * @since  3.0
  48.      */
  49.     public $active;
  50.  
  51.     /**
  52.      * Class constructor.
  53.      *
  54.      * @param   string   $text    The link text.
  55.      * @param   integer  $prefix  The prefix used for request variables.
  56.      * @param   integer  $base    The number of rows as a base offset.
  57.      * @param   string   $link    The link URL.
  58.      * @param   boolean  $active  Flag whether the object is the 'active' page
  59.      *
  60.      * @since   1.5
  61.      */
  62.     public function __construct($text, $prefix = '', $base = null, $link = null, $active = false)
  63.     {
  64.         $this->text   = $text;
  65.         $this->prefix = $prefix;
  66.         $this->base   = $base;
  67.         $this->link   = $link;
  68.         $this->active = $active;
  69.     }
  70. }

Documentation generated on Tue, 19 Nov 2013 15:09:42 +0100 by phpDocumentor 1.4.3