New Symfony Tips & Tricks (SymfonyCon Paris 2015)

SYMFONY
TIPS & TRICKS
SymfonyCon
Paris - December 4, 2015
Javier Eguiluz
NEW

License of this presentation
creativecommons.org/licenses/by-nc-sa/3.0

Javier Eguiluz evangelist and trainer at

What we'll talk about
New
features
Tips &
tricks
Rarely used
options

Doctrine
Twig
Monolog
Composer
PHPUnit
Symfony

Doctrine
Twig Monolog
Composer
PHPUnit
Symfony

Thanks to my awesome co-workers
for sharing their knowledge!
Grégoire Nicolas Hugo
SarahTugdual
JérémyJérémy Romain
Julien
FX
Charles

And thanks to the amazing
Symfony Community too
Christophe Benjamin Tobias
BernhardChristian
JordiKevin Jakub
Ryan
Lukas
Wouter

Agenda Doctrine Composer Twig
Conﬁg Monolog Security
Tests Services Console

Accessing request parameters
use SensioBundleFrameworkExtraBundleConfigurationRoute;
use SymfonyBundleFrameworkBundleControllerController;
use SymfonyComponentHttpFoundationRequest;
/** @Route("/blog") */
class BlogController extends Controller
{
/** @Route("/", name="blog_index") */
public function indexAction()
{
$value1 = $request->query->get('parameter1');
$value2 = $request->request->get('parameter2');
// ...
}
}

Accessing request parameters
use SensioBundleFrameworkExtraBundleConfigurationRoute;
use SymfonyBundleFrameworkBundleControllerController;
use SymfonyComponentHttpFoundationRequest;
/** @Route("/blog") */
class BlogController extends Controller
{
/** @Route("/", name="blog_index") */
public function indexAction()
{
$value1 = $request->query->get('parameter1');
$value2 = $request->request->get('parameter2');
// ...
}
}
everybody uses the get() method,
but there are other useful methods

ParameterBag defines some useful methods
// very useful methods
$pageNumber = $request->query->getInt('page');
$isPublished = $request->query->getBoolean('published');

ParameterBag defines some useful methods
// very useful methods
$pageNumber = $request->query->getInt('page');
$isPublished = $request->query->getBoolean('published');
// 'ABC+12.34DEF' -> 'ABCDEF'
$request->query->getAlpha('parameter');
// 'ABC+12.34DEF' -> 'ABC1234DEF'
$request->query->getAlnum('parameter');
// 'ABC+12.34DEF' -> '1234'
$request->query->getDigits('parameter');

Naming
strategies
I learned this from
Ruud
Bijnen
More information
http://doctrine-orm.readthedocs.org/projects/doctrine-orm/en/latest/reference/
namingstrategy.html

Setting custom table/properties names
namespace AppBundleEntity;
use DoctrineORMMapping as ORM;
/** @ORMTable(name="api_users") */
class ApiUsers
{
/** @ORMColumn(type="string", name="api_token") */
private $apiToken;
/** @ORMColumn(type="datetime", name="created_at") */
private $createdAt;
}

Setting custom table/properties names
/** @ORMTable(name="api_users") */
class ApiUsers
{
/** @ORMColumn(type="string", name="api_token") */
private $apiToken;
/** @ORMColumn(type="datetime", name="created_at") */
private $createdAt;
}
ApiUsers api_users
apiToken api_token
createdAt created_at
Entity Database

Using a built-in Doctrine naming strategy
/** @ORMTable */
class ApiUsers
{
/** @ORMColumn(type="string") */
private $apiToken;
/** @ORMColumn(type="datetime") */
private $createdAt;
}
# app/config/config.yml
doctrine:
dbal:
# ...
orm:
naming_strategy: doctrine.orm.naming_strategy.underscore
this is automatically
translated into api_token

Defining a custom naming strategy
namespace DoctrineORMMapping;
interface NamingStrategy
{
function classToTableName($className);
function propertyToColumnName($propertyName);
function referenceColumnName();
function joinColumnName($propertyName);
function joinTableName($sourceEntity, $targetEntity, $propertyName);
function joinKeyColumnName($entityName, $referencedColumnName);
}

Abstract
relationships
I learned this from
Ryan
Weaver
More information
http://symfony.com/doc/current/cookbook/doctrine/resolve_target_entity.html

Most entity relations are well defined
Invoice
entity
User
entity
ManyToOne

What if the target entity can change?
Invoice
entity
User
entityManyToOne
Company
entity

Our needs
• Create a generic InvoiceBundle able to
work both with User and Company
entities.
• No code change or special configuration is
needed for the bundle.

1. Define an abstract "subject" interface
namespace AcmeInvoiceBundleModel;
interface InvoiceSubjectInterface
{
// Add here your custom methods
// ...
}

2. Make entities implement this interface
use AcmeInvoiceBundleModelInvoiceSubjectInterface;
/** @ORMEntity */
class User implements InvoiceSubjectInterface
{
// ...
}
/** @ORMEntity */
class Company implements InvoiceSubjectInterface
{
// ...
}
different
applications

3. Configure the entity association
namespace AcmeInvoiceBundleEntity;
use DoctrineORMMapping AS ORM;
/** @ORMEntity */
class Invoice
{
/**
* @ORMManyToOne(
targetEntity="AcmeInvoiceBundleModelInvoiceSubjectInterface")
*/
protected $subject;
}

3. Configure the entity association
namespace AcmeInvoiceBundleEntity;
use DoctrineORMMapping AS ORM;
/** @ORMEntity */
class Invoice
{
/**
* @ORMManyToOne(
targetEntity="AcmeInvoiceBundleModelInvoiceSubjectInterface")
*/
protected $subject;
}
abstract target entity

