Symfony

https://github.com/symfony/symfony-docs
Admin
Symfony is a set of reusable PHP components and a web application framework that simplifies the...
Tokens:1,766,337
Snippets:13,027
Trust Score:9.2
Update:3 days ago
Show doc for...
Tokens:
Raw
### Output of DebugFormatterHelper::start

Source: https://github.com/symfony/symfony-docs/blob/7.4/console/helpers/debug_formatter.rst

Example output of the start method, showing the 'RUN' prefix.

```text
 RUN Some process description
```

--------------------------------

### Running processes asynchronously with start() and isRunning()

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/process.rst

Shows how to start a process asynchronously, check if it is running, and get its output. The while loop waits for the process to finish.

```php
$process = new Process(['ls', '-lsa']);
$process->start();

while ($process->isRunning()) {
    // waiting for process to finish
}

echo $process->getOutput();
```

--------------------------------

### Scheduler task provider file header

Source: https://github.com/symfony/symfony-docs/blob/7.4/scheduler.rst

Incomplete example showing the start of a scheduler task provider file. The source does not include the full implementation.

```php
// src/Scheduler/SaleTaskProvider.php
namespace App\Scheduler;
```

--------------------------------

### Wait until process is ready with waitUntil

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/process.rst

Use Process::waitUntil with a callback that returns true when the process is fully initialized. The example starts a slow-starting server and waits until its output equals 'Ready. Waiting for commands...'.

```php
$process = new Process(['/usr/bin/php', 'slow-starting-server.php']);
$process->start();

// ... do other things

// waits until the given anonymous function returns true
$process->waitUntil(function ($type, $output): bool {
    return $output === 'Ready. Waiting for commands...';
});

// ... do things after the process is ready
```

--------------------------------

### Enable and start systemd worker instances

Source: https://github.com/symfony/symfony-docs/blob/7.4/messenger.rst

Commands to enable and start systemd user services for messenger workers. Use the @.service template to run multiple instances; the example enables and starts one worker and then 20 workers.

```terminal
$ systemctl --user enable messenger-worker@1.service
$ systemctl --user start messenger-worker@1.service

# to enable and start 20 workers
$ systemctl --user enable messenger-worker@{1..20}.service
$ systemctl --user start messenger-worker@{1..20}.service
```

--------------------------------

### Initial setup for documentation repository

Source: https://github.com/symfony/symfony-docs/blob/7.4/_build/maintainer_guide.rst

Commands to clone the fork and configure the necessary remotes and git settings for the documentation repository.

```terminal
# Clone your fork
$ git clone https://github.com/<YOUR-NAME>/symfony-docs.git

$ cd symfony-docs/

# Add the original repo as 'upstream' remote
$ git remote add upstream https://github.com/symfony/symfony-docs

# Add the original repo as 'gh' remote (needed for the 'gh' tool)
$ git remote add gh https://github.com/symfony/symfony-docs

# Configure 'gh' in Git as the remote used by the 'gh' tool
$ git config gh.remote gh
```

--------------------------------

### Looping through cookies (incomplete example)

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/browser_kit.rst

Starts the example for looping through cookies. The full code is not shown on the page.

```php
use Acme\Client;
```

--------------------------------

### Install CA and start server for HTTPS/TLS

Source: https://github.com/symfony/symfony-docs/blob/7.4/setup/symfony_cli.rst

Run these commands to enable HTTPS/TLS for the Symfony server. The first command installs the certificate authority once per machine; the second starts or restarts the server to use HTTPS automatically.

```terminal
# install the certificate authority (run this only once on your machine)
$ symfony server:ca:install

# now start (or restart) your server; it will use HTTPS automatically
$ symfony server:start
```

--------------------------------

### PHP: Configure services with auto-discovery and mailer DSN

Source: https://github.com/symfony/symfony-docs/blob/7.4/service_container.rst

Initial configuration example showing how to set up services with autowiring, autoconfiguration, and loading the App\ namespace, plus setting a mailer service with an environment variable argument.

```php
// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return function(ContainerConfigurator $container): void {
    $services = $container->services()
        ->defaults()
            ->autowire()
            ->autoconfigure();

    $services->load('App\\', '../src/');

    $services->set(App\Mailer\MyMailer::class)
        ->arg(0, '%env(MAILER_DSN)%');
};
```

--------------------------------

### Install VarExporter with Composer

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/var_exporter.rst

Install the VarExporter component as a development dependency using Composer. This is the required setup step before using the component.

```terminal
$ composer require --dev symfony/var-exporter
```

--------------------------------

### Basic usage of Filesystem and Path classes

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/filesystem.rst

Shows how to instantiate the Filesystem class and use mkdir with Path::normalize to create a directory in the system temp directory. Catches IOExceptionInterface to handle errors.

```php
use Symfony\Component\Filesystem\Exception\IOExceptionInterface;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Filesystem\Path;

$filesystem = new Filesystem();

try {
    $filesystem->mkdir(
        Path::normalize(sys_get_temp_dir().'/'.random_int(0, 1000)),
    );
} catch (IOExceptionInterface $exception) {
    echo "An error occurred while creating your directory at ".$exception->getPath();
}
```

--------------------------------

### Customize environment variable prefix for a Docker service

Source: https://github.com/symfony/symfony-docs/blob/7.4/setup/symfony_cli.rst

