How to write better Symfony Bundles

How to split bundles into smallers ones and let them depend. Also many smaller tipps and tricks you may not have seen yet.

Transcript

1. Julius Beckmann (twitter|github).com/h4cc How to write better Bundles
2. Julius Beckmann (twitter|github).com/h4cc About me ...
3. Julius Beckmann (twitter|github).com/h4cc Where is this heading ...
4. Julius Beckmann (twitter|github).com/h4cc What's a Bundle?
5. Julius Beckmann (twitter|github).com/h4cc Plugin < Modul < Bundle
6. Julius Beckmann (twitter|github).com/h4cc "A bundle is a directory that has a well-defined structure and can host anything from classes to controllers and web resources." http://symfony.com/doc/current/cookbook/bundles/best_practices.html
7. Julius Beckmann (twitter|github).com/h4cc Bundle Structure
8. Julius Beckmann (twitter|github).com/h4cc Read Docs/Cookbooks & Follow Conventions
9. Julius Beckmann (twitter|github).com/h4cc Write your App
10. Julius Beckmann (twitter|github).com/h4cc Stop! Not everything needs to be in a Bundle
11. Julius Beckmann (twitter|github).com/h4cc Split your Code in 3 Layers!
12. Julius Beckmann (twitter|github).com/h4cc •Models •Logic using Models •Bundles integrating Logic
13. Julius Beckmann (twitter|github).com/h4cc Bundles are just glue!
14. Julius Beckmann (twitter|github).com/h4cc Example
15. Julius Beckmann (twitter|github).com/h4cc mathiasverraes/money
16. Julius Beckmann (twitter|github).com/h4cc tbbc/money-bundle + Doctrine
17. Julius Beckmann (twitter|github).com/h4cc App with just one Bundle?
18. Julius Beckmann (twitter|github).com/h4cc Decouple Bundles by Domain
19. Julius Beckmann (twitter|github).com/h4cc YourApp\Core • Models • Logic YourApp\CoreBundle • Services (Dependency Injection of Logic) • Configuration
20. Julius Beckmann (twitter|github).com/h4cc YourApp\WebBundle • For Browsers • Controller • Forms • Validations • Templates • Translations YourApp\ApiBundle • For API users like Mobile Apps • REST Controller • Serialization • Soap
21. Julius Beckmann (twitter|github).com/h4cc • YourCompany\ReuseableBundle • YourCompany\ReuseableLib
22. Julius Beckmann (twitter|github).com/h4cc Core Web Api Reuse1 Reuse2 Lib1 Lib2 Feature
23. Julius Beckmann (twitter|github).com/h4cc Summary ~ Recap
24. Julius Beckmann (twitter|github).com/h4cc Let me show you some practical Stuff
25. Julius Beckmann (twitter|github).com/h4cc Controller
26. Julius Beckmann (twitter|github).com/h4cc Slim Controller • No Logic in Controller • Keep Logic in Services • Just Request/Response wrapper
27. Julius Beckmann (twitter|github).com/h4cc Controller Annotations Avoid in ReuseableBundles!
28. Julius Beckmann (twitter|github).com/h4cc Use Route Parameters • Symfony can inject route params • Less code & very clean
29. Julius Beckmann (twitter|github).com/h4cc • Own Converter easy to integrate • Can be reused! Use ParamConverter
30. Julius Beckmann (twitter|github).com/h4cc Events in Controllers
31. Julius Beckmann (twitter|github).com/h4cc Events in Controllers • Decoupling via Events • Decoupling between bundles • Intercept/Manipulate actions • Less Controller dependencies
32. Julius Beckmann (twitter|github).com/h4cc Controller as Services • Instanciation by DI, not Symfony • Clear dependencies • Can be tested easily • Can be manipulated via DI • Need little more effort • "Controller" contains just shortcuts
33. Julius Beckmann (twitter|github).com/h4cc Commands
34. Julius Beckmann (twitter|github).com/h4cc • Very easy to use, great for Cronjobs • Reuse logic from services Write Commands
35. Julius Beckmann (twitter|github).com/h4cc Dependency Injection
36. Julius Beckmann (twitter|github).com/h4cc • Differ required and optional deps ➔ __construct($required) ➔setOptional($optional) • Use private/public • Use parameters for classes parameters: my_mailer.class: Acme\HelloBundle\Mailer services: my_mailer: class: "%my_mailer.class%" DI Tipps
37. Julius Beckmann (twitter|github).com/h4cc Alias global Services • "my_app.doctrine" alias for "doctrine" • "my_app.logger" alias for "logger" • Can be changed externally
38. Julius Beckmann (twitter|github).com/h4cc JMS/DiExtraBundle
39. Julius Beckmann (twitter|github).com/h4cc JMS/DiExtraBundle
40. Julius Beckmann (twitter|github).com/h4cc JMS/DiExtraBundle
41. Julius Beckmann (twitter|github).com/h4cc • Dependency Injection via Annotations ✔ Faster development possible ✔ DI config "where it's used" ➔ Cluttering DI over code ➔ Testing DI is harder ➔ Magic hard to test ➔ Transparent code generation (!) JMS/DiExtraBundle
42. Julius Beckmann (twitter|github).com/h4cc Good to know
43. Julius Beckmann (twitter|github).com/h4cc Use predefined Responses • Response • JsonResponse • BinaryFileResponse • RedirectResponse • StreamedResponse
44. Julius Beckmann (twitter|github).com/h4cc Logger everywhere!
45. Julius Beckmann (twitter|github).com/h4cc Use Parent Bundles • Great for "Whitelable" Apps • Overwrite Resources/*
46. Julius Beckmann (twitter|github).com/h4cc • Definition of possible parameters • Using default values • Validation integrated • Changeable in dev/prod/test • "php app/console config:dump-reference MyApp " • Extension moves values to DI Write a Configuration
47. Julius Beckmann (twitter|github).com/h4cc • Consider XML for services.xml • Support in IDE • Highlighting & Validation Prefer XML over YML
48. Julius Beckmann (twitter|github).com/h4cc • Skip large SQL files • Directly define entites • Integrate in CI/CD Use DataFixtures
49. Julius Beckmann (twitter|github).com/h4cc Filesystem: •Gaufrette •Flysystem Doctrine/Cache HTTP / APIs: •Guzzle •Buzz Use Abstractions
50. Julius Beckmann (twitter|github).com/h4cc Testing
51. Julius Beckmann (twitter|github).com/h4cc Unit Tests • Fast; No context; Idempotent • Generate coverage as a tool • Testing only units Functional Tests • Using context (Db, Caches, ...) • Can be slower • Testing functionality Separate Testing
52. Julius Beckmann (twitter|github).com/h4cc SQLite can be faster • Create SQLite DB from Fixtures • Copy SQLite DB • Run Test • Revert DB to copy Mock external behaviour • Create Mock Service Class • Overwrite Services in config_test.yml Functional Testing
53. Julius Beckmann (twitter|github).com/h4cc Install via composer Use Annotations: @covers My\Service::calculateBar @expectedException \RuntimeException @expectedExceptionMessage "FooBar" @dataProvider getTestInputs PHPUnit Hints
54. Julius Beckmann (twitter|github).com/h4cc matthiasnoback /symfony-config-test /symfony-dependency-injection-test Twig syntax check: php app/console twig:lint src/ Testing Bundles
55. Julius Beckmann (twitter|github).com/h4cc Documentation
56. Julius Beckmann (twitter|github).com/h4cc "Living" Documentation for free Nelmio/ApiDocBundle
57. Julius Beckmann (twitter|github).com/h4cc Composer
58. Julius Beckmann (twitter|github).com/h4cc require Only what you use directly Not what others may need require-dev Librarys you use Tools you use (h4cc/phpqatools) Composer config
59. Julius Beckmann (twitter|github).com/h4cc K, Thx, bye!