Merge branch 'master' of https://github.com/zendframework/zf2 into zf…

…-3371
zendframework · Jan 30, 2013 · af38e3f · af38e3f
commit af38e3f
Show file tree

Hide file tree

Showing 29 changed files with 448 additions and 118 deletions.
diff --git a/src/Adapter/AdapterInterface.php b/src/Adapter/AdapterInterface.php
@@ -5,7 +5,6 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Adapter;
@@ -14,9 +13,6 @@
 
 /**
  * Interface for pagination adapters.
- *
- * @category   Zend
- * @package    Paginator
  */
 interface AdapterInterface extends Countable
 {

diff --git a/src/Adapter/ArrayAdapter.php b/src/Adapter/ArrayAdapter.php
@@ -5,15 +5,10 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Adapter;
 
-/**
- * @category   Zend
- * @package    Paginator
- */
 class ArrayAdapter implements AdapterInterface
 {
     /**

diff --git a/src/Adapter/DbSelect.php b/src/Adapter/DbSelect.php
@@ -5,7 +5,6 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Adapter;
@@ -17,10 +16,6 @@
 use Zend\Db\ResultSet\ResultSetInterface;
 use Zend\Db\ResultSet\ResultSet;
 
-/**
- * @category   Zend
- * @package    Zend_Paginator
- */
 class DbSelect implements AdapterInterface
 {
 

diff --git a/src/Adapter/Exception/ExceptionInterface.php b/src/Adapter/Exception/ExceptionInterface.php
@@ -5,17 +5,11 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Adapter\Exception;
 
 use Zend\Paginator\Exception\ExceptionInterface as Exception;
 
-/**
- * @category   Zend
- * @package    Zend_Paginator
- * @subpackage Adapter
- */
 interface ExceptionInterface extends Exception
 {}
diff --git a/src/Adapter/Exception/InvalidArgumentException.php b/src/Adapter/Exception/InvalidArgumentException.php
@@ -5,18 +5,12 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Adapter\Exception;
 
 use Zend\Paginator\Exception;
 
-/**
- * @category   Zend
- * @package    Zend\Paginator\Adapter
- * @subpackage Exception
- */
 class InvalidArgumentException extends Exception\InvalidArgumentException implements
     ExceptionInterface
 {}
diff --git a/src/Adapter/Exception/RuntimeException.php b/src/Adapter/Exception/RuntimeException.php
@@ -5,18 +5,12 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Adapter\Exception;
 
 use Zend\Paginator\Exception;
 
-/**
- * @category   Zend
- * @package    Zend\Paginator\Adapter
- * @subpackage Exception
- */
 class RuntimeException extends Exception\RuntimeException implements
     ExceptionInterface
 {}
diff --git a/src/Adapter/Exception/UnexpectedValueException.php b/src/Adapter/Exception/UnexpectedValueException.php
@@ -5,18 +5,12 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Adapter\Exception;
 
 use Zend\Paginator\Exception;
 
-/**
- * @category   Zend
- * @package    Zend\Paginator\Adapter
- * @subpackage Exception
- */
 class UnexpectedValueException extends Exception\UnexpectedValueException implements
     ExceptionInterface
 {}
diff --git a/src/Adapter/Iterator.php b/src/Adapter/Iterator.php
@@ -5,17 +5,12 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Adapter;
 
 use Zend\Paginator;
 
-/**
- * @category   Zend
- * @package    Zend_Paginator
- */
 class Iterator implements AdapterInterface
 {
     /**

diff --git a/src/Adapter/Null.php b/src/Adapter/Null.php
@@ -5,15 +5,10 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Adapter;
 
-/**
- * @category   Zend
- * @package    Zend_Paginator
- */
 class Null implements AdapterInterface
 {
     /**

diff --git a/src/Adapter/Service/DbSelectFactory.php b/src/Adapter/Service/DbSelectFactory.php
@@ -0,0 +1,41 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Paginator\Adapter\Service;
+
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class DbSelectFactory implements FactoryInterface
+{
+    /**
+     * Adapter options
+     * @var array
+     */
+    protected $creationOptions;
+
+    /**
+     * Construct with adapter options
+     * @param array $creationOptions
+     */
+    public function __construct(array $creationOptions)
+    {
+        $this->creationOptions = $creationOptions;
+    }
+
+    /**
+     * @param ServiceLocatorInterface $serviceLocator
+     * @return \Zend\Navigation\Navigation
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $class = new \ReflectionClass('Zend\Paginator\Adapter\DbSelect');
+        return $class->newInstanceArgs($this->creationOptions);
+    }
+}
diff --git a/src/AdapterAggregateInterface.php b/src/AdapterAggregateInterface.php
@@ -5,7 +5,6 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator;
@@ -14,10 +13,6 @@
 
 /**
  * Interface that aggregates a Zend\Paginator\Adapter\Abstract just like IteratorAggregate does for Iterators.
- *
- * @category   Zend
- * @package    Zend_Paginator
- * @subpackage Adapter
  */
 interface AdapterAggregateInterface
 {

diff --git a/src/AdapterPluginManager.php b/src/AdapterPluginManager.php
@@ -0,0 +1,84 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Paginator;
+
+use Zend\ServiceManager\AbstractPluginManager;
+
+/**
+ * Plugin manager implementation for paginator adapters.
+ *
+ * Enforces that adapters retrieved are instances of
+ * Adapter\AdapterInterface. Additionally, it registers a number of default
+ * adapters available.
+ */
+class AdapterPluginManager extends AbstractPluginManager
+{
+    /**
+     * Default set of adapters
+     *
+     * @var array
+     */
+    protected $invokableClasses = array(
+        'array'         => 'Zend\Paginator\Adapter\ArrayAdapter',
+        'iterator'      => 'Zend\Paginator\Adapter\Iterator',
+        'null'          => 'Zend\Paginator\Adapter\Null',
+    );
+
+    /**
+     * Default set of adapter factories
+     *
+     * @var array
+     */
+    protected $factories = array(
+        'dbselect'         => 'Zend\Paginator\Adapter\Service\DbSelectFactory'
+    );
+
+    /**
+     * Attempt to create an instance via a factory
+     *
+     * @param  string $canonicalName
+     * @param  string $requestedName
+     * @return mixed
+     * @throws Exception\ServiceNotCreatedException If factory is not callable
+     */
+    protected function createFromFactory($canonicalName, $requestedName)
+    {
+        $factory = $this->factories[$canonicalName];
+        if (is_string($factory) && class_exists($factory, true)) {
+            $factory = new $factory($this->creationOptions);
+            $this->factories[$canonicalName] = $factory;
+        }
+        return parent::createFromFactory($canonicalName, $requestedName);
+    }
+
+    /**
+     * Validate the plugin
+     *
+     * Checks that the adapter loaded is an instance
+     * of Adapter\AdapterInterface.
+     *
+     * @param  mixed $plugin
+     * @return void
+     * @throws Exception\RuntimeException if invalid
+     */
+    public function validatePlugin($plugin)
+    {
+        if ($plugin instanceof Adapter\AdapterInterface) {
+            // we're okay
+            return;
+        }
+
+        throw new Exception\RuntimeException(sprintf(
+            'Plugin of type %s is invalid; must implement %s\Adapter\AdapterInterface',
+            (is_object($plugin) ? get_class($plugin) : gettype($plugin)),
+            __NAMESPACE__
+        ));
+    }
+}
diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php
@@ -5,14 +5,9 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Exception;
 
-/**
- * @category   Zend
- * @package    Zend_Paginator
- */
 interface ExceptionInterface
 {}
diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -5,16 +5,10 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Exception;
 
-/**
- * @category   Zend
- * @package    Zend\Paginator
- * @subpackage Exception
- */
 class InvalidArgumentException
     extends \InvalidArgumentException
     implements ExceptionInterface

diff --git a/src/Exception/RuntimeException.php b/src/Exception/RuntimeException.php
@@ -5,16 +5,10 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Exception;
 
-/**
- * @category   Zend
- * @package    Zend\Paginator
- * @subpackage Exception
- */
 class RuntimeException
     extends \RuntimeException
     implements ExceptionInterface

diff --git a/src/Exception/UnexpectedValueException.php b/src/Exception/UnexpectedValueException.php
@@ -5,16 +5,10 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Paginator
  */
 
 namespace Zend\Paginator\Exception;
 
-/**
- * @category   Zend
- * @package    Zend\Paginator
- * @subpackage Exception
- */
 class UnexpectedValueException
     extends \UnexpectedValueException
     implements ExceptionInterface