Symfony

https://symfony.com/doc/7.4
Admin
Symfony is a PHP web framework and set of reusable components for building web applications, APIs,...
Tokens:1,722,389
Snippets:16,181
Trust Score:9.7
Update:3 days ago
Show doc for...
Tokens:
Raw
### Start a program with start()

Source: https://symfony.com/doc/7.4/console/helpers/debug_formatter.html

Display information indicating that a program has started using the start() method.

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

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

$process->run();
```

```text
RUN Some process description
```

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

### Install Symfony components via Composer

Source: https://symfony.com/doc/7.4/configuration/micro_kernel_trait.html

Install the necessary framework and runtime components to start a minimal Symfony application.

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

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

### Install URI template expansion package

Source: https://symfony.com/doc/7.4/http_client.html

Before using URI templates, install a third-party package that expands them. The example shows installing league/uri, with guzzlehttp/uri-template and rize/uri-template as alternatives.

```bash
$ composer require league/uri

# Symfony also supports the following URI template packages:
# composer require guzzlehttp/uri-template
# composer require rize/uri-template
```

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

### Install Asset Component

Source: https://symfony.com/doc/7.4/components/asset.html

Install the component using Composer.

```bash
$ composer require symfony/asset
```

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

### Installation step indicator

Source: https://symfony.com/doc/7.4/components/config.html

A simple numeric indicator used in the installation guide.

```text
1
```

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

### Run a process with ProcessHelper

Source: https://symfony.com/doc/7.4/console/helpers/processhelper.html

Demonstrates initializing a Process instance and executing it using the ProcessHelper.

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

$helper = new ProcessHelper();
$process = new Process(['figlet', 'Symfony']);

$helper->run($output, $process);
```

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

### PHP Configuration Examples

Source: https://symfony.com/doc/7.4/configuration/using_parameters_in_dic.html

Demonstrates how PHP configuration handles the %kernel.debug% parameter.

```php
$container->loadFromExtension('my_bundle', [
        'logging' => true,
        // true, as expected
    ]
);

$container->loadFromExtension('my_bundle', [
        'logging' => "%kernel.debug%",
        // true/false (depends on 2nd parameter of Kernel),
        // as expected, because %kernel.debug% inside configuration
        // gets evaluated before being passed to the extension
    ]
);

$container->loadFromExtension('my_bundle');
// passes the string "%kernel.debug%".
// Which is always considered as true.
// The Configurator does not know anything about
// "%kernel.debug%" being a parameter.
```

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

### Install a package with Composer

Source: https://symfony.com/doc/7.4/setup.html

Example of using the composer require command to install a package in a Symfony project.

```bash
$ cd my-project/
$ composer require logger
```

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

### Implementing ConfigCache for resource collection and generation

Source: https://symfony.com/doc/7.4/components/config/caching.html

This example demonstrates how to initialize ConfigCache, check if the cache is fresh, load resources, and write generated code to the cache file.

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

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

### YAML Configuration Examples

Source: https://symfony.com/doc/7.4/configuration/using_parameters_in_dic.html

Demonstrates how YAML configuration handles the %kernel.debug% parameter.

```yaml
my_bundle:
    logging: true
    # true, as expected

my_bundle:
    logging: '%kernel.debug%'
    # true/false (depends on 2nd argument of the Kernel class),
    # as expected, because %kernel.debug% inside configuration
    # gets evaluated before being passed to the extension

my_bundle: ~
# passes the string "%kernel.debug%".
# Which is always considered as true.
# The Configurator does not know anything about
# "%kernel.debug%" being a parameter.
```

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

### XML Configuration Examples

Source: https://symfony.com/doc/7.4/configuration/using_parameters_in_dic.html

Demonstrates how XML configuration handles the %kernel.debug% parameter.

