Symfony Components Confoo 2010 100310231007 Phpapp02

8/8/2019 Symfony Components Confoo 2010 100310231007 Phpapp02

http://slidepdf.com/reader/full/symfony-components-confoo-2010-100310231007-phpapp02 1/148

The Symfony Components – Fabien Potencier




Serial entrepreneur

Developer by passion

Founder of Sensio

Creator and lead developer of Symfony

On Twitter @fabpotOn github http://www.github.com/fabpot

http://fabien.potencier.org/




Standalone components for PHP 5.3

No dependency between them

Used extensively in Symfony 2, the framework




Low-level libraries

needed by most websites


http://slidepdf.com/reader/full/symfony-components-confoo-2010-100310231007-phpapp02 5/148The Symfony Components – Fabien Potencier

Event Dispatcher

Output Escaper

YAML

Routing

Console

Dependency Injection Container

Request HandlerTemplating

Extracted from symfony 1

Written from scratch

for Symfony 2

Stable

Stable

Stable

Beta

Stable

Stable

Stable

Stable



YAML

Event Dispatcher

Templating

Dependency Injection Container

Console

Routing

Output EscaperRequest Handler

PHP Quebec 2009

ConFoo 2010



Download / Installation



git clone git://github.com/symfony/symfony.git

Main reposi tor y




svn checkout http://svn.symfony-project.org/branches/2.0/

Gi t Mirror

S ynchronized

e ver y 15 minu tes




curl -O http://github.com/symfony/symfony/tarball/mastertar zxpf symfony-symfony-XXXXXXX.tar.gz

curl -O http://github.com/symfony/symfony/zipball/masterunzip symfony-symfony-XXXXXXX.zip

Nigh tl y build




app/

.../Symfony/

Components/Foundation/

Framework/




Autoloading Classes




Before PHP 5.3

PEAR naming convention






PEAR_Log > PEAR/Log.php

Zend_Log > Zend/Log.php

Swift_Mime_Message > Swift/Mime/Message.phpDoctrine_Pager_Range > Doctrine/Pager/Range.php

Twig_Node_For > Twig/Node/For.php

Vendor name




As of PHP 5.3

PHP 5.3 technical

interoperability standards




Symfony\Foundation\Kernel > Symfony/Foundation/Kernel.php

Doctrine\DBAL\Driver > Doctrine/DBAL/Driver.phppdepend\reflection\ReflectionSession > pdepend/reflection/ReflectionSession.php




Symfony\Foundation\Kernel > Symfony/Foundation/Kernel.php

Doctrine\DBAL\Driver > Doctrine/DBAL/Driver.phppdepend\reflection\ReflectionSession > pdepend/reflection/ReflectionSession.php

Vendor name




PHP 5.3 technical interoperability standards

« … describes the mandatory requirements

that must be adhered to

for autoloader interoperability »

http://groups.google.com/group/php-standards/web/psr-0-final-proposal




use Symfony\Foundation\UniversalClassLoader;






$loader->registerNamespaces(array('Symfony' => '/path/to/symfony/src','Doctrine' => '/path/to/doctrine/lib',

'pdepend' => '/path/to/reflection/source',));

PHP 5.3 technical

in teroperabili t y s tandards




$loader->registerPrefixes(array('Swift_' => '/path/to/swiftmailer/lib/classes',

'Zend_' => '/path/to/vendor/zend/library',));

PEAR s t yle

i ' /S f /F d ti /U i lCl L d h '




require_once '.../Symfony/Foundation/UniversalClassLoader.php';

use Symfony\Foundation\UniversalClassLoader;

$loader = new UniversalClassLoader();$loader->registerNamespaces(array('Symfony' => '/path/to/symfony/src','Doctrine' => '/path/to/doctrine/lib',

));$loader->registerPrefixes(array('Swift_' => '/path/to/swiftmailer/lib/classes','Zend_' => '/path/to/vendor/zend/library',

));

$loader->register();

// use any class




Console




Console




Automate things

code generatorsdeployment




Long running tasks

deploymentget « things » from the Internet




Batches

