Symfony

https://symfony.com/doc/6.4/
Admin
Symfony is a high-performance PHP web framework and a set of reusable PHP components used for...
Tokens:1,142,601
Snippets:12,753
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Starting Progress Bar at a Specific Point

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

This example shows how to initialize a progress bar and start it at a predefined progress point, useful for resuming tasks. The second argument to `start()` sets the initial progress value.

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

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

### HttpKernel Full Working Example

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

A complete implementation demonstrating the setup of routes, event dispatcher, controller resolver, and argument resolver to handle a request with HttpKernel.

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

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

### Start a Program with start()

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

Use the start() method to display that a program has begun. The first argument is a unique identifier, typically an object hash.

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

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

$process->run();
```

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

### Importing a module

Source: https://symfony.com/doc/6.4/frontend/encore/faq.html

Example of importing a module after installation via npm.

```javascript
import 'respond.js';
```

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

### Version output example

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

Example output when checking the version.

```text
Acme Console Application version 1.2
```

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

### Start standalone var-dump-server

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

Command to start the standalone dump server.

```bash
$ ./vendor/bin/var-dump-server
  [OK] Server listening on tcp://127.0.0.1:9912
```

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

### Install Infobip Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the Infobip notifier package.

```bash
composer require symfony/infobip-notifier
```

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

### Install Asset Component

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

Install the component using Composer.

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

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

### Install Bandwidth Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the Bandwidth notifier package.

```bash
composer require symfony/bandwidth-notifier
```

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

### Output of start()

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

The default output generated by the start() method.

```text
RUN Some process description
```

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

### Example configuration block

Source: https://symfony.com/doc/6.4/reference/configuration/security.html

A basic example of a configuration block structure.

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

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

### Initialize Framework Directory

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

Create and enter the directory for the new framework project.

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

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

### Install Doctrine ORM Pack

Source: https://symfony.com/doc/6.4/doctrine/dbal.html

Install the Doctrine ORM pack using Composer to get started with database integration.

```bash
$ composer require symfony/orm-pack
```

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

### Start the Symfony Local Server with HTTPS

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

After installing the certificate authority, start or restart your Symfony local server. It will automatically use HTTPS.

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

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

### Standard Markdown Installation Instructions

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

Provide clear and standardized installation instructions in Markdown format for your bundle's README.md file. This helps users easily integrate your bundle into their projects.

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

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

### progressStart() method

Source: https://symfony.com/doc/6.4/console/style.html

Displays a progress bar. Pass an integer to define the total steps, or no 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);
```

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

### Basic HttpKernel instantiation and execution

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

Demonstrates the minimal setup required to instantiate an HttpKernel, handle a request, and terminate the kernel.

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

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

### Start server for environment variable configuration

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

Initial step to start the server before configuring the application to use it via environment variables.

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

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

### Example HTTP GET Request

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

A typical HTTP GET request from a browser to a web server. It specifies the method, URI, and includes headers like Host, Accept, and User-Agent.

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

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

### Install Symfony CLI Certificate Authority

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

Run this command once to install the certificate authority for enabling local HTTPS. This allows the Symfony server to use HTTPS automatically on subsequent starts.

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

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

### Configure Loco DSN in .env

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

Example of the DSN configuration line added to the .env file after installing the Loco provider.

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

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

### Configuring Workers in .symfony.local.yaml

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

Example configuration file (`.symfony.local.yaml`) for defining processes that should start automatically with the Symfony local server.

```yaml
workers:
    my_worker:
        command: "bin/console my:worker"
        # other options like: "max_memory", "max_runtime", "restart_policy"
```

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

### Define a custom getter validation method

Source: https://symfony.com/doc/6.4/components/validator/metadata.html

Create a public method starting with get, has, or is to perform dynamic validation logic.

```php
public function isPasswordSafe(): bool
{
    return $this->firstName !== $this->password;
}
```

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

### GitLab CI Configuration

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

