Symfony

https://symfony.com/
Admin
Symfony is a flexible and high-performance PHP web framework and set of reusable components used to...
Tokens:4,004,368
Snippets:41,313
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install the certificate authority and start HTTPS server

Source: https://symfony.com/doc/current/setup/symfony_server.html

Install the local certificate authority once, then start the server to use HTTPS automatically.

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

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

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

### Install Tailwind Bundle and Initialize

Source: https://symfony.com/bundles/TailwindBundle/current/index.html

Run these two commands to install the bundle and initialize your app. The init command will ask a few questions about your setup.

```bash
$ composer require symfonycasts/tailwind-bundle
$ php bin/console tailwind:init
```

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

### Create and start a Symfony project with Composer

Source: https://symfony.com/in-five-minutes

Use these three commands to create a minimal Symfony application and start the local server. No installers or scaffolding wizards are needed.

```bash
$ composer create-project symfony/skeleton my_project
$ cd my_project
$ symfony server:start
```

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

### package.xml <dependencies> section example

Source: https://symfony.com/blog/jobeet-day-20-the-plugins

Example of the <dependencies> section in a package.xml file, declaring required PHP and PEAR installer versions and a symfony dependency with minimum and maximum versions. The plugin:install task uses this information to install the best plugin version and required dependencies.

```xml
<dependencies>
  <required>
    <php>
      <min>5.0.0</min>
    </php>
    <pearinstaller>
      <min>1.4.1</min>
    </pearinstaller>
    <package>
      <name>symfony</name>
      <channel>pear.symfony-project.com</channel>
      <min>1.2.0</min>
      <max>1.3.0</max>
      <exclude>1.3.0</exclude>
    </package>
  </required>
</dependencies>
 

```

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

### Get incremental output from multiple processes

Source: https://symfony.com/blog/new-in-symfony-2-2-process-component-enhancements

Start multiple processes and retrieve their incremental output using getIncrementalOutput() and getIncrementalErrorOutput(). This example shows a loop that checks if each process is started, starts it if not, prints its incremental output, and removes it when it stops.

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

$processes = array();
$processes[] = new Process('ls -lsa');
$processes[] = new Process('ps waux');

while (count($processes) > 0) {
     foreach ($processes as $i => $process) {
         if (!$process->isStarted()) {
             echo "Process starts\n";

             $process->start();

             continue;
         }

         echo $process->getIncrementalOutput();
         echo $process->getIncrementalErrorOutput();

         if (!$process->isRunning()) {
             echo "Process stopped\n";

             unset($processes[$i]);
         }
     }

     sleep(1);
}
```

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

### Start the local server and open browser with --open

Source: https://symfony.com/doc/current/setup/symfony_server.html

Starts the server and opens the URL in the browser in a single command.

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

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

### ai:store:setup command usage

Source: https://symfony.com/doc/current/ai/bundles/ai-bundle.html

Prepares the required infrastructure for a store (e.g., creates database tables, indexes, collections). Only works with stores implementing ManagedStoreInterface.

```bash
$ php bin/console ai:store:setup <store>

# Setup the chromadb store
$ php bin/console ai:store:setup ai.store.chromadb.default
```

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

### Install Cloudflare provider bridge

Source: https://symfony.com/bundles/ux-image/current/index.html

Install one of the provider bridges, for example Cloudflare.

```bash
$ composer require symfony/ux-cloudflare-image
```

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

### Create and enter the framework directory

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

Commands to create a new directory named 'framework' and change into it. This is the first step in bootstrapping the project.

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

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

### Install JsonStreamer with Composer

Source: https://symfony.com/json-streamer

Use this command to install the symfony/json-streamer package in your PHP project. It is the required setup step before using the component.

```bash
$ composer require symfony/json-streamer
```

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

### Install SMSC Notifier with Composer

Source: https://symfony.com/packages/smsc-notifier

Use Composer to install the symfony/smsc-notifier package in your PHP project. This is the required setup step before using the bridge.

```bash
$ composer require symfony/smsc-notifier
```

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

### Show ckeditor:install help

Source: https://symfony.com/bundles/FOSCKEditorBundle/current/usage/ckeditor.html

Displays the command's documentation using the --help option.

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

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

### Install SmsboxNotifier with Composer

Source: https://symfony.com/packages/smsbox-notifier

Use Composer to install the symfony/smsbox-notifier package in your PHP project. This is the required setup step before using the notifier bridge.

```bash
$ composer require symfony/smsbox-notifier
```

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

### Install a Recipe with ux:install

Source: https://symfony.com/bundles/ux-toolkit/current/index.html

Run the `ux:install` command with the recipe name to copy its files into your application. The command asks which kit to use, copies files, and lists required dependencies.

```bash
$ php bin/console ux:install dialog
```

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

### Create a directory with Filesystem and Path

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

This example shows how to use the Filesystem and Path classes. It creates a directory in the system temp directory with a random suffix, and catches IOExceptionInterface to handle errors, printing 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();
}
```

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

