interface/modules/zend_modules/library/Zend/Mvc/Service/DiStrictAbstractServiceFactory.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\Mvc\Service;
  11
  12 use Zend\Di\Di;
  13 use Zend\Di\Exception\ClassNotFoundException;
  14 use Zend\Mvc\Exception\DomainException;
  15 use Zend\ServiceManager\AbstractFactoryInterface;
  16 use Zend\ServiceManager\AbstractPluginManager;
  17 use Zend\ServiceManager\Exception;
  18 use Zend\ServiceManager\ServiceLocatorInterface;
  19
  20 class DiStrictAbstractServiceFactory extends Di implements AbstractFactoryInterface
  21 {
  22     /**@#+
  23      * constants
  24      */
  25     const USE_SL_BEFORE_DI = 'before';
  26     const USE_SL_AFTER_DI  = 'after';
  27     const USE_SL_NONE      = 'none';
  28     /**@#-*/
  29
  30     /**
  31      * @var Di
  32      */
  33     protected $di = null;
  34
  35     /**
  36      * @var string
  37      */
  38     protected $useServiceLocator = self::USE_SL_AFTER_DI;
  39
  40     /**
  41      * @var ServiceLocatorInterface
  42      */
  43     protected $serviceLocator = null;
  44
  45     /**
  46      * @var array an array of whitelisted service names (keys are the service names)
  47      */
  48     protected $allowedServiceNames = array();
  49
  50     /**
  51      * @param Di $di
  52      * @param string $useServiceLocator
  53      */
  54     public function __construct(Di $di, $useServiceLocator = self::USE_SL_NONE)
  55     {
  56         $this->useServiceLocator = $useServiceLocator;
  57         // since we are using this in a proxy-fashion, localize state
  58         $this->di              = $di;
  59         $this->definitions     = $this->di->definitions;
  60         $this->instanceManager = $this->di->instanceManager;
  61     }
  62
  63     /**
  64      * @param array $allowedServiceNames
  65      */
  66     public function setAllowedServiceNames(array $allowedServiceNames)
  67     {
  68         $this->allowedServiceNames = array_flip(array_values($allowedServiceNames));
  69     }
  70
  71     /**
  72      * @return array
  73      */
  74     public function getAllowedServiceNames()
  75     {
  76         return array_keys($this->allowedServiceNames);
  77     }
  78
  79     /**
  80      * {@inheritDoc}
  81      *
  82      * Allows creation of services only when in a whitelist
  83      */
  84     public function createServiceWithName(ServiceLocatorInterface $serviceLocator, $serviceName, $requestedName)
  85     {
  86         if (!isset($this->allowedServiceNames[$requestedName])) {
  87             throw new Exception\InvalidServiceNameException('Service "' . $requestedName . '" is not whitelisted');
  88         }
  89
  90
  91         if ($serviceLocator instanceof AbstractPluginManager) {
  92             /* @var $serviceLocator AbstractPluginManager */
  93             $this->serviceLocator = $serviceLocator->getServiceLocator();
  94         } else {
  95             $this->serviceLocator = $serviceLocator;
  96         }
  97
  98         return parent::get($requestedName);
  99     }
 100
 101     /**
 102      * Overrides Zend\Di to allow the given serviceLocator's services to be reused by Di itself
 103      *
 104      * {@inheritDoc}
 105      *
 106      * @throws Exception\InvalidServiceNameException
 107      */
 108     public function get($name, array $params = array())
 109     {
 110         if (null === $this->serviceLocator) {
 111             throw new DomainException('No ServiceLocator defined, use `createServiceWithName` instead of `get`');
 112         }
 113
 114         if (self::USE_SL_BEFORE_DI === $this->useServiceLocator && $this->serviceLocator->has($name)) {
 115             return $this->serviceLocator->get($name);
 116         }
 117
 118         try {
 119             return parent::get($name, $params);
 120         } catch (ClassNotFoundException $e) {
 121             if (self::USE_SL_AFTER_DI === $this->useServiceLocator && $this->serviceLocator->has($name)) {
 122                 return $this->serviceLocator->get($name);
 123             }
 124
 125             throw new Exception\ServiceNotFoundException(
 126                 sprintf('Service %s was not found in this DI instance', $name),
 127                 null,
 128                 $e
 129             );
 130         }
 131     }
 132
 133     /**
 134      * {@inheritDoc}
 135      *
 136      * Allows creation of services only when in a whitelist
 137      */
 138     public function canCreateServiceWithName(ServiceLocatorInterface $serviceLocator, $name, $requestedName)
 139     {
 140         // won't check if the service exists, we are trusting the user's whitelist
 141         return isset($this->allowedServiceNames[$requestedName]);
 142     }
 143 }