```xml
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:my-bundle="http://example.org/schema/dic/my_bundle"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://example.org/schema/dic/my_bundle
        https://example.org/schema/dic/my_bundle/my_bundle-1.0.xsd">

    <my-bundle:config logging="true"/>
    <!-- true, as expected -->

    <my-bundle:config logging="%kernel.debug%"/>
    <!-- true/false (depends on 2nd parameter of Kernel),
         as expected, because %kernel.debug% inside configuration
         gets evaluated before being passed to the extension -->

    <my-bundle:config/>
    <!-- passes the string "%kernel.debug%".
         Which is always considered as true.
         The Configurator does not know anything about
         "%kernel.debug%" being a parameter. -->
</container>
```

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

### Install debugging features with a pack

Source: https://symfony.com/doc/7.4/setup.html

Example of using the composer require --dev command to install a Symfony pack for debugging.

```bash
composer require --dev debug
```

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

### Start the var-dump-server script (without output)

Source: https://symfony.com/doc/7.4/components/var_dumper.html

Starts the dump server using the vendor binary var-dump-server. This is the first step when configuring the dump server with environment variables.

```bash
$ ./vendor/bin/var-dump-server
```

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

### Example HTTP GET Request

Source: https://symfony.com/doc/7.4/introduction/http_fundamentals.html

A standard HTTP GET request showing the method, URI, protocol version, and common headers like Host and User-Agent.

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

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

### Get timezone names in a specific locale with Timezones::getNames() and getName()

Source: https://symfony.com/doc/7.4/components/intl.html

Passes 'de' as the locale to get timezone names in German. The output shows examples like 'America/Eirunepe' => 'Acre-Zeit (Eirunepe)'.

```PHP
$timezones = Timezones::getNames('de');
// => ['America/Eirunepe' => 'Acre-Zeit (Eirunepe)', 'America/Rio_Branco' => 'Acre-Zeit (Rio Branco)', ...]

$timezone = Timezones::getName('Africa/Nairobi', 'de');
// => 'Ostafrikanische Zeit (Nairobi)'
```

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

### Warming up and using the PhpArrayAdapter

Source: https://symfony.com/doc/7.4/cache/adapters/php_array_cache_adapter.html

This example demonstrates how to initialize the PhpArrayAdapter with a file path and a fallback adapter, perform a warm-up with static values, and retrieve cached items.

```php
use Symfony\Component\Cache\Adapter\FilesystemAdapter;
use Symfony\Component\Cache\Adapter\PhpArrayAdapter;

// somehow, decide it's time to warm up the cache!
if ($needsWarmup) {
    // some static values
    $values = [
        'stats.products_count' => 4711,
        'stats.users_count' => 1356,
    ];

    $cache = new PhpArrayAdapter(
        // single file where values are cached
        __DIR__ . '/somefile.cache',
        // a backup adapter, if you set values after warm-up
        new FilesystemAdapter()
    );
    $cache->warmUp($values);
}

// ... then, use the cache!
$cacheItem = $cache->getItem('stats.users_count');
echo $cacheItem->get();
```

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

### Accept header default values with AcceptHeader

Source: https://symfony.com/doc/7.4/components/http_foundation.html

Shows how quality values are assigned to unspecified types based on wildcard patterns. For example, 'text/xml' gets quality 0.8 from 'text/*' and 'application/xml' gets 0.3 from '*/*'.

```php
$acceptHeader = 'text/plain;q=0.5, text/html, text/*;q=0.8, */*;q=0.3';
$accept = AcceptHeader::fromString($acceptHeader);

$quality = $accept->get('text/xml')->getQuality(); // $quality = 0.8
$quality = $accept->get('application/xml')->getQuality(); // $quality = 0.3
```

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

### Configure extensions and media types

Source: https://symfony.com/doc/7.4/reference/constraints/File.html

Example showing how to explicitly set allowed media types for specific extensions while allowing all associated types for others.

```text
1
2
3
4
5
```

```php
[
    'xml' => ['text/xml', 'application/xml'],
    'txt' => 'text/plain',
    'jpg',
]
```

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

### Example URL with custom parameters

Source: https://symfony.com/doc/7.4/security/form_login.html

An example of how the query string parameters appear in the URL after configuration.

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

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

### Retrieve workflow, place, and transition metadata with getMetadata()

Source: https://symfony.com/doc/7.4/workflow.html

