[DependencyInjection] Fluent PHP DI Documentation

ragboyjr · ragboyjr · commit 72643e5b84cf · 2019-01-01T00:44:42.000-08:00
- Updated service_container.rst to include php-fluent-di
- Updated _build/conf.py to include codeblock for php-fluent-di
- Updated existing di resource loading to refer to latest sf 4.2
  excludes

Signed-off-by: RJ Garcia &lt;rj@bighead.net&gt;
diff --git a/_build/conf.py b/_build/conf.py
@@ -118,7 +118,8 @@
     'rst': 'reStructuredText',
     'terminal': 'Terminal',
     'varnish3': 'Varnish 3',
-    'varnish4': 'Varnish 4'
+    'varnish4': 'Varnish 4',
+    'php-fluent-di': 'PHP (Fluent)'
 }
 
 # use PHP as the primary domain
diff --git a/components/dependency_injection.rst b/components/dependency_injection.rst
@@ -302,6 +302,25 @@ config files:
             ->register('newsletter_manager', 'NewsletterManager')
             ->addMethodCall('setMailer', array(new Reference('mailer')));
 
+    .. code-block:: php-fluent-di
+
+        use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+        use function Symfony\Component\DependencyInjection\Loader\Configurator\ref;
+
+        return function(ContainerConfigurator $configurator) {
+            $configurator->parameters()
+                ->set('mailer.transport', 'sendmail');
+
+            $container = $configurator->services();
+
+            $container->set('mailer', 'Mailer')
+                ->args(['%mailer.transport%']);
+
+            $container->set('newsletter_manager', 'NewsletterManager')
+                ->call('setMailer', ref('mailer'));
+        };
+
+
 Learn More
 ----------
 
diff --git a/service_container.rst b/service_container.rst
@@ -154,7 +154,7 @@ each time you ask for it.
                 # this creates a service per class whose id is the fully-qualified class name
                 App\:
                     resource: '../src/*'
-                    exclude: '../src/{Entity,Migrations,Tests,Kernel.php}'
+                    exclude: '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}'
 
                 # ...
 
@@ -171,7 +171,7 @@ each time you ask for it.
                     <!-- Default configuration for services in *this* file -->
                     <defaults autowire="true" autoconfigure="true" public="false" />
 