A minimal .gitlab-ci.yaml file to run Panther tests in GitLab CI, including environment setup and dependency installation.

```yaml
image: ubuntu

before_script:
  - apt-get update
  - apt-get install software-properties-common -y
  - ln -sf /usr/share/zoneinfo/Europe/Paris /etc/localtime
  - apt-get install curl wget php php-cli php8.1 php8.1-common php8.1-curl php8.1-intl php8.1-xml php8.1-opcache php8.1-mbstring php8.1-zip libfontconfig1 fontconfig libxrender-dev libfreetype6 libxrender1 zlib1g-dev xvfb chromium-chromedriver firefox-geckodriver -y -qq
  - export PANTHER_NO_SANDBOX=1
  - export PANTHER_WEB_SERVER_PORT=9080
  - php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
  - php composer-setup.php --install-dir=/usr/local/bin --filename=composer
  - php -r "unlink('composer-setup.php');"
  - composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist

test:
  script:
    - bin/phpunit
```

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

### Front Controller Setup

Source: https://symfony.com/doc/6.4/create_framework/dependency_injection.html

The front controller bootstraps the application by loading routes and the dependency injection container, creating a request, and handling it with the framework instance obtained from the container.

```php
// example.com/web/front.php
require_once __DIR__.'/../vendor/autoload.php';

use Symfony\Component\HttpFoundation\Request;

$routes = include __DIR__.'/../src/app.php';
$container = include __DIR__.'/../src/container.php';

$request = Request::createFromGlobals();

$response = $container->get('framework')->handle($request);

$response->send();
```

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

### Entity with PositiveOrZero Constraint (Attribute)

Source: https://symfony.com/doc/6.4/reference/constraints/PositiveOrZero.html

This example shows how to apply the PositiveOrZero constraint to an entity property using PHP attributes. Ensure the 'symfony/validator' component is installed.

```php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Person
{
    #[Assert\PositiveOrZero]
    protected int $siblings;
}
```

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

### CHANGELOG Entry Example

Source: https://symfony.com/doc/6.4/contributing/code/conventions.html

Format CHANGELOG entries as a Markdown list item under the relevant minor version section. Start with an imperative verb and capitalize the line.

```markdown
CHANGELOG
=========

5.3
---

 * Add `MagicConfig` that allows configuring things
```

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

### Example Configuration Array (Multiple Files)

Source: https://symfony.com/doc/6.4/bundles/configuration.html

This shows how the configuration array looks when values are merged from multiple configuration files.

```yaml
[
    // values from config/packages/acme_social.yaml
    [
        "twitter" => [
            "client_id" => 123,
            "client_secret" => "your_secret",
        ],
    ],
    // values from config/packages/dev/acme_social.yaml
    [
        "twitter" => [
            "client_id" => 456,
        ],
    ],
]
```

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

### Create public/index.php

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

The front controller used to boot and run the application.

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

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

### Example Configuration File

Source: https://symfony.com/doc/6.4/lock.html

A simple numbered list representing a configuration file structure.

```text
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
```

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

### Define a Normalizer for Option Values

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

Use setNormalizer() to automatically transform option values before they are used. This example ensures the 'host' option always starts with 'http://'.

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

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

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

### Instantiating PhpFilesAdapter

Source: https://symfony.com/doc/6.4/components/cache/adapters/php_files_adapter.html

Demonstrates how to create an instance of PhpFilesAdapter, optionally specifying a namespace, default lifetime, and cache directory.

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

$cache = new PhpFilesAdapter(

    // a string used as the subdirectory of the root cache directory, where cache
    // items will be stored
    $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 files are deleted)
    $defaultLifetime = 0,

    // the main cache directory (the application needs read-write permissions on it)
    // if none is specified, a directory is created inside the system temporary directory
    $directory = null
);

```

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

### Injecting a Service Closure in PHP

Source: https://symfony.com/doc/6.4/service_container/service_closures.html

This example shows how to define a service closure in PHP and use it within another service. The closure is type-hinted as `callable(): MailerInterface` and is invoked to get the Mailer service when needed.

```php
namespace App\Service;

