Inside the Symfony DIC and Config

Slides for my Symfony workshop at PHPBenelux 2013

Transcript

2. Symfony DIC and Configuration
3. Andreas Hucks @meandmymonkey Senior Developer, Trainer, Consultant SensioLabs Deutschland
4. The Project:
5. €
6. http://goo.gl/rS06X
7. Life without Dependency Injection
8. class  Logger   {    public  function  log($message,  $level  =  'INFO')    {      $formatter  =  new  XmlFormatter();        $log  =  $formatter-­‐>format(        $message,        $level      );        $this-­‐>writeLog($log);    }   }  
9. Problems?
10. class  Logger   {    function  __construct(FormatterInterface  $formatter)    {      $this-­‐>formatter  =  $formatter;    }      [...]   }  
11. class  Logger   {    [...]      public  function  log($message,  $level  =  'INFO')    {      $log  =  $this-­‐>formatter-­‐>format(        $message,        $level      );        $this-­‐>writeLog($log);    }   }  
12. Alternative: Setter Injection
13. class  Logger   {    [...]      function  setFormatter(FormatterInterface  $formatter)    {      $this-­‐>formatter  =  $formatter;    }      [...]   }  
14. “Dependency Injection is where components are given their dependencies through their constructors, methods, or directly into fields.”
15. Interfacing with the Webservice
16. interface  ExchangeRatesInterface   {          /**            *  @return  array            */          public  function  getRates();            /**            *  @param  string  $currency            *  @return  float            */          public  function  getRate($currency);   }  
17.   interface  AdapterInterface   {          /**            *  @return  string            */          public  function  getRawData();   }  
18.   interface  ParserInterface   {          /**            *  @param  string  $rawData            *  @return  array            */          public  function  parse($rawData);   }  
19. Task Implement class ExchangeRates using MockAdapter and XmlParser. Generate output using ExchangeRatesCommand .
20. The Service Container
21. The Service Container is simply a PHP object that manages the instantiation of services.
22. $container-­‐>get('logger');       $container-­‐>getParameter('logger.class');    
23. Vocabulary Elements
24. service An object managed by the Dependency Injection Container.
25. argument A parameter given by the DIC to a service, via the constructor or a mutator method (setter).
26. parameter A configuration value.
27. <service  id="sensio.logger"  class="Sensio\Logger"  >            <!-­‐-­‐  Constructor  arguments  -­‐-­‐>          <argument>/path/to/app/logs/app.log</argument>          <argument  type="service"                                               id="sensio.logger.xml_formatter"  />              <!-­‐-­‐  Methods  to  call  -­‐-­‐>          <call  method="setDefaultSeverity">                  <argument>DEBUG</argument>          </call>      <!-­‐-­‐  Tags  -­‐-­‐>            <tag  name="tools.logger"  />         </service>  
28. Vocabulary Attributes
29. id The service identifier or name
30. class The service class to instantiate
31. alias An alias name for this service
32. public Set to false to make the service private and used internally
33. <service  id="sensio.logger"  class="Sensio\Logger"  >            <!-­‐-­‐  Constructor  arguments  -­‐-­‐>          <argument>/path/to/app/logs/app.log</argument>          <argument  type="service"                                               id="sensio.logger.xml_formatter"  />              <!-­‐-­‐  Methods  to  call  -­‐-­‐>          <call  method="setDefaultSeverity">                  <argument>DEBUG</argument>          </call>      <!-­‐-­‐  Tags  -­‐-­‐>            <tag  name="tools.logger"  />         </service>  
34. Vocabulary Service Elements
35. argument An argument to pass to a method (constructor or setter)
36. call A method to call on the newly created object
37. tag A tag to attach to the service definition
38. <service  id="sensio.logger"  class="Sensio\Logger"  >            <!-­‐-­‐  Constructor  arguments  -­‐-­‐>          <argument>/path/to/app/logs/app.log</argument>          <argument  type="service"                                               id="sensio.logger.xml_formatter"  />              <!-­‐-­‐  Methods  to  call  -­‐-­‐>          <call  method="setDefaultSeverity">                  <argument>DEBUG</argument>          </call>      <!-­‐-­‐  Tags  -­‐-­‐>            <tag  name="tools.logger"  />         </service>  
39. Vocabulary Argument Attributes
40. type Define the nature of the argument. Allowed values: string, constant, collection or service
41. id The service name, if the argument is a service
42. key The argument key when dealing with the collection type
43. <service  id="sensio.logger"  class="Sensio\Logger"  >            <!-­‐-­‐  Constructor  arguments  -­‐-­‐>          <argument>/path/to/app/logs/app.log</argument>          <argument  type="service"                                               id="sensio.logger.xml_formatter"  />              <!-­‐-­‐  Methods  to  call  -­‐-­‐>          <call  method="setDefaultSeverity">                  <argument>DEBUG</argument>          </call>      <!-­‐-­‐  Tags  -­‐-­‐>            <tag  name="tools.logger"  />         </service>  
44. http://goo.gl/FNJ9H
45. Task Write a container configuration!
46. Configuration
47. public  function  load(      array  $configs,      ContainerBuilder  $container   )   {    $configuration  =  new  Configuration();    $config  =  $this      -­‐>processConfiguration($configuration,  $configs);      $loader  =  new  Loader\XmlFileLoader(      $container,      new  FileLocator(__DIR__.'/../Resources/config')    );      $loader-­‐>load('exchangerates.xml');   }  
48. Array  (          [0]  =>  Array  (                  [exchange_rates]  =>  Array  (                          [curl]  =>  Array  (                                  [CURLOPT_TIMEOUT]  =>  5                          )                  )          )          [1]  =>  Array  (                  [exchange_rates]  =>  Array  (                          [curl]  =>  Array  (                                  [CURLOPT_TIMEOUT]  =>  10,                                  [CURLOPT_PROXY]  =>  http:// localhost:8888                          )                  )          )   )  
49. Array  (          [exchange_rates]  =>  Array  (                  [curl]  =>  Array  (                          [CURLOPT_TIMEOUT]  =>  10                          [CURLOPT_PROXY]  =>  http://localhost:8888                  )                  [endpoint]  =>  http://www.ecb.europa.eu/stats...          )   )  
50. class  Configuration  implements  ConfigurationInterface   {    public  function  getConfigTreeBuilder()    {      $treeBuilder  =  new  TreeBuilder();      $rootNode  =  $treeBuilder>root('acme_dic_workshop');        $rootNode        -­‐>children()          -­‐>scalarNode('some_config_var')            -­‐>isRequired()            -­‐>defaultValue('foo')            -­‐>end()          -­‐>end();        return  $treeBuilder;    }   }  
51. -­‐>scalarNode(‘some_url')    -­‐>isRequired()    -­‐>cannotBeEmpty()    -­‐>validate()      -­‐>ifTrue(function($value)  {        return  !filter_var($value,  \FILTER_VALIDATE_URL);    })      -­‐>thenInvalid('Not  a  valid  url.')    -­‐>end()   -­‐>end()  
52. http://goo.gl/8sa6Q
53. Thanks! https://joind.in/7778