Главная / Zend Manual Core
Конфигурация

Расширенное использование

Создание собственных адаптеров к источникам данных

Вы можете столкнуться с таким типом источника данных, для которого в Zend Framework-е не предусмотрено адаптера. В этом случае нужно создать собственный адаптер.

Для этого нужно реализовать интерфейс Zend_Paginator_Adapter_Interface. Он включает в себя два метода:

  • count()

  • getItems($offset, $itemCountPerPage)

Кроме того, нужно реализовать конструктор, который принимает источник данных в качестве параметра и сохраняет его в защищенном или закрытом свойстве. Как его обрабатывать - зависит от вас.

Если вы когда-либо использовали SPL-интерфейс » Countable, то вам должно быть известно о назначении метода count(). В Zend_Paginator он возвращает общее количество элементов в наборе данных. Кроме того, объект Zend_Paginator предоставляет метод countAllItems() который служит посредником к методу адаптера count().

Метод getItems() ненамного сложнее. Он должен принимать смещение и количество элементов на странице и возвращать соответствующий кусок данных. В случае массива он мог бы выглядеть следующим образом:

  1. return array_slice($this->_array, $offset, $itemCountPerPage);

Посмотрите исходники адаптеров, входящих в поставку Zend Framework (все они реализуют Zend_Paginator_Adapter_Interface), чтобы получить представление о том, как можно реализовать свой адаптер.

Создание своих стилей прокрутки

При создании своего стиля прокрутки реализуйте интерфейс Zend_Paginator_ScrollingStyle_Interface, который определяет единственный метод, getPages():

  1. public function getPages(Zend_Paginator $paginator, $pageRange = null);

Этот метод должен определять номера пограничных страниц в ряде так называемых "локальных" страниц (т.е. страниц, которые находятся рядом с текущей страницей).

Если только ваш стиль прокрутки не наследует от уже существующего (для примера смотрите Zend_Paginator_ScrollingStyle_Elastic), то этот метод должен иметь в конце что-то вроде следующего:

  1. return $paginator->getPagesInRange($lowerBound, $upperBound);

Этим вызовом не делается ничего особенного. Этот метод просто для удобства - он проверяет на корректность верхний и нижний пределы и возвращает массив номеров страниц для постраничной навигации.

Для того, чтобы использовать новый стиль прокрутки, следует указать Zend_Paginator-у, в какой директории этот стиль находится. Для этого сделайте следующее:

  1. $prefix = 'My_Paginator_ScrollingStyle';
  2. $path   = 'My/Paginator/ScrollingStyle/';
  3. Zend_Paginator::addScrollingStylePrefixPath($prefix, $path);

Возможности кэширования

Можно указать Zend_Paginator-у, чтобы он кэшировал получаемые данные, чтобы они не извлекались через адаптер всякий раз, когда будет в них нужда. Для этого просто передайте его методу setCache() экземпляр Zend_Cache_Core.

  1. $paginator = Zend_Paginator::factory($someData);
  2. $fO = array('lifetime' => 3600, 'automatic_serialization' => true);
  3. $bO = array('cache_dir'=>'/tmp');
  4. $cache = Zend_cache::factory('Core', 'File', $fO, $bO);
  5. Zend_Paginator::setCache($cache);

После того, как Zend_Paginator получит экземпляр Zend_Cache_Core, все данные будут кэшироваться. Иногда возникает необходимость отключать кэширование данных даже после того, как вы передали эекземпляр Zend_Cache_Core. Для этого вы можете использовать метод setCacheEnable().

  1. $paginator = Zend_Paginator::factory($someData);
  2. // $cache является экземпляром
  3. Zend_Paginator::setCache($cache);
  4. // ... ниже в коде
  5. $paginator->setCacheEnable(false);
  6. // теперь кэширование отключено

После того, как был установлен объект для кэширования, данные будут сохраняться и извлекаться через него. Иногда бывает нужно очищать кэш вручную. Вы можете делать это через вызов метода clearPageItemCache($pageNumber). В качестве аргумента метод принимает номер страницы, кэш которой следует очистить. Если вызов производится без передачи параметра, то весь кэш будет очищен:

  1. $paginator = Zend_Paginator::factory($someData);
  2. Zend_Paginator::setCache($cache);
  3. $items = $paginator->getCurrentItems();
  4. // теперь страница 1 в кэше
  5. $page3Items = $paginator->getItemsByPage(3);
  6. // теперь и страница 3 в кэше
  7.  
  8. // очищение кэша результатов для страницы 3
  9. $paginator->clearPageItemCache(3);
  10.  
  11. // очищение всего кэша
  12. $paginator->clearPageItemCache();

Изменение количества элементов на странице приведет к очищению всего кэша, поскольку после этого он должен потерять актуальность:

  1. $paginator = Zend_Paginator::factory($someData);
  2. Zend_Paginator::setCache($cache);
  3. // извлечение некоторых элементов
  4. $items = $paginator->getCurrentItems();
  5.  
  6. // весь кэш будет очищен:
  7. $paginator->setItemCountPerPage(2);

Можно также видеть данные в кэше и запрашивать их напрямую. Для этого может использоваться метод getPageItemCache():

  1. $paginator = Zend_Paginator::factory($someData);
  2. $paginator->setItemCountPerPage(3);
  3. Zend_Paginator::setCache($cache);
  4.  
  5. // извлечение некоторых элементов
  6. $items = $paginator->getCurrentItems();
  7. $otherItems = $paginator->getItemsPerPage(4);
  8.  
  9. // просмотр сохраненных в кэше элементов в виде двухмерного массива:
  10. var_dump($paginator->getPageItemCache());

Интерфейс Zend_Paginator_AdapterAggregate

В зависимости от разрабатываемого приложения может возникнуть потребность разбивать на страницы объекты, у которых внутренняя структура данных эквивалентна существующим адаптерам, но при этом вы не хотите нарушать инкапсуляцию для того, что предоставлять доступ к этим данным. В других случаях объект может участвовать в связи "имеет-адаптер" вместо связи "является-адаптером", которую предлагает Zend_Paginator_Adapter_Abstract. В этих случаях вы можете использовать интерфейс Zend_Paginator_AdapterAggregate, который по поведению значительно похож на интерфейс IteratorAggregate из расширения SPL.

  1. interface Zend_Paginator_AdapterAggregate
  2. {
  3.     /**
  4.      * Возвращайте из этого метода полностью сконфигурированный адаптер.
  5.      *
  6.      * @return Zend_Paginator_Adapter_Abstract
  7.      */
  8.     public function getPaginatorAdapter();
  9. }

Как видно из кода, интерфейс довольно небольшой и от вас ожидается только возврат экземпляра Zend_Paginator_Adapter_Abstract. Фабричный метод Zend_Paginator::factory и конструктор класса Zend_Paginator после этого распознают экземпляр Zend_Paginator_AdapterAggregate и обрабатывают его должным образом.


Конфигурация