cleanup a database from time to timemigrate a DB to a new schema




These tasks should never

be run from a browser




But PHP is

a web language, right?




So, why not use the right toolfor the job?

… like Perl or Python?




Don’t want to use/learn another language

Want to share code




PHP natively supports

the CLI environment




<?php

// ...




#!/usr/bin/env php<?php

// ...

$ ./ foo …




$ ./foobar Fabien

$name = $argv[1];echo 'Hello '.$name;




… but the complexity lies in the details

option / arguments handling




option / arguments handling

exit codesshell

output colorizationtests

error messages…






don’t reinvent the wheel…

use a “framework”






Let’s create a CLI tool

to get the weatheranywhere in the world




use Life\YahooWeather;




use Life\YahooWeather;

$weather = new YahooWeather('API_KEY', $argv[1]);

echo $weather->getTitle()."\n";

$attrs = $weather->getCurrentConditions();

echo "Current conditions:\n";

echo sprintf(" %s, %sC\n", $attrs['text'], $attrs['temp']);

$attrs = $weather->getForecast();

echo sprintf("\nForecast for %s\n", $attrs['date']);

echo sprintf(" %s, low: %s, high: %s\n", $attrs['text'],$attrs['low'], $attrs['high']);




use Symfony\Components\Console\Application;

$application = new Application();$application->run();




$command = new Command('weather');

$command->setCode(function ($input, $output){// do something

});

$application->addCommand($command);




use Symfony\Components\Console\Application;

$application = new Application();

$application->addCommand(new WeatherCommand());$application->run();

use Symfony\Components\Console\Command\Command;




use Symfony\Components\Console\Input\InputInterface;use Symfony\Components\Console\Output\OutputInterface;

class WeatherCommand extends Command{

protected function configure(){$this->setName('weather');

}

protected function execute(InputInterface $input, OutputInterface$output)

{// do something

}}




Console

The Output




$output->writeln($weather->getTitle());




$output->writeln(sprintf('<info>%s</info>', $weather->getTitle())

);

$output->writeln("<comment>Conditions</comment>");










Console

Getting help







$application = new Application('Life Tool', '0.1');

