Internals

Caution: You are browsing the documentation for Symfony version 2.0 which is not maintained anymore. If some of your projects are still using this version, consider upgrading to Symfony 2.5.

Internals

Looks like you want to understand how Symfony2 works and how to extend it. That makes me very happy! This section is an in-depth explanation of the Symfony2 internals.

Note

You need to read this section only if you want to understand how Symfony2 works behind the scene, or if you want to extend Symfony2.

Overview

The Symfony2 code is made of several independent layers. Each layer is built on top of the previous one.

Tip

Autoloading is not managed by the framework directly; it's done independently with the help of the UniversalClassLoader class and the src/autoload.php file. Read the dedicated chapter for more information.

HttpFoundation Component

The deepest level is the HttpFoundation component. HttpFoundation provides the main objects needed to deal with HTTP. It is an Object-Oriented abstraction of some native PHP functions and variables:

  • The Request class abstracts the main PHP global variables like $_GET, $_POST, $_COOKIE, $_FILES, and $_SERVER;
  • The Response class abstracts some PHP functions like header(), setcookie(), and echo;
  • The Session class and SessionStorageInterface interface abstract session management session_*() functions.

Note

Read more about the HttpFoundation Component.

HttpKernel Component

On top of HttpFoundation is the HttpKernel component. HttpKernel handles the dynamic part of HTTP; it is a thin wrapper on top of the Request and Response classes to standardize the way requests are handled. It also provides extension points and tools that makes it the ideal starting point to create a Web framework without too much overhead.

It also optionally adds configurability and extensibility, thanks to the Dependency Injection component and a powerful plugin system (bundles).

See also

Read more about the HttpKernel Component, Dependency Injection and Bundles.

FrameworkBundle Bundle

The FrameworkBundle bundle is the bundle that ties the main components and libraries together to make a lightweight and fast MVC framework. It comes with a sensible default configuration and conventions to ease the learning curve.

Kernel

The HttpKernel class is the central class of Symfony2 and is responsible for handling client requests. Its main goal is to "convert" a Request object to a Response object.

Every Symfony2 Kernel implements HttpKernelInterface:

1
function handle(Request $request, $type = self::MASTER_REQUEST, $catch = true)

Controllers

To convert a Request to a Response, the Kernel relies on a "Controller". A Controller can be any valid PHP callable.

The Kernel delegates the selection of what Controller should be executed to an implementation of ControllerResolverInterface:

1
2
3
public function getController(Request $request);

public function getArguments(Request $request, $controller);

The getController() method returns the Controller (a PHP callable) associated with the given Request. The default implementation (ControllerResolver) looks for a _controller request attribute that represents the controller name (a "class::method" string, like Bundle\BlogBundle\PostController:indexAction).

Tip

The default implementation uses the RouterListener to define the _controller Request attribute (see kernel.request Event).

The getArguments() method returns an array of arguments to pass to the Controller callable. The default implementation automatically resolves the method arguments, based on the Request attributes.

For each method argument, Symfony2 tries to get the value of a Request attribute with the same name. If it is not defined, the argument default value is used if defined:

1
2
3
4
5
6
// Symfony2 will look for an 'id' attribute (mandatory)
// and an 'admin' one (optional)
public function showAction($id, $admin = true)
{
    // ...
}

Handling Requests

The handle() method takes a Request and always returns a Response. To convert the Request, handle() relies on the Resolver and an ordered chain of Event notifications (see the next section for more information about each Event):

  1. Before doing anything else, the kernel.request event is notified -- if one of the listeners returns a Response, it jumps to step 8 directly;
  2. The Resolver is called to determine the Controller to execute;
  3. Listeners of the kernel.controller event can now manipulate the Controller callable the way they want (change it, wrap it, ...);
  4. The Kernel checks that the Controller is actually a valid PHP callable;
  5. The Resolver is called to determine the arguments to pass to the Controller;
  6. The Kernel calls the Controller;
  7. If the Controller does not return a Response, listeners of the kernel.view event can convert the Controller return value to a Response;
  8. Listeners of the kernel.response event can manipulate the Response (content and headers);
  9. The Response is returned.