use Symfony\Component\Mailer\MailerInterface;

class MyService
{
    /**
     * @param callable(): MailerInterface
     */
    public function __construct(
        private \Closure $mailer,
    ) {
    }

    public function doSomething(): void
    {
        // ...

        $this->getMailer()->send($email);
    }

    private function getMailer(): MailerInterface
    {
        return ($this->mailer)();
    }
}
```

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

### Console application bootstrap

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

Example of a bin/console file using the Runtime component to bootstrap a console application.

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

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

### Listen to ConsoleEvents::SIGNAL Event

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

Add a listener to the ConsoleEvents::SIGNAL event to execute custom logic when a command is interrupted. This example shows how to get the signal number and set a custom exit code.

```php
use Symfony
Component\Console\
ConsoleEvents;
use Symfony
Component\
Console\
Event\
ConsoleSignalEvent;

$dispatcher->addListener(ConsoleEvents::SIGNAL, function (ConsoleSignalEvent $event): void {

    // gets the signal number
    $signal = $event->getHandlingSignal();

    // sets the exit code
    $event->setExitCode(0);

    if (
																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																																	I'm looking for documentation on the `ConsoleEvents::SIGNAL` event in Symfony. I need to know how to handle signals in my console commands. I'm particularly interested in examples of how to set exit codes and how to abort the exit process. I also need to know how to implement the `SignalableCommandInterface` for commands to handle signals directly. Please provide the documentation in JSON format.```php
use Symfony
Component\
Console\
ConsoleEvents;
use Symfony
Component\
Console\
Event\
ConsoleSignalEvent;

$dispatcher->addListener(ConsoleEvents::SIGNAL, function (ConsoleSignalEvent $event) {
    $event->abortExit();
});
```
    }, 
    {
      "title": "Handle Signals Directly with SignalableCommandInterface",
      "description": "Implement the SignalableCommandInterface in your command to handle signals directly. This provides more control over signal handling within the command itself. The handleSignal method can return an integer for the exit code or false to continue execution.",
      "language": "php",
      "codeList": [
        {
          "language": "php",
          "code": "// src/Command/SomeCommand.php\nnamespace App\Command;\n\nuse Symfony\nComponent\nConsole\Command\Command;
use Symfony\nComponent\nConsole\Command\SignalableCommandInterface;

class SomeCommand extends Command implements SignalableCommandInterface
{
    // ...

    public function getSubscribedSignals(): array
    {
        // return here any of the constants defined by PCNTL extension
        return [\SIGINT, \SIGTERM];
    }

    public function handleSignal(int $signal): int|false
    {
        if (\SIGINT === $signal) {
            // ...
        }

        // ...

        // return an integer to set the exit code, or
        // false to continue normal execution
        return 0;
    }
}"
        }
      ]
    }
  ]
}
```

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

### Install New Private Recipes

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

Execute this command if your private bundles/packages are already installed and you only need to install new private recipes.

```bash
$ composer recipes
```

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

### Front Controller Setup with HttpKernel

Source: https://symfony.com/doc/6.4/create_framework/http_kernel_httpkernel_class.html

Set up the front controller to handle requests using the custom HttpKernel implementation.

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

use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpKernel;
use Symfony\Component\Routing;

$request = Request::createFromGlobals();
$requestStack = new RequestStack();
$routes = include __DIR__.'/../src/app.php';

$context = new Routing\RequestContext();
$matcher = new Routing\Matcher\UrlMatcher($routes, $context);

$controllerResolver = new HttpKernel\Controller\ControllerResolver();
$argumentResolver = new HttpKernel\Controller\ArgumentResolver();

$dispatcher = new EventDispatcher();
$dispatcher->addSubscriber(new HttpKernel\EventListener\RouterListener($matcher, $requestStack));

$framework = new Simplex\Framework($dispatcher, $controllerResolver, $requestStack, $argumentResolver);

$response = $framework->handle($request);
$response->send();
```

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

