Build your framework like constructicons (ZendCon 2016)

While we have a strong offering of full-stack frameworks and microframeworks, the rise of components and libraries combined with Composer allows us to easily build our own framework without reinventing the wheel. In this talk, you'll learn how the total can be more than the sum of the parts, just like how Devastator was stronger than the individual Constructicons in Transformers.

Transcript

1. View Slide

2. Build your framework
   like constructicons
   

   View Slide

3. Hi, I'm Stefan
   → Ingewikkeld
   → former Zend Framework translator
   → former Symfony Community Manager
   

   View Slide

4. View Slide

5. View Slide

6. View Slide

7. View Slide

8. View Slide

9. Wait, what?
   

   View Slide

10. Who has built their own
    framework?
    

    View Slide

11. View Slide

12. Who is still using a
    custom-built framework?
    

    View Slide

13. View Slide

14. The case for a framework
    

    View Slide

15. View Slide

16. View Slide

17. Open Source
    

    View Slide

18. So why would we build it ourselves?
    → Custom needs
    → Because we're developers (NIH)
    → An open source framework is overkill
    → As a learning experience
    

    View Slide

19. Surely, there are many
    more reasons
    

    View Slide

20. It is OK to build your own
    framework
    

    View Slide

21. It is not OK to write all
    the code for it yourself
    

    View Slide

22. Well, actually...
    

    View Slide

23. View Slide

24. WRONG MOVIE
    

    View Slide

25. Composer
    

    View Slide

26. View Slide

27. View Slide

28. Request and response
    

    View Slide

29. Routing
    

    View Slide

30. Templating
    

    View Slide

31. Handling configuration
    

    View Slide

32. Sending e-mail
    

    View Slide

33. Doing validation
    

    View Slide

34. The Code
    

    View Slide

35. composer init
    

    View Slide

36. composer init
    {
    "name": "stefankoopmanschap/constructicons",
    "authors": [
    {
    "name": "Stefan Koopmanschap",
    "email": "stefan@ingewikkeld.net"
    }
    ],
    "require": {}
    }
    

    View Slide

37. Request and response
    → react/http
    → illuminate/http
    → symfony/http-foundation
    

    View Slide

38. Request and response
    composer require symfony/http-foundation
    

    View Slide

39. Request and response
    "require": {
    "symfony/http-foundation": "^3.1"
    }
    

    View Slide

40. index.php and composer
    require(
    __DIR__ . ' /../vendor/autoload.php'
    );
    

    View Slide

41. Request and response
    use \Symfony\Component\HttpFoundation\Request;
    use \Symfony\Component\HttpFoundation\Response;
    $request = Request::createFromGlobals();
    $response = new Response(
    'Hello ' . $request->get('name', 'world')
    );
    $response->send();
    

    View Slide

42. /?name=Stefan
    results in
    Hello Stefan
    

    View Slide

43. View Slide

44. Routing
    → symfony/routing
    → illuminate/routing
    → zendframework/zend-router
    → nikic/fast-route
    

    View Slide

45. Routing
    composer require nikic/fast-route
    

    View Slide

46. Routing
    $dispatcher = FastRoute\simpleDispatcher(
    function(FastRoute\RouteCollector $r) use ($request) {
    $r->addRoute('GET', '/hello', function() use ($request) {
    $response = new Response(
    'Hello ' . $request->get('name', 'world')
    );
    $response->send();
    });
    $r->addRoute('GET', '/goodbye', function() use ($request) {
    $response = new Response(
    'Goodbye ' . $request->get('name', 'world')
    );
    $response->send();
    });
    }
    );
    

    View Slide

47. Routing
    $dispatcher = FastRoute\simpleDispatcher(
    function(FastRoute\RouteCollector $r) use ($request) {
    // do stuff here
    }
    );
    

    View Slide

48. Routing
    $r->addRoute('GET', '/hello', function() use ($request) {
    $response = new Response(
    'Hello ' . $request->get('name', 'world')
    );
    $response->send();
    });
    $r->addRoute('GET', '/goodbye', function() use ($request) {
    $response = new Response(
    'Goodbye ' . $request->get('name', 'world')
    );
    $response->send();
    });
    

    View Slide

49. Routing
    $routeInfo = $dispatcher->dispatch(
    $request->getMethod(),
    $request->getRequestUri()
    );
    if (is_callable($routeInfo[1])) {
    $routeInfo[1]();
    }
    

    View Slide

50. Routing
    $r->addRoute('GET', '/hello[/{name}]', function($params) use ($request) {
    $name = $params['name'] ?? 'world';
    $response = new Response(
    'Hello ' . $name
    );
    $response->send();
    });
    $r->addRoute('GET', '/goodbye[/{name}]', function() use ($request) {
    $name = $params['name'] ?? 'world';
    $response = new Response(
    'Goodbye ' . $name
    );
    $response->send();
    });
    

    View Slide

51. Routing
    if (is_callable($routeInfo[1])) {
    $params = ($routeInfo[2]) ?? [];
    $routeInfo[1]($params);
    }
    

    View Slide

52. View Slide

53. Templating
    → zetacomponents/template
    → eden/template
    → twig/twig
    

    View Slide