Use the com.symfony.server.service-prefix label to override the default environment variable prefix for a service. In this example, the service named 'db' would normally get DB_ prefixed variables, but setting the prefix to 'DATABASE' makes the web server create variables starting with DATABASE_ instead.

```yaml
services:
    db:
        image: postgres:15
        ports: [5432]
        labels:
            com.symfony.server.service-prefix: 'DATABASE'
```

--------------------------------

### Create a working HttpKernel example with a route and controller

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/http_kernel.rst

Shows how to set up a minimal HttpKernel application with a route collection and a controller closure. The example defines a single 'hello' route that returns a response with a greeting using the request attribute 'name'.

```php
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
use Symfony\Component\HttpKernel\Controller\ControllerResolver;
use Symfony\Component\HttpKernel\EventListener\RouterListener;
use Symfony\Component\HttpKernel\HttpKernel;
use Symfony\Component\Routing\Matcher\UrlMatcher;
use Symfony\Component\Routing\RequestContext;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

$routes = new RouteCollection();
$routes->add('hello', new Route('/hello/{name}', [
    '_controller' => function (Request $request): Response {
        return new Response(
            sprintf("Hello %s", $request->attributes->get('name'))
        );
    }]
));
```

--------------------------------

### Set up an existing Symfony project with Git and Composer

Source: https://github.com/symfony/symfony-docs/blob/7.4/setup.rst

Use these commands to set up an existing Symfony project. First clone the project, then run composer install to install dependencies into vendor/.

```terminal
# clone the project to download its contents
$ cd projects/
$ git clone ...

# make Composer install the project's dependencies into vendor/
$ cd my-project/
$ composer install
```

--------------------------------

### Build and serve documentation locally

Source: https://github.com/symfony/symfony-docs/blob/7.4/AGENTS.md

Build the documentation locally and serve the output for preview. The output directory is gitignored and should not be read, diffed, or committed.

```bash
cd _build/ && composer install && php build.php --disable-cache
php -S localhost:8000 -t output/
```

--------------------------------

### Get process PID

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/process.rst

Starts a process and retrieves its PID using getPid().

```php
use Symfony\Component\Process\Process;

$process = new Process(['/usr/bin/php', 'worker.php']);
$process->start();

$pid = $process->getPid();
```

--------------------------------

### Framework Configuration Formats

Source: https://github.com/symfony/symfony-docs/blob/7.4/configuration/micro_kernel_trait.rst

Configuration examples for framework settings in YAML, XML, and PHP formats.

```yaml
# config/framework.yaml
framework:
    secret: SOME_SECRET
    profiler: { only_exceptions: false }
```

```xml
<!-- config/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config secret="SOME_SECRET">
        <framework:profiler only-exceptions="false"/>
    </framework:config>
</container>
```

```php
// config/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    $framework
        ->secret('SOME_SECRET')
        ->profiler()
            ->onlyExceptions(false)
    ;
};
```

--------------------------------

### Get route name and parameters from Request

Source: https://github.com/symfony/symfony-docs/blob/7.4/routing.rst

Controller example showing how to retrieve the current route name and parameters from the Request object's attributes. Also shows how to get all attributes.

```php
// src/Controller/BlogController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;

class BlogController extends AbstractController
{
    #[Route('/blog', name: 'blog_list')]
    public function list(Request $request): Response
    {
        $routeName = $request->attributes->get('_route');
        $routeParameters = $request->attributes->get('_route_params');

        // use this to get all the available attributes (not only routing ones):
        $allAttributes = $request->attributes->all();

        // ...
    }
}
```

--------------------------------

### Create Basic Asset Package

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/asset.rst

Example of creating a package to manage assets without any versioning using EmptyVersionStrategy.

```php
use Symfony\Component\Asset\Package;
use Symfony\Component\Asset\VersionStrategy\EmptyVersionStrategy;

$package = new Package(new EmptyVersionStrategy());

// Absolute path
echo $package->getUrl('/image.png');
// result: /image.png

// Relative path
echo $package->getUrl('image.png');
// result: image.png
```

--------------------------------

### Execute PHPUnit tests

Source: https://github.com/symfony/symfony-docs/blob/7.4/create_framework/unit_testing.rst

Run the tests from the example.com directory using the vendor binary.

```terminal
$ ./vendor/bin/phpunit
```

--------------------------------

### Retrieve severity from constraint violation

Source: https://github.com/symfony/symfony-docs/blob/7.4/validation/severity.rst

When validation fails, retrieve the constraint from the violation using getConstraint() and access the payload to get the severity. The example shows how to get the severity with a null coalescing fallback.

```php
// a constraint validation failure, instance of
// Symfony\Component\Validator\ConstraintViolation
$constraintViolation = ...;
$constraint = $constraintViolation->getConstraint();
$severity = $constraint->payload['severity'] ?? null;
```

--------------------------------

### Retrieve flash messages in standalone PHP with get() and peek()

Source: https://github.com/symfony/symfony-docs/blob/7.4/session.rst

Examples of reading flash messages using the FlashBag methods get(), peek(), all(), and peekAll() to display warnings, errors, and all flashes, with or without clearing them.

