Keeping it small - Getting to know the Slim PHP micro framework

Keeping it small
Getting to know the Slim micro framework
php[tek] 2013
Wednesday, May 15, 13

I love to code

I love to code
I’m terribly forgetful

I love to code
I take pictures

I love to code
I take pictures
I work at OpenSky

Micro framework?

MicroPHP Manifesto

MicroPHP Manifesto
Written by Ed Finkler

MicroPHP Manifesto
Punk rock vs. Prog rock

MicroPHP Manifesto
Prophet or Madman?

MicroPHP Manifesto
Prophet or Madman?
Guiding principle

MicroPHP Manifesto
Prophet or Madman?
Guiding principle
http://microphp.org/

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

I chose Slim PHP

I chose Slim PHP
and I sucked at it

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

Install Composer
curl -s https://getcomposer.org/installer | php

Install Composer
curl -s https://getcomposer.org/installer | php
If you take nothing else away from this talk, I hope that
it’s Composer. It’s that big of a deal.

composer.json
{
"require": {
"slim/slim": "2.*"
}
}

Install via Composer
php composer.phar install

Add this to index.php
<?php
require 'vendor/autoload.php';

Pro tip
mv composer.phar /usr/local/bin/composer

Don’t forget .htaccess!
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [QSA,L]
http://docs.slimframework.com/#Route-URL-Rewriting
(nginx documentation available at same URL)

Hello $name
<?php
require '../vendor/autoload.php';
$app = new SlimSlim();
$app->get('/hello/:name', function ($name) {
echo "Hello, $name";
});
$app->run();

Getting there
http://localhost/index.php/hello/tek
OR
http://localhost/hello/tek

Slim in practice

Flaming Archer!

“Great repository names are short and memorable.
Need inspiration? How about ﬂaming-archer.”

Flaming Archer

Flaming Archer
Photo 365 project

Flaming Archer
Photo 365 project
Bulk of app built in 4 days

Flaming Archer
Photo 365 project
Basic application — a few bells, no whistles

Flaming Archer
Photo 365 project
Routing

Flaming Archer
Photo 365 project
Routing
Twig templates

Flaming Archer
Photo 365 project
Routing
Twig templates
Middleware

Flaming Archer
Photo 365 project
Routing
Twig templates
Middleware
Hooks

phploc --exclude vendor --exclude tests --exclude templates .
phploc 1.7.4 by Sebastian Bergmann.
Directories: 8
Files: 16
Lines of Code (LOC): 1212
Cyclomatic Complexity / Lines of Code: 0.03
Comment Lines of Code (CLOC): 453
Non-Comment Lines of Code (NCLOC): 759

Conﬁguration

return array(
'slim' => array(
'templates.path' => __DIR__ . '/templates',
'log.level' => 4,
'log.enabled' => true,
'log.writer' => new SlimExtrasLogDateTimeFileWriter(
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(
'log.level' => 4,
array(
'path' => __DIR__ . '/logs',
)
)
),
'twig' => array(
// . . .
),
'cookies' => array(
// . . .
),
'pdo' => array(
// . . .
)
);
Slim

return array(
'slim' => array(
'log.level' => 4,
array(
'path' => __DIR__ . '/logs',
)
)
),
'twig' => array(
// . . .
),
'cookies' => array(
// . . .
),
'pdo' => array(
// . . .
)
);
Slim
Views

return array(
'slim' => array(
'log.level' => 4,
array(
'path' => __DIR__ . '/logs',
)
)
),
'twig' => array(
// . . .
),
'cookies' => array(
// . . .
),
'pdo' => array(
// . . .
)
);
Slim
Views
Cookies

return array(
'slim' => array(
'log.level' => 4,
array(
'path' => __DIR__ . '/logs',
)
)
),
'twig' => array(
// . . .
),
'cookies' => array(
// . . .
),
'pdo' => array(
// . . .
)
);
Slim
Views
Cookies
App speciﬁc

$config = require_once __DIR__ . '/../config.php';
// Prepare app
$app = new SlimSlim($config['slim']);
Conﬁguration

$config = require_once __DIR__ . '/../config.php';
// Prepare app
Conﬁg array
goes here
Conﬁguration

Routing
$app->get('/', function () use ($app, $service) {
$images = $service->findAll();
$app->render('index.html', array('images' => $images));
}
);

Routing
}
);
HTTP Method

Routing
}
);
HTTP Method
Resource URI

Routing
}
);
HTTP Method
Resource URI
Anonymous Function

Routing
}
);
Grabs all the pics

Routing
}
);
Grabs all the pics
Passes array of image data to index.html

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]dd|3[0-5]d|36[0-6])'));

GET
if (!$image) {
$app->notFound();
}
}
URL parameter

GET
if (!$image) {
$app->notFound();
}
}
URL parameter
... gets passed as an
argument

GET
if (!$image) {
$app->notFound();
}
}
URL parameter
argument
Condition