Shows how to use the getMetadata() method to retrieve metadata by key, optionally specifying a place name or a Transition object. The first example gets workflow metadata, the second gets place metadata, and the third gets transition metadata.

```php
// get "workflow metadata" passing the metadata key as argument
$title = $workflow->getMetadataStore()->getMetadata('title');

// get "place metadata" passing the metadata key as the first argument and the place name as the second argument
$maxNumOfWords = $workflow->getMetadataStore()->getMetadata('max_num_of_words', 'draft');

// get "transition metadata" passing the metadata key as the first argument and a Transition object as the second argument
$priority = $workflow->getMetadataStore()->getMetadata('priority', $aTransition);
```

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

### Get GMT offset in a specific locale with Timezones::getGmtOffset()

Source: https://symfony.com/doc/7.4/components/intl.html

Pass the locale as the third optional argument to get the GMT offset string in that locale. Examples show Arabic ('ar') and Dzongkha ('dz') translations.

```PHP
$offset = Timezones::getGmtOffset('Europe/Madrid', strtotime('October 28, 2019'), 'ar'); // $offset = 'غرينتش+01:00'
$offset = Timezones::getGmtOffset('Europe/Madrid', strtotime('October 28, 2019'), 'dz'); // $offset = 'ཇི་ཨེམ་ཏི་+01:00'
```

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

### Initialize PdoStore

Source: https://symfony.com/doc/7.4/components/lock.html

Example of initializing the PdoStore using a DSN string and database credentials.

```php
use Symfony\Component\Lock\Store\PdoStore;

// a PDO instance or DSN for lazy connecting through PDO
$databaseConnectionOrDSN = 'mysql:host=127.0.0.1;dbname=app';
$store = new PdoStore($databaseConnectionOrDSN, ['db_username' => 'myuser', 'db_password' => 'mypassword']);
```

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

### Example Commit Message

Source: https://symfony.com/doc/7.4/contributing/code.html

A standard format for commit messages, starting with the component name in brackets followed by an imperative sentence.

```text
[HttpClient] Add support for streaming large responses
```

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

### Create a ChainAdapter instance

Source: https://symfony.com/doc/7.4/cache/adapters/chain_adapter.html

This example demonstrates how to initialize a ChainAdapter using ApcuAdapter as the fast storage and FilesystemAdapter as the slower fallback.

```php
use Symfony\Component\Cache\Adapter\ApcuAdapter;
use Symfony\Component\Cache\Adapter\ChainAdapter;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$cache = new ChainAdapter([
    new ApcuAdapter(),
    new FilesystemAdapter(),
]);
```

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

### Normalize option values with setNormalizer()

Source: https://symfony.com/doc/7.4/components/options_resolver.html

Use setNormalizer() to transform an option value after validation. 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;
        });
    }
}
```

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

### Create a directory with Filesystem

Source: https://symfony.com/doc/7.4/components/filesystem.html

Demonstrates creating a directory using the Filesystem class and Path::normalize. It includes error handling for potential IO exceptions.

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

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

### Get country code for a timezone with Timezones::getCountryCode()

Source: https://symfony.com/doc/7.4/components/intl.html

Returns the country code for a given timezone ID. The example returns 'CA' for 'America/Vancouver'.

```PHP
$countryCode = Timezones::getCountryCode('America/Vancouver');
// => $countryCode = 'CA' (CA = Canada)
```

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

### Get timezone offsets at a specific timestamp with Timezones::getRawOffset() and getGmtOffset()

Source: https://symfony.com/doc/7.4/components/intl.html

Pass a timestamp as the second argument to get the offset at a given point in time, accounting for daylight saving time. The example uses Madrid in 2019, showing offsets before and after DST changes.

```PHP
// In 2019, the DST period in Madrid (Spain) went from March 31 to October 27
$offset = Timezones::getRawOffset('Europe/Madrid', strtotime('March 31, 2019'));   // $offset = 3600
$offset = Timezones::getRawOffset('Europe/Madrid', strtotime('April 1, 2019'));    // $offset = 7200
$offset = Timezones::getGmtOffset('Europe/Madrid', strtotime('October 27, 2019')); // $offset = 'GMT+02:00'
$offset = Timezones::getGmtOffset('Europe/Madrid', strtotime('October 28, 2019')); // $offset = 'GMT+01:00'
```

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

### Standardized Installation Instructions in Markdown

Source: https://symfony.com/doc/7.4/bundles/best_practices.html

Markdown version of the recommended installation instructions for third-party bundles. Includes steps for Composer installation, Symfony Flex usage, and manual bundle enabling in config/bundles.php.

```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],
];
```
```

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