```php
// display warnings
foreach ($session->getFlashBag()->get('warning', []) as $message) {
    echo '<div class="flash-warning">'.$message.'</div>';
}

// display warnings without clearing them from the flash bag
foreach ($session->getFlashBag()->peek('warning', []) as $message) {
    echo '<div class="flash-warning">'.$message.'</div>';
}

// display errors
foreach ($session->getFlashBag()->get('error', []) as $message) {
    echo '<div class="flash-error">'.$message.'</div>';
}

// display all flashes at once
foreach ($session->getFlashBag()->all() as $type => $messages) {
    foreach ($messages as $message) {
        echo '<div class="flash-'.$type.'">'.$message.'</div>';
    }
}

// display all flashes at once without clearing the flash bag
foreach ($session->getFlashBag()->peekAll() as $type => $messages) {
    foreach ($messages as $message) {
        echo '<div class="flash-'.$type.'">'.$message.'</div>';
    }
}
```

--------------------------------

### Use withOptions to Set Default Options

Source: https://github.com/symfony/symfony-docs/blob/7.4/http_client.rst

Shows how to use the withOptions method to create a new client instance with new default options, such as base_uri, headers, and extra.

```php
$this->client = $client->withOptions([
    'base_uri' => 'https://...',
    'headers' => ['header-name' => 'header-value'],
    'extra' => ['my-key' => 'my-value'],
]);
```

--------------------------------

### Example URL with custom query parameters

Source: https://github.com/symfony/symfony-docs/blob/7.4/security/form_login.rst

An example URL demonstrating the use of the customized query string parameters.

```text
http://example.com/some/path?go_to=/dashboard&back_to=/forgot-password
```

--------------------------------

### Get locale names in a specific translation locale

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/intl.rst

All methods accept the translation locale as the last, optional parameter, which defaults to the current default locale. This example passes 'de' to get German translations.

```php
$locales = Locales::getNames('de');
// => ['af' => 'Afrikaans', 'af_NA' => 'Afrikaans (Namibia)', ...]

$locale = Locales::getName('zh_Hans_MO', 'de');
// => 'Chinesisch (Vereinfacht, Sonderverwaltungsregion Macau)'
```

--------------------------------

### Configure ElasticsearchLogstashHandler with FingersCrossedHandler (PHP)

Source: https://github.com/symfony/symfony-docs/blob/7.4/logging/handlers.rst

PHP configuration for config/packages/prod/monolog.php using the MonologConfig to define the same handler setup as the YAML and XML examples.

```php
// config/packages/prod/monolog.php
use Symfony\Bridge\Monolog\Handler\ElasticsearchLogstashHandler;
use Symfony\Config\MonologConfig;

return static function (MonologConfig $monolog): void {
    $monolog->handler('main')
        ->type('fingers_crossed')
        ->handler('es')
    ;
    $monolog->handler('es')
        ->type('service')
        ->id(ElasticsearchLogstashHandler::class)
    ;
};
```

--------------------------------

### Create and render a basic table with Table helper

Source: https://github.com/symfony/symfony-docs/blob/7.4/console/helpers/table.rst

Sets headers and rows on a Table instance and renders it. The command returns Command::SUCCESS after rendering. The output shows a bordered table with the provided data.

```php
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Output\OutputInterface;
// ...

#[AsCommand(name: 'app:my-command')]
class MyCommand
{
    public function __invoke(OutputInterface $output): int
    {
        $table = new Table($output);
        $table
            ->setHeaders(['ISBN', 'Title', 'Author'])
            ->setRows([
                ['99921-58-10-7', 'Divine Comedy', 'Dante Alighieri'],
                ['9971-5-0210-0', 'A Tale of Two Cities', 'Charles Dickens'],
                ['960-425-059-0', 'The Lord of the Rings', 'J. R. R. Tolkien'],
                ['80-902734-1-6', 'And Then There Were None', 'Agatha Christie'],
            ])
        ;
        $table->render();

        return Command::SUCCESS;
    }
}
```

```terminal
+---------------+--------------------------+------------------+
| ISBN          | Title                    | Author           |
+---------------+--------------------------+------------------+
| 99921-58-10-7 | Divine Comedy            | Dante Alighieri  |
| 9971-5-0210-0 | A Tale of Two Cities     | Charles Dickens  |
| 960-425-059-0 | The Lord of the Rings    | J. R. R. Tolkien |
| 80-902734-1-6 | And Then There Were None | Agatha Christie  |
+---------------+--------------------------+------------------+
```

--------------------------------

### TaskType form with issue text field

Source: https://github.com/symfony/symfony-docs/blob/7.4/form/data_transformers.rst

Initial setup for a form with a text field for an issue number, as part of Example #2.

```php
// src/Form/Type/TaskType.php
namespace App\Form\Type;

use App\Entity\Task;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
```

--------------------------------

### PHPUnit configuration file

Source: https://github.com/symfony/symfony-docs/blob/7.4/create_framework/unit_testing.rst

Create a phpunit.dist.xml file in the example.com directory to define test suite settings and bootstrap the autoloader.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<phpunit
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.0/phpunit.xsd"
    backupGlobals="false"
    colors="true"
    bootstrap="vendor/autoload.php"
>
    <source>
        <include>
            <directory suffix=".php">./src</directory>
        </include>
    </source>

    <testsuites>
        <testsuite name="Test Suite">
            <directory>./tests</directory>
        </testsuite>
    </testsuites>