### start(string $id, string $message, ?string $prefix)

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

Displays information indicating that a program has started.

```APIDOC
## start(string $id, string $message, ?string $prefix)

### Description
Displays a formatted string indicating that a program has started. The identifier is used to track multiple programs simultaneously.

### Parameters
- **$id** (string) - Required - A unique identifier for the program (e.g., spl_object_hash).
- **$message** (string) - Required - A description of the process.
- **$prefix** (string) - Optional - A custom prefix for the output message.
```

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

### Start Symfony local web server

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

Command to start the local development server to test the application.

```bash
$ symfony server:start
```

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

### Install External Test Dependencies

Source: https://symfony.com/doc/6.4/contributing/code/tests.html

Run this command to install the external dependencies required for running Symfony tests. Ensure Composer is installed first.

```bash
composer update
```

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

### Install iSendPro Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the iSendPro notifier package.

```bash
composer require symfony/isendpro-notifier
```

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

### Start webpack-dev-server

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

Command to start the development server for asset compilation and serving from memory.

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

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

### Install Iqsms Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the Iqsms notifier package.

```bash
composer require symfony/iqsms-notifier
```

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

### Basic Filesystem Usage

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

Initialize the Filesystem class and use it to create a directory with a normalized path.

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

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

### Complete front controller framework implementation

Source: https://symfony.com/doc/6.4/create_framework/front_controller.html

A full example of the front controller including autoloading, request/response initialization, and URL mapping.

```php
// example.com/web/front.php
require_once __DIR__.'/../vendor/autoload.php';

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

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

$map = [
    '/hello' => __DIR__.'/../src/pages/hello.php',
    '/bye'   => __DIR__.'/../src/pages/bye.php',
];

$path = $request->getPathInfo();
if (isset($map[$path])) {
    ob_start();
    include $map[$path];
    $response->setContent(ob_get_clean());
} else {
    $response->setStatusCode(404);
    $response->setContent('Not Found');
}

$response->send();
```

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

### Install GoIP Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the GoIP notifier package.

```bash
composer require symfony/go-ip-notifier
```

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

### View command help documentation

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

Run a command with the --help option to display its documentation.

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

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

### Install GatewayApi Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the GatewayApi notifier package.

```bash
composer require symfony/gateway-api-notifier
```

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

### Creating a ChainAdapter Instance

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

Example of initializing a ChainAdapter with ApcuAdapter as the fast storage and FilesystemAdapter as the slow storage.

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

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

### Install FreeMobile Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the FreeMobile notifier package.

```bash
composer require symfony/free-mobile-notifier
```

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

### Retrieve client instance with withOptions()

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

Use the withOptions() method to create a new client instance with specific default options.

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

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

### Installation via Composer

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

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

```bash
$ composer require symfony/http-foundation
```

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

### Install FakeSms Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the FakeSms notifier package.

```bash
composer require symfony/fake-sms-notifier
```

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

### Example URL with custom parameters

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

An example of how the URL appears when using the custom go_to and back_to query string parameters.

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

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

### Install Esendex Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the Esendex notifier package.

```bash
composer require symfony/esendex-notifier
```

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

### Initialize ZookeeperStore

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

Example of initializing the ZookeeperStore with a Zookeeper connection.

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

$zookeeper = new \Zookeeper('localhost:2181');
// use the following to define a high-availability cluster:
// $zookeeper = new \Zookeeper('localhost1:2181,localhost2:2181,localhost3:2181');

$store = new ZookeeperStore($zookeeper);
```

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

### Install ContactEveryone Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the ContactEveryone notifier package.

```bash
composer require symfony/contact-everyone-notifier
```

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

### Install Clickatell Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the Clickatell notifier package.

```bash
composer require symfony/clickatell-notifier
```

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

### Implement a Simple Extension

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

Create an extension that loads configuration files into the container using the load method.

```php
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;

