[Summary view] [Print] [Text view]

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