4. Define the target entity (at each application)
doctrine:
# ...
orm:
# ...
resolve_target_entities:
AcmeInvoiceBundleModelInvoiceSubjectInterface:
AcmeAppBundleEntityCustomer
this is where magic
happens: dynamic entity
resolution at runtime

Improved
WHERE … IN
I learned this from More information
http://doctrine-orm.readthedocs.org/projects/doctrine-orm/en/latest/changelog/ 
migration_2_5.html#query-api-where-in-query-using-a-collection-as-parameter
Marco
Pivetta

Common code when using collections
$categories = ...
$categoryIds = array();
foreach ($categories as $category) {
$categoryIds[] = $category->getId();
}
$queryBuilder = $this
->where('model.category IN (:category_ids)')
->setParameter('category_ids', $categoryIds)
;

Common code when using collections
$categories = ...
}
->where('model.category IN (:category_ids)')
->setParameter('category_ids', $categoryIds)
;
transform the
ArrayCollection
into an array of IDs

In Doctrine 2.5 this is no longer needed
$categories = ...
}
->where('model.category IN (:categories)')
->setParameter('categories', $categories)
;
WHERE..IN
supports the use of
ArrayCollection

Default table
options
https://github.com/doctrine/DoctrineBundle/pull/420Darien
Hager

Define the default table options
doctrine:
dbal:
default_table_options:
charset: utf8mb4
collate: utf8mb4_unicode_ci
engine: InnoDB
DoctrineBundle 1.6NEW

Define the default table options
doctrine:
dbal:
default_table_options:
charset: utf8mb4
collate: utf8mb4_unicode_ci
engine: InnoDB
required to
support emojis

Savepoints
https://github.com/doctrine/DoctrineBundle/pull/451
http://doctrine.readthedocs.org/en/latest/en/manual/transactions.html
Christopher
Davis

Normal Doctrine transaction
try {
$conn->beginTransaction();
// do something ...
$conn->commit();
} catch(Exception $e) {
$conn->rollback();
}

Doctrine transaction with save points
try {
$conn->beginTransaction('create_user');
// do something ...
$conn->commit('create_user');
} catch(Exception $e) {
$conn->rollback('create_user');
}
Give a name to a
transaction to create
a "save point"

Nesting Doctrine transactions
try {
$conn->beginTransaction();
// do something ...
$conn->beginTransaction('create_user');
try {
// do something ...
$conn->commit('create_user');
} catch(Exception $e) { $conn->rollback('create_user'); }
$conn->commit();
} catch(Exception $e) { $conn->rollback(); }
Nested transaction
with a save point

Adding "save points" automatically
doctrine:
dbal:
use_savepoints: true

Adding "save points" automatically
doctrine:
dbal:
use_savepoints: true
protected function _getNestedTransactionSavePointName()
{
return 'DOCTRINE2_SAVEPOINT_'.$this->_transactionNestingLevel;
}
DoctrineDBALConnection

Optional
things
I learned this from
Hugo
Hamon
Christophe
Coevoet
Grégoire
Pineau

The "action" suffix is optional for annotations
class DefaultController extends Controller
{
/**
* @Route("/", name="homepage")
*/
public function index(Request $request)
{
// ...
}
}
no need to call this
method indexAction()

{
/**
*/
{
// ...
}
}
this only works when using
routing annotations

{
/**
*/
{
// ...
}
}
this only works when using
routing annotations
best used when the
controller class only
contains action methods

The "method" param is optional for listeners
# app/config/services.yml
services:
app.exception_listener:
class: AppBundleEventListenerExceptionListener
tags:
- {
name: kernel.event_listener,
event: kernel.exception,
method: 'onKernelException'
}
no need to define the
method parameter

The "method" param is optional for listeners
services:
app.exception_listener:
class: AppBundleEventListenerExceptionListener
tags:
- {
name: kernel.event_listener,
event: kernel.exception,
method: 'onKernelException'
}
no need to define the
method parameter
on + camelCased event name