-                    <prototype namespace="App\" resource="../src/*" exclude="../src/{Entity,Migrations,Tests}" />
+                    <prototype namespace="App\" resource="../src/*" exclude="../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}" />
                 </services>
             </container>
 
@@ -190,7 +190,23 @@ each time you ask for it.
             ;
 
             // $this is a reference to the current loader
-            $this->registerClasses($definition, 'App\\', '../src/*', '../src/{Entity,Migrations,Tests}');
+            $this->registerClasses($definition, 'App\\', '../src/*', '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}');
+
+        .. code-block:: php-fluent-di
+
+            // config/services.php
+            use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+            return function(ContainerConfigurator $configurator) {
+                $container = $configurator->services()
+                    ->defaults()
+                    ->autowire()
+                    ->autoconfigure()
+                    ->private();
+
+                $container->load('App\\', '../src/*')
+                    ->exclude('../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}');
+            };
 
     .. tip::
 
@@ -393,7 +409,7 @@ pass here. No problem! In your configuration, you can explicitly set this argume
             # same as before
             App\:
                 resource: '../src/*'
-                exclude: '../src/{Entity,Migrations,Tests}'
+                exclude: '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}'
 
             # explicitly configure the service
             App\Updates\SiteUpdateManager:
@@ -413,7 +429,7 @@ pass here. No problem! In your configuration, you can explicitly set this argume
                 <!-- ... -->
 
                 <!-- Same as before -->
-                <prototype namespace="App\" resource="../src/*" exclude="../src/{Entity,Migrations,Tests}" />
+                <prototype namespace="App\" resource="../src/*" exclude="../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}" />
 
                 <!-- Explicitly configure the service -->
                 <service id="App\Updates\SiteUpdateManager">
@@ -437,12 +453,32 @@ pass here. No problem! In your configuration, you can explicitly set this argume
             ->setPublic(false)
         ;
 
-        $this->registerClasses($definition, 'App\\', '../src/*', '../src/{Entity,Migrations,Tests}');
+        $this->registerClasses($definition, 'App\\', '../src/*', '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}');
 
         // Explicitly configure the service
         $container->getDefinition(SiteUpdateManager::class)
             ->setArgument('$adminEmail', 'manager@example.com');
 
+    .. code-block:: php-fluent-di
+
+        // config/services.php
+        use App\Updates\SiteUpdateManager;
+        use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+        return function(ContainerConfigurator $configurator) {
+            $container = $configurator->services()
+                ->defaults()
+                ->autowire()
+                ->autoconfigure()
+                ->private();
+
+            $container->load('App\\', '../src/*')
+                ->exclude('../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}');
+
+            $container->set(SiteUpdateManager::class)->arg('$adminEmail', 'manager@example.com');
+        };
+
+
 Thanks to this, the container will pass ``manager@example.com`` to the ``$adminEmail``
 argument of ``__construct`` when creating the ``SiteUpdateManager`` service. The
 other arguments will still be autowired.
@@ -507,6 +543,22 @@ and reference it with the ``%parameter_name%`` syntax:
             // ...
             ->setArgument('$adminEmail', '%admin_email%');
 
+    .. code-block:: php-fluent-di
+
+        // config/services.php
+        use App\Updates\SiteUpdateManager;
+        use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+        return function(ContainerConfigurator $configurator) {
+            $configurator->parameters()->set('admin_email', 'manager@example.com');
+
+            $container = $configurator->services();
+            $container->set(SiteUpdateManager::class)
+                ->autowire()
+                ->arg('$adminEmail', '%admin_email%');
+        };
+
+
 Actually, once you define a parameter, it can be referenced via the
 ``%parameter_name%`` syntax in *any* other configuration file. Many parameters
 are defined in the ``config/services.yaml`` file.
@@ -617,6 +669,22 @@ But, you can control this and pass in a different logger:
             ->setPublic(false)
             ->setArgument('$logger', new Reference('monolog.logger.request'));
 
+    .. code-block:: php-fluent-di
+
+        // config/services.php
+        use App\Service\MessageGenerator;
+        use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+        use function Symfony\Component\DependencyInjection\Loader\Configurator\ref;
+
+        return function(ContainerConfigurator $configurator) {
+            $container = $configurator->services();
+            $container->set(SiteUpdateManager::class)
+                ->autowire()
+                ->autoconfigure()
+                ->private();
+                ->arg('$logger', ref('monolog.logger.request'));
+        };
+
 This tells the container that the ``$logger`` argument to ``__construct`` should use
 service whose id is ``monolog.logger.request``.
 
@@ -713,6 +781,25 @@ You can also use the ``bind`` keyword to bind specific arguments by name or type
             ))
         ;
 
+    .. code-block:: php-fluent-di
+
+        // config/services.php
+        use App\Controller\LuckyController;
+        use Psr\Log\LoggerInterface;
+        use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+        use function Symfony\Component\DependencyInjection\Loader\Configurator\ref;
+
+        return function(ContainerConfigurator $configurator) {
+            $container = $configurator->services()->defaults()
+                ->bind('$adminEmail', 'manager@example.com')
+                ->bind('$requestLogger', ref('monolog.logger.request'))
+                ->bind(LoggerInterface::class, ref('monolog.logger.request'))
+                ->bind('string $adminEmail', 'manager@example.com')
+                ->bind(LoggerInterface::class.' $requestLogger', ref('monolog.logger.request'));
+
+            // ...
+        };
+
 By putting the ``bind`` key under ``_defaults``, you can specify the value of *any*
 argument for *any* service defined in this file! You can bind arguments by name
 (e.g. ``$adminEmail``), by type (e.g. ``Psr\Log\LoggerInterface``) or both
@@ -852,6 +939,20 @@ But, if you *do* need to make a service public, override the ``public`` setting:
             </services>
         </container>
 
+    .. code-block:: php-fuent-di
+
+        // config/services.php
+
+        use App\Service\MessageGenerator;
+        use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+        return function(ContainerConfigurator $configurator) {
+            // ... same as code before
+
+            $container->set(MessageGenerator::class)
+                ->public();
+        };
+
 .. _service-psr4-loader:
 
 Importing Many Services at once with resource
@@ -872,7 +973,7 @@ key. For example, the default Symfony configuration contains this:
             # this creates a service per class whose id is the fully-qualified class name
             App\:
                 resource: '../src/*'
-                exclude: '../src/{Entity,Migrations,Tests}'
+                exclude: '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}'
 
     .. code-block:: xml
 
@@ -886,7 +987,7 @@ key. For example, the default Symfony configuration contains this:
             <services>
                 <!-- ... -->
 
-                <prototype namespace="App\" resource="../src/*" exclude="../src/{Entity,Migrations,Tests}" />
+                <prototype namespace="App\" resource="../src/*" exclude="../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}" />
             </services>
         </container>
 
@@ -904,7 +1005,19 @@ key. For example, the default Symfony configuration contains this:
             ->setPublic(false)
         ;
 
-        $this->registerClasses($definition, 'App\\', '../src/*', '../src/{Entity,Migrations,Tests}');
+        $this->registerClasses($definition, 'App\\', '../src/*', '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}');
+
+    .. code-block:: php-fluent-di
+
+        // config/services.php
+        use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+        return function(ContainerConfigurator $configurator) {
+            // ...
+
+            $container->load('App\\', '../src/*')
+                ->exclude('../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}');
+        };
 
 .. tip::
 
@@ -1063,6 +1176,35 @@ admin email. In this case, each needs to have a unique service id:
 
         $container->setAlias(SiteUpdateManager::class, 'site_update_manager.superadmin')
 
+    .. code-block:: php-fluent-di
+
+        // config/services.php
+        use App\Updates\SiteUpdateManager;
+        use App\Service\MessageGenerator;
+        use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+        use function Symfony\Component\DependencyInjection\Loader\Configurator\ref;
+
+        return function(ContainerConfigurator $configurator) {
+            // ...
+
+            $container->set('site_update_manager.superadmin', SiteUpdateManager::class)
+                ->autowire(false)
+                ->args([
+                    ref(MessageGenerator::class),
+                    ref('mailer'),
+                    'superadmin@example.com'
+                ]);
+            $container->set('site_update_manager.normal_users', SiteUpdateManager::class)
+                ->autowire(false)
+                ->args([
+                    ref(MessageGenerator::class),
+                    ref('mailer'),
+                    'contact@example.com'
+                ]);
+            $container->alias(SiteUpdateManager::class, 'site_update_manager.superadmin');
+        };
+
+
 In this case, *two* services are registered: ``site_update_manager.superadmin``
 and ``site_update_manager.normal_users``. Thanks to the alias, if you type-hint
 ``SiteUpdateManager`` the first (``site_update_manager.superadmin``) will be passed.

Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,8 @@`
`118`	`118`	`'rst': 'reStructuredText',`
`119`	`119`	`'terminal': 'Terminal',`
`120`	`120`	`'varnish3': 'Varnish 3',`
`121`		`- 'varnish4': 'Varnish 4'`
	`121`	`+ 'varnish4': 'Varnish 4',`
	`122`	`+ 'php-fluent-di': 'PHP (Fluent)'`
`122`	`123`	`}`
`123`	`124`
`124`	`125`	`# use PHP as the primary domain`