If an Exception is thrown during processing, the kernel.exception is notified and listeners are given a chance to convert the Exception to a Response. If that works, the kernel.response event is notified; if not, the Exception is re-thrown.

If you don't want Exceptions to be caught (for embedded requests for instance), disable the kernel.exception event by passing false as the third argument to the handle() method.

Internal Requests

At any time during the handling of a request (the 'master' one), a sub-request can be handled. You can pass the request type to the handle() method (its second argument):

  • HttpKernelInterface::MASTER_REQUEST;
  • HttpKernelInterface::SUB_REQUEST.

The type is passed to all events and listeners can act accordingly (some processing must only occur on the master request).

Events

Each event thrown by the Kernel is a subclass of KernelEvent. This means that each event has access to the same basic information:

  • getRequestType() - returns the type of the request (HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST);
  • getKernel() - returns the Kernel handling the request;
  • getRequest() - returns the current Request being handled.

getRequestType()

The getRequestType() method allows listeners to know the type of the request. For instance, if a listener must only be active for master requests, add the following code at the beginning of your listener method:

1
2
3
4
5
6
use Symfony\Component\HttpKernel\HttpKernelInterface;

if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
    // return immediately
    return;
}

Tip

If you are not yet familiar with the Symfony2 Event Dispatcher, read the Event Dispatcher Component Documentation section first.

kernel.request Event

Event Class: GetResponseEvent

The goal of this event is to either return a Response object immediately or setup variables so that a Controller can be called after the event. Any listener can return a Response object via the setResponse() method on the event. In this case, all other listeners won't be called.

This event is used by FrameworkBundle to populate the _controller Request attribute, via the RouterListener. RequestListener uses a RouterInterface object to match the Request and determine the Controller name (stored in the _controller Request attribute).

See also

Read more on the kernel.request event.

kernel.controller Event

Event Class: FilterControllerEvent

This event is not used by FrameworkBundle, but can be an entry point used to modify the controller that should be executed:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
use Symfony\Component\HttpKernel\Event\FilterControllerEvent;

public function onKernelController(FilterControllerEvent $event)
{
    $controller = $event->getController();
    // ...

    // the controller can be changed to any PHP callable
    $event->setController($controller);
}

See also

Read more on the kernel.controller event.

kernel.view Event

Event Class: GetResponseForControllerResultEvent

This event is not used by FrameworkBundle, but it can be used to implement a view sub-system. This event is called only if the Controller does not return a Response object. The purpose of the event is to allow some other return value to be converted into a Response.

The value returned by the Controller is accessible via the getControllerResult method:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
use Symfony\Component\HttpFoundation\Response;

public function onKernelView(GetResponseForControllerResultEvent $event)
{
    $val = $event->getControllerResult();
    $response = new Response();

    // ... some how customize the Response from the return value

    $event->setResponse($response);
}

See also

Read more on the kernel.view event.

kernel.response Event

Event Class: FilterResponseEvent

The purpose of this event is to allow other systems to modify or replace the Response object after its creation:

1
2
3
4
5
6
public function onKernelResponse(FilterResponseEvent $event)
{
    $response = $event->getResponse();

    // ... modify the response object
}

The FrameworkBundle registers several listeners:

See also

Read more on the kernel.response event.

kernel.exception Event

Event Class: GetResponseForExceptionEvent

FrameworkBundle registers an ExceptionListener that forwards the Request to a given Controller (the value of the exception_listener.controller parameter -- must be in the class::method notation).

A listener on this event can create and set a Response object, create and set a new Exception object, or do nothing:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
use Symfony\Component\HttpFoundation\Response;