### Interface Symfony with existing PHP session

Source: https://symfony.com/doc/7.4/session.html

Example of manually initializing a Symfony Session object to interface with an existing PHP session started by a legacy application.

```php
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\HttpFoundation\Session\Storage\PhpBridgeSessionStorage;

// legacy application configures session
ini_set('session.save_handler', 'files');
ini_set('session.save_path', '/tmp');
session_start();

// Get Symfony to interface with this existing session
$session = new Session(new PhpBridgeSessionStorage());

// symfony will now interface with the existing PHP session
$session->start();
```

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

### Initialize MongoDbStore

Source: https://symfony.com/doc/7.4/components/lock.html

Example of initializing the MongoDbStore using a MongoDB connection string and configuration options.

```php
use Symfony\Component\Lock\Store\MongoDbStore;

$mongo = 'mongodb://localhost/database?collection=lock';
$options = [
    'gcProbability' => 0.001,
    'database' => 'myapp',
    'collection' => 'lock',
    'uriOptions' => [],
    'driverOptions' => [],
];
$store = new MongoDbStore($mongo, $options);
```

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

### HttpKernel Full Working Example

Source: https://symfony.com/doc/7.4/components/http_kernel.html

A complete implementation of the HttpKernel component, including route definition, event dispatcher setup with a RouterListener, and kernel handling of a request.

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

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

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

### Advanced Kernel Configuration with MicroKernelTrait

Source: https://symfony.com/doc/7.4/configuration/micro_kernel_trait.html

A comprehensive example showing bundle registration, container configuration, and route loading using attributes.

```php
// src/Kernel.php
namespace App;

use App\DependencyInjection\AppExtension;
use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
use Symfony\Bundle\TwigBundle\TwigBundle;
use Symfony\Bundle\WebProfilerBundle\WebProfilerBundle;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symfony\Component\HttpKernel\Kernel as BaseKernel;
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

class Kernel extends BaseKernel
{
    use MicroKernelTrait;

    public function registerBundles(): iterable
    {
        yield new FrameworkBundle();
        yield new TwigBundle();

        if ('dev' === $this->getEnvironment()) {
            yield new WebProfilerBundle();
        }
    }

    protected function build(ContainerBuilder $containerBuilder): void
    {
        $containerBuilder->registerExtension(new AppExtension());
    }

    protected function configureContainer(ContainerConfigurator $container): void
    {
        $container->import(__DIR__.'/../config/framework.yaml');

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

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

### LOCO_DSN Environment Variable Example

Source: https://symfony.com/doc/7.4/translation.html

After installing the Loco provider, this line appears in your .env file. Replace API_KEY with your actual Loco API key. The loco scheme activates the Loco provider.

```dotenv
# .env
LOCO_DSN=loco://API_KEY@default
```

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

### Start and monitor an asynchronous process

Source: https://symfony.com/doc/7.4/components/process.html

Use start() to initiate a process and isRunning() to poll for completion before retrieving output with getOutput().

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

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

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

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

### Instantiating a ProxyAdapter

Source: https://symfony.com/doc/7.4/cache/adapters/proxy_adapter.html

Demonstrates how to initialize a ProxyAdapter by wrapping a PSR-6 cache pool, optionally providing a namespace for keys and a default lifetime.

```php
use Psrr
use Symfony\Component\Cache\Adapter\ProxyAdapter;

// create your own cache pool instance that implements
// the PSR-6 CacheItemPoolInterface
$psr6CachePool = ...