The is_granted() check in error pages
{# app/Resources/TwigBundle/views/Exception/error.html.twig #}
{% if app.user and is_granted('ROLE_ADMIN') %}
...
{% endif %}
Symfony 2.7 and previous need
this check to avoid issues in
pages not covered by a firewall.

The is_granted() check in error pages
{# app/Resources/TwigBundle/views/Exception/error.html.twig #}
{% if app.user and is_granted('ROLE_ADMIN') %}
...
{% endif %}
Symfony 2.7 and previous need
this check to avoid issues in
pages not covered by a firewall.
{% if is_granted('ROLE_ADMIN') %}
...
{% endif %}
Symfony 2.8 no longer
requires this check

Improve class
loading
performance
https://github.com/symfony/symfony/pull/16655Tobias
Schultze

This is what we
said during
SymfonyCon 2014
Don't load test classes in production
{
"autoload": {
"psr-4": { "MyLibrary": "src/" }
},
"autoload-dev": {
"psr-4": { "MyLibraryTests": "tests/" }
}
}

New "exclude-from-classmap" option
// composer.json
{
"autoload": {
"exclude-from-classmap": ["/Tests/", "/test/", "/tests/"]
}
}
These classes are excluded
from the optimized autoloader

// composer.json
{
"autoload": {
"exclude-from-classmap": ["/Tests/", "/test/", "/tests/"]
}
}
$ composer dump-autoload --optimize
These classes are excluded
from the optimized autoloader

// composer.json
{
"autoload": {
"exclude-from-classmap": ["**/Tests/", "/test/*"]
}
}
** matches anything
* matches anything except /

github.com/symfony/symfony/pull/16397

Deprecated
filters
http://twig.sensiolabs.org/doc/advanced.html#deprecated-filtersFabien
Potencier

Applications evolve in time…
class AppExtension extends Twig_Extension
{
public function getFilters()
{
return array(
new Twig_SimpleFilter('old_filter', ...),
new Twig_SimpleFilter('new_filter', ...),
);
}
}
How can you deprecate
"old_filter" without
breaking the application?

Filters can be deprecated
class AppExtension extends Twig_Extension
{
public function getFilters()
{
return array(
new Twig_SimpleFilter('old_filter', ..., array(
'deprecated' => true,
'alternative' => 'new_filter',
)),
new Twig_SimpleFilter('new_filter', ...),
);
}
}
Twig 1.23NEW
This is how you deprecate
filters and alert developers
without breaking things

Check if some
block exists
https://github.com/twigphp/Twig/pull/1831Martin
Hasoň

Avoid missing blocks
{% if 'title' is block %}
<title>{{ block('title') }}<title>
{% endif %}
Twig 1.2XNEW
not merged yet

Variadic
filters
https://github.com/twigphp/Twig/pull/1699Martin
Hasoň

The problem with filter arguments
{{ product.photo|image(400, 150, 0.9) }}

What if I need to define more arguments?

{{ product.photo|image(
width = 400, height = 150, opacity = 0.9
) }}
What if I need to define more arguments?
this is a valid solution for Twig, but the
underlying PHP code is still very complex

Defining a filter with lots of arguments
<?php
$filter = new Twig_SimpleFilter('image', function (
$path, $width, $height, $opacity
) {
$path = ...
$width = ...
$height = ...
$opacity = ...
});

Defining a variadic filter
$path, $options = array()
) {
// ...
}, array('is_variadic' => true));

