IceHawk Intro @ PHP Usergroup Berlin

A brief introduction to the PHP micro-framework IceHawk.

Transcript

1. APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF
2. HOLGER WOLTERSDORF CIO • FATHER • HUSBAND • PHP DEV WITH ♥ github.com/hollodotme github.com/icehawk @hollodotme @F9T3ch
4. HISTORY
5. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 5 ๏ THE MVC PATTERN VIEW 1 VIEW 2 CONTROLLER MODEL USER INPUT MODIFIES UPDATES
6. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 6 ๏ THE MVC PATTERN …THE PROBLEM! VIEW 1 VIEW 2 CONTROLLER MODEL USER INPUT MODIFIES UPDATES !
7. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 7 ๏ THE MVC PATTERN …THE PROBLEM! VIEW 1 VIEW 2 CONTROLLER MODEL USER INPUT MODIFIES HTTP
8. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 8 ๏ THE MVC PATTERN …THE SOLUTION? VIEW 1 VIEW 2 CONTROLLER MODEL USER INPUT MODIFIES HTTP RESPONDS
9. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 9 "THE MVC PATTERN SOLVES A PROBLEM THAT DOESN’T EXIST IN THE WEB."
10. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 10 "THE MVC PATTERN SOLVES A PROBLEM THAT DOESN’T EXIST IN THE WEB."
11. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 11 CONTROLLER ๏ THE MVC PATTERN …CONTROLLER RESPONSIBILITIES ๏ VALIDATE USER INPUT ๏ FIND MODEL(S), REPO(S) 
 HELPER(S) OR SERVICE(S) ๏ ISSUE CHANGES ๏ EVALUATE CHANGE RESULT ๏ FIND MODEL(S), REPO(S)
 HELPER(S) OR SERVICE(S) ๏ QUERY AND FETCH DATA ๏ RENDER VIEW (2) ๏ RESPOND TO CLIENT
12. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 12 CONTROLLER ๏ THE MVC PATTERN …CONTROLLER RESPONSIBILITIES ๏ VALIDATE USER INPUT ๏ FIND MODEL(S), REPO(S) 
 HELPER(S) OR SERVICE(S) ๏ ISSUE CHANGES ๏ EVALUATE CHANGE RESULT ๏ FIND MODEL(S), REPO(S)
 HELPER(S) OR SERVICE(S) ๏ QUERY AND FETCH DATA ๏ RENDER VIEW (2) ๏ RESPOND TO CLIENT WRITE READ
13. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 13 WRITE CONTROLLER ๏ SEGREGATED RESPONSIBILITIES ๏ VALIDATE USER INPUT ๏ FIND MODEL(S), REPO(S) 
 HELPER(S) OR SERVICE(S) ๏ ISSUE CHANGES ๏ EVALUATE CHANGE RESULT ๏ FIND MODEL(S), REPO(S)
 HELPER(S) OR SERVICE(S) ๏ QUERY AND FETCH DATA ๏ RENDER VIEW (2) ๏ RESPOND TO CLIENT WRITE READ READ CONTROLLER
14. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 14 WRITE CONTROLLER ๏ RESPONSIBILITY SEGREGATION ๏ VALIDATE USER INPUT ๏ FIND MODEL(S), REPO(S) 
 HELPER(S) OR SERVICE(S) ๏ ISSUE CHANGES ๏ EVALUATE CHANGE RESULT ๏ FIND MODEL(S), REPO(S)
 HELPER(S) OR SERVICE(S) ๏ QUERY AND FETCH DATA ๏ RENDER VIEW (2) ๏ RESPOND TO CLIENT COMMAND QUERY READ CONTROLLER
15. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 15 WRITE CONTROLLER ๏ RESPONSIBILITY SEGREGATION ๏ VALIDATE USER INPUT ๏ FIND MODEL(S), REPO(S) 
 HELPER(S) OR SERVICE(S) ๏ ISSUE CHANGES ๏ EVALUATE CHANGE RESULT ๏ FIND MODEL(S), REPO(S)
 HELPER(S) OR SERVICE(S) ๏ QUERY AND FETCH DATA ๏ RENDER VIEW (2) ๏ RESPOND TO CLIENT COMMAND QUERY READ CONTROLLER RESPONSIBILITY SEGREGATION (CQRS) TA-DA!
16. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 16 ๏ THE CQRS PATTERN (respecting HTTP) WRITE REQUESTHANDLER APP STATE USER INPUT MODIFIES QUERIES POST CLIENT / BROWSER REDIRECT TO PAGE 2 GET READ REQUESTHANDLER PAGE 1 PAGE 2 RESPONDS
17. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF PROJECTOR CHANGE PAGE 2 HISTORY 17 ๏ OPTIMISATION FOR READ INTENSIVE APPLICATIONS WRITE REQUESTHANDLER APP STATE USER INPUT MODIFIES POST CLIENT / BROWSER REDIRECT TO PAGE 2 GET PAGE 1 PAGE 2 CHANGE MESSAGE (ASYNC) PROJECTOR PREPARES PUB SUB QUERIES
18. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 18 […] the convention has been established that the GET and HEAD methods SHOULD NOT have the significance of taking an action other than retrieval. These methods ought to be considered "safe". https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
19. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF HISTORY 19 ๏ RULES SUMMARISED (FOR WEBSITES) ๏ A POST request MUST NOT not respond with UI content ๏ A POST request SHOULD change the application state ๏ A POST request SHOULD respond with a redirect ๏ A GET request SHOULD respond with UI content 
 representing the current application state ๏ A GET request MUST NOT change the application state (read-only)
20. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF 20 «We need a name!» «Yeah, something cool and fast!» HISTORY
21. ICEHAWK
22. FACTS
23. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FACTS 23 ๏ COMPONENTS STABLE v2.1.1 STABLE v1.1.1 STABLE v1.0.0 STABLE v1.0.1 ICEHAWK SESSION FORMS PUBSUB COVERAGE 100% COVERAGE 100% COVERAGE 100% COVERAGE 100%
24. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FACTS 24 ๏ MAIN COMPONENT: icehawk/icehawk 1.533 Logical lines of code (LLOC) 0 composer dependencies 0 third-party php extension dependencies v2.1.1 current stable v7.x.x php compatibility (only) STRICT typed MIT license FULLY documented at icehawk.github.io LOC Lines of code 1965 Logical lines of code 1533 Comment lines of code 433 Average volume 71.86 Average comment weight 21.28 Average intelligent content 21.28 Logical lines of code by class 29 Logical lines of code by method 5 Object oriented programming Classes 52 Interface 33 Methods 279 Methods by class 5.37 Lack of cohesion of methods 0.62 Average afferent coupling 0.66 Average efferent coupling 1.15 Average instability 0.61 Complexity Average Cyclomatic complexity by class 1.65 Average Relative system complexity 17.92 Average Difficulty 2.6
25. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FACTS 25 ๏ OBJECTIVES ๏ Producing comprehensible and readable code ๏ Avoiding inline comments where possible (includes PHPDoc) ๏ Applying the SOLID and CLEAN CODE principles ๏ Covering all code with tests ๏ Refactoring continuously ๏ Targeting the latest PHP version ๏ Doing open source ๏ APPLICABLE FOR ๏ WEBSITES ๏ (RESTful) APIs ๏ MICRO SERVICES ๏ EVENT SOURCING
26. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FACTS 26 NAMING CONVENTION interface BypassesRequest {} class RequestBypass {} trait DefaultRequestBypassing {}
27. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FACTS 27 POST PUT PATCH DELETE GET HEAD OPTIONS WRITE REQUEST HANDLER READ REQUEST HANDLER AUTO-RESPONSE BASIC ROUTING BEHAVIOUR
28. FEATURES & CODE (SELECTION)
29. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 29 INSTALLATION
30. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 30
31. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 31 class IceHawk { public function __construct( $config, $delegate ) public function init() {} public function handleRequest() {} }
32. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 32 <?php declare(strict_types = 1); namespace MyVendor\MyProject; use IceHawk\IceHawk\IceHawk; require(__DIR__ . '/../vendor/autoload.php'); $config = new IceHawkConfig(); $delegate = new IceHawkDelegate(); $application = new IceHawk( $config, $delegate ); $application->init(); $application->handleRequest();
33. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 33 DELEGATION
34. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - DELEGATION 34 final class IceHawkDelegate implements SetsUpEnvironment { public function setUpGlobalVars() { # Change your global vars $_SERVER, $_GET, $_POST, etc. # here, before IceHawk will use them. } public function setUpErrorHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default error handling is used unless you set up # something else here. } public function setUpSessionHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default session handling is used unless you set up # something else here. } }
35. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - DELEGATION 35 final class IceHawkDelegate implements SetsUpEnvironment { public function setUpGlobalVars() { # Change your global vars $_SERVER, $_GET, $_POST, etc. # here, before IceHawk will use them. } public function setUpErrorHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default error handling is used unless you set up # something else here. } public function setUpSessionHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default session handling is used unless you set up # something else here. } }
36. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - DELEGATION 36 final class IceHawkDelegate implements SetsUpEnvironment { public function setUpGlobalVars() { # Change your global vars $_SERVER, $_GET, $_POST, etc. # here, before IceHawk will use them. } public function setUpErrorHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default error handling is used unless you set up # something else here. } public function setUpSessionHandling( ProvidesRequestInfo $requestInfo ) { # PHP's default session handling is used unless you set up # something else here. } }
37. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 37 CONFIGURATION
38. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 38 final class IceHawkConfig implements ConfiguresIceHawk { use Defaults\Traits\DefaultRequestInfoProviding; use Defaults\Traits\DefaultReadRouting; use Defaults\Traits\DefaultWriteRouting; use Defaults\Traits\DefaultRequestBypassing; use Defaults\Traits\DefaultEventSubscribing; use Defaults\Traits\DefaultCookieProviding; use Defaults\Traits\DefaultFinalReadResponding; use Defaults\Traits\DefaultFinalWriteResponding; }
39. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 39 final class IceHawkConfig implements ConfiguresIceHawk { use Defaults\Traits\DefaultRequestInfoProviding; use Defaults\Traits\DefaultReadRouting; use Defaults\Traits\DefaultWriteRouting; use Defaults\Traits\DefaultRequestBypassing; use Defaults\Traits\DefaultEventSubscribing; use Defaults\Traits\DefaultCookieProviding; use Defaults\Traits\DefaultFinalReadResponding; use Defaults\Traits\DefaultFinalWriteResponding; }
40. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 40 final class MyHawkConfig extends IceHawkConfig { public function getReadRoutes() { return [ new ReadRoute( new Literal( '/' ), new SayHelloRequestHandler() ), ]; } public function getWriteRoutes() { return [ new WriteRoute( new Literal( '/do-something' ), new DoSomethingRequestHandler() ), ]; } }
41. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 41 # Literal route new ReadRoute( new Literal( '/' ), new SayHelloRequestHandler() ); # RegExp route with parameters from matches new ReadRoute( new RegExp("#^/post/([0-9]+)/?$#i", ['postId'] ), new ShowBlogPostRequestHandler() ); # NamedRegExp route with named matches new ReadRoute( new NamedRegExp("^/post/(?<postId>[0-9]+)/?$", 'i'), new ShowBlogPostRequestHandler() );
42. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 42 # Literal route new ReadRoute( new Literal( '/' ), new SayHelloRequestHandler() ); # RegExp route with parameters from matches new ReadRoute( new RegExp("#^/post/([0-9]+)/?$#i", ['postId'] ), new ShowBlogPostRequestHandler() ); # NamedRegExp route with named matches new ReadRoute( new NamedRegExp("^/post/(?<postId>[0-9]+)/?$", 'i'), new ShowBlogPostRequestHandler() );
43. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 43 # Literal route new ReadRoute( new Literal( '/' ), new SayHelloRequestHandler() ); # RegExp route with parameters from matches new ReadRoute( new RegExp("#^/post/([0-9]+)/?$#i", ['postId'] ), new ShowBlogPostRequestHandler() ); # NamedRegExp route with named matches new ReadRoute( new NamedRegExp("^/post/(?<postId>[0-9]+)/?$", 'i'), new ShowBlogPostRequestHandler() );
44. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - CONFIGURATION 44 final class MyHawkConfig extends IceHawkConfig { public function getReadRoutes() { $routes = require(__DIR__ . '../config/ReadRoutes.php'); # $routes = [ # "^/post/(?<postId>[0-9]+)/?" # => MyVendor\...\ShowPostRequestHandler::class, # ]; foreach ($routes as $pattern => $handlerClass) { yield new ReadRoute( new NamedRegExp($pattern), new $handlerClass() ), } } }
45. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 45 REQUEST HANDLERS
46. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - REQUEST HANDLERS 46 final class SayHelloRequestHandler implements HandlesGetRequest { public function handle(ProvidesReadRequestData $request) { $info = $request->getInfo(); $input = $request->getInput(); $cookies = $request->getCookies(); (new Page())->respond('Hello!', HttpCode::OK); } }
47. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - REQUEST HANDLERS 47 final class DoSomethingRequestHandler implements HandlesPostRequest { public function handle(ProvidesWriteRequestData $request) { $info = $request->getInfo(); $input = $request->getInput(); $cookies = $request->getCookies(); $files = $input->getAllUploadedFiles(); (new Redirect())->respond('/done'); } }
48. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE 48 FINAL RESPONDING
49. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - FINAL RESPONDING 49 final class IceHawkConfig implements ConfiguresIceHawk { use Defaults\Traits\DefaultRequestInfoProviding; use Defaults\Traits\DefaultReadRouting; use Defaults\Traits\DefaultWriteRouting; use Defaults\Traits\DefaultRequestBypassing; use Defaults\Traits\DefaultEventSubscribing; use Defaults\Traits\DefaultCookieProviding; use Defaults\Traits\DefaultFinalReadResponding; use Defaults\Traits\DefaultFinalWriteResponding; }
50. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - FINAL RESPONDING 50 final class MyHawkConfig extends IceHawkConfig { public function getFinalReadResponder() : RespondsFinallyToReadRequest { return MyFinalReadResponder(); } }
51. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF FEATURES & CODE - FINAL RESPONDING 51 final class MyFinalReadResponder implements RespondsFinallyToReadRequest { public function handleUncaughtException( \Throwable $throwable, ProvidesReadReqeustData $request ) { try { throw $throwable; } catch (UnresolvedRequest $e) { (new NotFound())->respond(); } catch (\Throwable $e) { (new InternalServerError())->respond(); } } }
52. FULL DOCUMENTATION AT icehawk.github.io
53. QUESTIONS?
54. THANK YOU! github.com/hollodotme @hollodotme / @F9T3ch fortuneglobe.com phpug-dresden.org @phpugdd HOLGER WOLTERSDORF https://hollo.me icehawk.github.io speakerdeck.com/hollodotme Slides available at:
55. ICEHAWK FRAMEWORK • APRIL, 4TH 2017 • BEPHPUG • BERLIN HOLGER WOLTERSDORF LINKS / REFERENCES 55 ๏ MVC-Pattern: http://martinfowler.com/eaaDev/uiArchs.html ๏ CQRS-Pattern: http://martinfowler.com/bliki/CQRS.html ๏ GET/HEAD methods: https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html ๏ SOLID principles https://en.wikipedia.org/wiki/SOLID_(object-oriented_design) ๏ "Clean Code" by Robert C. Martin: http://amzn.to/2dthxQn ๏ "Traitful" Configs: https://hollo.me/php/traitful-configs.html ๏ IceHawk Gitter chat: https://gitter.im/icehawk/Lobby