The Wonderful World of Symfony Components

The Wonderful World of the
Symfony Components
by your friend:
Ryan Weaver
@weaverryan
Friday, September 28, 12

View Slide

Who is this dude?
• That “Docs” guy
• KnpLabs US - Symfony consulting, training, Kumbaya
• Writer for KnpUniversity.com
screencasts
• Husband of the much more
talented @leannapelham
knplabs.com
github.com/weaverryan
@weaverryan

View Slide

Intro
Life before components
(The Desert of the Real)

View Slide

Symfony consists of 23
individual components

View Slide

Components are available
via Composer

View Slide

Snooze...

View Slide

Who Cares?

View Slide

We Suck at Sharing
and that sucks for you
@weaverryan
1

View Slide

Including External Libraries
is Depressing

View Slide

The Big Bummer :(
@weaverryan
• How do I autoload their files?
• Does their library depend on anything else?
• How do I even store their files in my project?

View Slide

Include a Zend Framework 1
component in symfony1

View Slide


View Slide

manually download the
library and commit it
into your project

View Slide

if you don’t want the
WHOLE library, carefully
delete everything except
the dependent components

View Slide

autoloading is completely
custom ... blah gross!

View Slide

Components are the key to
mastering your framework
@weaverryan
2

View Slide

If PHP is big, we’ll thrive
If PHP is small, we’ll die
@weaverryan
3

View Slide

Communities
@weaverryan
PHP is Huge! Right?
http://www.ﬂickr.com/photos/kitty-kat/

View Slide

@weaverryan
PHP > Ruby

View Slide

Fragmentation
@weaverryan
But fragmentation makes us tiny, isolated, and
misguided trend-setters
http://www.ﬂickr.com/photos/slpunk99/7329609744

View Slide

PHP frameworks < Rails
@weaverryan

View Slide

I don’t want a damned
CakePHP Plugin!
@weaverryan
CakePHP
CodeIgniter

View Slide

Fragmentation
@weaverryan
• More information we have to know
• Difficult to hire
• Disjointed forums, StackOverflow
• Interoperability? What’s that?

View Slide

Components are shareable
across all of PHP

View Slide

Act 1
Making Sharing Sexy

View Slide

PHP Framework
Interoperability Group
http://www.php-ﬁg.org/

View Slide

The United Nations of PHP

View Slide

(A)
The Problem of Autoloading

View Slide

My Autoloader doesn’t like
your PHPs
@weaverryan
• The symfony1 autoloader doesn’t know where ZF1
classes live. The Zf1 autoloader doesn’t know where
symfony1 classes live
• Each library has its own autoloader that you must
discover, configure and use

View Slide

like a town where every
store has its own currency

View Slide

From The Mountain:
PSR-0 Class Naming Conventions
@weaverryan
“Thou shalt name your classes by
following a predictable pattern”

View Slide

class:
sfRequest
path:
lib/vendor/symfony/???idk

View Slide

class:
Symfony\Component\HttpFoundation\Request
path:
vendor/symfony/src/Symfony/Component/
HttpFoundation/Request.php

View Slide

use Symfony\Component\ClassLoader\UniversalClassLoader;
$loader = new UniversalClassLoader();
$loader->registerNamespaces(array(
'Zend' => __DIR__.'/path/to/zf'
));
$loader->register();

View Slide

(B)
Managing Vendors in your
project

View Slide

Composer

View Slide

{
"require": {
"zendframework/ldap": "2.0.x-dev"
}
}
1) Composer.json

View Slide

$ curl -s https://getcomposer.org/installer | php
$ php composer.phar install
2) Composer.phar

View Slide

require 'vendor/autoload.php';
use Zend\Ldap\Ldap;
$options = array(...);
$ldap = new Ldap($options);
3) Use It

View Slide


View Slide

Act 2
Your friendly, neighborhood
Symfony Components

View Slide

The Symfony Components
• HttpFoundation
• HttpKernel
• Event Dispatcher
• Routing
• CSSSelector
• DomCrawler
• BrowserKit
• Config
• Yaml
• DependencyInjection
• Security
@weaverryan
• OptionsResolver
• Console
• Filesystem
• Finder
• Locale
• Process
• Serializer
• Templating
• Form
• Translation
• Validator

View Slide

• HttpFoundation
• HttpKernel
• Routing
• CSSSelector
• DomCrawler
• BrowserKit
• Config
• Yaml
• Security
@weaverryan
• OptionsResolver
• Console
• Filesystem
• Finder
• Locale
• Process
• Serializer
• Templating
• Form
• Translation
• Validator
The “Framework”
Components

