Merge branch 'develop'

Prepping for 2.2.0RC1.

src/AbstractContainer.php

@@ -9,12 +9,12 @@
 
 namespace Zend\Session;
 
-use Zend\Stdlib\ArrayObject;
 use ArrayIterator;
 use Iterator;
 use Traversable;
 use Zend\Session\ManagerInterface as Manager;
 use Zend\Session\Storage\StorageInterface as Storage;
+use Zend\Stdlib\ArrayObject;
 
 /**
  * Session storage container

src/Config/StandardConfig.php

@@ -9,10 +9,10 @@
 
 namespace Zend\Session\Config;
 
+use Traversable;
 use Zend\Session\Config\ConfigInterface;
 use Zend\Session\Exception;
 use Zend\Validator\Hostname as HostnameValidator;
-use Traversable;
 
 /**
  * Standard session configuration

src/SaveHandler/MongoDB.php

@@ -79,7 +79,7 @@ public function __construct($mongo, MongoDBOptions $options)
      *
      * @param string $savePath
      * @param string $name
-     * @return boolean
+     * @return bool
      */
     public function open($savePath, $name)
     {
@@ -93,7 +93,7 @@ public function open($savePath, $name)
     /**
      * Close session
      *
-     * @return boolean
+     * @return bool
      */
     public function close()
     {
@@ -130,7 +130,7 @@ public function read($id)
      *
      * @param string $id
      * @param string $data
-     * @return boolean
+     * @return bool
      */
     public function write($id, $data)
     {
@@ -165,7 +165,7 @@ public function write($id, $data)
      * Destroy session
      *
      * @param string $id
-     * @return boolean
+     * @return bool
      */
     public function destroy($id)
     {
@@ -188,7 +188,7 @@ public function destroy($id)
      *
      * @see http://docs.mongodb.org/manual/tutorial/expire-data/
      * @param int $maxlifetime
-     * @return boolean
+     * @return bool
      */
     public function gc($maxlifetime)
     {

src/Service/ContainerAbstractServiceFactory.php

@@ -0,0 +1,151 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @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
+ */
+
+namespace Zend\Session\Service;
+
+use Zend\ServiceManager\AbstractFactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use Zend\Session\Container;
+
+/**
+ * Session container abstract service factory.
+ *
+ * Allows creating Container instances, using the Zend\Service\ManagerInterface
+ * if present. Containers are named in a "session_containers" array in the
+ * Config service:
+ *
+ * <code>
+ * return array(
+ *     'session_containers' => array(
+ *         'auth',
+ *         'user',
+ *         'captcha',
+ *     ),
+ * );
+ * </code>
+ *
+ * Services use the prefix "SessionContainer\\":
+ *
+ * <code>
+ * $container = $services->get('SessionContainer\captcha');
+ * </code>
+ */
+class ContainerAbstractServiceFactory implements AbstractFactoryInterface
+{
+    /**
+     * Cached container configuration
+     *
+     * @var array
+     */
+    protected $config;
+
+    /**
+     * Configuration key in which session containers live
+     *
+     * @var string
+     */
+    protected $configKey = 'session_containers';
+
+    /**
+     * @var \Zend\Session\ManagerInterface
+     */
+    protected $sessionManager;
+
+    /**
+     * @param  ServiceLocatorInterface $services
+     * @param  string                  $name
+     * @param  string                  $requestedName
+     * @return bool
+     */
+    public function canCreateServiceWithName(ServiceLocatorInterface $services, $name, $requestedName)
+    {
+        $config = $this->getConfig($services);
+        if (empty($config)) {
+            return false;
+        }
+
+        $containerName = $this->normalizeContainerName($requestedName);
+        return array_key_exists($containerName, $config);
+    }
+
+    /**
+     * @param  ServiceLocatorInterface $services
+     * @param  string                  $name
+     * @param  string                  $requestedName
+     * @return Container
+     */
+    public function createServiceWithName(ServiceLocatorInterface $services, $name, $requestedName)
+    {
+        $manager = $this->getSessionManager($services);
+        return new Container($requestedName, $manager);
+    }
+
+    /**
+     * Retrieve config from service locator, and cache for later
+     *
+     * @param  ServiceLocatorInterface $services
+     * @return false|array
+     */
+    protected function getConfig(ServiceLocatorInterface $services)
+    {
+        if (null !== $this->config) {
+            return $this->config;
+        }
+
+        if (!$services->has('Config')) {
+            $this->config = array();
+            return $this->config;
+        }
+
+        $config = $services->get('Config');
+        if (!isset($config[$this->configKey]) || !is_array($config[$this->configKey])) {
+            $this->config = array();
+            return $this->config;
+        }
+
+        $config = $config[$this->configKey];
+        $config = array_flip($config);
+
+        $this->config = array_change_key_case($config);
+
+        return $this->config;
+    }
+
+    /**
+     * Retrieve the session manager instance, if any
+     *
+     * @param  ServiceLocatorInterface $services
+     * @return null|\Zend\Session\ManagerInterface
+     */
+    protected function getSessionManager(ServiceLocatorInterface $services)
+    {
+        if ($this->sessionManager !== null) {
+            return $this->sessionManager;
+        }
+
+        if ($services->has('Zend\Session\ManagerInterface')) {
+            $this->sessionManager = $services->get('Zend\Session\ManagerInterface');
+        }
+
+        return $this->sessionManager;
+    }
+
+    /**
+     * Normalize the container name in order to perform a lookup
+     *
+     * Strips off the "SessionContainer\" prefix, and lowercases the name.
+     *
+     * @param  string $name
+     * @return string
+     */
+    protected function normalizeContainerName($name)
+    {
+        return strtolower($name);
+    }
+}

src/Service/SessionConfigFactory.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @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
+ */
+
+namespace Zend\Session\Service;
+
+use Zend\ServiceManager\Exception\ServiceNotCreatedException;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use Zend\Session\Config\ConfigInterface;
+
+class SessionConfigFactory implements FactoryInterface
+{
+    /**
+     * Create session configuration object
+     *
+     * Uses "session_config" section of configuration to seed a ConfigInterface
+     * instance. By default, Zend\Session\Config\SessionConfig will be used, but
+     * you may also specify a specific implementation variant using the
+     * "config_class" subkey.
+     *
+     * @param  ServiceLocatorInterface    $services
+     * @return ConfigInterface
+     * @throws ServiceNotCreatedException if session_config is missing, or an
+     *         invalid config_class is used
+     */
+    public function createService(ServiceLocatorInterface $services)
+    {
+        $config = $services->get('Config');
+        if (!isset($config['session_config']) || !is_array($config['session_config'])) {
+            throw new ServiceNotCreatedException(
+                'Configuration is missing a "session_config" key, or the value of that key is not an array'
+            );
+        }
+        $class  = 'Zend\Session\Config\SessionConfig';
+        $config = $config['session_config'];
+        if (isset($config['config_class'])) {
+            if (!class_exists($config['config_class'])) {
+                throw new ServiceNotCreatedException(sprintf(
+                    'Invalid configuration class "%s" specified in "config_class" session configuration; must be a valid class',
+                    $class
+                ));
+            }
+            $class = $config['config_class'];
+            unset($config['config_class']);
+        }
+
+        $sessionConfig = new $class();
+        if (!$sessionConfig instanceof ConfigInterface) {
+            throw new ServiceNotCreatedException(sprintf(
+                'Invalid configuration class "%s" specified in "config_class" session configuration; must implement Zend\Session\Config\ConfigInterface',
+                $class
+            ));
+        }
+        $sessionConfig->setOptions($config);
+
+        return $sessionConfig;
+    }
+}