public function onKernelException(GetResponseForExceptionEvent $event)
{
    $exception = $event->getException();
    $response = new Response();
    // setup the Response object based on the caught exception
    $event->setResponse($response);

    // you can alternatively set a new Exception
    // $exception = new \Exception('Some special exception');
    // $event->setException($exception);
}

The Event Dispatcher

The event dispatcher is a standalone component that is responsible for much of the underlying logic and flow behind a Symfony request. For more information, see the Event Dispatcher Component Documentation.

See also

Read more on the kernel.exception event.

Profiler

When enabled, the Symfony2 profiler collects useful information about each request made to your application and store them for later analysis. Use the profiler in the development environment to help you to debug your code and enhance performance; use it in the production environment to explore problems after the fact.

You rarely have to deal with the profiler directly as Symfony2 provides visualizer tools like the Web Debug Toolbar and the Web Profiler. If you use the Symfony2 Standard Edition, the profiler, the web debug toolbar, and the web profiler are all already configured with sensible settings.

Note

The profiler collects information for all requests (simple requests, redirects, exceptions, Ajax requests, ESI requests; and for all HTTP methods and all formats). It means that for a single URL, you can have several associated profiling data (one per external request/response pair).

Visualizing Profiling Data

Using the Web Debug Toolbar

In the development environment, the web debug toolbar is available at the bottom of all pages. It displays a good summary of the profiling data that gives you instant access to a lot of useful information when something does not work as expected.

If the summary provided by the Web Debug Toolbar is not enough, click on the token link (a string made of 13 random characters) to access the Web Profiler.

Note

If the token is not clickable, it means that the profiler routes are not registered (see below for configuration information).

Analyzing Profiling data with the Web Profiler

The Web Profiler is a visualization tool for profiling data that you can use in development to debug your code and enhance performance; but it can also be used to explore problems that occur in production. It exposes all information collected by the profiler in a web interface.

Accessing the Profiling information

You don't need to use the default visualizer to access the profiling information. But how can you retrieve profiling information for a specific request after the fact? When the profiler stores data about a Request, it also associates a token with it; this token is available in the X-Debug-Token HTTP header of the Response:

1
2
3
$profile = $container->get('profiler')->loadProfileFromResponse($response);

$profile = $container->get('profiler')->loadProfile($token);

Tip

When the profiler is enabled but not the web debug toolbar, or when you want to get the token for an Ajax request, use a tool like Firebug to get the value of the X-Debug-Token HTTP header.

Use the find() method to access tokens based on some criteria:

1
2
3
4
5
6
7
8
// get the latest 10 tokens
$tokens = $container->get('profiler')->find('', '', 10);

// get the latest 10 tokens for all URL containing /admin/
$tokens = $container->get('profiler')->find('', '/admin/', 10);

// get the latest 10 tokens for local requests
$tokens = $container->get('profiler')->find('127.0.0.1', '', 10);

If you want to manipulate profiling data on a different machine than the one where the information were generated, use the export() and import() methods:

1
2
3
4
5
6
// on the production machine
$profile = $container->get('profiler')->loadProfile($token);
$data = $profiler->export($profile);

// on the development machine
$profiler->import($data);

Configuration

The default Symfony2 configuration comes with sensible settings for the profiler, the web debug toolbar, and the web profiler. Here is for instance the configuration for the development environment:

  • YAML
    1
    2
    3
    4
    5
    6
    7
    8
    9
    # load the profiler
    framework:
        profiler: { only_exceptions: false }
    
    # enable the web profiler
    web_profiler:
        toolbar: true
        intercept_redirects: true
        verbose: true
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    <!-- xmlns:webprofiler="http://symfony.com/schema/dic/webprofiler" -->
    <!-- xsi:schemaLocation="http://symfony.com/schema/dic/webprofiler http://symfony.com/schema/dic/webprofiler/webprofiler-1.0.xsd"> -->
    
    <!-- load the profiler -->
    <framework:config>
        <framework:profiler only-exceptions="false" />
    </framework:config>
    
    <!-- enable the web profiler -->
    <webprofiler:config
        toolbar="true"
        intercept-redirects="true"
        verbose="true"
    />
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    // load the profiler
    $container->loadFromExtension('framework', array(
        'profiler' => array('only-exceptions' => false),
    ));
    
    // enable the web profiler
    $container->loadFromExtension('web_profiler', array(
        'toolbar'             => true,
        'intercept-redirects' => true,
        'verbose'             => true,
    ));
    

