IoC container - PHP CE 2017

Did you know your IoC container can do a whole lot more than just constructor injection? Besides that it is actually packed with features. Inflectors, resolving callbacks, aliasing, method invocation to name a few. In this talk you will learn how to leverage the power of a great container and service providers to write better, loosely coupled code. Well designed code put together by your IoC container will make your applications SOLID, modular, lean and decoupled from the framework!

Transcript

1. IOC container
   @hannesvdvreken
   PHPCE
   

   View Slide

2. Hi, my name is Hannes.
   

   View Slide

3. !
   

   View Slide

4. View Slide

5. View Slide

6. IoC Container
   

   View Slide

7. I
   O
   C
   

   View Slide

8. International
   O
   C
   

   View Slide

9. International
   Olympic
   C
   

   View Slide

10. International
    Olympic
    Committee
    

    View Slide

11. International
    Olympic
    Committee
    

    View Slide

12. WHAT IS IOC?
    IoC == Inversion of Control
    

    View Slide

13. But first:
    Design patterns
    WHAT IS IOC?
    

    View Slide

14. class Service
    {
    public function calculate()
    {
    // Get stuff from FTP.
    // Do calculations.
    // Return result.
    }
    }
    WHAT IS IOC?
    

    View Slide

15. class Service
    {
    public function __construct(Ftp $ftp)
    {
    }
    public function calculate()
    {
    // Get stuff from FTP.
    // Do calculations.
    // Return result.
    }
    }
    WHAT IS IOC?
    

    View Slide

16. class Service
    {
    public function __construct(Ftp $ftp)
    {
    }
    public function calculate()
    {
    // Get stuff from FTP.
    // Add caching to prevent hitting FTP over and over again
    // Do calculations.
    // Return result.
    }
    }
    WHAT IS IOC?
    

    View Slide

17. class Service
    {
    public function __construct(Ftp $ftp)
    {
    }
    public function calculate()
    {
    // Get stuff from FTP.
    // Add caching to prevent hitting FTP over and over again
    // Log that FTP is accessed.
    // Do calculations.
    // Return result.
    }
    }
    WHAT IS IOC?
    

    View Slide

18. class Service
    {
    public function __construct(Ftp $ftp)
    {
    }
    public function calculate()
    {
    // Get stuff from FTP.
    // Add caching to prevent hitting FTP over and over again
    // Log that FTP is accessed.
    // Do calculations.
    // Return result.
    }
    }
    WHAT IS IOC?
    

    View Slide

19. class FtpStorage
    {
    public function __construct(Ftp $ftp)
    {
    $this->ftp = $ftp;
    }
    public function get($key)
    {
    // Get it.
    // Cache it.
    // Log it.
    // Return it.
    }
    }
    WHAT IS IOC?
    

    View Slide

20. class Service
    {
    public function __construct(FtpStorage $storage)
    {

    $this->storage = $storage;
    }
    }
    WHAT IS IOC?
    

    View Slide

21. interface Storage
    {
    public function get($key);
    }
    WHAT IS IOC?
    

    View Slide

22. class FtpStorage implements Storage
    {
    public function __construct(Ftp $ftp)
    {
    $this->ftp = $ftp;
    }
    public function get($key)
    {
    …
    }
    }
    WHAT IS IOC?
    

    View Slide

23. class Service
    {
    public function __construct(Storage $storage)
    {

    $this->storage = $storage;
    }
    }
    WHAT IS IOC?
    

    View Slide

24. class CacheDecorator implements Storage
    {
    public function __construct(Cache $cache, Storage $storage)
    {…}
    public function get($key)
    {
    return $this->cache->remember($key, 60, function () {
    return $this->storage->get($key);
    });
    }
    }
    WHAT IS IOC?
    

    View Slide

25. class LogDecorator implements Storage
    {
    public function __construct(LoggerInterface $log, Storage $storage)
    {…}
    public function get($key)
    {
    $this->log->info('Retrieved value for '.$key);
    return $this->storage->get($key);
    }
    }
    WHAT IS IOC?
    

    View Slide