$cache = new ProxyAdapter(

    // a cache pool instance
    CacheItemPoolInterface $psr6CachePool,

    // a string prefixed to the keys of the items stored in this cache
    $namespace = '',

    // the default lifetime (in seconds) for cache items that do not define their
    // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
    // until the cache is cleared)
    $defaultLifetime = 0
);
```

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

### Get raw and GMT offsets with Timezones::getRawOffset() and getGmtOffset()

Source: https://symfony.com/doc/7.4/components/intl.html

getRawOffset() returns an integer offset in seconds, while getGmtOffset() returns a string like 'GMT+00:00'. Examples show offsets for Etc/UTC, America/Buenos_Aires, and Asia/Katmandu.

```PHP
$offset = Timezones::getRawOffset('Etc/UTC');              // $offset = 0
$offset = Timezones::getRawOffset('America/Buenos_Aires'); // $offset = -10800
$offset = Timezones::getRawOffset('Asia/Katmandu');        // $offset = 20700

$offset = Timezones::getGmtOffset('Etc/UTC');              // $offset = 'GMT+00:00'
$offset = Timezones::getGmtOffset('America/Buenos_Aires'); // $offset = 'GMT-03:00'
$offset = Timezones::getGmtOffset('Asia/Katmandu');        // $offset = 'GMT+05:45'
```

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

### Get timezones for a country with Timezones::forCountryCode()

Source: https://symfony.com/doc/7.4/components/intl.html

Returns an array of timezone IDs for a given country code. Country codes are always uppercase (e.g., 'CL' for Chile). The example returns ['America/Punta_Arenas', 'America/Santiago', 'Pacific/Easter'].

```PHP
// unlike language codes, country codes are always uppercase (CL = Chile)
$timezones = Timezones::forCountryCode('CL');
// => ['America/Punta_Arenas', 'America/Santiago', 'Pacific/Easter']
```

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

### Create Project Directory

Source: https://symfony.com/doc/7.4/create_framework/introduction.html

Commands to create and enter the directory for the new framework project.

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

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

### Basic Usage with HttpClientInterface in Symfony Framework

Source: https://symfony.com/doc/7.4/http_client.html

Use the HttpClientInterface type-hint to autowire the http_client service in a Symfony application. The example makes a GET request to the GitHub API and retrieves status code, headers, content, and array data.

```php
use Symfony\Contracts\HttpClient\HttpClientInterface;

class SymfonyDocs
{
    public function __construct(
        private HttpClientInterface $client,
    ) {
    }

    public function fetchGitHubInformation(): array
    {
        $response = $this->client->request(
            'GET',
            'https://api.github.com/repos/symfony/symfony-docs'
        );

        $statusCode = $response->getStatusCode();
        // $statusCode = 200
        $contentType = $response->getHeaders()['content-type'][0];
        // $contentType = 'application/json'
        $content = $response->getContent();
        // $content = '{"id":521583, "name":"symfony-docs", ...}'
        $content = $response->toArray();
        // $content = ['id' => 521583, 'name' => 'symfony-docs', ...]

        return $content;
    }
}
```

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

### Configure framework.assets.version_strategy in PHP

Source: https://symfony.com/doc/7.4/reference/configuration/framework.html

Example showing global and package-specific version strategy configuration in PHP.

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

return static function (FrameworkConfig $framework): void {
    // ...
    $framework->assets()
        ->versionStrategy('app.asset.my_versioning_strategy');

    $framework->assets()->package('foo_package')
        // this package removes any versioning (its assets won't be versioned)
        ->version(null);

    $framework->assets()->package('bar_package')
        // this package uses its own strategy (the default strategy is ignored)
        ->versionStrategy('app.asset.another_version_strategy');

    $framework->assets()->package('baz_package')
        // this package inherits the default strategy
        ->basePath('/images');
};
```

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

### Start the local web server

Source: https://symfony.com/doc/7.4/setup/symfony_cli.html

Commands to start the local development server and open the application in the browser.

```bash
$ cd my-project/
$ symfony server:start

  [OK] Web server listening on http://127.0.0.1:8000
  ...
```

