Symfony Components

The Symfony Components – Fabien Potencier

Serial entrepreneur
Developer by passion
Founder of Sensio
Creator and lead developer of Symfony
On Twitter @fabpot
On 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


Event Dispatcher Stable

Output Escaper Stable
Extracted from symfony 1
YAML Stable

Routing Beta

Console Stable
Dependency Injection Container Stable Written from scratch
for Symfony 2
Request Handler Stable

Templating Stable


YAML
Event Dispatcher
PHP Quebec 2009
Templating
Dependency Injection Container
Console
Routing ConFoo 2010
Output Escaper
Request Handler

Download / Installation


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

Main repository


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

Git Mirror
Synchronized
every 15 minutes


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

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

Nightly 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.php
Doctrine_Pager_Range > Doctrine/Pager/Range.php
Twig_Node_For > Twig/Node/For.php


PEAR_Log > PEAR/Log.php
Zend_Log > Zend/Log.php
Swift_Mime_Message > Swift/Mime/Message.php
Doctrine_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

SymfonyFoundationKernel > Symfony/Foundation/Kernel.php
DoctrineDBALDriver > Doctrine/DBAL/Driver.php
pdependreflectionReflectionSession > pdepend/reflection/ReflectionSession.php


SymfonyFoundationKernel > Symfony/Foundation/Kernel.php
DoctrineDBALDriver > Doctrine/DBAL/Driver.php
pdependreflectionReflectionSession > 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 SymfonyFoundationUniversalClassLoader;


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


$loader = new UniversalClassLoader();
$loader->registerNamespace(
'Symfony', __DIR__.'/src/symfony/src'
);
$loader->register();

// use any Symfony class


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

PHP 5.3 technical
interoperability standards


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

PEAR style


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


$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


Automate things
code generators
deployment


Long running tasks
deployment
get « things » from the Internet


Batches
cleanup a database from time to time
migrate 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 tool
for 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
exit codes
shell
output colorization
tests
error messages
…

$ ./life foo "foo bar" --foo foobar -b

Array
(
[0] => ./life
[1] => foo
[2] => foo bar
[3] => --foo
[4] => foobar
[5] => -b
)


don’t reinvent the wheel…
use a “framework”


Let’s create a CLI tool
to get the weather
anywhere in the world

use LifeYahooWeather;

$weather = new YahooWeather('API_KEY', $argv[1]);
echo $weather->getTitle()."n";

$attrs = $weather->getCurrentConditions();

echo "Current conditions:n";
echo sprintf(" %s, %sCn", $attrs['text'], $attrs['temp']);

$attrs = $weather->getForecast();

echo sprintf("nForecast for %sn", $attrs['date']);
echo sprintf(" %s, low: %s, high: %sn", $attrs['text'],
$attrs['low'], $attrs['high']);


use SymfonyComponentsConsoleApplication;

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


$command = new Command('weather');
$command->setCode(
function ($input, $output)
{
// do something
}
);

$application->addCommand($command);


use SymfonyComponentsConsoleApplication;

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


use SymfonyComponentsConsoleCommandCommand;
use SymfonyComponentsConsoleInputInputInterface;
use SymfonyComponentsConsoleOutputOutputInterface;

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