26. class FtpStorage implements Storage
    {
    public function __construct(Ftp $ftp)
    {
    $this->ftp = $ftp;
    }
    public function get($key)
    {
    // Get it and return it.
    }
    }
    WHAT IS IOC?
    

    View Slide

27. Dependency inversion:
    Interface + implementation
    Dependency injection:
    Injecting `Storage` into `Service`
    Inversion of Control:
    The container builds your objects and calls them
    WHAT IS IOC?
    

    View Slide

28. FtpStorage
    Service
    depends on
    depends on
    Ftp
    WHAT IS IOC?
    

    View Slide

29. FtpStorage
    implements
    Storage
    Service
    depends on
    depends on
    Ftp
    WHAT IS IOC?
    

    View Slide

30. FtpStorage
    Storage
    CacheDecorator
    Service
    LogDecorator
    S3Storage
    depends on
    WHAT IS IOC?
    implements
    

    View Slide

31. new Service(new FtpStorage(new Ftp($settings)));
    WHAT IS IOC?
    

    View Slide

32. Don’t create these instances
    yourself
    WHAT IS IOC?
    

    View Slide

33. $container->get(Service::class);
    1) Make FtpStorage
    2) Wrap it with LogDecorator
    3) Wrap LogDecorator instance with CacheDecorator
    4) New up Service with CacheDecorator instance.
    WHAT IS IOC?
    

    View Slide

34. Inversion of Control
    IoC container to the rescue
    WHAT IS IOC?
    

    View Slide

35. IoC container is here to help
    you with Composition
    WHAT IS IOC?
    

    View Slide

36. symfony/dependency-injection
    illuminate/container
    aura/di
    zendframework/zend-di
    pimple/pimple
    league/container
    …
    container-interop/container-interop
    psr/container (PSR-11)
    CONSTRUCTOR INJECTION
    

    View Slide

37. View Slide

38. CONSTRUCTOR INJECTION
    namespace Interop\Container;
    use Psr\Container\ContainerInterface as PsrContainer;
    interface ContainerInterface extends PsrContainer
    {
    …
    }
    

    View Slide

39. Automatic object resolution
    

    View Slide

40. class SendInvoice
    {
    public function __construct(Mailer $mailer)
    {
    $this->mailer = $mailer;
    }
    public function listen($event)
    {
    …
    }
    }
    CONSTRUCTOR INJECTION
    

    View Slide

41. $listener = $container->get(SendInvoice::class);
    CONSTRUCTOR INJECTION
    

    View Slide

42. Constructor injection
    CONSTRUCTOR INJECTION
    

    View Slide

43. $listener = $container->get(SendInvoice::class);
    CONSTRUCTOR INJECTION
    

    View Slide

44. // League
    $container = new Container();
    $container->delegate(new ReflectionContainer());
    $listener = $container->get(SendInvoice::class);
    CONSTRUCTOR INJECTION
    

    View Slide

45. Reflection
    CONSTRUCTOR INJECTION
    

    View Slide

46. (new \ReflectionClass($class))
    ->getConstructor()
    ->getParameters();
    CONSTRUCTOR INJECTION
    

    View Slide

47. Recursively
    CONSTRUCTOR INJECTION
    

    View Slide

48. class SendInvoice
    {
    public function __construct(Mailer $mailer)
    {
    $this->mailer = $mailer;
    }
    public function listen(InvoiceGeneratedEvent $event)
    {
    …
    }
    }
    CONSTRUCTOR INJECTION
    

    View Slide

49. Auto wiring:
    - Symfony
    - Zend
    - Laravel
    - league/container
    - …
    CONSTRUCTOR INJECTION
    

    View Slide

50. Helping the container
    

    View Slide

51. Situation 1:
    When <> is type hinted,
    resolve <> instead
    REGISTRATION - BINDING
    

    View Slide

