Feedback

Author: bakura10

CHANGELOG.md

@@ -15,10 +15,11 @@ All notable changes to this project will be documented in this file, in reverse
 
   ```php
   $sm = new \Zend\ServiceManager\ServiceManager([
-    'factories'  => [
-      MyClassA::class => MyFactory::class,
-      MyClassB::class => MyFactory::class
-    ]
+      'factories'  => [
+          MyClassA::class => MyFactory::class,
+          MyClassB::class => MyFactory::class,
+          'MyClassC'      => 'MyFactory' // This is equivalent as using ::class
+      ],
   ]);
 
   $sm->get(MyClassA::class); // MyFactory will receive MyClassA::class as second parameter
@@ -53,9 +54,12 @@ All notable changes to this project will be documented in this file, in reverse
   In version 3, this becomes:
 
   ```php
+  use Zend\ServiceManager\AbstractPluginManager;
+  use Zend\Validator\ValidatorInterface;
+  
   class MyPluginManager extends AbstractPluginManager
   {
-    protected $instanceOf = \Zend\Validator\ValidatorInterface::class;
+      protected $instanceOf = ValidatorInterface::class;
   }
   ```
 
@@ -137,7 +141,7 @@ changes, outlined in this section.
 - The ServiceManager is now immutable. Once configured, it cannot be altered.
   You need to create a new service manager if you need to change the
   configuration. This ensures safer and more aggressive caching. A new method,
-  `withConfig()` allows you to create a new instance that merges the provided
+  `withConfig()`, allows you to create a new instance that merges the provided
   configuration.
 
 - Interfaces for `FactoryInterface`, `DelegatorFactoryInterface` and

src/AbstractPluginManager.php

@@ -19,9 +19,9 @@ abstract class AbstractPluginManager extends ServiceManager implements PluginMan
     /**
      * An object type that the created instance must be instanced of
      *
-     * @var string
+     * @var null|string
      */
-    protected $instanceOf = null;
+    In $instanceOf = null;
 
     /**
      * @param ServiceLocatorInterface $parentLocator

src/Exception/ExceptionInterface.php

@@ -11,9 +11,6 @@
 
 use Interop\Container\Exception\ContainerException;
 
-/**
- * Base exception
- */
 interface ExceptionInterface extends ContainerException
 {
 }

src/Exception/InvalidArgumentException.php

@@ -11,9 +11,6 @@
 
 use InvalidArgumentException as SplInvalidArgumentException;
 
-/**
- * InvalidFactoryException
- */
 class InvalidArgumentException extends SplInvalidArgumentException implements ExceptionInterface
 {
 }

src/Exception/InvalidServiceException.php

@@ -12,9 +12,7 @@
 use RuntimeException as SplRuntimeException;
 
 /**
- * InvalidServiceException
- *
- * This exception is triggered by plugin managers when the created object does not match
+ * This exception is thrown by plugin managers when the created object does not match
  * the plugin manager's conditions
  */
 class InvalidServiceException extends SplRuntimeException implements ExceptionInterface

src/Exception/ServiceNotCreatedException.php

@@ -12,7 +12,7 @@
 use RuntimeException as SplRuntimeException;
 
 /**
- * ServiceNotCreatedException
+ * This exception is thrown when the service locator do not manage to create the service (factory that has an error...)
  */
 class ServiceNotCreatedException extends SplRuntimeException implements ExceptionInterface
 {

src/Exception/ServiceNotFoundException.php

@@ -13,7 +13,7 @@
 use InvalidArgumentException as SplInvalidArgumentException;
 
 /**
- * ServiceNotFoundException
+ * This exception is thrown when the service locator do not manage to find a valid factory to create a service
  */
 class ServiceNotFoundException extends SplInvalidArgumentException implements ExceptionInterface, NotFoundException
 {

src/PluginManagerInterface.php

@@ -23,7 +23,7 @@ interface PluginManagerInterface extends ServiceLocatorInterface
      *
      * @param  object $instance
      * @return void
-     * @throws InvalidServiceException
+     * @throws InvalidServiceException If created instance does not respect the constraint on type imposed by the plugin manager
      */
     public function validate($instance);
 }

src/ServiceLocatorInterface.php

@@ -9,6 +9,8 @@
 
 namespace Zend\ServiceManager;
 
+use Zend\ServiceManager\Exception;
+
 /**
  * Interface for service locator
  */
@@ -20,6 +22,8 @@ interface ServiceLocatorInterface
      * @param  string $name
      * @param  array  $options
      * @return object
+     * @throws Exception\ServiceNotFoundException If no factory/abstract factory could be found to create the instance
+     * @throws Exception\ServiceNotCreatedException If factory/delegator fails to create the instance
      */
     public function get($name, array $options = []);
 

test/bootstrap.php

@@ -31,4 +31,4 @@
  */
 if (defined('TESTS_ZEND_OB_ENABLED') && constant('TESTS_ZEND_OB_ENABLED')) {
     ob_start();
-}
+}