<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Paginator

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Paginator.php 22865 2010-08-21 12:28:09Z ramon $

 */

/**

 * @see Zend_Loader_PluginLoader

 */

require_once 'Zend/Loader/PluginLoader.php';

/**

 * @see Zend_Json

 */

require_once 'Zend/Json.php';

/**

 * @category   Zend

 * @package    Zend_Paginator

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Paginator implements Countable, IteratorAggregate

{

    /**

     * Specifies that the factory should try to detect the proper adapter type first

     *

     * @var string

     */

    const INTERNAL_ADAPTER = 'Zend_Paginator_Adapter_Internal';

    /**

     * The cache tag prefix used to namespace Paginator results in the cache

     *

     */

    const CACHE_TAG_PREFIX = 'Zend_Paginator_';

    /**

     * Adapter plugin loader

     *

     * @var Zend_Loader_PluginLoader

     */

    protected static $_adapterLoader = null;

    /**

     * Configuration file

     *

     * @var Zend_Config

     */

    protected static $_config = null;

    /**

     * Default scrolling style

     *

     * @var string

     */

    protected static $_defaultScrollingStyle = 'Sliding';

    /**

     * Default item count per page

     *

     * @var int

     */

    protected static $_defaultItemCountPerPage = 10;

    /**

     * Default number of local pages (i.e., the number of discretes

     * page numbers that will be displayed, including the current

     * page number)

     *

     * @var int

     */

    protected static $_defaultPageRange = 10;

    /**

     * Scrolling style plugin loader

     *

     * @var Zend_Loader_PluginLoader

     */

    protected static $_scrollingStyleLoader = null;

    /**

     * Cache object

     *

     * @var Zend_Cache_Core

     */

    protected static $_cache;

    /**

     * Enable or disable the cache by Zend_Paginator instance

     *

     * @var bool

     */

    protected $_cacheEnabled = true;

    /**

     * Adapter

     *

     * @var Zend_Paginator_Adapter_Interface

     */

    protected $_adapter = null;

    /**

     * Number of items in the current page

     *

     * @var integer

     */

    protected $_currentItemCount = null;

    /**

     * Current page items

     *

     * @var Traversable

     */

    protected $_currentItems = null;

    /**

     * Current page number (starting from 1)

     *

     * @var integer

     */

    protected $_currentPageNumber = 1;

    /**

     * Result filter

     *

     * @var Zend_Filter_Interface

     */

    protected $_filter = null;

    /**

     * Number of items per page

     *

     * @var integer

     */

    protected $_itemCountPerPage = null;

    /**

     * Number of pages

     *

     * @var integer

     */

    protected $_pageCount = null;

    /**

     * Number of local pages (i.e., the number of discrete page numbers

     * that will be displayed, including the current page number)

     *

     * @var integer

     */

    protected $_pageRange = null;

    /**

     * Pages

     *

     * @var array

     */

    protected $_pages = null;

    /**

     * View instance used for self rendering

     *

     * @var Zend_View_Interface

     */

    protected $_view = null;

    /**

     * Adds an adapter prefix path to the plugin loader.

     *

     * @param string $prefix

     * @param string $path

     */

    public static function addAdapterPrefixPath($prefix, $path)

    {

        self::getAdapterLoader()->addPrefixPath($prefix, $path);

    }

    /**

     * Adds an array of adapter prefix paths to the plugin

     * loader.

     *

     * <code>

     * $prefixPaths = array(

     *     'My_Paginator_Adapter'   => 'My/Paginator/Adapter/',

     *     'Your_Paginator_Adapter' => 'Your/Paginator/Adapter/'

     * );

     * </code>

     *

     * @param array $prefixPaths

     */

    public static function addAdapterPrefixPaths(array $prefixPaths)

    {

        if (isset($prefixPaths['prefix']) && isset($prefixPaths['path'])) {

            self::addAdapterPrefixPath($prefixPaths['prefix'], $prefixPaths['path']);

        } else {

            foreach ($prefixPaths as $prefix => $path) {

                if (is_array($path) && isset($path['prefix']) && isset($path['path'])) {

                    $prefix = $path['prefix'];

                    $path   = $path['path'];

                }

                self::addAdapterPrefixPath($prefix, $path);

            }

        }

    }

    /**

     * Adds a scrolling style prefix path to the plugin loader.

     *

     * @param string $prefix

     * @param string $path

     */

    public static function addScrollingStylePrefixPath($prefix, $path)

    {

        self::getScrollingStyleLoader()->addPrefixPath($prefix, $path);

    }

    /**

     * Adds an array of scrolling style prefix paths to the plugin

     * loader.

     *

     * <code>

     * $prefixPaths = array(

     *     'My_Paginator_ScrollingStyle'   => 'My/Paginator/ScrollingStyle/',

     *     'Your_Paginator_ScrollingStyle' => 'Your/Paginator/ScrollingStyle/'

     * );

     * </code>

     *

     * @param array $prefixPaths

     */

    public static function addScrollingStylePrefixPaths(array $prefixPaths)

    {

        if (isset($prefixPaths['prefix']) && isset($prefixPaths['path'])) {

            self::addScrollingStylePrefixPath($prefixPaths['prefix'], $prefixPaths['path']);

        } else {

            foreach ($prefixPaths as $prefix => $path) {

                if (is_array($path) && isset($path['prefix']) && isset($path['path'])) {

                    $prefix = $path['prefix'];

                    $path   = $path['path'];

                }

                self::addScrollingStylePrefixPath($prefix, $path);

            }

        }

    }

    /**

     * Factory.

     *

     * @param  mixed $data

     * @param  string $adapter

     * @param  array $prefixPaths

     * @return Zend_Paginator

     */

    public static function factory($data, $adapter = self::INTERNAL_ADAPTER,

                                   array $prefixPaths = null)

    {

        if ($data instanceof Zend_Paginator_AdapterAggregate) {

            return new self($data->getPaginatorAdapter());

        } else {

            if ($adapter == self::INTERNAL_ADAPTER) {

                if (is_array($data)) {

                    $adapter = 'Array';

                } else if ($data instanceof Zend_Db_Table_Select) {

                    $adapter = 'DbTableSelect';

                } else if ($data instanceof Zend_Db_Select) {

                    $adapter = 'DbSelect';

                } else if ($data instanceof Iterator) {

                    $adapter = 'Iterator';

                } else if (is_integer($data)) {

                    $adapter = 'Null';

                } else {

                    $type = (is_object($data)) ? get_class($data) : gettype($data);

                    /**

                     * @see Zend_Paginator_Exception

                     */

                    require_once 'Zend/Paginator/Exception.php';

                    throw new Zend_Paginator_Exception('No adapter for type ' . $type);

                }

            }

            $pluginLoader = self::getAdapterLoader();

            if (null !== $prefixPaths) {

                foreach ($prefixPaths as $prefix => $path) {

                    $pluginLoader->addPrefixPath($prefix, $path);

                }

            }

            $adapterClassName = $pluginLoader->load($adapter);

            return new self(new $adapterClassName($data));

        }

    }

    /**

     * Returns the adapter loader.  If it doesn't exist it's created.

     *

     * @return Zend_Loader_PluginLoader

     */

    public static function getAdapterLoader()

    {

        if (self::$_adapterLoader === null) {

            self::$_adapterLoader = new Zend_Loader_PluginLoader(

                array('Zend_Paginator_Adapter' => 'Zend/Paginator/Adapter')

            );

        }

        return self::$_adapterLoader;

    }

    /**

     * Set a global config

     *

     * @param Zend_Config $config

     */

    public static function setConfig(Zend_Config $config)

    {

        self::$_config = $config;

        $adapterPaths = $config->get('adapterpaths');

        if ($adapterPaths != null) {

            self::addAdapterPrefixPaths($adapterPaths->adapterpath->toArray());

        }

        $prefixPaths = $config->get('prefixpaths');

        if ($prefixPaths != null) {

            self::addScrollingStylePrefixPaths($prefixPaths->prefixpath->toArray());

        }

        $scrollingStyle = $config->get('scrollingstyle');

        if ($scrollingStyle != null) {

            self::setDefaultScrollingStyle($scrollingStyle);

        }

    }

    /**

     * Returns the default scrolling style.

     *

     * @return  string

     */

    public static function getDefaultScrollingStyle()

    {

        return self::$_defaultScrollingStyle;

    }

    /**

     * Get the default item count per page

     *

     * @return int

     */

    public static function getDefaultItemCountPerPage()

    {

        return self::$_defaultItemCountPerPage;

    }

    /**

     * Set the default item count per page

     *

     * @param int $count

     */

    public static function setDefaultItemCountPerPage($count)

    {

        self::$_defaultItemCountPerPage = (int) $count;

    }

    /**

     * Get the default page range

     *

     * @return int

     */

    public static function getDefaultPageRange()

    {

        return self::$_defaultPageRange;

    }

    /**

     * Set the default page range

     *

     * @param int $count

     */

    public static function setDefaultPageRange($count)

    {

        self::$_defaultPageRange = (int) $count;

    }

    /**

     * Sets a cache object

     *

     * @param Zend_Cache_Core $cache

     */

    public static function setCache(Zend_Cache_Core $cache)

    {

        self::$_cache = $cache;

    }

    /**

     * Sets the default scrolling style.

     *

     * @param  string $scrollingStyle

     */

    public static function setDefaultScrollingStyle($scrollingStyle = 'Sliding')

    {

        self::$_defaultScrollingStyle = $scrollingStyle;

    }

    /**

     * Returns the scrolling style loader.  If it doesn't exist it's

     * created.

     *

     * @return Zend_Loader_PluginLoader

     */

    public static function getScrollingStyleLoader()

    {

        if (self::$_scrollingStyleLoader === null) {

            self::$_scrollingStyleLoader = new Zend_Loader_PluginLoader(

                array('Zend_Paginator_ScrollingStyle' => 'Zend/Paginator/ScrollingStyle')

            );

        }

        return self::$_scrollingStyleLoader;

    }

    /**

     * Constructor.

     *

     * @param Zend_Paginator_Adapter_Interface|Zend_Paginator_AdapterAggregate $adapter

     */

    public function __construct($adapter)

    {

        if ($adapter instanceof Zend_Paginator_Adapter_Interface) {

            $this->_adapter = $adapter;

        } else if ($adapter instanceof Zend_Paginator_AdapterAggregate) {

            $this->_adapter = $adapter->getPaginatorAdapter();

        } else {

            /**