class WeatherCommand extends Command{

protected function configure()




{$this->setName('weather')

->setDescription('Displays weather forecast')

->setHelp(<<<EOF The <info>weather</info> command displaysweather forecast for a given city:

<info>./life weather Paris</info>

You can also change the default degree unitwith the <comment>--unit</comment> option:

<info>./life weather Paris --unit=c</info><info>./life weather Paris -u c</info>

EOF );}










$ ./life weather

$ ./life weath$ ./life w




Console

The Input









protected function execute(InputInterface $input,OutputInterface $output){$city = $input->getArgument('place');$unit = $input->getOption('unit');

$output->writeln("<comment>Conditions</comment>");}




Console

Error codes / Exit status







d f i ( f $i




protected function execute(InputInterface $input,OutputInterface $output){$city = $input->getArgument('place');$unit = $input->getOption('unit');

$output->writeln("<comment>Conditions</comment>");

return 120;}




Console

Interact with the user

t t d f ti i t t($i t $ t t)




protected function interact($input, $output){

$city = $this->dialog->ask($output,'<comment>Which city?</comment> (Paris)','Paris’

);

$input->setArgument('place', $city);}




./life weather --no-interaction

dialogask()askConfirmation()




askConfirmation()askAndValidate()

formatterformatSection()

formatBlock()

... your own



$output >writeln(sprintf(




$output->writeln(sprintf(" %s, low: %s, high: %s",

$attrs['text'],$this->weather->formatTemperature($attrs['low'],$input->getOption('unit')),

$this->weather->formatTemperature($attrs['high'],$input->getOption('unit'))

));







Console

Testing




$input = new ArrayInput(array('place' => 'Paris', '--unit' => 'C')

);$application->run($input);

$input = new StringInput('Paris --unit=C');$application->run($input);




$stream = fopen('php://memory', 'a', false);$output = new StreamOutput($stream);

$application->run($input, $output);

rewind($output->getStream());echo stream_get_contents($output->getStream());




$application = new Application();

// for testing

$application->setCatchExceptions(false);$application->setAutoExit(false);






$command = new WeatherCommand();

echo $command->asXml();




Create a PHAR archive

out of your CLI toolfor distribution








Routing

Pretty and Smart URLs




http://example.com/article.php?id=44

http://example.com/article/confoo-2010




Routing is a two-way process

Matching incoming requests (URLs)Generating URLs




The architecture

is difficult to get right




Symfony one is built

with performance in mind




Routing

Describing your routes

use Symfony\Components\Routing\RouteCollection;




use Symfony\Components\Routing\Route;

$routes = new RouteCollection();$route = new Route(

'/',array('to' => function () { echo "Home!"; }));$routes->addRoute('home', $route);

(




$route = new Route(

'/:year/:month/:day/:slug',array('to' => function ($params) { var_export

($params); }),

array('year' => '\d{4}'));$routes->addRoute('blog_post', $route);




Routing

Matching URLs

use Symfony\Components\Routing\Matcher\UrlMatcher;




$matcher = new UrlMatcher($routes);

if (false === $params = $matcher->match('/')){

throw new \Exception('No route matches.');}

$params['to']();

( )




$params = $matcher->match('/2010/03/10/confoo');

if (false === $params){throw new \Exception('No route matches.');

}

$params['to']($params);

array ('to' =>




to >

Closure::__set_state(array()),'year' => '2010','month' => '03',

'day' => '10','slug' => 'confoo','_route' => 'blog_post',

)

$params = $matcher->match('/yyyy/03/10/confoo'); if (false === $params)




if (false $params)

{ throw new \Exception('No route matches.');}

$params['to']($params);

Uncaught exception 'Exception' with message 'Noroute matches.'




Routing

Generating URLs




use Symfony\Components\Routing\Generator\UrlGenerator;

$generator = new UrlGenerator($routes);

echo $generator->generate('home', array());

$params = array(




p y(

'year' => 2010,'month' => 10,'day' => 10,'slug' => 'another-one'

);

echo $generator->generate('blog_post', $params);

$params = array('year' => 'yyyy','month' > 10




'month' => 10,

'day' => 10,);

echo $generator->generate('blog_post', $params);

Uncaught exception 'InvalidArgumentException'with message 'The "blog_post" route has some

missing mandatory parameters (:slug).'

use Symfony\Components\Routing\Generator\UrlGenerator;




$generator = new UrlGenerator($routes);

echo $generator->generate('home', array('foo' =>'bar'));

/?foo=bar

$generator = new UrlGenerator($routes, array('base url' => '/myapp',




_ y pp ,

'host' => 'www.example.com','is_secure' => false,));

echo $generator->generate('home', array(), true);

http://www.example.com/myapp/

The context

makes the routing

d l d f th t f th ld




decoupled from the rest of the world

base_url

hostis_secure

method




Routing

Describing your routes with XML or YAML

home:pattern: /defaults: { controller: home, action: index }




blog_post:pattern: /:year/:month/:day/:slugdefaults:

controller: blogaction: showrequirements:year: \d{4}




use Symfony\Components\Routing\Loader\YamlFileLoader;

$loader = new YamlFileLoader();

$routes = $loader->load('routes.yml');

<?xml version="1.0" encoding="UTF-8" ?>

<routes xmlns="http://www.symfony-project.org/schema/routing" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.symfony-project.org/schema/routing

htt // s f r j t r /s h /r ti /r ti 1 0 sd">




http://www.symfony-project.org/schema/routing/routing-1.0.xsd">

<route id="blog_post" pattern="/:year/:month/:day/:slug"><default key="controller">blog</default><default key="action">show</default><requirement key="year">\d{4}</requirement>

</route>

<route id="home" pattern="/"><default key="controller">home</default><default key="action">index</default>

</route></routes>




use Symfony\Components\Routing\Loader\XmlFileLoader;

$loader = new XmlFileLoader();

$routes = $loader->load('routes.xml');

<?xml version="1.0" encoding="UTF-8" ?>

<routes>




<routes>

<route id="home" pattern="/"><default key="controller">home</default><default key="action">index</default>

</route>

<import resource="blog.yml" prefix="/blog" /><import resource="forum.xml" prefix="/forum" />

</routes>

home:




pattern: /defaults: { controller: home, action: index }

import:- { resource: blog.yml, prefix: /blog }- { resource: forum.xml, prefix: /forum }

$yamlLoader = new YamlFileLoader();$xmlLoader = new XmlFileLoader();

$routes = new RouteCollection();$ t R t (




$route = new Route('/',array('to' => function () { echo "Home!"; })

);$routes->addRoute('home', $route);

$routes->addCollection($yamlLoader->load('blog.yml'), '/blog');

$routes->addCollection($xmlLoader->load('forum.xml'), '/forum');




/blog/2010/03/10/confoo

prefix pattern




Routing

Make it simple & fast




use Symfony\Components\Routing\Router;

$router = new Router($loader, $options, $context);

$loader = function ()

{$routes = new RouteCollection();// ...

return $routes;




return $routes;

};

$context = array('base_url' => '/myapp','host' => 'www.example.com','is_secure' => false,

);

$options = array('cache_dir' => '/tmp/routing','debug' => true,

);

$router = new Router($loader, $options, $context);




if (false === $params = $router->match('/')){throw new \Exception('No route matches.');

}

echo $router->generate('home', array());

class ProjectUrlMatcher extends Symfony\Components\Routing

\Matcher\UrlMatcher{// ...




public function match($url){$url = $this->normalizeUrl($url);

if (preg_match('#^/$#x', $url, $matches))

return array_merge($this->mergeDefaults($matches, array( 'to' => 'foo',)), array('_route' => 'home'));

return false;}

}

class ProjectUrlGenerator extends Symfony\Components\Routing\Generator\UrlGenerator{// ...

public function generate($name, array $parameters, $absolute = false){

if (!method_exists($this, $method = 'get'.$name.'RouteInfo'))




{ throw new \InvalidArgumentException(sprintf('Route "%s" does not exist.', $name));}

list($variables, $defaults, $requirements, $tokens) = $this->$method();

return $this->doGenerate($variables, $defaults, $requirements, $tokens, $parameters,

$name, $absolute);}

protected function gethomeRouteInfo(){

return array(array (), array_merge($this->defaults, array ( 'to' => 'foo',)), array(), array ( 0 => array ( 0 => 'text', 1 => '/', 2 => '', 3 => NULL, ),));

}}

use Symfony\Components\Routing\FileResource;

$loader = function ()




$ ()

{$routes = new RouteCollection();// ...

$routes->addResource(new FileResource(__FILE__));

return $routes;};




Routing

Make it really fast

use Symfony\Components\Routing\Matcher\Dumper




use Symfony\Components\Routing\Matcher\Dumper\ApacheMatcherDumper;

$dumper = new ApacheMatcherDumper($routes);

echo $dumper->dump();




RewriteCond %{PATH_INFO} ^/$RewriteRule .* index.php[QSA,L,E=_ROUTING__route:home,E=_ROUTING_to:foo

]

$options = array(




'cache_dir' => '/tmp/routing','debug' => true,'matcher_class' => 'Symfony\Components

\Routing\Matcher\ApacheUrlMatcher',);




Output Escaper




Provides XSS protection

for your PHP templates

Wraps template variables

Works for

strings




arrays

objects

properties

methods__call(), __get(), …

Iterators, Coutables, …

…

Works for deep method calls




use Symfony\Components\OutputEscaper\Escaper;

$title = 'Foo ';

echo Escaper::escape('htmlspecialchars', $title);


$article = array('title' => 'Foo ',




> < /> ,'author' => array('name' => 'Fabien ',

));

$article = Escaper::escape('htmlspecialchars', $article);

echo $article['title']."\n";echo $article['author']['name']."\n";

class Article

{ protected $title;protected $author;

public $full_title; public property




public function __construct($title, Author $author){$this->title = $title;$this->full_title = $title;$this->author = $author;

}

public function getTitle() { return $this->title; }public function getAuthor() { return $this->author; }public function __get($key) { return $this->$key; }public function __call($method, $arguments){

return $this->{'get'.$method}();}}

public method

public method returning

another object

magic __get()

magic __call()

class Author




{protected $name;

public function __construct($name) { $this->name = $name; }

public function getName() { return $this->name; }}


$article = new Article('foo ',




new Author('Fabien '));

$article = Escaper::escape('htmlspecialchars', $article);

echo $article->getTitle()."\n";echo $article->getAuthor()->getName()."\n";echo $article->full_title."\n";echo $article->title."\n";echo $article->title()."\n";

explicitly ask

for raw data




echo $article->getHtmlContent('raw');

echo $article->getTitle('js');

change the default

escaping strategy




Request Handler

use Symfony\Components\RequestHandler\Request;




$request = new Request();$request->getPathInfo();

$request->getPreferredLanguage(array('en', 'fr'));$request->isXmlHttpRequest();

use Symfony\Components\RequestHandler\Request;

( (




$request = new Request(array('request' => $_POST,'query' => $_GET,

'path' => array(),'server' => $_SERVER,));

use Symfony\Components\RequestHandler\Response;

$ (' ll ld'




$response = new Response('Hello World', 200,array('Content-Type' => 'text/plain'));$response->send();

$response->setHeader('Content-Type', 'text/plain');$response->setCookie('foo', 'bar');$response->setContent('Hello World');$response->setStatusCode(200);




Request Handler

Framework to build Frameworks

use Symfony\Components\RequestHandler\Request;use Symfony\Components\RequestHandler\Response;

S f \C t \R tH dl \R tH dl




use Symfony\Components\RequestHandler\RequestHandler;

$handler = new RequestHandler($dispatcher);

$request = new Request();$response = $handler->handle($request);$response->send();

use Symfony\Components\EventDispatcher\EventDispatcher;use Symfony\Components\EventDispatcher\Event;

$di t h E tDi t h ()




$dispatcher = new EventDispatcher();$dispatcher->connect('core.load_controller', function (Event $event){

$event->setReturnValue(array(function ($request) { return new Response('Hello!'); },array($event['request'])

));

return true;});




Request Handler

A small Framework

$framework = new Framework(array('/' => function ($request){

$ t t 'H ll '




$content = 'Hello '.$request->getParameter('name');

return new Response($content);}));$framework->run();

class Framework{protected $map;

public function __construct($map){

$this >map = $map;




$this->map = $map;}

public function run(){$dispatcher = new EventDispatcher();

$dispatcher->connect('core.load_controller', array($this, 'loadController'));

$handler = new RequestHandler($dispatcher);$response = $handler->handle(new Request());$response->send();

}}

public function loadController(Event $event){

$request = $event['request'];

$routes = new RouteCollection();foreach ($this->map as $pattern => $to){$route = new Route($pattern, array('to' => $to));$routes->addRoute(str_replace('/', '_', $pattern), $route);

}

$matcher new UrlMatcher($routes array(




$matcher = new UrlMatcher($routes, array('base_url' => $request->getBaseUrl(),'method' => $request->getMethod(),'host' => $request->getHost(),'is_secure' => $request->isSecure(),

));

$parameters = $matcher->match($request->getPathInfo());if (false === $parameters){return false;

}

$request->setPathParameters($parameters);

$event->setReturnValue(array($parameters['to'], array($request)));

return true;}

$framework = new Framework(array('/' => function ($request){

$content 'Hello '




$content = Hello .$request->getParameter('name');

return new Response($content);}));$framework->run();




Questions?

Sensio S.A.

92-98, boulevard Victor Hugo

92 115 Clichy Cedex

FRANCE




Tél. : +33 1 40 99 80 80

ContactFabien Potencier

fabien.potencier at sensio.com

http://www.sensiolabs.com/

http://www.symfony-project.org/

http://fabien.potencier.org/

Symfony Components Confoo 2010 100310231007 Phpapp02

Documents