Defining a variadic filter
) {
// ...
a single variadic parameter holds any
number of passed parameters (unlimited)

Getting the values passed
) {
$path = ...
$width = $options['width'];
$height = $options['height'];
$opacity = $options['opacity'];

Template
source code
https://github.com/twigphp/Twig/pull/1813
https://github.com/twigphp/Twig/pull/1807
Nicolas
Grekas

The Template class added a new method
abstract class Twig_Template implements Twig_TemplateInterface
{
// ...
public function getSource()
{
// ...
}
}
Twig 1.22NEW

How to display the source code of the template
{% set template = _self %}
{{ template.source|e }}

How to display the source code of the template
{% set template = _self %}
{{ template.source|e }}
having the source code allows for
example to test if the template is
backwards/forwards compatible

The (dirty) secret of the getSource() method
/* default/index.html.twig */
class __TwigTemplate_c917e55e0a4ad9b0ed28003c15c48de756d875a69e121aca97d5a53e84eaef4f extends Twig_Template
{
public function __construct(Twig_Environment $env) { }
protected function doDisplay(array $context, array $blocks = array()) { // ... }
public function getTemplateName()
{
return "default/index.html.twig";
}
// ...
public function getDebugInfo()
{
return array ( 115 => 54, 109 => 53, 93 => 43, 68 => 22, 66 => 21, 57 => 15, 46 => 7, 41 => 4, 35 => 3, 11 => 1,);
}
}
/* {% extends 'base.html.twig' %}*/
/* */
/* {% block body %}*/
/* <div id="wrapper">*/
/* <div id="container">*/
/* <div id="welcome">*/
/* <h1><span>Welcome to</span> Symfony {{ constant('SymfonyComponentHttpKernelKernel::VERSION') }}</h1>*/
/* </div>*/
/* ... */
Compiled Twig templates include
its full source code at the bottom

Email delivery
whitelist
https://github.com/symfony/symfony-docs/pull/4924
https://github.com/symfony/symfony-docs/pull/4925
Terje
Bråten
E.
Weimann

In dev environment, redirect all emails
# app/config/config_dev.yml
swiftmailer:
delivery_address: dev@example.com

Whitelist some emails in dev environment
swiftmailer:
delivery_whitelist:
- "/notifications@example.com$/"
- "/^admin@*$/""

Whitelist some emails in dev environment
swiftmailer:
delivery_whitelist:
- "/notifications@example.com$/"
- "/^admin@*$/""
email addresses that match
the regular expression will be
sent (even in dev environment)

Environment
variables
http://github.com/symfony/symfony/pull/16403Fabien
Potencier

Setting ENV variables via the web server
<VirtualHost *:80>
ServerName Symfony
DocumentRoot "/path/to/symfony_2_app/web"
DirectoryIndex index.php index.html
SetEnv SYMFONY__DATABASE_USER user
SetEnv SYMFONY__DATABASE_PASSWORD secret
<Directory "/path/to/symfony_2_app/web">
AllowOverride All
Allow from All
</Directory>
</VirtualHost>
same as setting
database_user and
database_password
in parameters.yml

ENV variables are dumped into the container
// app/cache/dev/appDevDebugProjectContainer.xml
<container>
<parameters>
<parameter key="database_user">root</parameter>
<parameter key="database_password"> __secret__ </parameter>

</parameters>
</container>
// app/cache/prod/appProdProjectContainer.php
protected function getDefaultParameters()
{
return array(
// ...
'database_user' => 'root',
'database_password' => __secret__,
);
}
DEV
environment
PROD
environment

<container>
<parameters>

</parameters>
</container>
{
return array(
// ...
);
}
DEV
environment
PROD
environment
You can see the password.

<container>
<parameters>

</parameters>
</container>
{
return array(
// ...
);
}
DEV
environment
PROD
environment
You can see the password.
It's static (if ENV variable
changes, app breaks)

This is what you want…
{
return array(
// ...
'database_password' => getenv("SYMFONY__DATABASE_PASSWORD");
);
}

This is what you want…
{
return array(
// ...
'database_password' => getenv("SYMFONY__DATABASE_PASSWORD");
);
}
… but we failed at
implementing this feature.

github.com/symfony/symfony/pull/16403

github.com/Incenteev/DynamicParametersBundle

Alternative to
environment
variables

1. Create a "credentials" file in the prod server
# /etc/credentials/example.com.yml
parameters:
database_user: ...
database_password: ...
mailer_user: ...
mailer_password: ...
secret: ...
github_client_id: ...
github_client_secret: ...

2. Load the credentials file in the application
imports:
- { resource: parameters.yml }
- { resource: services.yml }
- { resource: security.yml }
- { resource: admin.yml }
- { resource: '/etc/credentials/example.com.yml',
ignore_errors: true }
# ...

3. In "dev" machine
• Credentials file doesn't exist but no error is
triggered (because of ignore_errors).
• App uses the regular parameters.yml file.

4. In "prod" machine
• Credentials file overrides parameters.yml
• The right parameters are available
anywhere (e.g. console commands)
• Developers can't see the production
configuration options.
• Requires discipline to add/remove options.

Creating a custom channel is painless
monolog:
channels: ["marketing"]

monolog:
$this->get('monolog.logger.marketing')->info('......');

monolog:
# app/logs/dev.log
[2015-11-30 17:44:19] marketing.INFO: ...... [] []

monolog:
now you can process these
messages apart from the
rest of logs (e.g. save them
in a different file)
# app/logs/dev.log
[2015-11-30 17:44:19] marketing.INFO: ...... [] []

The channel name can be a parameter
parameters:
app_channel: 'marketing'
monolog:
channels: [%app_channel%]
services:
app_logger:
class: ...
tags: [{ name: monolog.logger, channel: %app_channel% }]
MonologBundle 2.8NEW

Custom
formatters
Grégoire
Pineau
http://symfony.com/doc/current/cookbook/logging/monolog.html#changing- 
the-formatter

This is what we
said during
SymfonyCon 2014
Custom monolog processor
namespace AppBundleLoggerOrderProcessor;
use AppBundleEntityOrder;
class OrderProcessor
{
public function __invoke(array $record)
{
if (isset($record['context']['order']) && $record['context']['order'] instanceof Order) {
$order = $record['context']['order'];
$record['context']['order'] = [
'number' => $order->getNumber(),
'user' => $order->get...,
'total' => $order->get...,
'status' => $order->get...,
];
}
return $record;
}
# app/config/config_prod.yml
services:
monolog_processor:
class: AppBundleLoggerOrderProcessor
tags:
- { name: monolog.processor }

Creating simple custom formatters is painless
services:
app.log.formatter:
class: 'MonologFormatterLineFormatter'
public: false
arguments:
- "%%level_name%% [%%datetime%%] [%%channel%%] %%message%%n 
%%context%%nn"
- 'H:i:s'
- false

services:
app.log.formatter:
public: false
arguments:
%%context%%nn"
- 'H:i:s'
- false
the format of
each log line

services:
app.log.formatter:
public: false
arguments:
%%context%%nn"
- 'H:i:s'
- false
the format of
each log line
the format of
%datetime% placeholder

services:
app.log.formatter:
public: false
arguments:
%%context%%nn"
- 'H:i:s'
- false
the format of
each log line
the format of
%datetime% placeholder
ignore n inside the
log messages?

Enable the custom log formatter
monolog:
handlers:
main:
type: stream
path: "%kernel.logs_dir%/%kernel.environment%.log"
level: debug
formatter: app.log.formatter
add the formatter option

Custom log format Default log format
INFO [18:38:21] [php] The SymfonyComponent
DependencyInjectionReference::isStrict method is
deprecated since version 2.8 and will be removed in 3.0.
{"type":16384,"file":"myproject/vendor/symfony/symfony/
src/Symfony/Component/DependencyInjection/
Reference.php","line":73,"level":28928}
INFO [18:38:21] [request] Matched route "homepage".
{"route_parameters":{"_controller":"AppBundle
Controller
DefaultController::indexAction","_route":"homepage"},"r
equest_uri":"http://127.0.0.1:8000/"}
INFO [18:38:21] [security] Populated the TokenStorage
with an anonymous Token.
[]
DEBUG [18:38:21] [event] Notified event "kernel.request"
to listener "SymfonyComponentHttpKernelEventListener
DebugHandlersListener::configure".
[]
DEBUG [18:38:21] [event] Notified event "kernel.request"
to listener "SymfonyComponentHttpKernelEventListener
ProfilerListener::onKernelRequest".
[2015-11-30 18:38:21] php.INFO: The SymfonyComponent
DependencyInjectionReference::isStrict method is
deprecated since version 2.8 and will be removed in 3.0.
{"type":16384,"file":"myproject/vendor/symfony/symfony/
src/Symfony/Component/DependencyInjection/
Reference.php","line":73,"level":28928} []
[2015-11-30 18:38:21] request.INFO: Matched route
"homepage". {"route_parameters":
{"_controller":"AppBundleController
DefaultController::indexAction","_route":"homepage"},"r
equest_uri":"http://127.0.0.1:8000/"} []
[2015-11-30 18:38:21] security.INFO: Populated the
TokenStorage with an anonymous Token. [] []
[2015-11-30 18:38:21] event.DEBUG: Notified event
"kernel.request" to listener "SymfonyComponent
HttpKernelEventListener
DebugHandlersListener::configure". [] []
HttpKernelEventListener
ProfilerListener::onKernelRequest". [] []
HttpKernelEventListenerDumpListener::configure". []
[]

Monolog
"plugins"
Jordi
Boggiano
http://github.com/Seldaek/monolog/wiki/Third-Party-Packages

github.com/Seldaek/monolog/wiki/Third-Party-Packages

bramus/monolog-colored-line-formatter
• Shows log messages in color according to
their level.
• It uses ANSI Escape Sequences.

Colored logs in action
if your editor or
console supports
ANSI escape
sequences

Colored logs in action
if your editor or
console doesn't
support ANSI
escape sequences

Christophe
Coevoet
Tweaking the
web debug
toolbar
http://symfony.com/doc/current/cookbook/profiler/data_collector.html

The new web debug toolbar
the new toolbar is less cluttered because it
hides panels that don't contain information

Reordering toolbar panels
services:
data_collector.request:
class: SymfonyComponentHttpKernelDataCollectorRequestDataCollector
tags:
- { name: "data_collector", template: "@WebProfiler/Collector/request.html.twig",
id: "request", priority: "-512" }
data_collector.security:
class: 'SymfonyBundleSecurityBundleDataCollectorSecurityDataCollector'
arguments: ['@security.token_storage', '@security.role_hierarchy', '@security.logout_url_generator']
tags:
- { name: "data_collector", template: "@Security/Collector/security.html.twig",
id: "security", priority: "512" }

Built-in panels priorities
Panel Priority
request 335
time 330
memory 325
ajax 315
form 310
exception 305
logger 300
events 290
Panel Priority
router 285
translation 275
security 270
twig 257
swiftmailer 245
dump 240
config -255

Adding your panels between the built-in panels
services:
app.data_collector:
# ...
tags:
- { name: "data_collector", template: "...", id: "..." } (NO EXPLICIT PRIORITY)

services:
app.data_collector:
# ...
tags:
tags:
- { name: "data_collector", template: "...", id: "...", priority: "273" }

services:
app.data_collector:
# ...
tags:
tags:
tags:

Remove panels
services:
data_collector.translation:
class: SymfonyComponentTranslationDataCollectorTranslationDataCollector
arguments: ['@translator.data_collector']
tags:
- { name: "data_collector" }
tags:
to remove a panel, define its service without
any argument in its data_collector tag

Remove panels
services:
data_collector.translation:
class: SymfonyComponentTranslationDataCollectorTranslationDataCollector
arguments: ['@translator.data_collector']
tags:
tags:
to remove a panel, define its service without
any argument in its data_collector tag
remove the Translation panel
remove the Request panel

Success and
failure handlers
https://github.com/symfony/symfony-docs/issues/4258Fabien
Potencier

Success/failure handlers are
available since Symfony 2.0
(2011) …

Success/failure handlers are
available since Symfony 2.0
(2011) …
… but lots of developers
don't use them because they
are not documented.

The security.interactive_login event
services:
login_listener:
class: AppBundleListenerLoginListener
arguments: ['@security.token_storage', '@doctrine']
tags:
- { name: 'kernel.event_listener', event: 'security.interactive_login' }
the most common event to "do things"
after the user successfully logs in

Defining a success handler
namespace AppBundleSecurity;
use SymfonyComponentSecurityHttpAuthenticationAuthenticationSuccessHandlerInterface;
class LoginHandler implements AuthenticationSuccessHandlerInterface
{
public function onAuthenticationSuccess(Request $request, TokenInterface $token)
{
// do something ...
return $this->redirect('...');
return new Response('...');
}
}

{
{
// do something ...
}
}
you just need to implement
this interface…

{
{
// do something ...
}
}
you just need to implement
this interface…
…and return a Response
instance

Enabling the success handler
services:
app.login_handler:
class: AppBundleSecurityLoginHandler
arguments: ...
# app/config/security.yml
firewalls:
main:
pattern: ^/
form_login:
success_handler: app.login_handler

Enabling the success handler
services:
app.login_handler:
class: AppBundleSecurityLoginHandler
arguments: ...
# app/config/security.yml
firewalls:
main:
pattern: ^/
form_login:
success_handler: app.login_handler
the LoginHandler class is
executed when the user logs
in successfully and after the
event.interactive_login

Meaningful
data providers
http://www.thisprogrammingthing.com/2015/making-dataproviders-more-maintainableScott
Warren

Common data providers
public function getUserData()
{
return array(
array(true, false, false),
array(true, true, false),
array(true, true, true),
);
}
/** @dataProvider getUserData */
public function testRegistration($register, $enable, $notify)
{
// ...
}

When an error happens…
$ phpunit -c app
F..
Time: 137 ms, Memory: 12.50Mb
There was 1 failure:
1) AppBundleTestsControllerDefaultControllerTest::testRegistration
with data set #0 (true, false, false)
very hard to understand
the exact error

Meaningful data providers
public function getUserData()
{
return array(
'register user only' => array(true, false, false),
'register and enable' => array(true, true, false),
'register, enable and notify' => array(true, true, true),
);
}
/** @dataProvider getUserData */
public function testRegistration($register, $enable, $notify)
{
// ...
}
array keys are the
labels of each data set

When an error happens…
$ phpunit -c app
F..
Time: 137 ms, Memory: 12.50Mb
There was 1 failure:
1) AppBundleTestsControllerDefaultControllerTest::testRegistration
with data set "register user only" (true, false, false)
meaningful error
messages

Generating
data providers
http://php.net/manual/en/language.generators.overview.phpTugdual
Saunier

Common data providers
public function dataProvider()
{
public function providerBasicDrivers()
{
return array(
array('doctrine.orm.cache.apc.class', array('type' => 'apc')),
array('doctrine.orm.cache.array.class', array('type' => 'array')),
array('doctrine.orm.cache.xcache.class', array('type' => 'xcache')),
array('doctrine.orm.cache.wincache.class', array('type' => 'wincache')),
array('doctrine.orm.cache.zenddata.class', array('type' => 'zenddata')),
);
}
}

Data providers using PHP generators
{
{
yield ['doctrine.orm.cache.apc.class', ['type' => 'apc']];
yield ['doctrine.orm.cache.array.class', ['type' => 'array']];
yield ['doctrine.orm.cache.xcache.class', ['type' => 'xcache']];
yield ['doctrine.orm.cache.wincache.class', ['type' => 'wincache']];
yield ['doctrine.orm.cache.zenddata.class', ['type' => 'zenddata']];
}
}
PHP 5.5NEW

Data providers using PHP generators
{
{
yield ['doctrine.orm.cache.apc.class', ['type' => 'apc']];
yield ['doctrine.orm.cache.array.class', ['type' => 'array']];
yield ['doctrine.orm.cache.xcache.class', ['type' => 'xcache']];
yield ['doctrine.orm.cache.wincache.class', ['type' => 'wincache']];
yield ['doctrine.orm.cache.zenddata.class', ['type' => 'zenddata']];
}
}
PHP 5.5NEW
it reduces memory
consumption

Better setUp
and tearDown
https://phpunit.de/manual/current/en/appendixes.annotations.html
#appendixes.annotations.before
Sebastian
Bergmann

Common use of setUp( ) method in tests
class IntegrationTest extends PHPUnit_Framework_TestCase
{
private $rootDir;
private $fs;
public function setUp()
{
$this->rootDir = realpath(__DIR__.'/../../../../');
$this->fs = new Filesystem();
if (!$this->fs->exists($this->rootDir.'/symfony.phar')) {
throw new RuntimeException("...");
}
}
}

Common use of setUp( ) method in tests
{
private $rootDir;
private $fs;
{
}
}
}
public function tearDown()
public static function setUpBeforeClass()
public static function tearDownAfterClass()

Better alternative: @before annotation
{
private $rootDir;
private $fs;
/** @before */
public function initialize()
{
}
/** @before */
public function checkPharFile() {
}
}
}

{
private $rootDir;
private $fs;
/** @before */
{
}
/** @before */
}
}
}
you can define any number
of @before methods

{
private $rootDir;
private $fs;
/** @before */
{
}
/** @before */
}
}
}
you can define any number
of @before methods
order matters (first
method is executed first)