```bash
$ symfony open:local
```

```bash
$ symfony server:start --open
```

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

### Front controller example in index.php

Source: https://symfony.com/doc/7.4/introduction/http_fundamentals.html

A minimal front controller that handles every request. It creates a Request from globals, gets the path info, and returns a Response for the homepage, /contact, or a 404. This is the traditional approach before using Symfony's full stack.

```php
// index.php
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

$request = Request::createFromGlobals();
$path = $request->getPathInfo(); // the URI path being requested

if (in_array($path, ['', '/'])) {
    $response = new Response('Welcome to the homepage.');
} elseif ('/contact' === $path) {
    $response = new Response('Contact us');
} else {
    $response = new Response('Page not found.', Response::HTTP_NOT_FOUND);
}
$response->send();
```

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

### Find profiler tokens using find()

Source: https://symfony.com/doc/7.4/profiler.html

Use this snippet to search for tokens based on criteria such as IP, URL, limit, method, and date range. The examples show how to get the latest tokens, filter by URL patterns (including negation), filter by IP and method, and specify a date range.

```php
// gets the latest 10 tokens
$tokens = $profiler->find('', '', 10, '', '', '');

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

// gets the latest 10 tokens for all URLs not containing /api/
$tokens = $profiler->find('', '!/api/', 10, '', '', '');

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

// gets the latest 10 tokens for requests that happened between 2 and 4 days ago
$tokens = $profiler->find('', '', 10, '', '4 days ago', '2 days ago');
```

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

### Configure framework.assets.version_strategy in XML

Source: https://symfony.com/doc/7.4/reference/configuration/framework.html

Example showing global and package-specific version strategy configuration in XML.

```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:assets version-strategy="app.asset.my_versioning_strategy">
            <!-- this package removes any versioning (its assets won't be versioned) -->
            <framework:package
                name="foo_package"
                version="null"/>
            <!-- this package uses its own strategy (the default strategy is ignored) -->
            <framework:package
                name="bar_package"
                version-strategy="app.asset.another_version_strategy"/>
            <!-- this package inherits the default strategy -->
            <framework:package
                name="baz_package"
                base_path="/images"/>
        </framework:assets>
    </framework:config>
</container>
```

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

### Instantiate and execute HttpKernel

Source: https://symfony.com/doc/7.4/components/http_kernel.html

Basic setup for the HttpKernel, including creating the request, initializing resolvers, and handling the request lifecycle.

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

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

### Get timezone names and a single timezone name with Timezones::getNames() and getName()

Source: https://symfony.com/doc/7.4/components/intl.html

Sets the default locale to 'en' and retrieves all timezone names as an associative array (timezone ID => localized name) and a single timezone name. The output shows examples like 'America/Eirunepe' => 'Acre Time (Eirunepe)'.

```PHP
use Symfony\Component\Intl\Timezones;

\Locale::setDefault('en');

$timezones = Timezones::getNames();
// ('timezoneID' => 'timezoneValue')
// => ['America/Eirunepe' => 'Acre Time (Eirunepe)', 'America/Rio_Branco' => 'Acre Time (Rio Branco)', ...]

$timezone = Timezones::getName('Africa/Nairobi');
// => 'East Africa Time (Nairobi)'
```

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

### Example Front Controller

Source: https://symfony.com/doc/7.4/components/runtime.html

Shows how an end user utilizes the custom runtime in a front controller file.

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

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

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

### Install VarDumper with Composer

Source: https://symfony.com/doc/7.4/components/var_dumper.html

Use this command to install the VarDumper component as a development dependency. If installing outside a Symfony application, you must require vendor/autoload.php; inside a Symfony app, ensure the DebugBundle is installed.

```bash
$ composer require --dev symfony/var-dumper
```

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

### View Command Help

Source: https://symfony.com/doc/7.4/console.html

Use the --help global option to display documentation for a specific command.

```bash
$ php bin/console assets:install --help
```

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

### Start webpack-dev-server

Source: https://symfony.com/doc/7.4/frontend/encore/dev-server.html