</phpunit>
```

--------------------------------

### Configure ElasticsearchLogstashHandler with FingersCrossedHandler (XML)

Source: https://github.com/symfony/symfony-docs/blob/7.4/logging/handlers.rst

XML configuration for config/packages/prod/monolog.xml that defines the same handler setup as the YAML example, using the monolog XML namespace.

```xml
<!-- config/packages/prod/monolog.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:monolog="http://symfony.com/schema/dic/monolog"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/monolog
        https://symfony.com/schema/dic/monolog/monolog-1.0.xsd">

    <monolog:config>
        <monolog:handler
            name="main"
            type="fingers_crossed"
            handler="es"
        />
        <monolog:handler
            name="es"
            type="service"
            id="Symfony\Bridge\Monolog\Handler\ElasticsearchLogstashHandler"
        />
    </monolog:config>
</container>
```

--------------------------------

### Install Symfony components via Composer

Source: https://github.com/symfony/symfony-docs/blob/7.4/configuration/micro_kernel_trait.rst

Initialize a new project by installing the necessary FrameworkBundle and runtime components.

```terminal
$ composer require symfony/framework-bundle symfony/runtime
```

--------------------------------

### Use Psr18Client to send request

Source: https://github.com/symfony/symfony-docs/blob/7.4/http_client.rst

Standalone example of using Psr18Client to send a GET request and decode the JSON response. Requires the Symfony HttpClient component.

```php
use Symfony\Component\HttpClient\Psr18Client;

$client = new Psr18Client();

$request = $client->createRequest('GET', 'https://symfony.com/versions.json');
$response = $client->sendRequest($request);

$content = json_decode($response->getBody()->getContents(), true);
```

--------------------------------

### Define Bundle Configuration Parameters

Source: https://github.com/symfony/symfony-docs/blob/7.4/bundles/best_practices.rst

Examples of setting bundle configuration parameters using YAML, XML, and PHP formats.

```yaml
# config/services.yaml
parameters:
    acme_blog.author.email: 'fabien@example.com'
```

```xml
<!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd"
>
    <parameters>
        <parameter key="acme_blog.author.email">fabien@example.com</parameter>
    </parameters>

</container>
```

```php
// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container): void {
    $container->parameters()
        ->set('acme_blog.author.email', 'fabien@example.com')
    ;
};
```

--------------------------------

### Create front controller public/index.php

Source: https://github.com/symfony/symfony-docs/blob/7.4/configuration/micro_kernel_trait.rst

The front controller boots the application, handles the request, and terminates the kernel.

```php
// public/index.php
use App\
Kernel;
use Symfony\Component\HttpFoundation\Request;

require __DIR__.'/../vendor/autoload.php';

$kernel = new Kernel('dev', true);
$request = Request::createFromGlobals();
$response = $kernel->handle($request);
$response->send();
$kernel->terminate($request, $response);
```

--------------------------------

### TaskType form with tags text field

Source: https://github.com/symfony/symfony-docs/blob/7.4/form/data_transformers.rst

Initial form setup for a Task entity with a 'tags' text field. This is the starting point before adding a data transformer.

```php
// src/Form/Type/TaskType.php
namespace App\Form\Type;

use App\Entity\Task;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

// ...
class TaskType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('tags', TextType::class);
    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'data_class' => Task::class,
        ]);
    }

    // ...
}
```

--------------------------------

### Check server status and stop server

Source: https://github.com/symfony/symfony-docs/blob/7.4/setup/symfony_cli.rst

Use these commands to check if the server is running and stop it if necessary, for example when the server doesn't start due to a port conflict.

```terminal
$ symfony server:status
$ symfony server:stop  # If a server is already running
```

--------------------------------

### Front Controller for Custom Runtime

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/runtime.rst

Example of how an end user initializes the custom runtime in their front controller.

```php
require_once dirname(__DIR__).'/vendor/autoload_runtime.php';

return function (array $context): SomeCustomPsr15Application {
    return new SomeCustomPsr15Application();
};
```

--------------------------------

### Get Bytes at a Position with bytesAt()

Source: https://github.com/symfony/symfony-docs/blob/7.4/string.rst

Shows how to retrieve the bytes at a given position using bytesAt(). The example demonstrates the difference between byte strings and Unicode strings for the same character.

```php
// ('नमस्ते' bytes = [224, 164, 168, 224, 164, 174, 224, 164, 184,
//                  224, 165, 141, 224, 164, 164, 224, 165, 135])
b('नमस्ते')->bytesAt(0);   // [224]
u('नमस्ते')->bytesAt(0);   // [224, 164, 168]

b('नमस्ते')->bytesAt(1);   // [164]
u('नमस्ते')->bytesAt(1);   // [224, 164, 174]
```

--------------------------------

### Create a shared initialization script

Source: https://github.com/symfony/symfony-docs/blob/7.4/create_framework/front_controller.rst

An include file to extract common setup code shared between pages.

```php
// framework/init.php
require_once __DIR__.'/vendor/autoload.php';

use Symfony\\Component\\HttpFoundation\\Request;
use Symfony\\Component\\HttpFoundation\\Response;