View Slide

Level 1
HttpFoundation
symfony/http-foundation

View Slide

@weaverryan
{
"require": {
"symfony/http-foundation": "2.1.x-dev"
}
}
php composer.phar install
// your app
1
2
3
Fun to Install!

View Slide

@weaverryan
Request
/foo
Response
Hi!
?
?
?
? ?
?
Mystery
PHP Code

View Slide

The Request

View Slide

GET /foo?p=v1 HTTP/1.1
Host: knplabs.com
Accept: text/html
User-Agent: Mozilla/5.0
// /foo?p=v1
$uri = $_SERVER['REQUEST_URI'];
$p = isset($_GET['p']) ? $_GET['p'] : '';
$host = $_SERVER['HTTP_HOST'];
$accept = $_SERVER['HTTP_ACCEPT'];
$ua = $_SERVER['HTTP_USER_AGENT'];

View Slide

use Symfony\Component\HttpFoundation\Request;
$request = Request::createFromGlobals();
$uri = $request->getPathInfo(); /foo
$p = $request->query->get('p');
$host = $request->getHost();
$accept = $request->headers->get('Accept');
GET /foo?p=v1 HTTP/1.1
Host: knplabs.com
Accept: text/html
User-Agent: Mozilla/5.0

View Slide

The Response

View Slide

HTTP/1.1 200 OK
Date: Tue, 04 Jun 2011 21:05:05 GMT
Content-Type: text/html
Set-Cookie:foo=fooval; path=/; httponly
Foo!
header('Content-Type', 'text/html');
setcookie('foo', 'fooval');
echo 'Foo!';

View Slide

HTTP/1.1 200 OK
Date: Tue, 04 Jun 2011 21:05:05 GMT
Content-Type: text/html
Set-Cookie:foo=fooval; path=/; httponly
Foo!
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Cookie;
$response = new Response('Foo!');
$cookie = new Cookie('foo', 'fooval');
$response->headers->setCookie($cookie);
$response->send();

View Slide

A Mini Framework

View Slide

// not dependable!
$uri = $_SERVER['REQUEST_URI'];
ob_start();
if ($uri == '/') {
echo 'Homepage! \o/';
} else {
echo 'sad missing page :/';
}
header('X-TOKEN: Foo');
ob_end_flush();

View Slide

$req = Request::createFromGlobals();
if ($req->getPathInfo() == '/') {
$res = new Response('Homepage! \o/');
} else {
$res = new Response('sad missing page :/');
}
$res->headers->set('X-SECRET', 'Foo');
$res->send();
Symfony3

View Slide

Get some learning about
HttpFoundation
@weaverryan
• Docs: http://bit.ly/sf2-http-foundation
• Code: http://bit.ly/sf2-http-foundation-code
• API: http://bit.ly/sf2-http-foundation-api

View Slide

Level 2
HttpKernel
symfony/http-kernel

View Slide

@weaverryan
Framework
Request
Determine
the controller
?
? ?
Execute it
Flush the Response
Response

View Slide

Framework:
A pattern for converting a
request into a response

View Slide

@weaverryan
Framework
Request
Determine
the controller
?
? ?
Execute it
Flush the Response
Response

View Slide

@weaverryan
HttpKernel
Request
Determine
the controller
?
? ?
Execute it
Flush the Response
Response

View Slide

$kernel = new HttpKernel(...);
$response = $kernel->handle($request);
$response->send();
There be magic inside!

View Slide

These lines execute your
Symfony application
(hint, see - web/app.php)

View Slide

... and Drupal 8 too ...

View Slide

Yea, this is abstract
Stay Tuned...

View Slide

Level 3
EventDispatcher
symfony/event-dispatcher

View Slide

@weaverryan
Event
Dispatcher
A classic “observer pattern”
Listener
Listener
Tell me when Liz
gets to work
Tell me when Liz
gets to work

View Slide

@weaverryan
Event
Dispatcher
• Event Dispatcher: a classic “observer pattern”
Listener
Listener
Yo! I’m at
work!

View Slide

@weaverryan
Event
Dispatcher
Listener
Listener
Liz is at
work!
Liz is at
work!

View Slide

Event
Dispatcher
Listener
Listener
She’s the best
around!
I’m totally
going to go talk
with her!!

View Slide

Level 4
Routing
symfony/routing