54. Templating
    composer require twig/twig
    

    View Slide

55. Templating
    $twigLoader = new Twig_Loader_Filesystem(
    __DIR__ . '/../views/'
    );
    $twig = new Twig_Environment($twigLoader, [
    'cache' => '/tmp/twigCache',
    ]);
    

    View Slide

56. Templating
    function(FastRoute\RouteCollector $r) use (
    $request, $twig
    ) {
    

    View Slide

57. Templating
    $r->addRoute(
    'GET',
    '/hello[/{name}]',
    function($params) use ($request, $twig) {
    $name = $params['name'] ?? 'world';
    $response = new Response(
    $twig->render('hello.twig', [
    'name' => $name
    ]
    )
    );
    $response->send();
    });
    

    View Slide

58. Templating
    hello.twig
    Hello {{ name }}
    goodbye.twig
    Goodbye {{ name }}
    

    View Slide

59. Handling configuration
    → symfony/config
    → illuminate/config
    → packaged/config
    → werx/config
    

    View Slide

60. Handling configuration
    $r->addRoute(
    'GET',
    '/contact',
    function() use ($request, $twig) {
    $response = new Response(
    $twig->render('contact.twig', [])
    );
    $response->send();
    }
    );
    

    View Slide

61. Handling configuration
    
    Your name:
    
    Your e-mailaddress:
    
    Your message:
    
    
    
    
    
    

    View Slide

62. Handling configuration
    $r->addRoute(
    'POST',
    '/contact',
    function() use ($request, $twig) {
    $mailbody = 'An e-mail was sent through the site with the following message: ' .
    $request->get('message') . "\n";
    $mailbody .= 'Sent by: ' .
    $request->get('name') .
    '<' . $request->get('email') . '>';
    mail(
    'my-email@example.org',
    'An e-mail from the site',
    $mailbody
    );
    $response = new \Symfony\Component\HttpFoundation\RedirectResponse('/hello');
    $response->send();
    }
    );
    

    View Slide

63. Handling configuration
    composer require werx/config
    

    View Slide

64. Handling configuration
    $configProvider = new \werx\Config\Providers\JsonProvider(
    __DIR__ . '/../config/'
    );
    $config = new \werx\Config\Container($configProvider);
    $config->load('config');
    

    View Slide

65. Handling configuration
    $r->addRoute(
    'POST',
    '/contact',
    function() use ($request, $config)
    {
    

    View Slide

66. Handling configuration
    mail(
    $config->get('contact_email'),
    'An e-mail from the site',
    $mailbody
    );
    

    View Slide

67. Sending e-mail
    → nette/mail
    → zetacomponents/mail
    → swiftmailer/swiftmailer
    

    View Slide

68. Sending e-mail
    composer require swiftmailer/swiftmailer
    

    View Slide

69. Sending e-mail
    $mailerTransport = Swift_SmtpTransport::newInstance(
    $config->get('mailer_server'),
    $config->get('mailer_port')
    )->setUsername($config->get('mailer_username'))
    ->setPassword($config->get('mailer_password'))
    ;
    $mailer = Swift_Mailer::newInstance($mailerTransport);
    

    View Slide

70. Sending e-mail
    $message = Swift_Message::newInstance('An e-mail from the site')
    ->setFrom([
    $request->get('email'),
    $request->get('name')]
    )
    ->setTo([
    $config->get('contact_email')
    ])
    ->setBody('An e-mail was sent through the site with the following message: ' .
    $request->get('message'))
    ;
    $mailer->send($message);
    

    View Slide

71. Doing validation
    → symfony/validator
    → zendframework/zend-validator
    → particle/validator
    

    View Slide

72. Doing validation
    composer require particle/validator
    

    View Slide

73. Doing validation
    $contactMailValidator = new \Particle\Validator\Validator();
    $contactMailValidator
    ->required('name')
    ->string();
    $contactMailValidator
    ->required('email')
    ->email();
    $contactMailValidator
    ->required('message')
    ->string();
    

    View Slide

74. Doing validation
    $r->addRoute(
    'POST',
    '/contact',
    function() use ($request, $config, $mailer, $contactMailValidator, $twig) {
    $result = $contactMailValidator->validate([
    'name' => $request->get('name'),
    'email' => $request->get('email'),
    'message' => $request->get('message')
    ]);
    if ($result->isValid()) {
    // send e-mail and redirect
    }
    return new Response($twig->render('contact.twig', [
    'errors' => $result->getMessages(),
    ]));
    });
    

    View Slide

75. Summary
    → valid use cases for building your own framework
    → Leverage the power of open source components
    and composer
    → Only need a few lines of glue
    

    View Slide

76. Some other components you could think of
    → DI (bitexpert/disco, symfony/dependency-
    injection, league/container)
    → Console (symfony/console, illuminate/console,
    webmozart/console)
    → http requests (Guzzle)
    → logging (monolog/monolog)
    

    View Slide

77. View Slide

78. Photo credits
    → Foundation by Paul Sableman, cc-by 2.0
    → Constructicon icons: James Peng
    

    View Slide

79. Thank you!
    Questions?
    http://leftontheweb.com
    @skoop
    https://legacy.joind.in/19458
    

    View Slide