$request = Request::createFromGlobals();
$response = new Response();
```

--------------------------------

### Stop a process with Process::stop

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/process.rst

Starts an asynchronous process and stops it after a timeout with a signal. The default signal is SIGKILL. This example uses a timeout of 3 seconds and sends SIGINT.

```php
$process = new Process(['ls', '-lsa']);
$process->start();

// ... do other things

$process->stop(3, SIGINT);
```

--------------------------------

### Normalize an option value

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/options_resolver.rst

Use setNormalizer to normalize an option value. The normalizer receives the value and returns the normalized form. This example ensures the host starts with http://.

```php
    use Symfony\Component\OptionsResolver\Options;

    // ...
    class Mailer
    {
        // ...

        public function configureOptions(OptionsResolver $resolver): void
        {
            // ...

            $resolver->setNormalizer('host', function (Options $options, string $value): string {
                if (!str_starts_with($value, 'http://')) {
                    $value = 'http://'.$value;
                }

                return $value;
            });
        }
    }
```

--------------------------------

### Command class with UserRepository and suggestUsers()

Source: https://github.com/symfony/symfony-docs/blob/7.4/console/input.rst

Example of a command class that uses constructor property promotion to inject a UserRepository and a suggestUsers() method that returns usernames for completion.

```php
public function __construct(
    private UserRepository $userRepository,
) {
}

// ...

public function suggestUsers(CompletionInput $input): array
{
    return $this->userRepository->findAllUsernames();
}
```

--------------------------------

### XML configuration with xsi:schemaLocation for custom namespace

Source: https://github.com/symfony/symfony-docs/blob/7.4/bundles/configuration.rst

Example XML configuration file that uses the custom namespace and points to the XSD schema via xsi:schemaLocation. The schema location starts with the XML namespace and is followed by the path from the base path to the XSD file. This example assumes the XSD file is named hello-1.0.xsd.

```xml
<!-- config/packages/acme_hello.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:acme-hello="http://acme_company.com/schema/dic/hello"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://acme_company.com/schema/dic/hello
        https://acme_company.com/schema/dic/hello/hello-1.0.xsd"
>
    <acme-hello:config>
        <!-- ... -->
    </acme-hello:config>

    <!-- ... -->
</container>
```

--------------------------------

### Configure Services and Routes in Micro Kernel

Source: https://github.com/symfony/symfony-docs/blob/7.4/configuration/micro_kernel_trait.rst

Example of registering services and conditionally importing routes for the WebProfilerBundle within a kernel class.

```php
// register all classes in /src/ as service
            $container->services()
                ->load('App\\', __DIR__.'/*')
                ->autowire()
                ->autoconfigure()
            ;

            // configure WebProfilerBundle only if the bundle is enabled
            if (isset($this->bundles['WebProfilerBundle'])) {
                $container->extension('web_profiler', [
                    'toolbar' => true,
                    'intercept_redirects' => false,
                ]);
            }
        }

        protected function configureRoutes(RoutingConfigurator $routes): void
        {
            // import the WebProfilerRoutes, only if the bundle is enabled
            if (isset($this->bundles['WebProfilerBundle'])) {
                $routes->import('@WebProfilerBundle/Resources/config/routing/wdt.php', 'php')->prefix('/_wdt');
                $routes->import('@WebProfilerBundle/Resources/config/routing/profiler.php', 'php')->prefix('/_profiler');
            }

            // load the routes defined as PHP attributes
            $routes->import(__DIR__.'/Controller/', 'attribute');
        }

        // optionally, you can define the getCacheDir() and getLogDir() methods
        // to override the default locations for these directories
    }
```

--------------------------------

### Fetch firewall configuration for a request

Source: https://github.com/symfony/symfony-docs/blob/7.4/security.rst

Example service using Security and RequestStack to get the firewall name for the current request. Avoid calling getFirewallConfig() in the constructor because authentication may not be complete.

```php
// src/Service/ExampleService.php
// ...

use Symfony\Bundle\SecurityBundle\Security;
use Symfony\Component\HttpFoundation\RequestStack;

class ExampleService
{
    public function __construct(
        // Avoid calling getFirewallConfig() in the constructor: auth may not
        // be complete yet. Instead, store the entire Security object.
        private Security $security,
        private RequestStack $requestStack,
    ) {
    }

    public function someMethod(): void
    {
        $request = $this->requestStack->getCurrentRequest();
        $firewallName = $this->security->getFirewallConfig($request)?->getName();

        // ...
    }
}
```

--------------------------------

### Console application bootstrap

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/runtime.rst

Example of bootstrapping a console application using the Runtime component.

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

use App\Kernel;
use Symfony\Bundle\FrameworkBundle\Console\Application;

require_once dirname(__DIR__).'/vendor/autoload_runtime.php';

return function (array $context): Application {
    $kernel = new Kernel($context['APP_ENV'], (bool) $context['APP_DEBUG']);

    // returning an "Application" makes the Runtime run a Console
    // application instead of the HTTP Kernel
    return new Application($kernel);
};
```

--------------------------------

### Example directory structure for adding an admin application

Source: https://github.com/symfony/symfony-docs/blob/7.4/configuration/multiple_kernels.rst

Shows the directory layout for a new admin application, including config files and src directory. This is the result of repeating step 1 to add more applications.