Alternatives to setUp and tearDown
{
/** @before */
public function initialize() { }
/** @after */
public function clean() { }
/** @beforeClass */
public static function initialize() { }
/** @afterClass */
public static function initialize() { }
}

Avoid risky
tests
https://phpunit.de/manual/current/en/risky-tests.htmlSebastian
Bergmann

Common PHPUnit configuration
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.1/phpunit.xsd"
backupGlobals="false"
colors="true"
bootstrap="vendor/autoload.php"
>
...
</phpunit>

Common PHPUnit configuration
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.1/phpunit.xsd"
backupGlobals="false"
colors="true"
bootstrap="vendor/autoload.php"
beStrictAboutTestsThatDoNotTestAnything="true"
checkForUnintentionallyCoveredCode="true"
beStrictAboutOutputDuringTests="true"
beStrictAboutTestSize="true"
beStrictAboutChangesToGlobalState="true"
>
...
</phpunit>
this strict configuration
will force you to create
better tests

Nicolas
Grekas
Deprecation
stack traces
https://github.com/symfony/symfony/pull/16709

Use the PHPUnit Bridge to detect deprecations
$ composer require --dev symfony/phpunit-bridge
$ phpunit -c app
PHPUnit by Sebastian Bergmann and contributors.
.................
Time: 3.7 seconds, Memory: 75.00Mb
OK (17 tests, 21 assertions)
Remaining deprecation notices (368)
OK (17 tests, 21 assertions)
Remaining deprecation notices (368)

