Symfony

https://symfony.com/doc/5.x/
Admin
Symfony is a PHP web framework and set of reusable components for building web applications, APIs,...
Tokens:1,656,640
Snippets:12,788
Trust Score:9.7
Update:1 day ago
Show doc for...
Tokens:
Raw
### Output of start()

Source: https://symfony.com/doc/5.x/components/console/helpers/debug_formatter.html

The output produced by the start() example above.

```text
RUN Some process description
```

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

### HTTP GET request example

Source: https://symfony.com/doc/5.x/introduction/http_fundamentals.html

Shows a typical HTTP GET request to fetch a resource. The first line contains the method (GET) and URI (/). Headers include Host, Accept, and User-Agent.

```http
GET / HTTP/1.1
Host: xkcd.com
Accept: text/html
User-Agent: Mozilla/5.0 (Macintosh)
```

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

### Full working example using HttpKernel component

Source: https://symfony.com/doc/5.x/components/http_kernel.html

This example shows a complete setup for the Symfony HttpKernel component. It creates a route collection with a single 'hello' route, builds a request from globals, uses a UrlMatcher with a RequestContext, sets up an EventDispatcher with a RouterListener, and then uses HttpKernel to handle and terminate the request. The example uses built-in listeners and resolvers to create a working application.

```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) {
        return new Response(
            sprintf("Hello %s", $request->get('name'))
        );
    }]
));

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

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

### Render form start tag with form_start() and change method to GET

Source: https://symfony.com/doc/5.x/form/form_customization.html

Use form_start() to render the opening form tag, including method, action, and enctype if needed. Pass variables to override the method.

```twig
{# render the start tag and change the submission method #}
{{ form_start(form, {'method': 'GET'}) }}
```

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

### Create and Render a Table

Source: https://symfony.com/doc/5.x/components/console/helpers/table.html

Example command that creates a Table instance, sets headers and rows, and renders it. Returns Command::SUCCESS.

```php
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
// ...

class SomeCommand extends Command
{
    public function execute(InputInterface $input, 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;
    }
}
```

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

### Customize the prefix of start()

Source: https://symfony.com/doc/5.x/components/console/helpers/debug_formatter.html

The third argument of start() overrides the default 'RUN' prefix. The example uses 'STARTED' and shows the resulting output.

```php
$output->writeln($debugFormatter->start(
    spl_object_hash($process),
    'Some process description',
    'STARTED'
));
// will output:
//  STARTED Some process description
```

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

### Create application.php to run the CLI

Source: https://symfony.com/doc/5.x/components/console/usage.html

This is the initial setup file required to run console commands. It requires the autoloader, creates an Application instance, and runs it.

```php
#!/usr/bin/env php
<?php
// application.php

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

use Symfony\Component\Console\Application;

$application = new Application();
// ...
$application->run();
```

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

### Install Supervisor on Ubuntu

Source: https://symfony.com/doc/5.x/messenger.html

Install Supervisor using apt-get on Ubuntu. This is a prerequisite for the Supervisor configuration examples.

```bash
$ sudo apt-get install supervisor
```

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

### Create project directory

Source: https://symfony.com/doc/5.x/create_framework/introduction.html

Creates a new directory named 'framework' and changes into it. This is the first step in bootstrapping the project.

```bash
$ mkdir framework
$ cd framework
```

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

### Basic HttpKernel setup with EventDispatcher and resolvers

Source: https://symfony.com/doc/5.x/components/http_kernel.html

Shows the minimal steps to instantiate and run an HttpKernel: create a Request from globals, an EventDispatcher, controller and argument resolvers, then handle the request, send the response, and trigger the terminate event. Add event listeners to the dispatcher to customize behavior.

```php
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
use Symfony\Component\HttpKernel\Controller\ControllerResolver;
use Symfony\Component\HttpKernel\HttpKernel;

// create the Request object
$request = Request::createFromGlobals();

$dispatcher = new EventDispatcher();
// ... add some event listeners

// create your controller and argument resolvers
$controllerResolver = new ControllerResolver();
$argumentResolver = new ArgumentResolver();

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

// actually execute the kernel, which turns the request into a response
// by dispatching events, calling a controller, and returning the response
$response = $kernel->handle($request);

// send the headers and echo the content
$response->send();

// trigger the kernel.terminate event
$kernel->terminate($request, $response);
```

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

### Create Symfony 5.4 application with Symfony binary

Source: https://symfony.com/doc/5.x/setup.html

Use these commands to create a new Symfony application using the Symfony binary. The --webapp option installs extra packages for a traditional web application; without it, you get a minimal setup for microservices, console apps, or APIs.

```bash
# run this if you are building a traditional web application
$ symfony new my_project_directory --version=5.4 --webapp

# run this if you are building a microservice, console application or API
$ symfony new my_project_directory --version=5.4
```

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

### Execute app:create-user command and its output

Source: https://symfony.com/doc/5.x/console.html

Shows the command to run the example command and the resulting console output, demonstrating the messages written by the writeln and write calls.

```bash
$ php bin/console app:create-user
User Creator
============

Whoa!
You are about to create a user.
```

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

### Install Symfony console completion script for Bash

Source: https://symfony.com/doc/5.x/console.html

Install the Symfony completion bash script once by running the completion command. Requires the bash-completion package to be installed and setup. After installation, restart the shell.

```bash
$ php bin/console completion bash | sudo tee /etc/bash_completion.d/console-events-terminate
# after the installation, restart the shell
```

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

### Set up EventDispatcher and Application

Source: https://symfony.com/doc/5.x/components/console/events.html

Creates an EventDispatcher, assigns it to the Application, and runs the application. This is the basic setup for using console events.

```php
use Symfony\Component\Console\Application;
use Symfony\Component\EventDispatcher\EventDispatcher;

$dispatcher = new EventDispatcher();

$application = new Application();
$application->setDispatcher($dispatcher);
$application->run();
```

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

### Install symfony/redis-messenger package

Source: https://symfony.com/doc/5.x/messenger.html

Starting from Symfony 5.1, the Redis transport is in a separate package. Run this command to install it.

```bash
$ composer require symfony/redis-messenger
```

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

### Output of make:migration

Source: https://symfony.com/doc/5.x/doctrine.html

Example output after running make:migration, showing the next steps to review and run the migration.

```text
SUCCESS!

Next: Review the new migration "migrations/Version20211116204726.php"
Then: Run the migration with php bin/console doctrine:migrations:migrate
```

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

### Install AMQP Messenger package

Source: https://symfony.com/doc/5.x/messenger.html

Command to install the AMQP transport package, which is required starting from Symfony 5.1.

```bash
$ composer require symfony/amqp-messenger
```

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

### Start a process with DebugFormatterHelper::start()

Source: https://symfony.com/doc/5.x/components/console/helpers/debug_formatter.html

Use start() to display a message when a process starts. The first argument is a unique identifier (e.g., spl_object_hash), the second is a description. The output is prefixed with 'RUN' by default.

```php
// ...
$process = new Process(...);

$output->writeln($debugFormatter->start(
    spl_object_hash($process),
    'Some process description'
));

$process->run();
```

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

### Pad and Trim Methods (u() helper)

Source: https://symfony.com/doc/5.x/components/string.html

Shows how to use padBoth(), padStart(), padEnd(), repeat(), trim(), trimStart(), trimEnd(), trimPrefix(), and trimSuffix() methods. Includes comments explaining behavior and expected output. Note that trimPrefix() and trimSuffix() were introduced in Symfony 5.4.

```php
// makes a string as long as the first argument by adding the given
// string at the beginning, end or both sides of the string
u(' Lorem Ipsum ')->padBoth(20, '-'); // '--- Lorem Ipsum ----'
u(' Lorem Ipsum')->padStart(20, '-'); // '-------- Lorem Ipsum'
u('Lorem Ipsum ')->padEnd(20, '-');   // 'Lorem Ipsum --------'

// repeats the given string the number of times passed as argument
u('_.')->repeat(10); // '_._._._._._._._._._.'

// removes the given characters (default: whitespace characters) from the beginning and end of a string
u('   Lorem Ipsum   ')->trim(); // 'Lorem Ipsum'
u('Lorem Ipsum   ')->trim('m'); // 'Lorem Ipsum   '
u('Lorem Ipsum')->trim('m');    // 'Lorem Ipsu'

u('   Lorem Ipsum   ')->trimStart(); // 'Lorem Ipsum   '
u('   Lorem Ipsum   ')->trimEnd();   // '   Lorem Ipsum'

// removes the given content from the start/end of the string
u('file-image-0001.png')->trimPrefix('file-');           // 'image-0001.png'
u('file-image-0001.png')->trimPrefix('image-');          // 'file-image-0001.png'
u('file-image-0001.png')->trimPrefix('file-image-');     // '0001.png'
u('template.html.twig')->trimSuffix('.html');            // 'template.html.twig'
u('template.html.twig')->trimSuffix('.twig');            // 'template.html'
u('template.html.twig')->trimSuffix('.html.twig');       // 'template'
// when passing an array of prefix/suffix, only the first one found is trimmed
u('file-image-0001.png')->trimPrefix(['file-', 'image-']); // 'image-0001.png'
u('template.html.twig')->trimSuffix(['.twig', '.html']);   // 'template.html'
```

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

### Get query parameter with default value

Source: https://symfony.com/doc/5.x/components/http_foundation.html

Shows how to use $request->query->get() to retrieve a query parameter. The second argument is the default value returned if the parameter does not exist. The example uses the query string '?foo=bar' and demonstrates that get('bar') returns null and get('bar', 'baz') returns 'baz'.

```php
// the query string is '?foo=bar'

$request->query->get('foo');
// returns 'bar'

$request->query->get('bar');
// returns null

$request->query->get('bar', 'baz');
// returns 'baz'
```

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

### Get process PID with getPid()

Source: https://symfony.com/doc/5.x/components/process.html

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

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

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

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

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

### Configure workers in .symfony.local.yaml

Source: https://symfony.com/doc/5.x/setup/symfony_server.html

Example `.symfony.local.yaml` workers configuration. Workers start automatically with `symfony server:start`. Built-in workers include `npm_encore_watch` and `messenger_consume_async`; custom commands can be added. Use `--no-workers` to start the server without workers (e.g., in CI).

```yaml
# .symfony.local.yaml
workers:
    # built-in command that builds and watches front-end assets
    # npm_encore_watch:
    #     cmd: ['npx', 'encore', 'dev', '--watch']
    npm_encore_watch: ~

    # built-in command that starts messenger consumer
    # messenger_consume_async:
    #     cmd: ['symfony', 'console', 'messenger:consume', 'async']
    #     watch: ['config', 'src', 'templates', 'vendor']
    messenger_consume_async: ~

    # you can also add your own custom commands
    build_spa:
        cmd: ['npm', '--cwd', './spa/', 'dev']

    # auto start Docker compose when starting server (available since Symfony CLI 5.7.0)
    docker_compose: ~
```

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

### Parameter naming examples in config/services.yaml

Source: https://symfony.com/doc/5.x/best_practices.html

Shows recommended and discouraged parameter names in YAML. Use a short prefix like 'app.' and consistent separators (dots, underscores, dashes) to avoid collisions and improve clarity.

```yaml
# config/services.yaml
parameters:
    # don't do this: 'dir' is too generic, and it doesn't convey any meaning
    app.dir: '...'
    # do this: short but easy to understand names
    app.contents_dir: '...'
    # it's OK to use dots, underscores, dashes or nothing, but always
    # be consistent and use the same format for all the parameters
    app.dir.contents: '...'
    app.contents-dir: '...'
```

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

### Install production vendors with composer install --no-dev --optimize-autoloader

Source: https://symfony.com/doc/5.x/deployment.html

Use this command to install or update vendors for production. The --no-dev flag ensures development packages are not installed, and --optimize-autoloader builds a class map to improve autoloader performance. If you get a 'class not found' error, set APP_ENV=prod before running.

```bash
$ composer install --no-dev --optimize-autoloader
```

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

### Example configuration array

Source: https://symfony.com/doc/5.x/components/dependency_injection/compilation.html

Shows the structure of configuration values that are passed to the extension's load method.

```php
[
    [
        'foo' => 'fooValue',
        'bar' => 'barValue',
    ],
]
```

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

### Standardized Installation Instructions in Markdown for README.md

Source: https://symfony.com/doc/5.x/bundles/best_practices.html

Markdown version of the recommended installation instructions for a Symfony bundle. It covers Composer installation, Symfony Flex usage, and manual bundle enabling for non-Flex applications. The example uses placeholders like <package-name> and <vendor>\<bundle-name>\<bundle-long-name>.

```markdown
Installation
============

Make sure Composer is installed globally, as explained in the
[installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.

Applications that use Symfony Flex
----------------------------------

Open a command console, enter your project directory and execute:

```console
$ composer require <package-name>
```

Applications that don't use Symfony Flex
----------------------------------------

### Step 1: Download the Bundle

Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:

```console
$ composer require <package-name>
```

### Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles
in the `config/bundles.php` file of your project:

```php
// config/bundles.php

return [
    // ...
    <vendor>\<bundle-name>\<bundle-long-name>::class => ['all' => true],
];
```
```

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

### progressStart() - Start a progress bar

Source: https://symfony.com/doc/5.x/console/style.html

Starts a progress bar. Pass the number of steps if known, or omit the argument for an unknown length.

```PHP
// displays a progress bar of unknown length
$io->progressStart();

// displays a 100-step length progress bar
$io->progressStart(100);
```

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

### Get user locale with Request::getLocale()

Source: https://symfony.com/doc/5.x/session.html

Example controller method showing how to retrieve the current user's locale using Request::getLocale(). Always use this method to get the user's locale.

```PHP
// from a controller...
use Symfony\Component\HttpFoundation\Request;

public function index(Request $request)
{
    $locale = $request->getLocale();
}
```

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

### Run the command with and without --iterations

Source: https://symfony.com/doc/5.x/console/input.html

Shows example command invocations and their output, demonstrating the default value and the effect of passing --iterations=5, as well as the order of options not being important.

```bash
# no --iterations provided, the default (1) is used
$ php bin/console app:greet Fabien
Hi Fabien!

$ php bin/console app:greet Fabien --iterations=5
Hi Fabien!
Hi Fabien!
Hi Fabien!
Hi Fabien!
Hi Fabien!

# the order of options isn't important
$ php bin/console app:greet Fabien --iterations=5 --yell
$ php bin/console app:greet Fabien --yell --iterations=5
$ php bin/console app:greet --yell --iterations=5 Fabien
```

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

### Tabs directive example

Source: https://symfony.com/doc/5.x/contributing/documentation/format.html

Shows the reStructuredText syntax for creating tabs in Symfony documentation. The example defines a 'UX Installation' tab group with two tabs: 'Webpack Encore' and 'AssetMapper', each containing introductory text and a code block.

```rst
.. tabs:: UX Installation

    .. tab:: Webpack Encore

        Introduction to Webpack

        .. code-block:: yaml

            webpack:
                # ...

    .. tab:: AssetMapper

        Introduction to AssetMapper

        Something else about AssetMapper
```

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

### Use --version and -V options

Source: https://symfony.com/doc/5.x/components/console/usage.html

These options output the application name and version.

```bash
$ php application.php list --version
$ php application.php list -V
```

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

### Set SYMFONY_REQUIRE to install a specific Symfony version

Source: https://symfony.com/doc/5.x/bundles/best_practices.html

Use the SYMFONY_REQUIRE environment variable with Symfony Flex to install a specific Symfony version. The example shows setting it to 5.*, optionally updating composer.json via composer config, installing Symfony Flex globally, and running composer update with recommended flags.

```bash
# this requires Symfony 5.x for all Symfony packages
export SYMFONY_REQUIRE=5.*
# alternatively you can run this command to update composer.json config
# composer config extra.symfony.require "5.*"

# install Symfony Flex in the CI environment
composer global config --no-plugins allow-plugins.symfony/flex true
composer global require --no-progress --no-scripts --no-plugins symfony/flex

# install the dependencies (using --prefer-dist and --no-progress is
# recommended to have a better output and faster download time)
composer update --prefer-dist --no-progress
```

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

### Example URL with customized parameters

Source: https://symfony.com/doc/5.x/security/form_login.html

Shows the resulting URL when using the customized parameters go_to and back_to.

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

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

### Access array query parameters using all()

Source: https://symfony.com/doc/5.x/components/http_foundation.html

Shows how to access query parameters that are arrays, like 'foo[bar]=baz'. The get() method does not support returning arrays, so use $request->query->all()['foo'] to get the array. The example demonstrates that get('foo[bar]') returns null and all()['foo']['bar'] returns 'baz'.

```php
// the query string is '?foo[bar]=baz'

// don't use $request->query->get('foo'); use the following instead:
$request->query->all()['foo'];
// returns ['bar' => 'baz']

$request->query->get('foo[bar]');
// returns null

$request->query->all()['foo']['bar'];
// returns 'baz'
```

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

### progressStart()

Source: https://symfony.com/doc/5.x/console/style.html

Displays a progress bar with a number of steps equal to the argument passed. If no argument is passed, the length is unknown.

```APIDOC
## progressStart()

### Description
Displays a progress bar with a number of steps equal to the argument passed to the method. Don't pass any value if the length of the progress bar is unknown.

### Method
progressStart()

### Parameters
- **max** (int) - Optional - The number of steps for the progress bar. If omitted, the length is unknown.

### Example
```php
// displays a progress bar of unknown length
$io->progressStart();

// displays a 100-step length progress bar
$io->progressStart(100);
```
```

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

### Store and retrieve session attributes

Source: https://symfony.com/doc/5.x/session.html

Shows how to set and get session attributes. The second argument to get() is the default value returned when the attribute doesn't exist. Accessing the session starts it automatically, which may hurt performance for anonymous users.

```php
// stores an attribute for reuse during a later user request
$session->set('attribute-name', 'attribute-value');

// gets an attribute by name
$foo = $session->get('foo');

// the second argument is the value returned when the attribute doesn't exist
$filters = $session->get('filters', []);
```

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

### Run PHPUnit tests

Source: https://symfony.com/doc/5.x/create_framework/unit_testing.html

Execute the test suite using PHPUnit in the example.com directory.

```bash
$ ./vendor/bin/phpunit
```

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

### Accessing configuration values with getParameter()

Source: https://symfony.com/doc/5.x/controller.html

Use the getParameter() helper method to retrieve any configuration parameter from a controller. This example gets the kernel.project_dir parameter.

```php
// ...
public function index(): Response
{
    $contentsDir = $this->getParameter('kernel.project_dir').'/contents';
    // ...
}
```

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

### Create a directory with Filesystem and Path

Source: https://symfony.com/doc/5.x/components/filesystem.html

This example creates a new directory in the system temp folder using a random integer as the directory name. It catches IOExceptionInterface to handle errors and prints the path where the error occurred.

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

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

### API Platform configuration file (config/packages/api_platform.yaml)

Source: https://symfony.com/doc/5.x/configuration.html

Example of a package configuration file created by Symfony Flex during installation, here for the API Platform bundle.

```yaml
# config/packages/api_platform.yaml
api_platform:
    mapping:
        paths: ['%kernel.project_dir%/src/Entity']
```

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

### List installed PHP versions

Source: https://symfony.com/doc/5.x/setup/symfony_server.html

Run this command to see all supported SAPIs (CGI, FastCGI, etc.) for each installed PHP version. FastCGI is used when possible, then CGI, and finally plain CGI.

```bash
$ symfony local:php:list

  # You'll see all supported SAPIs (CGI, FastCGI, etc.) for each version.
  # FastCGI (php-fpm) is used when possible; then CGI (which acts as a FastCGI
  # server as well), and finally, the server falls back to plain CGI.
```

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

### Common DSN examples for RedisAdapter::createConnection

Source: https://symfony.com/doc/5.x/components/cache/adapters/redis_adapter.html

Provides multiple examples of valid DSNs showing combinations of host, port, database index, auth, timeout, socket, and multiple servers. Includes a comment explaining the syntax for multiple servers.

```php
use Symfony\Component\Cache\Adapter\RedisAdapter;

// host "my.server.com" and port "6379"
RedisAdapter::createConnection('redis://my.server.com:6379');

// host "my.server.com" and port "6379" and database index "20"
RedisAdapter::createConnection('redis://my.server.com:6379/20');

// host "localhost", auth "abcdef" and timeout 5 seconds
RedisAdapter::createConnection('redis://abcdef@localhost?timeout=5');

// socket "/var/run/redis.sock" and auth "bad-pass"
RedisAdapter::createConnection('redis://bad-pass@/var/run/redis.sock');

// a single DSN can define multiple servers using the following syntax:
// host[hostname-or-IP:port] (where port is optional). Sockets must include a trailing ':'

// a single DSN can also define multiple servers
RedisAdapter::createConnection(
    'redis:?host[localhost]&host[localhost:6379]&host[/var/run/redis.sock:]&auth=my-password&redis_cluster=1'
);
```

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

### Reverse Finder sorting with reverseSorting()

Source: https://symfony.com/doc/5.x/components/finder.html

Use reverseSorting() to reverse any sorting. The example sorts by name and then reverses to get results from Z to A instead of A to Z.

```php
// results will be sorted "Z to A" instead of the default "A to Z"
$finder->sortByName()->reverseSorting();
```

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

### Example MONGODB_URL environment variable

Source: https://symfony.com/doc/5.x/configuration/env_var_processors.html

Shows a sample .env file with a MONGODB_URL that includes a query string for the query_string processor example.

```bash
# .env
MONGODB_URL="mongodb://db_user:db_password@127.0.0.1:27017/db_name?timeout=3000"
```

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

### Standardized Installation Instructions in reStructuredText (RST) for README.md

Source: https://symfony.com/doc/5.x/bundles/best_practices.html

RST version of the recommended installation instructions for a Symfony bundle. It mirrors the Markdown version, using reStructuredText directives like .. code-block:: bash and .. code-block:: terminal. The example uses placeholders and includes a link reference at the end.

```rst
Installation
============

Make sure Composer is installed globally, as explained in the
`installation chapter`_ of the Composer documentation.

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

Open a command console, enter your project directory and execute:

.. code-block:: bash

    $ composer require <package-name>

Applications that don't use Symfony Flex
----------------------------------------

Step 1: Download the Bundle
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:

.. code-block:: terminal

    $ composer require <package-name>

Step 2: Enable the Bundle
~~~~~~~~~~~~~~~~~~~~~~~~~

Then, enable the bundle by adding it to the list of registered bundles
in the ``config/bundles.php`` file of your project::

    // config/bundles.php
    return [
        // ...
        <vendor>\<bundle-name>\<bundle-long-name>::class => ['all' => true],
    ];

.. _`installation chapter`: https://getcomposer.org/doc/00-intro.md
```

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

### XML configuration example

Source: https://symfony.com/doc/5.x/components/dependency_injection/compilation.html

Shows the XML format for the extension's configuration, using the namespace and schema location.

```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-demo="http://www.example.com/schema/dic/acme_demo"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://www.example.com/schema/dic/acme_demo
        https://www.example.com/schema/dic/acme_demo/acme_demo-1.0.xsd"
>
    <acme-demo:config>
        <acme_demo:foo>fooValue</acme_demo:foo>
        <acme_demo:bar>barValue</acme_demo:bar>
    </acme-demo:config>
</container>
```

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

### Get property types with PropertyInfo::getTypes()

Source: https://symfony.com/doc/5.x/components/property_info.html

Uses the PropertyInfo component to retrieve type information for a property. The result is an array of Symfony\Component\PropertyInfo\Type objects, as shown in the example output.

```php
$types = $propertyInfo->getTypes($class, $property);
/*
    Example Result
    --------------
    array(1) {
        [0] =>
            class Symfony\Component\PropertyInfo\Type (6) {
            private $builtinType          => string(6) "string"
            private $nullable             => bool(false)
            private $class                => NULL
            private $collection           => bool(false)
            private $collectionKeyType    => NULL
            private $collectionValueType  => NULL
        }
    }
*/
```

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

### Create a basic asset package with EmptyVersionStrategy

Source: https://symfony.com/doc/5.x/components/asset.html

Creates a package without versioning. getUrl() returns the same path for absolute and relative paths.

```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
```

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

### start()

Source: https://symfony.com/doc/5.x/components/console/helpers/debug_formatter.html

Displays a message indicating that a program has started. Accepts a process identifier, a description, and an optional prefix.

```APIDOC
## start()

### Description
Displays a message indicating that a program has started. Accepts a process identifier, a description, and an optional prefix.

### Method
start

### Signature
`start(string $processId, string $description, string $prefix = 'RUN')`

### Parameters
- **processId** (string) - Required - A unique identifier for the process (e.g., `spl_object_hash($process)`).
- **description** (string) - Required - A description of the process.
- **prefix** (string) - Optional - The prefix to display before the description. Defaults to `'RUN'`.

### Return Value
Returns a string formatted as `{prefix} {description}`.

### Example
```php
$output->writeln($debugFormatter->start(
    spl_object_hash($process),
    'Some process description'
));
// Output: RUN Some process description
```

### Example with Custom Prefix
```php
$output->writeln($debugFormatter->start(
    spl_object_hash($process),
    'Some process description',
    'STARTED'
));
// Output: STARTED Some process description
```
```
Tokens:
Raw