keeping it small - getting to know the slim micro framework - @jeremykendall

8/13/2019 Keeping It Small - Getting to know the Slim micro framework - @JeremyKendall

http://slidepdf.com/reader/full/keeping-it-small-getting-to-know-the-slim-micro-framework-jeremykendall 1/135

Keeping it smallGetting to know the Slim micro framework

@JeremyKendall



Jeremy

Kendall



Jeremy

Kendall

I love to code



Jeremy

Kendall

I love to code

I’m terribly forgetful



Jeremy

Kendall

I love to code


I take pictures



Jeremy

Kendall

I love to code


I take pictures

I work at OpenSky



Micro framework?



Micro framework?

Concise codebase



Micro framework?

Concise codebase

Clear codebase



Micro framework?

Concise codebase

Clear codebase

Addresses a small set of use cases



Micro framework?

Concise codebase

Clear codebase

Addresses a small set of use cases

Addresses those use cases well



What is Slim?



What is Slim?

Inspired by Sinatra



What is Slim?

Inspired by Sinatra

Favors cleanliness over terseness



What is Slim?

Inspired by Sinatra

Favors cleanliness over terseness

Favors common cases over edge cases



Installing Slim



RTFM



RTFM ;-)



Don’t forget .htaccess!

RewriteEngine On

RewriteCond %{REQUEST_FILENAME} !-f

RewriteRule ^ index.php [QSA,L]

http://docs.slimframework.com/pages/routing-url-rewriting/





Hello world

<?php

require '../vendor/autoload.php';

$app = new \Slim\Slim();

$app->get('/hello/:name', function ($name) {

echo "Hello, $name";

});

$app->run();



Hello world

<?php





});

$app->run();



Let’s look at a

Slim application



Flaming Archer



Flaming Archer

wat



“Great repository names are short and memorable.

Need inspiration? How about flaming-archer.”



Flaming Archer



Flaming Archer

Photo 365 project



Flaming Archer

Photo 365 project

Built in 4 days (Saturday through Tuesday)



Flaming Archer

Photo 365 projectBuilt in 4 days (Saturday through Tuesday)

Basic application — a few bells, no whistles



Flaming Archer



Routing



Flaming Archer



Routing

Twig views



Flaming Archer



Routing

Twig views

Middleware



4 views



phploc --exclude vendor,tests,templates .

phploc 1.6.4 by Sebastian Bergmann.

Directories: 7Files: 13

Lines of Code (LOC): 876 Cyclomatic Complexity / Lines of Code: 0.04Comment Lines of Code (CLOC): 272Non-Comment Lines of Code (NCLOC): 604



Configuration

return array(

'slim' => array(



y(

'templates.path' => __DIR__ . '/templates',

'log.level' => 4,

'log.enabled' => true,

'log.writer' => new Slim\Extras\Log\DateTimeFileWriter(

array( 'path' => __DIR__ . '/logs',

'name_format' => 'y-m-d'

)

)

),

'twig' => array(

// . . . ),

'cookies' => array(

// . . .

),

'flickr.api.key' => 'FLICKR API KEY',

'pdo' => array(

// . . . )

);

return array(

'slim' => array(



y(


'log.level' => 4,





)

)

),

'twig' => array(

// . . . ),

'cookies' => array(

// . . .

),


'pdo' => array(

// . . . )

);

S

return array(

'slim' => array(




'log.level' => 4,





)

)

),

'twig' => array(

// . . . ),

'cookies' => array(

// . . .

),


'pdo' => array(

// . . . )

);

S

Views

return array(

'slim' => array(




'log.level' => 4,





)

)

),

'twig' => array(

// . . . ),

'cookies' => array(

// . . .

),


'pdo' => array(

// . . . )

);

S

Views

Cookies

return array(

'slim' => array(




'log.level' => 4,





)

)

),

'twig' => array(

// . . . ),

'cookies' => array(

// . . .

),


'pdo' => array(

// . . . )

);

S

Views

Cookies

My stuff



$config = require_once __DIR__ . '/../config.php

// Prepare app

$app = new Slim\Slim($config['slim']);



$config = require_once __DIR__ . '/../config.php

// Prepare app

$app = new Slim\Slim($config['slim']);

Config arraygoes here



Routing

R i



Routing

$app->get('/', function () use ($app, $service) { $images = $service->findAll();

$app->render('index.html', array('images' => $images));

});

R i



Routing



});

HTTP Method

R i



Routing



});

HTTP MethodResource URI

R ti



Routing



});

HTTP MethodResource URI

Anonymous Function

R ti



Routing



});

R ti



Routing



});

Grabs all t

R tin



Routing



});

Grabs all t

Passes array of image data to index.html

GET



GET