Run the dev-server command to build and serve assets from memory.

```bash
$ npm run dev-server
```

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

### Start ProgressBar at a specific point

Source: https://symfony.com/doc/7.4/console/helpers/progressbar.html

Creates a ProgressBar with 100 units and starts it at 25 completed units using the second optional argument of start().

```PHP
use Symfony\Component\Console\Helper\ProgressBar;

// creates a new progress bar (100 units)
$progressBar = new ProgressBar($output, 100);

// displays the progress bar starting at 25 completed units
$progressBar->start(null, 25);
```

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

### Install Private Recipes for Existing Bundles

Source: https://symfony.com/doc/7.4/setup/flex_private_recipes.html

Run this command to install new private recipes when the associated bundles or packages are already installed in the project.

```bash
$ composer recipes
```

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

### Retrieve and Create BrowserKit Clients

Source: https://symfony.com/doc/7.4/testing/end_to_end.html

Demonstrates how to retrieve different client instances or create custom ones for specific browser configurations.

```php
namespace App\Tests;

use Symfony\Component\Panther\Client;
use Symfony\Component\Panther\PantherTestCase;

class AppTest extends PantherTestCase
{
    public function testMyApp(): void
    {
        // retrieve an existing client
        $symfonyClient = static::createClient();
        $httpBrowserClient = static::createHttpBrowserClient();
        $pantherClient = static::createPantherClient();
        $firefoxClient = static::createPantherClient(['browser' => static::FIREFOX]);

        // create a custom client
        $customChromeClient = Client::createChromeClient(null, null, [], 'https://example.com');
        $customFirefoxClient = Client::createFirefoxClient(null, null, [], 'https://example.com');
        $customSeleniumClient = Client::createSeleniumClient('http://127.0.0.1:4444/wd/hub', null, 'https://example.com');

        // if you are testing a Symfony app, you also have access to the kernel
        $kernel = static::createKernel();

        // ...
    }
}
```

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

### Install symfony/phpunit-bridge with Composer

Source: https://symfony.com/doc/7.4/components/phpunit_bridge.html

Run this command in your project root to install the PHPUnit bridge as a dev dependency. After installation, a simple-phpunit script is created in the vendor/ directory.

```bash
$ composer require --dev symfony/phpunit-bridge
```

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

### Console application bootstrap

Source: https://symfony.com/doc/7.4/components/runtime.html

Example of a bin/console file configured to run a Console application via 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 YAML configuration for an extension

Source: https://symfony.com/doc/7.4/service_container/extensions.html

A sample configuration file using the extension alias as a key to pass values to the extension.

```yaml
# config.yaml
acme_demo:
    foo: fooValue
    bar: barValue
```

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

### Install DoctrineFixturesBundle

Source: https://symfony.com/doc/7.4/testing.html

Install the fixtures bundle as a development dependency.

```bash
$ composer require --dev doctrine/doctrine-fixtures-bundle
```

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

### Basic Panther Client Usage

Source: https://symfony.com/doc/7.4/testing/end_to_end.html

Demonstrates how to initialize a browser client, navigate to a URL, interact with elements, and perform actions like waiting for visibility or taking screenshots.

```php
use Symfony\Component\Panther\Client;

$client = Client::createChromeClient();
// alternatively, create a Firefox client
$client = Client::createFirefoxClient();

$client->request('GET', 'https://api-platform.com');
$client->clickLink('Getting started');

// wait for an element to be present in the DOM, even if hidden
$crawler = $client->waitFor('#bootstrapping-the-core-library');
// you can also wait for an element to be visible
$crawler = $client->waitForVisibility('#bootstrapping-the-core-library');

// get the text of an element thanks to the query selector syntax
echo $crawler->filter('div:has(> #bootstrapping-the-core-library)')->text();
// take a screenshot of the current page
$client->takeScreenshot('screen.png');
```

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

### Installation via Composer

Source: https://symfony.com/doc/7.4/components/type_info.html

Use this command to install the TypeInfo component in your project.

```bash
$ composer require symfony/type-info
```
Tokens:
Raw