class.PagingInfo.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses 
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for 
 * additional information.
 *
 * $Id: class.PagingInfo.php 1462 2014-02-04 23:52:27Z iherwig $
 */

/**
 * @class PagingInfo
 * @ingroup Persistence
 * @brief PagingInfo contains information about a paged list.
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class PagingInfo
{
  var $_pageSize = 10;
  var $_index = 0;
  var $_totalCount = 0;

  /**
   * Creates a PagingInfo object.
   * @param pageSize The pageSize (-1 to set no page size)
   */  
  function PagingInfo($pageSize)
  {
    $this->_pageSize = intval($pageSize);
  }

  /**
   * Set the number of list items.
   * @param totalCount The number of list items.
   */  
  function setTotalCount($totalCount)
  {
    $this->_totalCount = intval($totalCount);
  }

  /**
   * Get the number of list items.
   * @return The number of list items.
   */  
  function getTotalCount()
  {
    return $this->_totalCount;
  }

  /**
   * Set the current page (1-based).
   * @param page The current page.
   */  
  function setPage($page)
  {
    $this->_index = (intval($page)-1) * $this->_pageSize;
  }

  /**
   * Get the current page (1-based).
   * @return The current page.
   */  
  function getPage()
  {
    return intval($this->_index / $this->_pageSize)+1;
  }

  /**
   * Get the size of a pages.
   * @return The size of a pages.
   */  
  function getPageSize()
  {
    return $this->_pageSize;
  }

  /**
   * Get the number of pages.
   * @return The number of pages.
   */  
  function getPageCount()
  {
    return ceil($this->_totalCount / $this->_pageSize);
  }

  /**
   * Set the current index (0-based).
   * @param index The current list index.
   */  
  function setIndex($index)
  {
    $this->_index = $index;
  }

  /**
   * Get the current index (0-based).
   */  
  function getIndex()
  {
    return $this->_index;
  }

  /**
   * Determine if we are on the first page.
   * @return True/false.
   */  
  function isOnFirstPage()
  {
    return $this->getPage() == 1;
  }

  /**
   * Determine if we are on the first page.
   * @return True/false.
   */  
  function isOnLastPage()
  {
    return $this->getPage() == $this->getPageCount();
  }
}
?>