View Slide

@weaverryan
Router
Url
Match against
a route
Return info
about the route
Route
Route

View Slide

$loader = new ClosureLoader();
$router = new Router($loader, function() {
$collection = new RouteCollection();
$route = new Route('/blog/{slug}');
$collection->add('blog', $route);
return $collection;
});
$results = $router->match('/blog/sflive');
array(
'slug' => 'sflive',
'_route' => 'blog',
)

View Slide

$loader = new ClosureLoader();
$router = new Router($loader, function() {
$collection = new RouteCollection();
$route = new Route('/blog/{slug}', array(
'_controller' => 'SomeBundle:Blog:show'
));
$collection->add('blog', $route);
return $collection;
});
$results = $router->match('/blog/sflive');
array(
'_controller' => 'SomeBundle:Blog:show',
'slug' => 'sflive',
'_route' => 'blog'
)

View Slide

Input: Request Information
Output: An array of info

View Slide

Level 5
A “Framework”

View Slide

$kernel = new HttpKernel(...);
$response = $kernel->handle($request);
$response->send();

View Slide

@weaverryan
HttpKernel::handle()
HttpFoundation
+
EventDispatcher
+
Routing (optional)
=
Framework

View Slide

@weaverryan
HttpKernel::handle()
Request
+
Determine Controller
+
Controller Returns a Response
=
Response

View Slide

Homework:
Hack your Framework
... or do Karaoke later... your call

View Slide

