vendor/zendframework/zend-mvc/src/Router/RouteInvokableFactory.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-2015 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\Router;
  11
  12 use Interop\Container\ContainerInterface;
  13 use Zend\ServiceManager\Exception\ServiceNotCreatedException;
  14 use Zend\ServiceManager\AbstractFactoryInterface;
  15 use Zend\ServiceManager\FactoryInterface;
  16 use Zend\ServiceManager\ServiceLocatorInterface;
  17
  18 /**
  19  * Specialized invokable/abstract factory for use with RoutePluginManager.
  20  *
  21  * Can be mapped directly to specific route plugin names, or used as an
  22  * abstract factory to map FQCN services to invokables.
  23  */
  24 class RouteInvokableFactory implements
  25     AbstractFactoryInterface,
  26     FactoryInterface
  27 {
  28     /**
  29      * Options used to create instance (used with zend-servicemanager v2)
  30      *
  31      * @var array
  32      */
  33     protected $creationOptions = [];
  34
  35     /**
  36      * Can we create a route instance with the given name? (v3)
  37      *
  38      * Only works for FQCN $routeName values, for classes that implement RouteInterface.
  39      *
  40      * @param ContainerInterface $container
  41      * @param string $routeName
  42      * @return bool
  43      */
  44     public function canCreate(ContainerInterface $container, $routeName)
  45     {
  46         if (! class_exists($routeName)) {
  47             return false;
  48         }
  49
  50         if (! is_subclass_of($routeName, RouteInterface::class)) {
  51             return false;
  52         }
  53
  54         return true;
  55     }
  56
  57     /**
  58      * Can we create a route instance with the given name? (v2)
  59      *
  60      * Proxies to canCreate().
  61      *
  62      * @param ServiceLocatorInterface $container
  63      * @param string $normalizedName
  64      * @param string $routeName
  65      * @return bool
  66      */
  67     public function canCreateServiceWithName(ServiceLocatorInterface $container, $normalizedName, $routeName)
  68     {
  69         return $this->canCreate($container, $routeName);
  70     }
  71
  72     /**
  73      * Create and return a RouteInterface instance.
  74      *
  75      * If the specified $routeName class does not exist or does not implement
  76      * RouteInterface, this method will raise an exception.
  77      *
  78      * Otherwise, it uses the class' `factory()` method with the provided
  79      * $options to produce an instance.
  80      *
  81      * @param ContainerInterface $container
  82      * @param string $routeName
  83      * @param null|array $options
  84      * @return RouteInterface
  85      */
  86     public function __invoke(ContainerInterface $container, $routeName, array $options = null)
  87     {
  88         $options = $options ?: [];
  89
  90         if (! class_exists($routeName)) {
  91             throw new ServiceNotCreatedException(sprintf(
  92                 '%s: failed retrieving invokable class "%s"; class does not exist',
  93                 __CLASS__,
  94                 $routeName
  95             ));
  96         }
  97
  98         if (! is_subclass_of($routeName, RouteInterface::class)) {
  99             throw new ServiceNotCreatedException(sprintf(
 100                 '%s: failed retrieving invokable class "%s"; class does not implement %s',
 101                 __CLASS__,
 102                 $routeName,
 103                 RouteInterface::class
 104             ));
 105         }
 106
 107         return $routeName::factory($options);
 108     }
 109
 110     /**
 111      * Create a route instance with the given name. (v2)
 112      *
 113      * Proxies to __invoke().
 114      *
 115      * @param ServiceLocatorInterface $container
 116      * @param string $normalizedName
 117      * @param string $routeName
 118      * @return RouteInterface
 119      */
 120     public function createServiceWithName(ServiceLocatorInterface $container, $normalizedName, $routeName)
 121     {
 122         return $this($container, $routeName, $this->creationOptions);
 123     }
 124
 125     /**
 126      * Create and return RouteInterface instance
 127      *
 128      * For use with zend-servicemanager v2; proxies to __invoke().
 129      *
 130      * @param ServiceLocatorInterface $container
 131      * @return RouteInterface
 132      */
 133     public function createService(ServiceLocatorInterface $container, $normalizedName = null, $routeName = null)
 134     {
 135         $routeName = $routeName ?: RouteInterface::class;
 136         return $this($container, $routeName, $this->creationOptions);
 137     }
 138
 139     /**
 140      * Set options to use when creating a service (v2)
 141      *
 142      * @param array $creationOptions
 143      */
 144     public function setCreationOptions(array $creationOptions)
 145     {
 146         $this->creationOptions = $creationOptions;
 147     }
 148 }