When only-exceptions is set to true, the profiler only collects data when an exception is thrown by the application.

When intercept-redirects is set to true, the web profiler intercepts the redirects and gives you the opportunity to look at the collected data before following the redirect.

When verbose is set to true, the Web Debug Toolbar displays a lot of information. Setting verbose to false hides some secondary information to make the toolbar shorter.

If you enable the web profiler, you also need to mount the profiler routes:

  • YAML
    _profiler:
        resource: @WebProfilerBundle/Resources/config/routing/profiler.xml
        prefix:   /_profiler
  • XML
    1
    <import resource="@WebProfilerBundle/Resources/config/routing/profiler.xml" prefix="/_profiler" />
    
  • PHP
    1
    $collection->addCollection($loader->import("@WebProfilerBundle/Resources/config/routing/profiler.xml"), '/_profiler');
    

As the profiler adds some overhead, you might want to enable it only under certain circumstances in the production environment. The only-exceptions settings limits profiling to 500 pages, but what if you want to get information when the client IP comes from a specific address, or for a limited portion of the website? You can use a request matcher:

  • YAML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    # enables the profiler only for request coming for the 192.168.0.0 network
    framework:
        profiler:
            matcher: { ip: 192.168.0.0/24 }
    
    # enables the profiler only for the /admin URLs
    framework:
        profiler:
            matcher: { path: "^/admin/" }
    
    # combine rules
    framework:
        profiler:
            matcher: { ip: 192.168.0.0/24, path: "^/admin/" }
    
    # use a custom matcher instance defined in the "custom_matcher" service
    framework:
        profiler:
            matcher: { service: custom_matcher }
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    <!-- enables the profiler only for request coming for the 192.168.0.0 network -->
    <framework:config>
        <framework:profiler>
            <framework:matcher ip="192.168.0.0/24" />
        </framework:profiler>
    </framework:config>
    
    <!-- enables the profiler only for the /admin URLs -->
    <framework:config>
        <framework:profiler>
            <framework:matcher path="^/admin/" />
        </framework:profiler>
    </framework:config>
    
    <!-- combine rules -->
    <framework:config>
        <framework:profiler>
            <framework:matcher ip="192.168.0.0/24" path="^/admin/" />
        </framework:profiler>
    </framework:config>
    
    <!-- use a custom matcher instance defined in the "custom_matcher" service -->
    <framework:config>
        <framework:profiler>
            <framework:matcher service="custom_matcher" />
        </framework:profiler>
    </framework:config>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    // enables the profiler only for request coming for the 192.168.0.0 network
    $container->loadFromExtension('framework', array(
        'profiler' => array(
            'matcher' => array('ip' => '192.168.0.0/24'),
        ),
    ));
    
    // enables the profiler only for the /admin URLs
    $container->loadFromExtension('framework', array(
        'profiler' => array(
            'matcher' => array('path' => '^/admin/'),
        ),
    ));
    
    // combine rules
    $container->loadFromExtension('framework', array(
        'profiler' => array(
            'matcher' => array('ip' => '192.168.0.0/24', 'path' => '^/admin/'),
        ),
    ));
    
    # use a custom matcher instance defined in the "custom_matcher" service
    $container->loadFromExtension('framework', array(
        'profiler' => array(
            'matcher' => array('service' => 'custom_matcher'),
        ),
    ));
    

This work is licensed under a Creative Commons Attribution-Share Alike 3.0 Unported License .