@weaverryan
HttpKernel::handleRaw()
private function handleRaw(Request $request, $type = self::MASTER_REQUEST)
{
// request
$event = new GetResponseEvent($this, $request, $type);
$this->dispatcher->dispatch(KernelEvents::REQUEST, $event);
if ($event->hasResponse()) {
return $this->filterResponse($event->getResponse(), $request, $type);
}
// load controller
if (false === $controller = $this->resolver->getController($request)) {
throw new NotFoundHttpException('Unable to find the controller);
}
$event = new FilterControllerEvent($this, $controller, $request, $type);
$this->dispatcher->dispatch(KernelEvents::CONTROLLER, $event);
$controller = $event->getController();
// ... returns a response
}
The kewlest code I know about... seriously

View Slide

@weaverryan
• Symfony\Component\HttpKernel\HttpKernel::handle()
http://bit.ly/sf2-http-kernel-code
• Symfony Framework Important Classes
Symfony\Component\HttpKernel\EventListener\RouterListener
- Executes the routing
Symfomy\Bundle\FrameworkBundle\Controller\ControllerResolver
- Parses _controller and instantiates the controller object
step/var_dump()die; the core

View Slide

Timeline of events in the Symfony Framework
kernel.request
kernel.controller
kernel.response

View Slide

Profile events in the Symfony Framework

View Slide

• HttpFoundation
• HttpKernel
• Routing
• CSSSelector
• DomCrawler
• BrowserKit
• Config
• Yaml
• Security
@weaverryan
• OptionsResolver
• Console
• Filesystem
• Finder
• Locale
• Process
• Serializer
• Templating
• Form
• Translation
• Validator
Awesome
Tools

View Slide

Process
symfony/process
Now with more
Windows Love!

View Slide

@weaverryan
{
"require": {
"symfony/process": "2.1.x-dev"
}
}
Find Symfony’s Process on Packagist.org
php composer.phar install
1
2
3
// your app

View Slide

// dinner.php
for ($i = 1; $i <= 3; $i++) {
sleep(1);
echo sprintf("Cooking... %s\n", $i);
}
echo "DING! \n";
External Script to Cook Dinner

View Slide

Run the script synchronously

View Slide

// app.php
use Symfony\Component\Process\Process;
$process = new Process('php dinner.php');
// if dinner takes longer than 5 seconds
// to cook, freak out!
$process->setTimeout(5);
$process->run(function($type, $buffer) {
echo $buffer;
});
// executed after the command finishes
if (!$process->isSuccessful()) {
throw new \Exception('Process misbehaved')
}

View Slide


View Slide

Run the script asynchronously

View Slide

$process->start();
// do more work here
echo "WORKING!!! \n";
while ($process->isRunning()) {
// wait for the process to finish
};
echo $process->getOutput();

View Slide

Interacting via Stdin

View Slide

$process->setStdin('turkey');
“turkey” is read from Stdin

View Slide

$process->run(function($type, $buffer) {
if ($type == 'err') {
// perhaps do some logging?
echo $buffer;
}
});
Handling things that blow up!
if (!$process->isSuccessful()) {
echo sprintf(
"Process failed! Exit code %s, '%s'\n",
$process->getExitCode(),
$process->getExitCodeText()
);
}

View Slide

Find out more about Process
@weaverryan
• Docs: http://bit.ly/sf2-process
• Code: http://bit.ly/sf2-process-code
• API: http://bit.ly/sf2-process-api

View Slide

SPORK!
@kriswallsmith
$manager = new Spork\ProcessManager();
$manager->fork(function() {
// do something in another process!
return 'Hello from '.getmypid();
})->then(function(Spork\Fork $fork) {
// do something in the parent process afterwards
echo "{$fork->getPid()} says '{$fork->getResult()}'";
});
Fork yourself some more PHP
https://github.com/kriswallsmith/spork

View Slide

Finder
symfony/finder

View Slide

From the Fablog
http://fabien.potencier.org/article/44/php-iterators-and-
streams-are-awesome
use Symfony\Components\Finder\Finder;
$s3 = new \Zend_Service_Amazon_S3($key, $secret);
$s3->registerStreamWrapper("s3");
$finder = new Finder();
$finder->name('photos*')
->size('< 100K')
->date('since 1 hour ago');
foreach ($finder->in('s3://bucket-name') as $file) {
// do something
print $file->getFilename()."\n";
}

View Slide

Find(er) out more about Finder
@weaverryan
• Docs: http://bit.ly/sf2-finder
• Code: http://bit.ly/sf2-finder-code
• API: http://bit.ly/sf2-finder-api

View Slide

Filesystem
symfony/filesystem
New in 2.1!

View Slide

@weaverryan
{
"require": {
"symfony/filesystem": "2.1.x-dev"
}
}
Find Symfony’s Filesystem on Packagist.org
php composer.phar update symfony/filesystem
1
2
3
// your app

View Slide

// ...
use Symfony\Component\Filesystem\Filesystem;
$filesystem = new Filesystem();
$filesystem->copy(
'cowboy.jpg',
's3://my-bucket/cowboy.jpg'
);
$filesystem->copy(
's3://my-bucket/rodeo.mov',
'rodeo.mov'
);
$filesystem->mirror(
'thumbnails',
's3://my-bucket/thumbnails'
);

View Slide

// ...
use Symfony\Component\Finder\Finder;
$finder = new Finder();
$finder->name('*.jpg')
->date('since 1 hour ago');
->in('thumbs');
$filesystem->chmod($finder, 0777);

View Slide

// ...
$filesystem->touch('foo.txt');
$filesystem->chmod('foo.txt', 0777);
$filesystem->symlink('/some/dir', '/symlink/target')

View Slide

Find out more about Filesystem
@weaverryan
• Docs: http://bit.ly/sf2-filesystem
• Code: http://bit.ly/sf2-filesystem-code
• API: http://bit.ly/sf2-filesystem-api

View Slide

Console
symfony/console

View Slide


View Slide

// command.php
$loader = require 'vendor/autoload.php';
$loader->add('App', __DIR__);
use Symfony\Component\Console\Application;
use App\Command\EchoCommand;
$app = new Application();
$app->add(new EchoCommand());
$app->run();

View Slide

namespace App\Command;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
class EchoCommand extends Command
{
protected function configure()
{
$this->setName('echo')->addArgument('msg');
}
public function execute(
InputInterface $input,
OutputInterface $output)
{
$output->writeln('Yo '.$input->getArgument('msg'));
}
}

View Slide

Output with pretty colors

View Slide

Find out more about Command
@weaverryan
• Docs http://bit.ly/sf2-console
• Code http://bit.ly/sf2-console-code
• API http://api.symfony.com/master/namespaces.html
-> and search for “Console”

View Slide

If you download Composer
in the next 5 minutes, we’ll
throw in a special gift!

View Slide

CssSelector + DomCrawler
symfony/css-selector
symfony/dom-crawler

View Slide

use Symfony\Component\DomCrawler\Crawler;
$html = <<

Hello World!
Hello Crawler!

HTML;
$crawler = new Crawler($html);
$crawler->filter('p')->eq(0)->attr('class');
$crawler->filter('p')->eq(1)->text();

View Slide

Goutte!

View Slide

Config
symfony/config

View Slide

Config
@weaverryan
• Load configuration from many formats (YAML,
PHP files, XML)
• Config Validation
• Caching for parsed config

View Slide

Validator
symfony/validator

View Slide

Shh... a little setup

View Slide

use Symfony\Component\Validator\Validator;
use Symfony\Component\Validator\Mapping\ClassMetadataFactory;
use Symfony\Component\Validator\ConstraintValidatorFactory;
// a little setup
$metadata = new ClassMetadataFactory();
$constraintFactory = new ConstraintValidatorFactory();
$validator = new Validator($metadata, $constraintFactory);

View Slide

use Symfony\Component\Validator\Constraints\Email;
$value = 'ryan[AT]knplabs.com';
$email = new Email();
$email->message = 'Invalid! You entered {{ value }}';
$errors = $validator->validateValue($value, $email);
if (count($errors) > 0) {
echo strtr(
$errors[0]->getMessageTemplate(),
$errors[0]->getMessageParameters()
);
}

View Slide

34 Core Validators and counting
• String length
• Regular expressions
• Ip addresses
• Dates
• Collections
• File size, mime-type, etc
... and the brand new Luhn validator
for credit card numbers thanks to
@merk ----------------------------------->
@weaverryan
See the “Reference”
section of the docs

View Slide

But wait there’s more!

View Slide

More Components
• Security
• OptionsResolver
• Locale
• Serializer
• Templating
• Form
• Translation
@weaverryan

View Slide

Many components are easy

View Slide

Some are still wtf-hard

View Slide

(cough) Security (cough)

View Slide

Documentation
Documentation
Documentation

View Slide

The Security Component
https://github.com/symfony/symfony-docs/pull/1604
WIP by @matthiasnoback

View Slide

Act 3
Kicking ass in the new
PHP eco-system

View Slide

The PHP Ecosphere
• Symfony
• Zend Framework
• EZ Components
• Drupal
• ...
• Individuals
@weaverryan
Symfony is only one part of the picture
What other stuff exists?

View Slide

How do we find good
libraries?

View Slide


View Slide

Some Favorites

View Slide

Mink
behat/mink
http://mink.behat.org/
By @everzet, written on
Fabien’s childhood computer

View Slide

Command a browser, find elements, click
them, and fill out forms
$driver = new \Behat\Mink\Driver\SahiDriver('firefox');
$session->visit('http://my_project.dev/some_page.php');
$page = $session->getPage();
$anchor = $page->find('css', '.something');
$anchor->click();
// get the content of the new page
echo $page->getContent();

View Slide

Monolog
monolog/monolog
https://github.com/Seldaek/monolog
Your Friend Jordi

View Slide

A Logger, where bells and whistles
come standard
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\FirePHPHandler;
// Create the logger
$logger = new Logger('my_logger');
$logger->pushHandler(new StreamHandler(
__DIR__.'/my_app.log'
));
$logger->pushHandler(new FirePHPHandler());
$logger->addInfo('My logger is now ready');

View Slide

Zend Framework 2
They have some stuff

View Slide

Yay Find More!

View Slide

Epilogue
4 Reasons to get
silly-excited about
the Future

View Slide

1) Look for Participation &
Consolidation