When a deprecation occurs…
This information is
useful, but incomplete.
Often you need the
stack trace of the code
that triggered the
deprecation.

On-demand deprecation stack traces
// BEFORE
$ phpunit -c app
// AFTER
$ SYMFONY_DEPRECATIONS_HELPER=/Blog::index/
phpunit -c app
A regular expression that
is matched against
className::methodName

On-demand deprecation stack traces
$ SYMFONY_DEPRECATIONS_HELPER=/.*/ phpunit -c app
The class "SymfonyBundleAsseticBundleConfigAsseticResource" is performing resource 
checking through ResourceInterface::isFresh(), which is deprecated since 2.8 and will be removed in 3.0
Stack trace: 
#0 vendor/symfony/symfony/src/Symfony/Component/Config/Resource/BCResourceInterfaceChecker.php(32): 
trigger_error() 
#1 app/bootstrap.php.cache(3061): SymfonyComponentConfigResourceBCResourceInterfaceChecker->isFresh() 
#2 vendor/symfony/symfony/src/Symfony/Component/Config/ResourceCheckerConfigCacheFactory.php(45): 
SymfonyComponentConfigResourceCheckerConfigCache->isFresh() 
#3 vendor/symfony/symfony/src/Symfony/Component/Routing/Router.php(302): SymfonyComponentConfigResourceCheckerConfigCacheFactory->cache() 
#4 vendor/symfony/symfony/src/Symfony/Component/Routing/Router.php(250): SymfonyComponentRoutingRouter->getMatcher() 
#5 vendor/symfony/symfony/src/Symfony/Component/HttpKernel/EventListener/RouterListener.php(154): SymfonyComponentRoutingRouter->matchRequest() 
#6 [internal function]: SymfonyComponentHttpKernelEventListenerRouterListener->onKernelRequest() 
#7 vendor/symfony/symfony/src/Symfony/Component/EventDispatcher/Debug/WrappedListener.php(61): call_user_func() 
#8 [internal function]: SymfonyComponentEventDispatcherDebugWrappedListener->__invoke() 
#9 vendor/symfony/symfony/src/Symfony/Component/EventDispatcher/EventDispatcher.php(181): call_user_func() 
#10 vendor/symfony/symfony/src/Symfony/Component/EventDispatcher/EventDispatcher.php(46): SymfonyComponentEventDispatcherEventDispatcher->doDispatch() 
#11 vendor/symfony/symfony/src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.php(132): SymfonyComponentEventDispatcherEventDispatcher-
>dispatch() 
#12 app/bootstrap.php.cache(3178): SymfonyComponentEventDispatcherDebugTraceableEventDispatcher->dispatch() 
#13 app/bootstrap.php.cache(3151): SymfonyComponentHttpKernelHttpKernel->handleRaw() 
#14 app/bootstrap.php.cache(3302): SymfonyComponentHttpKernelHttpKernel->handle() 
#15 app/bootstrap.php.cache(2498): SymfonyComponentHttpKernelDependencyInjectionContainerAwareHttpKernel->handle() 
#16 vendor/symfony/symfony/src/Symfony/Component/HttpKernel/Client.php(79): SymfonyComponentHttpKernelKernel->handle() 
#17 vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Client.php(131): SymfonyComponentHttpKernelClient->doRequest() 
#18 vendor/symfony/symfony/src/Symfony/Component/BrowserKit/Client.php(317): SymfonyBundleFrameworkBundleClient->doRequest() 
#19 src/AppBundle/Tests/Controller/Admin/BlogControllerTest.php(42): SymfonyComponentBrowserKitClient->request() 
#20 [internal function]: AppBundleTestsControllerAdminBlogControllerTest->testRegularUsersCannotAccessToTheBackend() 
#21 {main}
It stops at the first
deprecation and shows
its stack trace

