interface/modules/zend_modules/library/Zend/Paginator/AdapterPluginManager.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Paginator;
  11
  12 use Zend\ServiceManager\AbstractPluginManager;
  13
  14 /**
  15  * Plugin manager implementation for paginator adapters.
  16  *
  17  * Enforces that adapters retrieved are instances of
  18  * Adapter\AdapterInterface. Additionally, it registers a number of default
  19  * adapters available.
  20  */
  21 class AdapterPluginManager extends AbstractPluginManager
  22 {
  23     /**
  24      * Default set of adapters
  25      *
  26      * @var array
  27      */
  28     protected $invokableClasses = array(
  29         'array'         => 'Zend\Paginator\Adapter\ArrayAdapter',
  30         'iterator'      => 'Zend\Paginator\Adapter\Iterator',
  31         'null'          => 'Zend\Paginator\Adapter\Null',
  32     );
  33
  34     /**
  35      * Default set of adapter factories
  36      *
  37      * @var array
  38      */
  39     protected $factories = array(
  40         'dbselect'         => 'Zend\Paginator\Adapter\Service\DbSelectFactory'
  41     );
  42
  43     /**
  44      * Attempt to create an instance via a factory
  45      *
  46      * @param  string $canonicalName
  47      * @param  string $requestedName
  48      * @return mixed
  49      * @throws \Zend\ServiceManager\Exception\ServiceNotCreatedException If factory is not callable
  50      */
  51     protected function createFromFactory($canonicalName, $requestedName)
  52     {
  53         $factory = $this->factories[$canonicalName];
  54         if (is_string($factory) && class_exists($factory, true)) {
  55             $factory = new $factory($this->creationOptions);
  56             $this->factories[$canonicalName] = $factory;
  57         }
  58         return parent::createFromFactory($canonicalName, $requestedName);
  59     }
  60
  61     /**
  62      * Validate the plugin
  63      *
  64      * Checks that the adapter loaded is an instance
  65      * of Adapter\AdapterInterface.
  66      *
  67      * @param  mixed $plugin
  68      * @return void
  69      * @throws Exception\RuntimeException if invalid
  70      */
  71     public function validatePlugin($plugin)
  72     {
  73         if ($plugin instanceof Adapter\AdapterInterface) {
  74             // we're okay
  75             return;
  76         }
  77
  78         throw new Exception\RuntimeException(sprintf(
  79             'Plugin of type %s is invalid; must implement %s\Adapter\AdapterInterface',
  80             (is_object($plugin) ? get_class($plugin) : gettype($plugin)),
  81             __NAMESPACE__
  82         ));
  83     }
  84 }