View Slide

Shared Building-blocks
• Drupal
• phpBB
• Midgard
• Zikula
• ez Publish 5
• ...
@weaverryan

View Slide

Less Library Duplication?
• Zend/Form
• Zend/Serializer
• Zend/Http
• Zend/EventManager
• Zend/Log
• Zend/Navigation
• ...
@weaverryan
• Symfony/Form
• Symfony/Serializer
• Symfony/HttpFoundation
• Symfony/EventDispatcher
• Monlog
• KnpMenu
• ...

View Slide

2) More high quality,
community-grown libraries

View Slide

Solving 1 specific problem
is a low barrier to entry

View Slide

Find them, fork them.

View Slide

Write their docs :)

View Slide

Programmers that write
docs get hugs

View Slide

3) Easier upgrades

View Slide

4) Grow your Community

View Slide

Solutions exist outside of
your framework

View Slide

Fabien will not come to your
house and tell you about them

View Slide

Cast your vote by using the
best libraries and improving
them

View Slide

and realize the power of
the entire PHP community

View Slide

Thanks...
Ryan Weaver
@weaverryan

View Slide

... and we love you!
Ryan Weaver
@weaverryan
Ryan Weaver
@weaverryan
https://joind.in/7218

View Slide

The Wonderful World of Symfony Components

The Wonderful World of Symfony Components

weaverryan

More Decks by weaverryan

Other Decks in Technology

Featured

Transcript