Smoke testing
for services
Benjamin
Eberlei
http://www.whitewashing.de/2015/06/12/the_containertest.html

«Smoke Tests are an
early warning for when
things go wrong»

Automatic "smoke testing" for services
public function testContainerServices()
{
$client = static::createClient();
foreach ($client->getContainer()->getServiceIds() as $serviceId) {
$service = $client->getContainer()->get($serviceId);
$this->assertNotNull($service);
}
}

{
}
}
get all services defined
by the container

{
}
}
get all services defined
by the container
try to instantiate all of
them to look for errors

{
try {
} catch(InactiveScopeException $e) { }
}
}
you may need this try … catch to avoid
issues with request related services

Manual "smoke testing" for important services
public static function dataServices()
{
return [
['app.datetimepicker', 'AppBundleFormTypeDateTimePickerType'],
['app.redirect_listener', 'AppBundleEventListenerRedirectToPreferredLocaleListener'],
];
}
/** @dataProvider dataServices */
public function testImportantServices($id, $class)
{
$service = $client->getContainer()->get($id);
$this->assertInstanceOf($class, $service);
}
check that the service
is instantiable and that
the returned class is
the right one

Services
benchmark
Alexandre
Salomé
https://speakerdeck.com/alexandresalome/french-symfony2-et-performances

Service instantiation should not take too long
{
try {
$startedAt = microtime(true);
$elapsed = (microtime(true) - $startedAt) * 1000;
$this->assertLessThan(50, $elapsed);
} catch(InactiveScopeException $e) {
}
}
}

Service instantiation should not take too long
{
try {
$startedAt = microtime(true);
$elapsed = (microtime(true) - $startedAt) * 1000;
$this->assertLessThan(50, $elapsed);
} catch(InactiveScopeException $e) {
}
}
}
services should be
created in 50ms or less

Most expensive
services in
Symfony Standard
Service Time (ms)
cache_warmer 42.95
doctrine.orm.default_entity_manager 14.05
web_profiler.controller.router 11.88
swiftmailer.mailer.default 6.65
profiler 5.45
annotation_reader 4.53
doctrine.dbal.default_connection 4.22
form.type_extension.form.validator 4.13
routing.loader 4.02
form.type.choice 3.10

Simpler
command
interactions
Nikita
Gusakov
https://github.com/symfony/swiftmailer-bundle/blob/master/Command/
NewEmailCommand.php

Common lifecycle of a command
class MyCustomCommand extends ContainerAwareCommand
{
protected function configure()
{
}
protected function execute(InputInterface $input, OutputInterface $output)
{
}
}

Full lifecycle of a command
class MyCustomCommand extends ContainerAwareCommand
{
protected function configure()
{ }
protected function initialize(InputInterface $input, OutputInterface $output)
{ }
protected function interact(InputInterface $input, OutputInterface $output)
{ }
{ }
}
here you can ask the user for
any missing option or argument

Ask for any missing command argument
class MyCommand extends ContainerAwareCommand
{
// ...
protected function interact(InputInterface $input, OutputInterface $output)
{
$dialog = $this->getHelper('dialog');
foreach ($input->getArguments() as $argument => $value) {
if ($value === null) {
$input->setArgument($argument, $dialog->ask($output,
sprintf('<question>%s</question>: ', ucfirst($argument))
));
}
}
}
}
the interact() method is usually
very verbose. This is the minimal
useful interact() method.