{
{
$this->setName('weather')
->setDescription('Displays weather forecast')
->setHelp(<<<EOF
The <info>weather</info> command displays
weather forecast for a given city:

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

You can also change the default degree unit
with 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


{
{
$definition = array(
new InputArgument('place',
InputArgument::OPTIONAL, 'The place name', 'Paris'),

new InputOption('unit', 'u',
InputOption::PARAMETER_REQUIRED, 'The degree unit',
'c'),
);

$this->setDefinition($definition);


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

}


Console

Error codes / Exit status


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


return 120;
}


Console

Interact with the user


protected function interact($input, $output)
{
$city = $this->dialog->ask(
$output,
'<comment>Which city?</comment> (Paris)',
'Paris’
);

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

./life weather --no-interaction


dialog
ask()
askConfirmation()
askAndValidate()

formatter
formatSection()
formatBlock()

... your own


class WeatherHelper extends Helper
{
public function __construct()
{
Output::setStyle('weather_hot', array('bg' => 'red', 'fg' => 'yellow'));
Output::setStyle('weather_cold', array('bg' => 'blue', 'fg' => 'white'));
}

public function formatTemperature($temperature, $unit)
{
$style = $temperature < 0 ? 'weather_cold' : 'weather_hot';

return sprintf("<%s> %s%s </%s>", $style, $temperature, strtoupper($unit),
$style);
}

public function getName()
{
return 'weather';
}
}

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



// for testing
$application->setCatchExceptions(false);
$application->setAutoExit(false);


echo $application->asXml();


$command = new WeatherCommand();
echo $command->asXml();


Create a PHAR archive
out of your CLI tool
for distribution

$pharFile = 'life.phar’;
if (file_exists($pharFile))
unlink($pharFile);

$phar = new Phar($pharFile, 0, $this->application->getName());
$phar->setSignatureAlgorithm(Phar::SHA1);
$phar->startBuffering();

// CLI Component files
foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator(__DIR__.'/../symfony/src/Symfony/Components/
Console'), RecursiveIteratorIterator::LEAVES_ONLY) as $file)
{
$phar['Symfony/Components/Console'.str_replace(__DIR__.'/../symfony/src/Symfony/Components/Console', '', $file)] =
file_get_contents($file);
}
// Life stuff
foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator(__DIR__.'/../Life'),
RecursiveIteratorIterator::LEAVES_ONLY) as $file)
{
$phar['Life'.str_replace(__DIR__.'/../Life', '', $file)] = file_get_contents($file);
}
// Autoloader
$phar['Symfony/Foundation/UniversalClassLoader.php'] = file_get_contents(__DIR__.'/../symfony/src/Symfony/Foundation/
UniversalClassLoader.php');

// Stubs
$phar['_cli_stub.php'] = $this->getCliStub();
$phar['_web_stub.php'] = $this->getWebStub();
$phar->setDefaultStub('_cli_stub.php', '_web_stub.php');
$phar->stopBuffering();
$phar->compressFiles(Phar::GZ);
unset($phar);


git clone http://github.com/fabpot/confoo2010


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 diﬃcult to get right


Symfony one is built
with performance in mind


Routing

Describing your routes


use SymfonyComponentsRoutingRouteCollection;
use SymfonyComponentsRoutingRoute;

$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 SymfonyComponentsRoutingMatcherUrlMatcher;

$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)
{
}

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


array (
'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)
{
}

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

Uncaught exception 'Exception' with message 'No
route matches.'


Routing

Generating URLs


use SymfonyComponentsRoutingGeneratorUrlGenerator;

$generator = new UrlGenerator($routes);

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


$params = array(
'year' => 2010,
'month' => 10,
'day' => 10,
'slug' => 'another-one'
);

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


$params = array(
'year' => 'yyyy',
'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 SymfonyComponentsRoutingGeneratorUrlGenerator;

$generator = new UrlGenerator($routes);

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

/?foo=bar


$generator = new UrlGenerator($routes, array(
'base_url' => '/myapp',
'host' => 'www.example.com',
'is_secure' => false,
));

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

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


The context
makes the routing
decoupled from the rest of the world

base_url
host
is_secure
method


Routing

Describing your routes with XML or YAML


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

blog_post:
pattern: /:year/:month/:day/:slug
defaults:
controller: blog
action: show
requirements:
year: d{4}


use SymfonyComponentsRoutingLoaderYamlFileLoader;

$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
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 SymfonyComponentsRoutingLoaderXmlFileLoader;

$loader = new XmlFileLoader();

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


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

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

$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
preﬁx pattern


Routing

Make it simple & fast


use SymfonyComponentsRoutingRouter;

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


$loader = function ()
{
// ...

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('/'))
{
}

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


class ProjectUrlMatcher extends SymfonyComponentsRouting
MatcherUrlMatcher
{
// ...

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 SymfonyComponentsRoutingGeneratorUrlGenerator
{
// ...

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

$loader = function ()
{
// ...

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

return $routes;
};


Routing

Make it really fast


use SymfonyComponentsRoutingMatcherDumper
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' => 'SymfonyComponents
RoutingMatcherApacheUrlMatcher',
);


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

$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 method
public function getTitle() { return $this->title; }
public function getAuthor() { return $this->author; } public method returning
public function __get($key) { return $this->$key; } another object
public function __call($method, $arguments)
{ magic __get()
return $this->{'get'.$method}(); 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 SymfonyComponentsRequestHandlerRequest;

$request = new Request();
$request->getPathInfo();
$request->getPreferredLanguage(array('en', 'fr'));
$request->isXmlHttpRequest();



$request = new Request(array(
'request' => $_POST,
'query' => $_GET,
'path' => array(),
'server' => $_SERVER,
));


use SymfonyComponentsRequestHandlerResponse;

$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 SymfonyComponentsRequestHandlerResponse;
use SymfonyComponentsRequestHandlerRequestHandler;

$handler = new RequestHandler($dispatcher);

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


use SymfonyComponentsEventDispatcherEventDispatcher;
use SymfonyComponentsEventDispatcherEvent;

$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)
{
$content = 'Hello '.
$request->getParameter('name');

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


class Framework
{
protected $map;

public function __construct($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'];

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

$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;
}

Questions?


Sensio S.A.
92-98, boulevard Victor Hugo
92 115 Clichy Cedex
FRANCE
Tél. : +33 1 40 99 80 80

Contact
Fabien Potencier
fabien.potencier at sensio.com

http://www.sensiolabs.com/
http://www.symfony-project.org/
http://fabien.potencier.org/


Symfony Components

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Was ist angesagt?

Was ist angesagt? (20)

Andere mochten auch

Andere mochten auch (20)

Ähnlich wie Symfony Components

Ähnlich wie Symfony Components (20)

Mehr von Fabien Potencier

Mehr von Fabien Potencier (19)

Kürzlich hochgeladen

Kürzlich hochgeladen (20)

Symfony Components