Merge branch 'feature/221' into develop

Close #221

Author: weierophinney

CHANGELOG.md

@@ -10,7 +10,10 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Changed
 
-- Nothing.
+- [#221](https://github.com/zendframework/zend-servicemanager/pull/221) provides
+  enormous performance improvements for each of the various mutator methods
+  (`setAlias()`, `setFactory()`, etc.), `has()` lookups, and initial
+  container configuration.
 
 ### Deprecated
 

benchmarks/HasBench.php

@@ -45,14 +45,6 @@ public function __construct()
                 BenchAsset\AbstractFactoryFoo::class
             ]
         ]);
-
-        // forcing initialization of all the services
-        $this->sm->get('factory1');
-        $this->sm->get('invokable1');
-        $this->sm->get('service1');
-        $this->sm->get('alias1');
-        $this->sm->get('recursiveAlias1');
-        $this->sm->get('recursiveAlias2');
     }
 
     public function benchHasFactory1()

benchmarks/SetNewServicesBench.php

@@ -56,6 +56,14 @@ public function __construct()
         $this->sm = new ServiceManager($config);
     }
 
+    public function benchSetService()
+    {
+        // @todo @link https://github.com/phpbench/phpbench/issues/304
+        $sm = clone $this->sm;
+
+        $sm->setService('service2', new \stdClass());
+    }
+
     public function benchSetFactory()
     {
         // @todo @link https://github.com/phpbench/phpbench/issues/304

src/AbstractPluginManager.php

@@ -120,6 +120,17 @@ public function configure(array $config)
         return $this;
     }
 
+    /**
+     * Override setService for additional plugin validation.
+     *
+     * {@inheritDoc}
+     */
+    public function setService($name, $service)
+    {
+        $this->validate($service);
+        parent::setService($name, $service);
+    }
+
     /**
      * {@inheritDoc}
      *

src/Exception/ContainerModificationsNotAllowedException.php

@@ -14,4 +14,17 @@
  */
 class ContainerModificationsNotAllowedException extends DomainException implements ExceptionInterface
 {
+    /**
+     * @param string $service Name of service that already exists.
+     * @return self
+     */
+    public static function fromExistingService($service)
+    {
+        return new self(sprintf(
+            'The container does not allow replacing or updating a service'
+            . ' with existing instances; the following service'
+            . ' already exists in the container: %s',
+            $service
+        ));
+    }
 }

src/Exception/CyclicAliasException.php

@@ -19,9 +19,29 @@
 
 class CyclicAliasException extends InvalidArgumentException
 {
+    /**
+     * @param string   $alias conflicting alias key
+     * @param string[] $aliases map of referenced services, indexed by alias name (string)
+     * @return self
+     */
+    public static function fromCyclicAlias($alias, array $aliases)
+    {
+        $cycle = $alias;
+        $cursor = $alias;
+        while (isset($aliases[$cursor]) && $aliases[$cursor] !== $alias) {
+            $cursor = $aliases[$cursor];
+            $cycle .= ' -> '. $cursor;
+        }
+        $cycle .= ' -> ' . $alias . "\n";
+
+        return new self(sprintf(
+            "A cycle was detected within the aliases definitions:\n%s",
+            $cycle
+        ));
+    }
+
     /**
      * @param string[] $aliases map of referenced services, indexed by alias name (string)
-     *
      * @return self
      */
     public static function fromAliasesMap(array $aliases)
@@ -53,7 +73,6 @@ function ($alias) use ($aliases) {
      *
      * @param string[] $aliases
      * @param string   $alias
-     *
      * @return array|null
      */
     private static function getCycleFor(array $aliases, $alias)
@@ -67,7 +86,6 @@ private static function getCycleFor(array $aliases, $alias)
             }
 
             $cycleCandidate[$targetName] = true;
-
             $targetName = $aliases[$targetName];
         }
 
@@ -76,7 +94,6 @@ private static function getCycleFor(array $aliases, $alias)
 
     /**
      * @param string[] $aliases
-     *
      * @return string
      */
     private static function printReferencesMap(array $aliases)
@@ -92,7 +109,6 @@ private static function printReferencesMap(array $aliases)
 
     /**
      * @param string[][] $detectedCycles
-     *
      * @return string
      */
     private static function printCycles(array $detectedCycles)
@@ -102,7 +118,6 @@ private static function printCycles(array $detectedCycles)
 
     /**
      * @param string[] $detectedCycle
-     *
      * @return string
      */
     private static function printCycle(array $detectedCycle)
@@ -123,7 +138,6 @@ function ($cycle) {
 
     /**
      * @param bool[][] $detectedCycles
-     *
      * @return bool[][] de-duplicated
      */
     private static function deDuplicateDetectedCycles(array $detectedCycles)

src/Exception/InvalidArgumentException.php

@@ -8,10 +8,39 @@
 namespace Zend\ServiceManager\Exception;
 
 use InvalidArgumentException as SplInvalidArgumentException;
+use Zend\ServiceManager\AbstractFactoryInterface;
+use Zend\ServiceManager\Initializer\InitializerInterface;
 
 /**
  * @inheritDoc
  */
 class InvalidArgumentException extends SplInvalidArgumentException implements ExceptionInterface
 {
+    /**
+     * @param mixed $initializer
+     * @return self
+     */
+    public static function fromInvalidInitializer($initializer)
+    {
+        return new self(sprintf(
+            'An invalid initializer was registered. Expected a callable or an'
+            . ' instance of "%s"; received "%s"',
+            InitializerInterface::class,
+            is_object($initializer) ? get_class($initializer) : gettype($initializer)
+        ));
+    }
+
+    /**
+     * @param mixed $abstractFactory
+     * @return self
+     */
+    public static function fromInvalidAbstractFactory($abstractFactory)
+    {
+        return new self(sprintf(
+            'An invalid abstract factory was registered. Expected an instance of or a valid'
+            . ' class name resolving to an implementation of "%s", but "%s" was received.',
+            AbstractFactoryInterface::class,
+            is_object($abstractFactory) ? get_class($abstractFactory) : gettype($abstractFactory)
+        ));
+    }
 }