$app->get('/:day', function($day) use ($app, $service) {

$image = $service->find($day);

if (!$image) {

$app->notFound();

}

$app->render('images.html', $image);

}

)->conditions(array('day' => '([1-9]\d?|[12]\d\d|3[0-5]\d|36[0-6])

GET



GET



if (!$image) {

$app->notFound();

}


}


URL parameter

GET



GET



if (!$image) {

$app->notFound();

}


}


URL parameter... gets passed as an

argument

GET



GET



if (!$image) {

$app->notFound();

}


}



argument

Condition

GET



GET



if (!$image) {

$app->notFound();

}


}



argument

Condition 1 to 366

GET



GET



if (!$image) {

$app->notFound();

}


}


404!

POST (with redirect)




$app->post('/admin/add-photo', function() use ($app, $service)

$data = $app->request()->post(); $service->save($data);

$app->redirect('/admin');

}

);





$app->post('/admin/add-photo', function() use ($app, $service)

$data = $app->request()->post(); $service->save($data);


}

);

$_POST data is i

the request objec



Multiple methods



Multiple methods

$app->map('/login', function() { // Login

})->via('GET', 'POST');

Multiple methods



Multiple methods



Not an HTTP Method

Multiple methods



Multiple methods



Not an HTTP Method

via() is the

awesome sauce



Logging and flash messaging

$app->post('/admin/clear-cache', function() use ($app) {

$log $app getLog();



$log = $app->getLog();

$cleared = null;

$clear = $app->request()->post('clear');

if ($clear == 1) {

if (apc_clear_cache('user')) {

$cleared = 'Cache was successfully cleared!';

} else {

$cleared = 'Cache was not cleared!';

$log->error('Cache not cleared'); }

}

$app->flash('cleared', $cleared);


}

);


$log $app >getLog(); Get the log from $app




$cleared = null;


if ($clear == 1) {



} else {



}



}

);

Get the log from $app


$log $app >getLog(); Get the log from $app




$cleared = null;


if ($clear == 1) {



} else {



}



}

);


Erro


$log = $app->getLog(); Get the log from $app




$cleared = null;


if ($clear == 1) {



} else {



}



}

);


Erro

Flash message availthe next reque

Middleware



Middleware

“. . . a Slim application can have middlewarethat may inspect, analyze, or modify the application environment, request, and

response before and/or after the Slimapplication is invoked.”

http://docs.slimframework.com/pages/middleware-overview/

Hooks





Hooks

Hooks



slim.before

Hooks



slim.before

slim.before.router

Hooks



slim.before

slim.before.router

slim.before.dispatch

Hooks



slim.before

slim.before.router


slim.after.dispatch

Hooks



slim.before

slim.before.router


slim.after.dispatch

slim.after.router

Hooks



slim.before

slim.before.router


slim.after.dispatch

slim.after.router

slim.after

Hooks



slim.before

slim.before.router


slim.after.dispatch

slim.after.router

slim.after

class MyMiddleware extends \Slim\Middleware

{

public function call()

{



{

//The Slim application

$app = $this->app;

//The Environment object

$env = $app->environment();

//The Request object

$req = $app->request();

//The Response object

$res = $app->response();

//Optionally call the next middleware

$this->next->call();

}}


{


{

Extend th



{


$app = $this->app;









}

}


{


{

Extend th

Define call()



{


$app = $this->app;









}

}

Define call()

class MyMiddleware extends \Slim\Middleware{


{

Extend th

Define call()



{


$app = $this->app;









}

}

Define call()

Inspect, analyze,and modify!

class MyMiddleware extends \Slim\Middleware{


{

Extend th

Define call()



{


$app = $this->app;









}

}

Define call()

On to the nex

Inspect, analyze,and modify!



Middleware + Hooks = WIN



Navigation example

namespace Tsf\Middleware;

use \Zend\Authentication\AuthenticationService;

class Navigation extends \Slim\Middleware



g

{

/** * @var \Zend\Authentication\AuthenticationService

*/

private $auth;

public function __construct(AuthenticationService $auth)

{

$this->auth = $auth; }


{

// . . .

}

}



class Navigation extends \Slim\Middleware extends



g

{


*/

private $auth;


{



{

// . . .

}

}

extends



class Navigation extends \Slim\Middleware extends



g

{


*/

private $auth;


{



{

// . . .

}

}

Constructor injectionFTW

extends


{

$app = $this->app;

$auth = $this->auth;



$auth = $this >auth;


$home = array('caption' => 'Home', 'href' => '/');

$admin = array('caption' => 'Admin', 'href' => '/admin');

$login = array('caption' => 'Login', 'href' => '/login');

$logout = array('caption' => 'Logout', 'href' => '/logout');

if ($auth->hasIdentity()) {

$navigation = array($home, $admin, $logout); } else {

$navigation = array($home, $login);

}

// . . .

}


{

$app = $this->app;

$auth = $this->auth;Arrays ofnav items



$auth $this >auth;


$home = array('caption' => 'Home', 'href' => '/');

$admin = array('caption' => 'Admin', 'href' => '/admin');






}

// . . .

}

nav items


{

$app = $this->app;

$auth = $this->auth;Arrays ofnav items



$auth $this >auth;


$home = array('caption' => 'Home', 'href' => '/'); $admin = array('caption' => 'Admin', 'href' => '/admin');






}

// . . .

}

nav items

Nav differs on auth st


{

// . . .

$this->app->hook('slim.before.router', function () use (...) {



$ pp ( , () ( ) {

foreach ($navigation as &$link) {

if ($link['href'] == $req->getPath()) { $link['class'] = 'active';

} else {

$link['class'] = '';

}

}

$app->view()

->appendData(array('navigation' => $navigation));

}

);

$this->next->call();}


{

// . . .


Delicious hookgoodness



pp ( , () ( ) {



} else {


}

}

$app->view()


}

);



{

// . . .





pp ,



} else {


}

}

$app->view()


}

);


Matchdispatched p


{

// . . .







} else {


}

}

$app->view()


}

);