52. Solution:
    Aliasing.
    REGISTRATION - BINDING
    

    View Slide

53. // Symfony
    $container->setAlias(MailerInterface::class, Mailer::class);
    // Laravel
    $container->alias(MailerInterface::class, Mailer::class);
    // League, et al.
    $container->add(MailerInterface::class, function () {
    return $container->get(Mailer::class);
    });
    REGISTRATION - BINDING
    

    View Slide

54. Situation 2:
    When <> has non-type hinted
    constructor arguments.
    REGISTRATION - BINDING
    

    View Slide

55. Solution:
    Define dependencies.
    REGISTRATION - BINDING
    

    View Slide

56. // Symfony
    $container->register(Mailer::class)
    ->addArgument(…);
    REGISTRATION - BINDING
    

    View Slide

57. // Pimple
    $container[MailerInterface::class] = function () {
    …
    };
    REGISTRATION - BINDING
    

    View Slide

58. Situation 3:
    When <> is type hinted, always
    return the same object.
    REGISTRATION - BINDING
    

    View Slide

59. Example:
    Global state in a
    - Translator
    - View
    - Session
    REGISTRATION - BINDING
    

    View Slide

60. Solution:
    Sharing an instance.
    REGISTRATION - BINDING
    

    View Slide

61. // League
    $container->share(EntityManagerInterface::class, function () {
    …
    });
    // Laravel
    $container->singleton(EntityManagerInterface::class, function () {
    …
    });
    // Symfony
    $container->register()->setShared(true);
    REGISTRATION - BINDING
    

    View Slide

62. Situation 4:
    When different classes need a
    different object of the same interface.
    REGISTRATION - BINDING
    

    View Slide

63. Solution:
    Contextual binding.
    REGISTRATION - BINDING
    

    View Slide

64. // Laravel
    $container->bind('fs.photos', function () {});
    $container->bind('fs.files', function () {});
    REGISTRATION - BINDING
    

    View Slide

65. // Laravel
    $container
    ->when(PhotosController::class)
    ->needs(FilesystemInterface::class)
    ->give('fs.photos');
    REGISTRATION - CONTEXTUAL BINDING
    

    View Slide

66. Situation 5:
    When resolving <>, do
    some setup.
    REGISTRATION - BINDING
    

    View Slide

67. Example:
    When resolving the EntityManager,
    register some ModelListeners.
    REGISTRATION - BINDING
    

    View Slide

68. Solution:
    Container events / inflection / hooks / …
    REGISTRATION - BINDING
    

    View Slide

69. // League
    $container->inflector(EntityManager, function ($em)
    $em->getConfiguration()
    ->getEntityListenerResolver()
    ->register(new ModelListener());
    });
    REGISTRATION - BINDING
    

    View Slide

70. // Laravel
    $container->resolving(function (EntityManager $em)
    …
    });
    REGISTRATION - BINDING
    

    View Slide

71. interface EnvironmentAware
    {
    public function setEnv($env);
    }
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

72. trait EnvironmentAware
    {
    public function setEnv($env)
    {
    $this->env = $env;
    }
    private function isEnv($envs): bool
    {
    return in_array($this->env, (array) $envs);
    }
    }
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

73. $container->resolving(function (EnvironmentAware $object) {
    $object->setEnv(getenv(‘APP_ENV’));
    });
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

74. Also useful for:
    - Quickly injecting stuff
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

75. interface CommandBusAware
    trait CommandBusAware
    interface EventDispatcherAware
    trait EventDispatcherAware
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

76. Also useful for:
    - Quickly injecting stuff
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

77. Also useful for:
    - Quickly injecting stuff
    - Injecting soft dependencies
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

