Build your framework like constructicons (ZendCon 2016)

Slide 1

Slide 1 text

No content

Slide 2

Slide 2 text

Build your framework like constructicons

Slide 3

Slide 3 text

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

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

No content

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

No content

Slide 9

Slide 9 text

Wait, what?

Slide 10

Slide 10 text

Who has built their own framework?

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

Who is still using a custom-built framework?

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

The case for a framework

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

Open Source

Slide 18

Slide 18 text

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

Slide 19

Slide 19 text

Surely, there are many more reasons

Slide 20

Slide 20 text

It is OK to build your own framework

Slide 21

Slide 21 text

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

Slide 22

Slide 22 text

Well, actually...

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

WRONG MOVIE

Slide 25

Slide 25 text

Composer

Slide 26

Slide 26 text

No content

Slide 27

Slide 27 text

No content

Slide 28

Slide 28 text

Request and response

Slide 29

Slide 29 text

Routing

Slide 30

Slide 30 text

Templating

Slide 31

Slide 31 text

Handling conﬁguration

Slide 32

Slide 32 text

Sending e-mail

Slide 33

Slide 33 text

Doing validation

Slide 34

Slide 34 text

The Code

Slide 35

Slide 35 text

composer init

Slide 36

Slide 36 text

composer init { "name": "stefankoopmanschap/constructicons", "authors": [ { "name": "Stefan Koopmanschap", "email": "[email protected]" } ], "require": {} }

Slide 37

Slide 37 text

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

Slide 38

Slide 38 text

Request and response composer require symfony/http-foundation

Slide 39

Slide 39 text

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

Slide 40

Slide 40 text

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

Slide 41

Slide 41 text

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();

Slide 42

Slide 42 text

/?name=Stefan results in Hello Stefan

Slide 43

Slide 43 text

No content

Slide 44

Slide 44 text

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

Slide 45

Slide 45 text

Routing composer require nikic/fast-route

Slide 46

Slide 46 text

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(); }); } );

Slide 47

Slide 47 text

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

Slide 48

Slide 48 text

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(); });

Slide 49

Slide 49 text

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

Slide 50

Slide 50 text

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(); });

Slide 51

Slide 51 text

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

Slide 52

Slide 52 text

No content

Slide 53

Slide 53 text

Templating → zetacomponents/template → eden/template → twig/twig

Slide 54

Slide 54 text

Templating composer require twig/twig

Slide 55

Slide 55 text

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

Slide 56

Slide 56 text

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

Slide 57

Slide 57 text

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(); });

Slide 58

Slide 58 text

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

Slide 59

Slide 59 text

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

Slide 60

Slide 60 text

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

Slide 61

Slide 61 text

Handling conﬁguration Your name:
Your e-mailaddress:
Your message:

Slide 62

Slide 62 text

Handling conﬁguration $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( '[email protected]', 'An e-mail from the site', $mailbody ); $response = new \Symfony\Component\HttpFoundation\RedirectResponse('/hello'); $response->send(); } );

Slide 63

Slide 63 text

Handling conﬁguration composer require werx/config

Slide 64

Slide 64 text

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

Slide 65

Slide 65 text

Handling conﬁguration $r->addRoute( 'POST', '/contact', function() use ($request, $config) {

Slide 66

Slide 66 text

Handling conﬁguration mail( $config->get('contact_email'), 'An e-mail from the site', $mailbody );

Slide 67

Slide 67 text

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

Slide 68

Slide 68 text

Sending e-mail composer require swiftmailer/swiftmailer

Slide 69

Slide 69 text

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);

Slide 70

Slide 70 text

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);

Slide 71

Slide 71 text

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

Slide 72

Slide 72 text

Doing validation composer require particle/validator

Slide 73

Slide 73 text

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

Slide 74

Slide 74 text

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(), ])); });

Slide 75

Slide 75 text

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

Slide 76

Slide 76 text

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)

Slide 77

Slide 77 text

No content

Slide 78

Slide 78 text

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

Slide 79

Slide 79 text

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