```text
your-project/
├─ apps/
│  ├─ admin/
│  │  ├─ config/
│  │  │  ├─ bundles.php
│  │  │  ├─ routes.yaml
│  │  │  └─ services.yaml
│  │  └─ src/
│  └─ api/
│     └─ ...
```

--------------------------------

### Enable CSRF protection in framework.yaml (YAML, XML, PHP)

Source: https://github.com/symfony/symfony-docs/blob/7.4/reference/configuration/framework.rst

Configuration to enable CSRF protection in Symfony. The YAML example sets 'csrf_protection: true' in config/packages/framework.yaml. The XML example uses the 'framework:csrf-protection' element with 'enabled="true"'. The PHP example uses the FrameworkConfig to call 'csrfProtection()->enabled(true)'. Note: If using forms but want to avoid starting a session (e.g., API-only), set 'csrf_protection' to false.

```yaml
# config/packages/framework.yaml
framework:
    # ...
    csrf_protection: true
```

```xml
<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
    <framework:config>
        <framework:csrf-protection enabled="true"/>
    </framework:config>
</container>
```

```php
// config/packages/framework.php
use Symfony\Config\FrameworkConfig;
return static function (FrameworkConfig $framework): void {
    $framework->csrfProtection()
        ->enabled(true)
    ;
};
```

--------------------------------

### Add configuration options to PostalAddressType

Source: https://github.com/symfony/symfony-docs/blob/7.4/form/create_custom_field_type.rst

Partial example showing the start of configureOptions() method for defining custom form type options. The code is incomplete in the source, but it shows the imports and method signature.

```PHP
// src/Form/Type/PostalAddressType.php
namespace App\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;
```

--------------------------------

### Initialize Framework and Handle Request

Source: https://github.com/symfony/symfony-docs/blob/7.4/create_framework/event_dispatcher.rst

Basic initialization of the Simplex framework and handling of an incoming request.

```php
$framework = new Simplex\Framework($dispatcher, $matcher, $controllerResolver, $argumentResolver);
$response = $framework->handle($request);

$response->send();
```

--------------------------------

### Standalone Serializer setup and usage with JsonEncoder and ObjectNormalizer

Source: https://github.com/symfony/symfony-docs/blob/7.4/serializer.rst

Standalone example showing how to instantiate the Serializer with JsonEncoder and ObjectNormalizer, then use normalize(), denormalize(), encode(), and decode() to convert between objects, arrays, and JSON.

```php
use App\Model\Person;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Serializer;

$encoders = [new JsonEncoder()];
$normalizers = [new ObjectNormalizer()];
$serializer = new Serializer($normalizers, $encoders);

// use normalize() to convert a PHP object to an array
$personArray = $serializer->normalize($person, 'json');

// ...and denormalize() to convert an array back to a PHP object
$personCopy = $serializer->denormalize($personArray, Person::class);

$data = ['name' => 'Jane Doe'];

// use encode() to transform PHP arrays into another format
$json = $serializer->encode($data, 'json');

// ...and decode() to transform any format to just PHP arrays (instead of objects)
$data = $serializer->decode('{"name":"Charlie Doe"}', 'json');
// $data contains ['name' => 'Charlie Doe']
```

--------------------------------

### Chain option configurations with define()

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/options_resolver.rst

Shows how to use the define() method to chain multiple configurations for an option, improving readability by avoiding repeated option names. The example defines 'host' with required, default, allowedTypes, and info, and 'transport' with required, default, and allowedValues.

```php
// ...
class InvoiceMailer
{
    // ...
    public function configureOptions(OptionsResolver $resolver): void
    {
        // ...
        $resolver->define('host')
            ->required()
            ->default('smtp.example.org')
            ->allowedTypes('string')
            ->info('The IP address or hostname');

        $resolver->define('transport')
            ->required()
            ->default('transport')
            ->allowedValues('sendmail', 'mail', 'smtp');
    }
}
```

--------------------------------

### Start SaleTaskProvider with imports

Source: https://github.com/symfony/symfony-docs/blob/7.4/scheduler.rst

Starts the SaleTaskProvider class that implements ScheduleProviderInterface. The code is incomplete in the source; it shows the namespace and imports needed for the provider.

```php
// src/Scheduler/SaleTaskProvider.php
namespace App\Scheduler;

use App\Scheduler\Message\SendDailySalesReports;
use Symfony\Component\Scheduler\Attribute\AsSchedule;
use Symfony\Component\Scheduler\RecurringMessage;
use Symfony\Component\Scheduler\Schedule;
use Symfony\Component\Scheduler\ScheduleProviderInterface;
```

--------------------------------

### Testing a Service Subscriber with PHPUnit Mock

Source: https://github.com/symfony/symfony-docs/blob/7.4/service_container/subscribers_locators.rst

Alternative example of unit testing a service subscriber by mocking the container using PHPUnit's createMock and expecting the get method to return mapped services.

```APIDOC
## Testing a Service Subscriber with PHPUnit Mock

### Description
Shows how to unit test a service subscriber by mocking the container interface with PHPUnit and setting up a return value map for the get method.

### Method
N/A (Testing example)

### Endpoint
N/A

### Parameters
N/A

### Request Example
php
use Psr\Container\ContainerInterface;

$container = $this->createMock(ContainerInterface::class);
$container->expects(self::any())
    ->method('get')
    ->willReturnMap([
        ['foo', $this->createStub(Foo::class)],
        ['bar', $this->createStub(Bar::class)],
    ])
;

$serviceSubscriber = new MyService($container);
// ...


### Response
N/A
```