### Install Symfony UX Dropzone with Composer

Source: https://symfony.com/bundles/ux-dropzone/current/index.html

Use this command to install the bundle via Composer and Symfony Flex. Ensure StimulusBundle is configured before starting.

```bash
$ composer require symfony/ux-dropzone
```

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

### Example services.yml before upgrade

Source: https://symfony.com/doc/current/service_container/3.3-di-changes.html

Initial service configuration with machine-name service IDs and explicit class definitions.

```yaml
# app/config/services.yml
services:
    app.github_notifier:
        class: AppBundle\Service\GitHubNotifier
        arguments:
            - '@app.api_client_github'

    markdown_transformer:
        class: AppBundle\Service\MarkdownTransformer

    app.api_client_github:
        class: AppBundle\Service\ApiClient
        arguments:
            - 'https://api.github.com'

    app.api_client_sl_connect:
        class: AppBundle\Service\ApiClient
        arguments:
            - 'https://connect.symfony.com/api'
```

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

### Set up store and index documents from console

Source: https://symfony.com/doc/current/ai/cookbook/ai-bundle-fast-track.html

Console commands to prepare the store infrastructure and run the indexer. The first command sets up the ChromaDB store, the second indexes documents from a specified file path.

```bash
$ php bin/console ai:store:setup ai.store.chromadb.knowledge_base
$ php bin/console ai:store:index docs --source=/path/to/document.txt
```

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

### Install Symfony UX Cropper.js with Composer

Source: https://symfony.com/bundles/ux-cropperjs/current/index.html

Run this command to install the bundle using Composer and Symfony Flex. Ensure StimulusBundle is configured before starting.

```bash
$ composer require symfony/ux-cropperjs
```

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

### Install WhatsApp Notifier Bridge with Composer

Source: https://symfony.com/packages/whats-app-notifier

Use Composer to install the symfony/whats-app-notifier package in your PHP project. This is the required setup step before using the bridge.

```bash
$ composer require symfony/whats-app-notifier
```

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

### Install a common Toolkit recipe with ux:install

Source: https://symfony.com/blog/symfony-ux-3-4-0-released

Installs the clipboard recipe from the common Toolkit kit. Use the --kit common option to specify the kit, and replace 'clipboard' with the desired recipe name (e.g., post-link, logout-link, closeable, tooltip).

```bash
$ php bin/console ux:install clipboard --kit common
```

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

### Install Symfony features with Composer require

Source: https://symfony.com/in-five-minutes

Install features on demand with Composer. Symfony configures them automatically. Examples include an ORM, a mailer, and a live component.

```bash
$ composer require orm
$ composer require mailer
$ composer require symfony/ux-live-component
```

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

### setUploadDir examples

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ImageField.html

Sets the directory where uploaded images are stored. Relative paths are resolved from the project root; absolute filesystem paths are used as-is. This option is required; an exception is thrown if not called.

```php
// relative to your project root directory
yield ImageField::new('...')->setUploadDir('public/uploads/images/');
// absolute filesystem paths are also supported
yield ImageField::new('...')->setUploadDir('/mnt/data/images/');
// the property will only store the file path relative to this dir
// (e.g. 'logo.png', 'venue/layout.jpg')
```

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

### Get a configuration parameter with getParameter()

Source: https://symfony.com/doc/current/controller.html