Most commands are a mess
$description = $this->formatSection(
'container', sprintf('Information for service <info>%s</info>', $options['id']))
."n".sprintf('<comment>Service Id</comment> %s', isset($options['id']) ? $options['id'] : '-')
."n".sprintf('<comment>Class</comment> %s', get_class($service)
);
$description[] = sprintf('<comment>Scope</comment> %s', $definition->getScope(false));
$description[] = sprintf('<comment>Public</comment> %s', $definition->isPublic() ? 'yes' : 'no');
$description[] = sprintf('<comment>Synthetic</comment> %s', $definition->isSynthetic() ? 'yes' : 'no');
$description[] = sprintf('<comment>Lazy</comment> %s', $definition->isLazy() ? 'yes' : 'no');
$this->writeText($description, $options);

Most commands are a mess
$description = $this->formatSection(
'container', sprintf('Information for service <info>%s</info>', $options['id']))
."n".sprintf('<comment>Service Id</comment> %s', isset($options['id']) ? $options['id'] : '-')
."n".sprintf('<comment>Class</comment> %s', get_class($service)
);
$description[] = sprintf('<comment>Scope</comment> %s', $definition->getScope(false));
$description[] = sprintf('<comment>Public</comment> %s', $definition->isPublic() ? 'yes' : 'no');
$description[] = sprintf('<comment>Synthetic</comment> %s', $definition->isSynthetic() ? 'yes' : 'no');
$description[] = sprintf('<comment>Lazy</comment> %s', $definition->isLazy() ? 'yes' : 'no');
$this->writeText($description, $options);
you are mixing content with
presentation, like in the good
old days of HTML+CSS

The new "Style Guide"
makes built-in commands
visually consistent.

You can use it in your own commands too
use SymfonyComponentConsoleStyleSymfonyStyle;
class MyCustomCommand
{
// ...
{
$io = new SymfonyStyle($input, $output);
$io->...
// ...
}
}

Displaying a title (BEFORE)
// alternative 1
$formatter = $this->getHelperSet()->get('formatter');
$formattedBlock = $formatter->formatBlock($title, '', true);
$output->writeln($formattedBlock);
// alternative 2
$title = 'Lorem Ipsum Dolor Sit Amet';
$output->writeln('<info>'.$title.'</info>');
$output->writeln(str_repeat('=', strlen($title)));
// alternative 3
$output->writeln('');
$output->writeln('Add User Command Interactive Wizard');
$output->writeln('-----------------------------------');

Displaying a title (AFTER)
$io->title('Lorem Ipsum Dolor Sit Amet');

Displaying a table (BEFORE)
$table = new Table($this->getOutput());
$table->setStyle('compact');
$table->setHeaders(['Parameter', 'Value']);
$table->addRow(['...', '...']);
$table->addRow(['...', '...']);
$table->addRow(['...', '...']);
$table->render();

Displaying a table (AFTER)
$headers = ['Parameter', 'Value'];
$rows = [ ... ];
$io->table($headers, $rows);

All the common features are covered
$io->title();
$io->section();
$io->text();
$io->listing();
$io->table();
$io->choice();
$io->success();
$io->error();
$io->warning();
$io->ask();
$io->askHidden();
$io->confirm();

Create consistent commands effortlesslyFull Sample Command
$ php app/console command
Lorem Ipsum Dolor Sit Amet
==========================
// Duis aute irure dolor in reprehenderit in voluptate velit esse
// cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
Name Method Scheme Host Path
----------------- ------ ------ ---- ---------------------
admin_post_new ANY ANY ANY /admin/post/new
admin_post_show GET ANY ANY /admin/post/{id}
admin_post_edit ANY ANY ANY /admin/post/{id}/edit
admin_post_delete DELETE ANY ANY /admin/post/{id}
----------------- ------ ------ ---- ---------------------
! [CAUTION] Lorem ipsum dolor sit amet, consectetur adipisicing elit,
! sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
! Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.
Consectetur Adipisicing Elit Sed Do Eiusmod
-------------------------------------------
* Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.
* Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
aliquip ex ea commodo.
* Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt
mollit anim id est laborum.
Bundle namespace:
> AppBundle <Enter>
Bundle name [AcmeAppBundle]:
> <Enter>
Configuration format (yml, xml, php, annotation) [annotation]:
> <Enter>
Command title
All types of questions
Section title
List
Info message
Table
Caution admonition
! Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.
Consectetur Adipisicing Elit Sed Do Eiusmod
-------------------------------------------
* Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.
* Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
aliquip ex ea commodo.
* Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt
mollit anim id est laborum.
Bundle namespace:
> AppBundle <Enter>
Bundle name [AcmeAppBundle]:
> <Enter>
Configuration format (yml, xml, php, annotation) [annotation]:
> <Enter>
Do you want to enable the bundle? (yes/no) [yes]:
> <Enter>
Configuration format (select one) [annotation]:
> yml
> xml
> php
> annotation
! [NOTE] Duis aute irure dolor in reprehenderit in voluptate velit esse
! cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat.
[OK] Lorem ipsum dolor sit amet, consectetur adipisicing elit
[ERROR] Duis aute irure dolor in reprehenderit in voluptate velit esse.
[WARNING] Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi.
All ty
Secti
List
All ty
resul
Note

Contact information
javier.eguiluz@sensiolabs.com

New Symfony Tips & Tricks (SymfonyCon Paris 2015)

New Symfony Tips & Tricks (SymfonyCon Paris 2015)

More Related Content

What's hot (20)

Viewers also liked (20)

Similar to New Symfony Tips & Tricks (SymfonyCon Paris 2015) (20)

More from Javier Eguiluz (19)

Recently uploaded (20)

New Symfony Tips & Tricks (SymfonyCon Paris 2015)