78. $this->app->resolving(function (Mailer $mailer) {
    $mailer->setQueueResolver(function () {
    return $this->app->make(Queue::class);
    });
    );
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

79. Also useful for:
    - Quickly injecting stuff
    - Injecting soft dependencies
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

80. Also useful for:
    - Quickly injecting stuff
    - Injecting soft dependencies
    - Setting configurable values
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

81. $this->app->resolving(function (Validator) {
    $fileTypes = $app['config']->get(…)
    $validator->setAllowedFileTypes($fileTypes);
    );
    REGISTRATION - CONTAINER EVENTS
    

    View Slide

82. Where to put all this?
    REGISTRATION
    

    View Slide

83. container-interop/service-provider
    Similar to:
    - league/container
    - illuminate/container
    REGISTRATION
    

    View Slide

84. Symfony:
    - Configuration files
    - Factories
    REGISTRATION
    

    View Slide

85. Using a container
    

    View Slide

86. Preferably only in
    - Factories
    - Event Dispatchers
    - Router
    - Command Bus
    - …
    CALLING THE CONTAINER
    

    View Slide

87. Retrieving objects
    CALLING THE CONTAINER
    

    View Slide

88. // Psr\Container\ContainerInterface
    $container->has('fs');
    $container->get('fs');
    CALLING THE CONTAINER
    

    View Slide

89. Retrieving objects, with arguments
    CALLING THE CONTAINER
    

    View Slide

90. // Laravel
    $container->bind('fs', function ($args) {
    // Use $args[0] to see what folder to use.
    });
    $container->make('fs', ['images']);
    CALLING THE CONTAINER
    

    View Slide

91. // Laravel
    $container->bind('fs.images', function () {
    return $container->make('fs', ['images']);
    });
    CALLING THE CONTAINER
    

    View Slide

92. Calling functions, with resolved params
    CALLING THE CONTAINER
    

    View Slide

93. // League & Laravel
    $container->call($closure);
    $container->call(function (Mailer $mailer) {});
    $container->call([$listener, 'handle']);
    $container->call('Listener::handle');
    CALLING THE CONTAINER
    

    View Slide

94. (new ReflectionFunction($callback))
    ->getParameters();
    CALLING THE CONTAINER
    

    View Slide

95. // Laravel
    $func = $container->wrap('Listener@handle');
    $func();
    CALLING THE CONTAINER
    

    View Slide

96. public function wrap($callback) {
    return function () {
    $this->call($callback);
    };
    }
    CALLING THE CONTAINER
    

    View Slide

97. Tagging
    CALLING THE CONTAINER
    

    View Slide

98. // Laravel
    $container->tag('fs.images', 'filesystem');
    $container->tag('fs.pdfs', 'filesystem');
    $filesystems = $container->tagged('filesystem');
    foreach ($filesystems as $filesystem) {
    …
    }
    CALLING THE CONTAINER
    

    View Slide

99. Bonus
    

    View Slide

100. Solving circular
     dependencies
     BONUS - CIRCULAR DEPENDENCIES
     

     View Slide

101. $mailer = new Mailer(QueueInterface $queue);
     $queue = new Queue(MailerInterface $mailer);
     BONUS - CIRCULAR DEPENDENCIES
     

     View Slide

102. $mailer = new Mailer();
     $queue = new Queue(MailerInterface $mailer);
     $mailer->setQueueResolver($callable);
     BONUS CIRCULAR DEPENDENCIES
     

     View Slide

103. $queue = $container->get(QueueInterface);
     // League
     $container->inflector(Mailer::class, function () {
     $mailer->setQueueResolver(function () use ($container)
     return $container->get(QueueInterface::class);
     });
     });
     BONUS CIRCULAR DEPENDENCIES
     

     View Slide

104. recap:
     Reflection
     Binding
     Calling code
     Bonus
     

     View Slide

105. @hannesvdvreken
     Thank you!
     PHPCE
     

     View Slide

106. @hannesvdvreken
     Time for
     questions.
     PHPCE
     

     View Slide

107. • http://mwl.be
     REFERENCES
     

     View Slide