Use $this->getParameter() to retrieve any configuration parameter from a controller. The example shows getting the kernel.project_dir parameter to build a path.

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

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

### Install SendGrid Mailer

Source: https://symfony.com/doc/current/components/mime.html

Install the SendGrid mailer package to use SendGrid as a third-party transport. The Flex recipe adds a configuration example to your .env file.

```bash
$ composer require symfony/sendgrid-mailer
```

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

### Install HttpClient and Serializer

Source: https://symfony.com/doc/current/webhook.html

Run this command to install the required packages for sending webhooks.

```bash
$ composer require symfony/http-client symfony/serializer
```

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

### Basic HttpKernel setup with EventDispatcher and resolvers

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

Shows the minimal setup for creating and running an HttpKernel instance. It creates a Request, dispatcher, controller and argument resolvers, then handles the request and terminates. The numbered lines above the code are line references, not part of the code.

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

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

### Install Symfony AI Failover Platform with Composer

Source: https://symfony.com/packages/ai-failover-platform

Use Composer to install the symfony/ai-failover-platform package in your PHP project. This is the required setup step before using the package.

```bash
$ composer require symfony/ai-failover-platform
```

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

### Install the Symfony Serializer Pack with Composer

Source: https://symfony.com/doc/current/components/serializer.html

Run this command in a Symfony Flex application to install the serializer pack. The pack also installs commonly used optional dependencies; outside the framework, start with the symfony/serializer package instead.

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

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

### Define a Live Component with Map (MapLivePlayground)

Source: https://symfony.com/bundles/ux-map/current/index.html

Use the ComponentWithMapTrait and implement instantiateMap() to return a Map instance. The example sets the center, fits bounds to markers, and adds two markers with info windows.

```php
namespace App\Twig\Components;

use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
use Symfony\UX\LiveComponent\Attribute\LiveAction;
use Symfony\UX\LiveComponent\DefaultActionTrait;
use Symfony\UX\Map\InfoWindow;
use Symfony\UX\Map\Live\ComponentWithMapTrait;
use Symfony\UX\Map\Map;
use Symfony\UX\Map\Marker;
use Symfony\UX\Map\Point;

#[AsLiveComponent]
final class MapLivePlayground
{
    use DefaultActionTrait;
    use ComponentWithMapTrait;

    protected function instantiateMap(): Map
    {
        return (new Map())
            ->center(new Point(48.8566, 2.3522))
            ->fitBoundsToMarkers()
            ->addMarker(new Marker(position: new Point(48.8566, 2.3522), title: 'Paris', infoWindow: new InfoWindow('Paris')))
            ->addMarker(new Marker(position: new Point(45.75, 4.85), title: 'Lyon', infoWindow: new InfoWindow('Lyon')))
        ;
    }
}
```

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

### ManagedStoreInterface::setup() and drop()

Source: https://symfony.com/doc/current/ai/components/store.html

Defines methods to setup and drop the store, required for stores that need to create tables, indexes, etc. before storing vectors.

```APIDOC
## ManagedStoreInterface::setup() and drop()

### Description
Defines methods to setup and drop the store. The setup() method creates the necessary tables, indexes, etc., while drop() removes the store and related vectors.

### Method
setup() and drop()

### Signature
```php
public function setup(array $options = []): void
public function drop(array $options = []): void
```

### Parameters
- **$options** (array) - Optional - An associative array of options for the operation.

### Example
```php
use Symfony\AI\Store\ManagedStoreInterface;
use Symfony\AI\Store\StoreInterface;

class MyCustomStore implements ManagedStoreInterface, StoreInterface
{
    public function setup(array $options = []): void
    {
        // Implementation to create the store
    }

    public function drop(array $options = []): void
    {
        // Implementation to drop the store (and related vectors)
    }
}
```
```

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

### Get timezone offsets with Timezones::getRawOffset() and getGmtOffset()

Source: https://symfony.com/blog/new-in-symfony-4-3-timezone-improvements