--------------------------------

### Implement TransportInterface with Database Example

Source: https://github.com/symfony/symfony-docs/blob/7.4/messenger/custom-transport.rst

Simplified database transport implementing TransportInterface. Uses a FakeDatabase for demo purposes and PhpSerializer by default. Handles get, ack, reject, and send operations on a 'my_queue' table.

```php
use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;
use Symfony\Component\Messenger\Transport\TransportInterface;
use Symfony\Component\Uid\Uuid;

class YourTransport implements TransportInterface
{
    private SerializerInterface $serializer;

    /**
     * @param FakeDatabase $db is used for demo purposes. It is not a real class.
     */
    public function __construct(
        private FakeDatabase $db,
        ?SerializerInterface $serializer = null,
    ) {
        $this->serializer = $serializer ?? new PhpSerializer();
    }

    public function get(): iterable
    {
        // Get a message from "my_queue"
        $row = $this->db->createQuery(
                'SELECT *
                FROM my_queue
                WHERE (delivered_at IS NULL OR delivered_at < :redeliver_timeout)
                AND handled = FALSE'
            )
            ->setParameter('redeliver_timeout', new DateTimeImmutable('-5 minutes'))
            ->getOneOrNullResult();

        if (null === $row) {
            return [];
        }

        $envelope = $this->serializer->decode([
            'body' => $row['envelope'],
        ]);

        return [$envelope->with(new TransportMessageIdStamp($row['id']))];
    }

    public function ack(Envelope $envelope): void
    {
        $stamp = $envelope->last(TransportMessageIdStamp::class);
        if (!$stamp instanceof TransportMessageIdStamp) {
            throw new \LogicException('No TransportMessageIdStamp found on the Envelope.');
        }

        // Mark the message as "handled"
        $this->db->createQuery('UPDATE my_queue SET handled = TRUE WHERE id = :id')
            ->setParameter('id', $stamp->getId())
            ->execute();
    }

    public function reject(Envelope $envelope): void
    {
        $stamp = $envelope->last(TransportMessageIdStamp::class);
        if (!$stamp instanceof TransportMessageIdStamp) {
            throw new \LogicException('No TransportMessageIdStamp found on the Envelope.');
        }

        // Delete the message from the "my_queue" table
        $this->db->createQuery('DELETE FROM my_queue WHERE id = :id')
            ->setParameter('id', $stamp->getId())
            ->execute();
    }

    public function send(Envelope $envelope): Envelope
    {
        $encodedMessage = $this->serializer->encode($envelope);
        $uuid = (string) Uuid::v4();
        // Add a message to the "my_queue" table
        $this->db->createQuery(
                'INSERT INTO my_queue (id, envelope, delivered_at, handled)
                VALUES (:id, :envelope, NULL, FALSE)'
            )
            ->setParameters([
                'id' => $uuid,
                'envelope' => $encodedMessage['body'],
            ])
            ->execute();

        return $envelope->with(new TransportMessageIdStamp($uuid));
    }
}
```

--------------------------------

### Basic Finder Usage

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/finder.rst

Initialize the Finder, define a search directory, and iterate over the results.

```php
use Symfony\Component\Finder\Finder;

$finder = new Finder();
// find all files in the current directory
$finder->files()->in(__DIR__);

// check if there are any search results
if ($finder->hasResults()) {
    // ...
}

foreach ($finder as $file) {
    $absoluteFilePath = $file->getRealPath();
    $fileNameWithExtension = $file->getRelativePathname();

    // ...
}
```

--------------------------------

### makePathRelative: Get relative path between two absolute paths

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/filesystem.rst

Takes two absolute paths and returns the relative path from the second path to the first one. The examples show the expected return values.

```php
// returns '../'
$filesystem->makePathRelative(
    '/var/lib/symfony/src/Symfony/',
    '/var/lib/symfony/src/Symfony/Component'
);
// returns 'videos/'
$filesystem->makePathRelative('/tmp/videos', '/tmp');
```

--------------------------------

### Generic front-controller implementation

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/runtime.rst

Example of a front-controller using the Runtime component to bootstrap an App\Kernel.

```php
// public/index.php
use App\Kernel;

require_once dirname(__DIR__).'/vendor/autoload_runtime.php';

return function (array $context): Kernel {
    return new Kernel($context['APP_ENV'], (bool) $context['APP_DEBUG']);
};
```

--------------------------------

### PHP Example: Configure HtmlSanitizer with URL options

Source: https://github.com/symfony/symfony-docs/blob/7.4/html_sanitizer.rst

Sets up an HtmlSanitizer with forceHttpsUrls, allowed media schemes/hosts, and relative media support.

```php
        $postSanitizer = new HtmlSanitizer(
            (new HtmlSanitizerConfig())
                // if `true`, all URLs using the `http://` scheme will be converted to
                // use the `https://` scheme instead. `http` still needs to be
                // allowed in `allowMediaSchemes`
                ->forceHttpsUrls()

                // specifies the allowed URL schemes. If the URL has a different scheme, the
                // attribute will be dropped
                ->allowMediaSchemes(['http', 'https', 'mailto'])

                // specifies the allowed hosts, the attribute will be dropped if the URL
                // contains a different host which is not a subdomain of the allowed host
                ->allowMediaHosts(['symfony.com']) // Also allows any subdomain (i.e. www.symfony.com)

                // whether to allow relative URLs (i.e. URLs without scheme and host)
                ->allowRelativeMedias()
        );