Matchdispatched p

Appen$navigatio

view


{

// . . .







} else {


}

}

$app->view()


}

);


Matchdispatched p

Appen$navigatio

viewOn to the next!



Views



Two great tastesthat taste great together

Twig



Twig



Concise

Twig



Concise

Template oriented

Twig



Concise

Template oriented

Fast

Twig



Concise

Template oriented

Fast

Multiple inheritance

Twig



Concise

Template oriented

Fast


Blocks

Twig



Concise

Template oriented

Fast


Blocks

Automatic escaping



layout.htand

index.htm



layout.html



<title>{% block page_title %} {% endblock %}</tit



<ul class="nav">

{% for link in navigation %}

<li class="{{link.class}}">

<a href="{{link.href}}">{{link.caption}}<

</li>

{% endfor %}

</ul>



<h1>365 Days of Photography</h1>

<h3>Photographer: Jeremy Kendall</h3>

{% block content %} {% endblock %}

<hr />



index.html

{% extends 'layout.html' %}

{% block page_title %}365.jeremykendall.net{% endblock %}

{% block content %}

{% for image in images %}



g g

<div class="row">

<div class="span6"> <h2><a href="/{{image.day}}">{{image.day}}/365</a></h2 <p>

<a href="/{{image.day}}">

<img src="{{image.sizes.size.5.source}}" />

</a>

</p> <p>Posted {{image.posted|date("m/d/Y")}}</p>

</div></div>

{% else %}

<p>No images in project</p>

{% endfor %}{% endblock %}



{% block content %}


extends



<div class="row">




</a>


</div></div>

{% else %}





{% block content %}


extends

<title



<div class="row">




</a>


</div></div>

{% else %}





{% block content %}


extends

<title

iterator



<div class="row">




</a>


</div></div>

{% else %}





{% block content %}


di l " "

extends

<title

iterator



<div class="row">




</a>


</div></div>

{% else %}



else



{% block content %}


di l " "

extends

<title

iterator



<div class="row">




</a>


</div></div>

{% else %}



else

format



login.htm


{% block page_title %}365.jeremykendall.net | Login{% endblock %}

{% block content %}



{ }

<div class="row">

<div class="span4">

<h2>Login</h2>

{% if flash.error %}

<p style="color: red;">{{flash.error}}</p>

{% endif %} <form name="login" id="login" class="well" method="post">

// Login form . . . </form>

</div>

</div>

{% endblock %}


{% block page_title %}365.jeremykendall.net | Login{% endblock %}

{% block content %}



<div class="row">

<div class="span4">

<h2>Login</h2>

{% if flash.error %}

<p style="color: red;">{{flash.error}}</p>

{% endif %} <form name="login" id="login" class="well" method="post">

// Login form . . . </form>

</div>

</div>

{% endblock %}



The other viewswould be redundant

GOTO 0



Small but powerfulGOTO 0



p




p

Excellent tools to write elegant code





Routing, middleware & hooks, views





Routing, middleware & hooks, views

I just scratched the surface

Read



Slim: slimframework.com

Twig: twig.sensiolabs.org

Composer: getcomposer.org

MicroPHP Manifesto: microphp.org

Flaming Archer: http://git.io/rH0nrg



Questions?

Thanks!



[email protected]

@jeremykendall

keeping it small - getting to know the slim micro framework - @jeremykendall

Documents