GET
if (!$image) {
$app->notFound();
}
}
URL parameter
argument
Condition 1 to 366

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

}
);
$_POST data is in
the request object

}
);
$_POST data is in
the request object
302 Redirect

Multiple methods
$app->map('/login', function() {
// Login
}
)->via('GET', 'POST');

Multiple methods
// Login
}
Not an HTTP Method

Multiple methods
// Login
}
Not an HTTP Method
via() is the
awesome sauce

Logging and ﬂash messaging

$app->post('/admin/clear-cache', function() use ($app) {
$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);
}
);

$cleared = null;
if ($clear == 1) {
} else {
}
}
}
);
Get the log from $app

$cleared = null;
if ($clear == 1) {
} else {
}
}
}
);
Error!

$cleared = null;
if ($clear == 1) {
} else {
}
}
}
);
Error!
Flash message available in
the next request.

Middleware
“. . . a Slim application can have middleware
that may inspect, analyze, or modify
the application environment, request, and
response before and/or after the Slim
application is invoked.”
http://docs.slimframework.com/#Middleware-Overview

Middleware

Middleware
Like layers of an onion

Middleware
The Slim application is the core of the onion

Middleware
Each new middleware wraps any existing middleware

Middleware
Each middleware optionally calls the next middleware in
the chain

Middleware
the chain
Middleware is executed from the outside in

Middleware
the chain
Middleware is executed from the outside in
Pay careful attention to the order in which you register
middleware

Middleware
// Prepare app
// . . .
$app->add(new Navigation($auth));
$app->add(new Authentication($auth, $config));

Existing Middleware

Existing Middleware
Flash messaging

Existing Middleware
Flash messaging
Content types

Existing Middleware
Flash messaging
Content types
Pretty exceptions

Existing Middleware
Flash messaging
Content types
Pretty exceptions
Session cookie

Existing Middleware
Flash messaging
Content types
Pretty exceptions
Session cookie
More in Slim Extras

Roll your own Middleware

Super easy

Super easy
DRYs up code

Super easy
DRYs up code
Awesome application wide functionality

Super easy
DRYs up code
Awesome application wide functionality
Just extend SlimMiddleware and implement call()

class MyMiddleware extends SlimMiddleware
{
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();
}
}

{
{
$app = $this->app;
}
}
Extend this

{
{
$app = $this->app;
}
}
Extend this
Deﬁne call()

{
{
$app = $this->app;
}
}
Extend this
Deﬁne call()
Inspect, analyze,
and modify!

{
{
$app = $this->app;
}
}
Extend this
Deﬁne call()
On to the next!
Inspect, analyze,
and modify!

Navigation example

namespace FaMiddleware;
use ZendAuthenticationAuthenticationService;
class Navigation extends SlimMiddleware
{
/** @var AuthenticationService */
private $auth;
public function __construct(AuthenticationService $auth)
{
$this->auth = $auth;
}
{
// . . .
}
}

{
private $auth;
{
}
{
// . . .
}
}
extends

{
private $auth;
{
}
{
// . . .
}
}
Constructor injection
FTW
extends

{
$app = $this->app;
$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;
} else {
}
// . . .
}
Arrays of
nav items

{
$app = $this->app;
} else {
}
// . . .
}
Arrays of
nav items
Nav differs based
on auth status

{
// . . .
foreach ($navigation as &$link) {
if ($link['href'] == $req->getPath()) {
$link['class'] = 'active';
} else {
$link['class'] = '';
}
}
$app->view()->appendData(array('navigation' => $navigation));
}

{
// . . .
} else {
}
}
}
Match
dispatched path

{
// . . .
} else {
}
}
}
Match
dispatched path
Append
$navigation to
view

{
// . . .
} else {
}
}
}
Match
dispatched path
Append
$navigation to
view
On to the next!

Route Middleware

Route Middleware
Anything that returns true for is_callable()

Route Middleware
Apply directly to route!

Route Middleware
Apply directly to route!
Goes between route deﬁnition and route callable

Route Middleware
<?php
function mw1() {
echo "This is middleware!";
}
function mw2() {
echo "This is middleware!";
}
$app->get('/foo', 'mw1', 'mw2', function () {
//Do something
});
http://docs.slimframework.com/#Route-Middleware

Hooks
A “hook” is a moment in the Slim application lifecycle
at which a priority list of callables assigned to the
hook will be invoked.A hook is identiﬁed by a string
name.
http://docs.slimframework.com/#Hooks-Overview

Hooks

Hooks
Prioritized

Hooks
Prioritized
Six default 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

Hooks
$app->hook('the.hook.name', function () {
//Do something
}, 5);

Hooks
$app->hook('the.hook.name', function () {
//Do something
}, 5);
Optional Priority

Middleware + Hooks = WIN

Middleware + Hooks
Using middleware to register hooks allows
me to inspect, analyze, or modify my
application at a speciﬁc time in the
application’s lifecycle in a DRY, testable, and
reusable manner.

Authentication Example

{
$app = $this->app;
$config = $this->config;
// $checkAuth anonymous function snipped
$this->app->hook('slim.before.router', $checkAuth);
}