Use Timezones::getRawOffset() to get the raw offset in seconds from UTC, and Timezones::getGmtOffset() to get the offset as a GMT string. Examples show results 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'
```

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

### Write Agent Instructions in INSTRUCTIONS.md

Source: https://symfony.com/doc/current/ai/components/mate/creating-extensions.html

Example `INSTRUCTIONS.md` file that maps existing CLI commands to Mate tools and states the benefits. It shows how to structure the instructions to tell an agent when to use your tools, including a table of command replacements and a list of benefits.

```markdown
## My Extension

Use the Mate tools instead of the CLI for better results:

| Instead of...              | Use                                                    |
|----------------------------|--------------------------------------------------------|
| `my-cli command`           | `vendor/bin/mate tools:call my-tool`                   |
| `my-cli search "term"`     | `vendor/bin/mate tools:call my-search --term="term"`   |

### Benefits
- Structured output that AI can parse
- Better error handling and context
- Integrated with project configuration
```

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

### Install and verify a Mate extension

Source: https://symfony.com/doc/current/ai/components/mate/creating-extensions.html

Installs the extension and verifies its capabilities. In a project that ran mate init, the Composer plugin runs mate discover automatically.

```bash
$ composer require --dev vendor/my-extension
$ vendor/bin/mate debug:capabilities --extension=vendor/my-extension
```

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

### Install Symfony 2.3.0 with Composer

Source: https://symfony.com/blog/upgrading-your-symfony-projects-the-easy-way

Use this command to install Symfony 2.3.0 via Composer. It is the only explicit code example in the source and is used to demonstrate the upgrade process.

```bash
composer create-project symfony/framework-standard-edition . 2.3.0
```

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

### Install a Recipe with a Specific Kit

Source: https://symfony.com/bundles/ux-toolkit/current/index.html

Use the `--kit` option to skip the kit selection question and directly install a recipe from a specified kit, such as `shadcn`.

```bash
$ php bin/console ux:install button --kit=shadcn
```

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

### Install Vonage Notifier with Composer

Source: https://symfony.com/packages/vonage-notifier

Use Composer to install the symfony/vonage-notifier package in your PHP project. This is the required setup step before using the Vonage SMS notifier bridge.

```bash
$ composer require symfony/vonage-notifier
```

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

### Install Supervisor on Ubuntu

Source: https://symfony.com/doc/current/components/messenger.html

Install Supervisor on Ubuntu using apt-get.

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

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

### Install Symfony Slack Notifier with Composer

Source: https://symfony.com/packages/slack-notifier

Use Composer to install the symfony/slack-notifier package in your PHP project. This is the required setup step before using the Slack notifier bridge.

```bash
$ composer require symfony/slack-notifier
```

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

### Install vue-loader and run watch

Source: https://symfony.com/bundles/ux-vue/current/index.html

Install the Vue loader with npm and start the watch mode. The --force flag is required to override potential peer dependency conflicts.

```bash
$ npm install -D vue-loader --force
$ npm run watch
```

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

### Show make:controller help

Source: https://symfony.com/bundles/SymfonyMakerBundle/current/index.html

Displays the help for the make:controller command, including its optional arguments and options.

```bash
$ php bin/console make:controller --help
```

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

### Get country code from timezone ID

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

Uses Timezones::getCountryCode() to get the country code for a given timezone ID. The example shows 'America/Vancouver' returning 'CA' for Canada.

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

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

### Enable multiple server tools simultaneously

Source: https://symfony.com/doc/current/ai/components/platform/gemini-server-tools.html

Shows how to enable multiple server tools at once: URL Context, Google Search, and Code Execution. The example asks to calculate the factorial of 20 and show the code. Uses 'server_tools' with all three options set to true.

```php
$messages = new MessageBag(
    Message::ofUser('Calculate the factorial of 20 and show me the code')
);

$result = $platform->invoke('gemini-2.5-pro', $messages, [
    'server_tools' => [
        'url_context' => true,
        'google_search' => true,
        'code_execution' => true,
    ]
]);
```

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

### Install Symfony Telegram Notifier via Composer

Source: https://symfony.com/packages/telegram-notifier

Use Composer to install the symfony/telegram-notifier package in your PHP project. This is the required setup step before using the Telegram notifier bridge.

```bash
$ composer require symfony/telegram-notifier
```
Tokens:
Raw