```

--------------------------------

### Run PHPUnit with Deprecation Notices

Source: https://github.com/symfony/symfony-docs/blob/7.4/setup/upgrade_major.rst

Run the PHPUnit bridge to see a summary of deprecation notices at the end of the test report. The command is available after installing the bridge. The output shows an example of remaining deprecation notices.

```terminal
# this command is available after running "composer require --dev symfony/phpunit-bridge"
$ ./bin/phpunit
...

OK (10 tests, 20 assertions)

Remaining deprecation notices (6)

The "request" service is deprecated and will be removed in 3.0. Add a type-hint for
Symfony\Component\HttpFoundation\Request to your controller parameters to retrieve the
request instead: 6x
    3x in PageAdminTest::testPageShow from Symfony\Cmf\SimpleCmsBundle\Tests\WebTest\Admin
    2x in PageAdminTest::testPageList from Symfony\Cmf\SimpleCmsBundle\Tests\WebTest\Admin
    1x in PageAdminTest::testPageEdit from Symfony\Cmf\SimpleCmsBundle\Tests\WebTest\Admin
```

--------------------------------

### Import JavaScript file with relative path

Source: https://github.com/symfony/symfony-docs/blob/7.4/frontend/asset_mapper.rst

Imports a JavaScript file from another JavaScript file. The path must be relative to the importing file and start with './' or '../'. In this example, '../farm/chicken.js' points to 'assets/farm/chicken.js'.

```javascript
// assets/controllers/farm-controller.js
import '../farm/chicken.js';
```

--------------------------------

### Example project directory structure

Source: https://github.com/symfony/symfony-docs/blob/7.4/create_framework/front_controller.rst

A recommended directory structure for securing code by moving files outside the web root.

```text
example.com
├── composer.json
├── composer.lock
├── src
│   └── pages
│       ├── hello.php
│       └── bye.php
├── vendor
│   └── autoload.php
└── web
    └── front.php
```

--------------------------------

### Inject Security service for user-dependent fields

Source: https://github.com/symfony/symfony-docs/blob/7.4/form/events.rst

Example of injecting the Security service to get the current user and populate a select field with friends. This is an alternative to using form events for data that depends on the logged-in user.

```php
class MessageType extends AbstractType
{
    public function __construct(
        private Security $security,
        private UserRepository $userRepository,
    ) {
    }

    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('body', TextareaType::class);

        $currentUser = $this->security->getUser();
        $friends = $this->userRepository->findFriendsOf($currentUser);

        $builder->add('recipient', EntityType::class, [
            'class' => User::class,
            'choices' => $friends,
            'choice_label' => 'displayName',
            'placeholder' => 'Select a friend',
        ]);
    }

    // ...
}
```

--------------------------------

### Generating and caching configuration code with ConfigCache

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/config/caching.rst

This example demonstrates how to collect resources, generate code, and write it to a cache file. The cache checks the freshness of the resources to determine if regeneration is required.

```php
use Symfony\Component\Config\ConfigCache;
use Symfony\Component\Config\Resource\FileResource;

$cachePath = __DIR__.'/cache/appUserMatcher.php';

// the second argument indicates whether or not you want to use debug mode
$userMatcherCache = new ConfigCache($cachePath, true);

if (!$userMatcherCache->isFresh()) {
    // fill this with an array of 'users.yaml' file paths
    $yamlUserFiles = ...;

    $resources = [];

    foreach ($yamlUserFiles as $yamlUserFile) {
        // see the article "Loading resources" to
        // know where $delegatingLoader comes from
        $delegatingLoader->load($yamlUserFile);
        $resources[] = new FileResource($yamlUserFile);
    }

    // the code for the UserMatcher is generated elsewhere
    $code = ...;

    $userMatcherCache->write($code, $resources);
}

// you may want to require the cached code:
require $cachePath;
```

--------------------------------

### Create and handle a request with HttpKernel

Source: https://github.com/symfony/symfony-docs/blob/7.4/components/http_kernel.rst

Shows the minimal setup and usage of the HttpKernel component: create a request from globals, build the kernel with a router listener, controller resolver, and argument resolver, then handle, send, and terminate the request.

```php
$request = Request::createFromGlobals();

$matcher = new UrlMatcher($routes, new RequestContext());

$dispatcher = new EventDispatcher();
$dispatcher->addSubscriber(new RouterListener($matcher, new RequestStack()));

$controllerResolver = new ControllerResolver();
$argumentResolver = new ArgumentResolver();

$kernel = new HttpKernel($dispatcher, $controllerResolver, new RequestStack(), $argumentResolver);

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

$kernel->terminate($request, $response);
```

--------------------------------

### Make a request with the test client

Source: https://github.com/symfony/symfony-docs/blob/7.4/testing.rst

Makes a GET request to '/post/hello-world' using the test client. The request() method returns a Crawler instance.

```PHP
$crawler = $client->request('GET', '/post/hello-world');
```
Tokens:
Raw