class AcmeDemoExtension implements ExtensionInterface
{
    public function load(array $configs, ContainerBuilder $container): void
    {
        $loader = new XmlFileLoader(
            $container,
            new FileLocator(__DIR__.'/../Resources/config')
        );
        $loader->load('services.xml');
    }

    // ...
```

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

### Install Brevo Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the Brevo notifier package.

```bash
composer require symfony/brevo-notifier
```

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

### Example importmap.php Configuration

Source: https://symfony.com/doc/6.4/frontend/asset_mapper.html

The resulting configuration in importmap.php after adding a package.

```php
// importmap.php
return [
    'app' => [
        'path' => './assets/app.js',
        'entrypoint' => true,
    ],
    'bootstrap' => [
        'version' => '5.3.0',
    ],
];
```

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

### Install Encore dependencies

Source: https://symfony.com/doc/6.4/frontend/encore/installation.html

Run these commands to install the necessary PHP and JavaScript dependencies for your project.

```bash
$ composer require symfony/webpack-encore-bundle
$ npm install
```

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

### Install AmazonSns Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the AmazonSns notifier package.

```bash
composer require symfony/amazon-sns-notifier
```

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

### API Platform bundle configuration example

Source: https://symfony.com/doc/6.4/configuration.html

An example of a package-specific configuration file created in config/packages/.

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

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

### Install AllMySms Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Install the AllMySms notifier package.

```bash
composer require symfony/all-my-sms-notifier
```

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

### Importing services in PHP

Source: https://symfony.com/doc/6.4/service_container.html

Example of using the load method in config/services.php to register services.

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

return function(ContainerConfigurator $container): void {
    // ...

    // makes classes in src/ available to be used as services
    // this creates a service per class whose id is the fully-qualified class name
    $services->load('App\', '../src/')
        ->exclude('../src/{DependencyInjection,Entity,Kernel.php}');
};
```

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

### Create Asset Package

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

Example of creating a basic package without 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
```

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

### Example env.json file

Source: https://symfony.com/doc/6.4/configuration.html

A sample JSON file structure containing environment variables to be loaded.

```json
{
    "vars": {
        "APP_ENV": "prod",
        "APP_DEBUG": false
    }
}
```

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

### Define Routes with PHP

Source: https://symfony.com/doc/6.4/templating.html

Example of defining routes using a PHP configuration file.

```php
// config/routes.php
use App\Controller\BlogController;
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

return function (RoutingConfigurator $routes): void {
    $routes->add('blog_index', '/')
        ->controller([BlogController::class, 'index'])
    ;

    $routes->add('blog_post', '/articles/{slug}')
        ->controller([BlogController::class, 'show'])
    ;
};
```

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

### Install Monolog Bundle

Source: https://symfony.com/doc/6.4/logging.html

Run this command to install the Monolog based logger before using it.

```text
1
```

```bash
$ composer require symfony/monolog-bundle
```

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

### Install Redis Messenger

Source: https://symfony.com/doc/6.4/messenger.html

Install the Redis transport for message queuing.

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

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

### Install Beanstalkd Messenger

Source: https://symfony.com/doc/6.4/messenger.html

Install the Beanstalkd transport for message queuing.

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

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

### Install php-parser dependency

Source: https://symfony.com/doc/6.4/reference/dic_tags.html

Install the required dependency for the advanced PhpAstExtractor.

```bash
$ composer require nikic/php-parser
```

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

### Start an asynchronous process

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

Use start() to initiate a process and isRunning() to check its status while performing other tasks.

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

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

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

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

### Basic Panther Client Usage

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

Demonstrates creating a browser client, navigating to a URL, interacting with elements, and 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');
```

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

### Install Yunpian Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Installation command for the Yunpian SMS notifier.

```bash
composer require symfony/yunpian-notifier
```

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

### Install Vonage Notifier

Source: https://symfony.com/doc/6.4/notifier.html

Installation command for the Vonage SMS notifier.

```bash
composer require symfony/vonage-notifier
```
Tokens:
Raw