Merge pull request #187 from michaelmoussa/psr-11

Replace container-interop with PSR-11 container interface

Author: Ocramius

benchmarks/BenchAsset/AbstractFactoryFoo.php

@@ -7,7 +7,7 @@
 
 namespace ZendBench\ServiceManager\BenchAsset;
 
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\Factory\AbstractFactoryInterface;
 
 class AbstractFactoryFoo implements AbstractFactoryInterface

benchmarks/BenchAsset/FactoryFoo.php

@@ -7,7 +7,7 @@
 
 namespace ZendBench\ServiceManager\BenchAsset;
 
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\Factory\FactoryInterface;
 
 class FactoryFoo implements FactoryInterface

composer.json

@@ -22,7 +22,6 @@
     },
     "require": {
         "php": "^7.1",
-        "container-interop/container-interop": "^1.2",
         "psr/container": "^1.0",
         "zendframework/zend-stdlib": "^3.1"
     },
@@ -34,7 +33,6 @@
         "zendframework/zend-coding-standard": "~1.0.0"
     },
     "provide": {
-        "container-interop/container-interop-implementation": "^1.2",
         "psr/container-implementation": "^1.0"
     },
     "suggest": {
@@ -55,6 +53,9 @@
     "config": {
         "sort-packages": true
     },
+    "conflict": {
+        "container-interop/container-interop": "<1.2.0"
+    },
     "extra": {
         "branch-alias": {
             "dev-master": "3.3-dev",

composer.lock

@@ -60,7 +60,7 @@ $serviceManager = new ServiceManager([
 As said before, a factory can also be a callable, to create more complex objects:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\Factory\InvokableFactory;
 use Zend\ServiceManager\ServiceManager;
 use stdClass;
@@ -267,7 +267,7 @@ For instance, if we'd want to automatically inject the dependency
 `EventManagerAwareInterface`, we could create the following initializer:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use stdClass;
 use Zend\ServiceManager\ServiceManager;
 
@@ -303,7 +303,7 @@ class MyInitializer implements InitializerInterface
 
 // When creating the service manager:
 
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use stdClass;
 use Zend\ServiceManager\ServiceManager;
 

docs/book/configuring-the-service-manager.md

@@ -14,7 +14,7 @@ intercept actions being performed on the delegate in an
 A delegator factory has the following signature:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 
 public function __invoke(
     ContainerInterface $container,
@@ -106,7 +106,7 @@ A simple delegator factory for the `buzzer` service can be implemented as
 following:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\Factory\DelegatorFactoryInterface;
 
 class BuzzerDelegatorFactory implements DelegatorFactoryInterface

docs/book/delegators.md

@@ -0,0 +1,43 @@
+# Migration Guide
+
+Migration guide for Zend Service version 4.0.0.
+
+## PSR-11: Container Interface
+
+[`container-interop/container-interop`](https://github.com/container-interop/container-interop)
+was officially deprecated in favor of [PSR-11](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-11-container.md)
+on February 13, 2017. As such, all uses of the interop-container interfaces
+have been replaced with PSR-11 containers interfaces as follows:
+  - `Interop\Container\ContainerInterface` to `Psr\Container\ContainerInterface`,
+  - `Interop\Container\Exception\ContainerException` to `Psr\Container\ContainerExceptionInterface`,
+  - `Interop\Container\Exception\NotFoundException` to `Psr\Container\NotFoundExceptionInterface`.
+
+Further, installs of `container-interop/container-interop` below version `1.2.0`
+is prohibited via Composer's `conflicts` configuration. Version `1.2.0` _does_
+extend the PSR-11 interfaces, and is thus still usable.
+
+If your project typehints any `Interop\ContainerInterop\*` interfaces where any
+`Zend\ServiceManager\*` classes are expected, you _**must**_ update your code to
+expect `Zend\ServiceManager\*` or `Psr\Container\*` classes or interfaces instead.
+The latter is preferred, unless your code utilizes any additional functionality
+provided by the `Zend\ServiceManager\*` classes that are not declared in the
+PSR-11 interfaces.
+
+To do this, use your favorite find-and-replace tool to update the following:
+  - `use Interop\Container\ContainerInterface;` -> `use Psr\Container\ContainerInterface;`
+  - `use Interop\Container\Exception\ContainerException;` -> `use Psr\Container\ContainerExceptionInterface;`
+  - `use Interop\Container\Exception\NotFoundException;` -> `use Psr\Container\NotFoundExceptionInterface;`
+    - **Note:** You will also need to replace `ContainerException` with `ContainerExceptionInterface`
+      and `NotFoundException` with `NotFoundExceptionInterface` where it is used
+      throughout your code. If you _don't_ want to do that, you can include
+      `as ContainerException`/`as NotFoundException` in the find-and-replace,
+      and any existing use of `ContainerException`/`NotFoundException` will
+      continue to work.
+
+> ### Note
+>
+> If you use fully-qualified class names in your typehints, rather than taking
+> advantage of `use` statements, you will need to run additional find-and-replace
+> commands to update those class paths within your code. The exact finds and
+> replaces to run for those scenarios are not covered in this migration guide, as
+> they can vary greatly and are not a generally recommended practice.

docs/book/migration-v4.md

@@ -251,7 +251,7 @@ $container->mapLazyService('MyClass');
 ## ServiceLocatorInterface Changes
 
 The `ServiceLocatorInterface` now extends the
-[container-interop](https://github.com/container-interop/container-interop)
+[Psr\Container\ContainerInterface](https://github.com/php-fig/container)
 interface `ContainerInterface`, which defines the same `get()` and `has()`
 methods as were previously defined.
 
@@ -436,7 +436,7 @@ To update this for version 3 compatibility, you will add the methods
 them, and update the existing methods to proxy to the new methods:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\AbstractFactoryInterface;
 use Zend\ServiceManager\ServiceLocatorInterface;
 
@@ -474,7 +474,7 @@ the migration artifacts:
 From our example above, we would update the class to read as follows:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\Factory\AbstractFactoryInterface; // <-- note the change!
 
 class LenientAbstractFactory implements AbstractFactoryInterface
@@ -562,7 +562,7 @@ To prepare this for version 3, we'd implement the `__invoke()` signature from
 version 3, and modify `createDelegatorWithName()` to proxy to it:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\DelegatorFactoryInterface;
 use Zend\ServiceManager\ServiceLocatorInterface;
 
@@ -591,7 +591,7 @@ the migration artifacts:
 From our example above, we would update the class to read as follows:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\Factory\DelegatorFactoryInterface; // <-- note the change!
 
 class ObserverAttachmentDelegator implements DelegatorFactoryInterface
@@ -674,7 +674,7 @@ To prepare this for version 3, we'd implement the `__invoke()` signature from
 version 3, and modify `createService()` to proxy to it:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\FactoryInterface;
 use Zend\ServiceManager\ServiceLocatorInterface;
 
@@ -706,7 +706,7 @@ the migration artifacts:
 From our example above, we would update the class to read as follows:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\Factory\FactoryInterface; // <-- note the change!
 
 class FooFactory implements FactoryInterface
@@ -808,7 +808,7 @@ To prepare this for version 3, we'd implement the `__invoke()` signature from
 version 3, and modify `initialize()` to proxy to it:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\InitializerInterface;
 use Zend\ServiceManager\ServiceLocatorInterface;
 
@@ -839,7 +839,7 @@ the migration artifacts:
 From our example above, we would update the class to read as follows:
 
 ```php
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use Zend\ServiceManager\Initializer\InitializerInterface; // <-- note the change!
 
 class FooInitializer implements InitializerInterface

docs/book/migration.md

@@ -3,7 +3,7 @@
 The Service Manager is a modern, fast, and easy-to-use implementation of the
 [Service Locator design pattern](https://en.wikipedia.org/wiki/Service_locator_pattern).
 The implementation implements the
-[Container Interop](https://github.com/container-interop/container-interop)
+[Psr\Container\ContainerInterface](https://github.com/psr/container)
 interfaces, providing interoperability with other implementations.
 
 The following is a "quick start" tutorial intended to get you up and running