{
$app = $this->app;
}
Grab stuff to
inspect

{
$app = $this->app;
}
Grab stuff to
inspect
(via constructor)

{
$app = $this->app;
}
Grab stuff to
inspect
Register hook
(via constructor)

// Snip looping through secured url array
if (preg_match($urlPattern, $req->getPathInfo())
&& !$auth->hasIdentity()) {
if ($req->getPath() !== $config['login.url']) {
$app->redirect($config['login.url']);
}
}

}
}
Match path to
secured url

}
}
Match path to
secured url
Logged in?

}
}
Match path to
secured url
Logged in?
Redirect

SlimView

SlimView
Slim delegates rendering of templates to its view object.

SlimView
Easily extensible by extending theView class and
returning a string from render()

SlimView
Use Slim application’s render() method in your app

SlimView
Use Slim application’s render() method in your app
Will echo() template output, buffer the output, and
append to response object’s body

Rendering an app view
$app->render(
'hello.html',
array( 'name' => 'Josh' ),
200
);

$app->render(
'hello.html',
200
);
Template

$app->render(
'hello.html',
200
);
Template View data
(optional)

$app->render(
'hello.html',
200
);
Template View data
(optional)
HTTP Response
(optional)

Templates

Two great tastes
that taste great together

Twig
Concise

Twig
Concise
Template oriented

Twig
Concise
Template oriented
Fast

Twig
Concise
Template oriented
Fast
Multiple inheritance

Twig
Concise
Template oriented
Fast
Content blocks

Twig
Concise
Template oriented
Fast
Content blocks
Automatic escaping

Bootstrap
Because I majorly suck at design

Caveat
I chose Twig because I wanted to learn Twig,
but you could choose any or more of the
following:
PHP, Mustache, Haml, Haanga, Blitz,
Dwoo . . .
https://github.com/codeguy/Slim-Extras

layout.html
and
index.html

layout.html

<title>{% block page_title %} {% endblock %}</title>
layout.html: title

<ul class="nav">
{% for link in navigation %}
<li class="{{link.class}}">
<a href="{{link.href}}">{{link.caption}}</
a>
</li>
{% endfor %}
</ul>
layout.html: navigation

<h1>365 Days of Photography</h1>
<h3>Photographer: Jeremy Kendall</h3>
{% block content %} {% endblock %}
<hr />
layout.html:
headers and content

index.html
(extends layout.html)

{% extends 'layout.html' %}
{% block page_title %}365.jeremykendall.net{% endblock %}
{% block content %}
{% for image in images %}
<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 %}
<div class="row">
<div class="span6">
<p>
</a>
</p>
</div>
</div>
{% else %}
{% endfor %}
{% endblock %}
extends

{% block content %}
<div class="row">
<div class="span6">
<p>
</a>
</p>
</div>
</div>
{% else %}
{% endfor %}
{% endblock %}
extends
<title />

{% block content %}
<div class="row">
<div class="span6">
<p>
</a>
</p>
</div>
</div>
{% else %}
{% endfor %}
{% endblock %}
extends
<title />
iterator

{% block content %}
<div class="row">
<div class="span6">
<p>
</a>
</p>
</div>
</div>
{% else %}
{% endfor %}
{% endblock %}
extends
<title />
iterator
else

{% block content %}
<div class="row">
<div class="span6">
<p>
</a>
</p>
</div>
</div>
{% else %}
{% endfor %}
{% endblock %}
extends
<title />
iterator
else
format

login.html

{% 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 %}
login.html

The other templates
are just more of the same

Application Code
Another big hurdle I had with Slim was
ﬁguring out how to organize my application
code.

Thin Controller, Fat Model

Duh!

Duh!
All my application code is in a library directory

Duh!
It’s all namespaced, autoloadable, and testable

Duh!
I have (almost) zero business logic in index.php

Duh!
Dependencies are managed by Composer

Duh!
Dependencies are managed by Composer
I could theoretically switch frameworks with very little
effort

Small but powerful GOTO 0

Small but powerful
Excellent tools to write elegant code
GOTO 0

Small but powerful
Routing, middleware, hooks, templates, and
views
GOTO 0

Small but powerful
Routing, middleware, hooks, templates, and
views
I just scratched the surface
GOTO 0

Read
Slim: slimframework.com
Twig: twig.sensiolabs.org
Composer: getcomposer.org
MicroPHP Manifesto: microphp.org
Flaming Archer: http://git.io/rH0nrg

Questions?

Thanks!
jeremy@jeremykendall.net
@jeremykendall
http://joind.in/8175

Keeping it small - Getting to know the Slim PHP micro framework

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

Similaire à Keeping it small - Getting to know the Slim PHP micro framework

Similaire à Keeping it small - Getting to know the Slim PHP micro framework (20)

Plus de Jeremy Kendall

Plus de Jeremy Kendall (16)

Dernier

Dernier (20)

Keeping it small - Getting to know the Slim PHP micro framework