Symfony Bundles

https://symfony.com/bundles
Admin
Symfony Bundles provide ready-to-use features, integrations, and utilities to extend and simplify...
Tokens:359,805
Snippets:4,287
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Handle Existing Installations

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

Define how the installer should behave when a previous installation is detected.

```bash
$ php bin/console ckeditor:install --clear=drop
   $ php bin/console ckeditor:install --clear=keep
   $ php bin/console ckeditor:install --clear=skip
```

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

### Clear Cache and Install Assets

Source: https://symfony.com/bundles/SonataAdminBundle/current/getting_started/installation.html

Prepare the environment after installation by clearing the cache and installing assets.

```bash
bin/console cache:clear
bin/console assets:install
```

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

### Install SassBundle

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

Install the bundle using Composer.

```bash
$ composer require symfonycasts/sass-bundle
```

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

### Install UX Live Component Bundle

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

Install the bundle via Composer.

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

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

### Install OneupFlysystemBundle

Source: https://symfony.com/bundles/LiipImagineBundle/current/cache-resolver/flysystem.html

Command to install the OneupFlysystemBundle via Composer.

```bash
$ composer require oneup/flysystem-bundle
```

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

### Install Web-Token Bundle

Source: https://symfony.com/bundles/LexikJWTAuthenticationBundle/current/10-web-token.html

Required dependency installation for enabling Web-Token support.

```bash
1
```

```bash
composer require web-token/jwt-bundle
```

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

### Install and Initialize TailwindBundle

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

Commands to install the bundle via Composer and initialize the application configuration.

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

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

### Rendered output examples

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

Examples of how the field is rendered in different contexts.

```text
1
```

```html
<input type="text">
```

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

### Install Symfony UX Svelte

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

Commands to install the bundle and initialize assets.

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

$ npm install --force
$ npm run watch
```

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

### Complete Controller Example

Source: https://symfony.com/bundles/NelmioApiDocBundle/current/symfony_attributes.html

A comprehensive example demonstrating MapQueryString, MapQueryParameter, MapRequestPayload, and MapUploadedFile with corresponding OA attributes.

```php
namespace AppBundle\Controller;

use AppBundle\UserDTO;
use AppBundle\UserQuery;
use OpenApi\Attributes as OA;
use Symfony\Component\HttpKernel\Attribute\MapQueryParameter;
use Symfony\Component\HttpKernel\Attribute\MapQueryString;
use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
use Symfony\Component\HttpKernel\Attribute\MapUploadedFile;
use Symfony\Component\Routing\Attribute\Route;

class UserController
{
    /**
     * Find user with MapQueryString.
     */
    #[Route('/api/users', methods: ['GET'])]
    #[OA\Parameter(
        name: 'userId',
        description: 'Id of the user to find',
        in: 'query',
    )]
    public function findUser(#[MapQueryString] UserQuery $userQuery)
    {
        // ...
    }

    /**
     * Find user with MapQueryParameter.
     */
    #[Route('/api/users/v2', methods: ['GET'])]
    #[OA\Parameter(
        name: 'userId',
        description: 'Id of the user to find',
        in: 'query',
    )]
    public function findUserV2(#[MapQueryParameter] int $userId)
    {
        // ...
    }

    /**
     * Create a new user.
     */
    #[Route('/api/users', methods: ['POST'])]
    #[OA\RequestBody(
        groups: ['create'],
    )]
    public function createUser(#[MapRequestPayload] UserDTO $user)
    {
        // ...
    }

    /**
     * Upload a profile picture
     */
    #[Route('/api/users/picture', methods: ['POST'])]
    #[OA\RequestBody(
        description: 'Content of the profile picture upload request',
        content: [
            new OA\MediaType('multipart/form-data', new OA\Schema(
                properties: [new OA\Property(
                    property: 'file',
                    description: 'File containing the profile picture',
                )],
            )),
        ],
    )]
    public function createUser(#[MapUploadedFile] UploadedFile $picture)
    {
        // ...
    }
}
```

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

### Install Backup Code Bundle

Source: https://symfony.com/bundles/SchebTwoFactorBundle/current/backup_codes.html

Install the required dependency via Composer.

```bash
composer require scheb/2fa-backup-code
```

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

### Setup Admin ACL Rules

Source: https://symfony.com/bundles/SonataAdminBundle/current/reference/security.html

Install or update CRUD ACL rules for existing Admin classes.

```bash
bin/console sonata:admin:setup-acl
Starting ACL AdminBundle configuration
> install ACL for sonata.media.admin.media
   - add role: ROLE_SONATA_MEDIA_ADMIN_MEDIA_GUEST, permissions: ["VIEW","LIST"]
   - add role: ROLE_SONATA_MEDIA_ADMIN_MEDIA_STAFF, permissions: ["EDIT","LIST","CREATE"]
   - add role: ROLE_SONATA_MEDIA_ADMIN_MEDIA_EDITOR, permissions: ["OPERATOR","EXPORT"]
   - add role: ROLE_SONATA_MEDIA_ADMIN_MEDIA_ADMIN, permissions: ["MASTER"]
... skipped ...
```

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

### Install assets manually

Source: https://symfony.com/bundles/NelmioApiDocBundle/current/faq.html

Execute this command to manually install bundle assets if automatic installation fails.

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

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

### Install Vue loader for Webpack Encore

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

Install the required vue-loader dependency and start the watch process.

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

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

### Warm Up Cache Output Example

Source: https://symfony.com/bundles/LiipImagineBundle/current/commands.html

Example output showing the resolved URLs for warmed up cache.

```text
http://localhost/media/cache/thumb1/path1
http://localhost/media/cache/thumb1/path2
```

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

### Install Flysystem Bundle

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

Install the required Flysystem bundle via Composer.

```bash
$ composer require league/flysystem-bundle
```

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

### Install Reprise Bundle

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

Install the bundle via Composer and the npm package via npm.

```bash
$ composer require symfony/reprise
```

```bash
$ npm install @symfony/reprise --save-dev
```

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

### Install NelmioApiDocBundle

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

Execute this command in your project directory to download the bundle.

```bash
$ composer require nelmio/api-doc-bundle
```

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

### Install SchebTwoFactorBundle via Composer

Source: https://symfony.com/bundles/SchebTwoFactorBundle/current/installation.html

Commands to install the bundle and optional feature packages.

```bash
composer require 2fa
```

```bash
composer require scheb/2fa-bundle
```

```bash
composer require scheb/2fa-backup-code            # Add backup code feature
composer require scheb/2fa-trusted-device         # Add trusted devices feature
composer require scheb/2fa-totp                   # Add two-factor authentication using TOTP
composer require scheb/2fa-google-authenticator   # Add two-factor authentication with Google Authenticator
composer require scheb/2fa-email                  # Add two-factor authentication using email
```

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

### Install Required Dependencies

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

Install necessary packages for reflection and property info extraction.

```bash
$ composer require phpdocumentor/reflection-docblock
```

```bash
$ composer require symfony/property-info:^7.1
```

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

### Install Email Authentication Package

Source: https://symfony.com/bundles/SchebTwoFactorBundle/current/providers/email.html

Install the required package to enable email-based two-factor authentication.

```bash
composer require scheb/2fa-email
```

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

### Field Label Configuration Examples

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

Examples demonstrating how to define or omit labels for fields, including handling of null, false, and HTML content.

```php
// label not defined: generate it automatically (label = 'First Name') TextField::new('firstName'), // label is null: generate it automatically (label = 'First Name') TextField::new('firstName', null),
// label is false: no label is displayed and no <label> element is rendered TextField::new('firstName', false),
// label is set explicitly: render its contents, including HTML tags TextField::new('firstName', 'Customer <b>Name</b>'),
```

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

### Install Flysystem Adapter

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

Install the specific adapter for your storage service, such as Amazon S3.

```bash
$ composer require league/flysystem-aws-s3-v3
```

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

### Install MakerBundle

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

Use Composer to add the bundle as a development dependency.

```bash
$ composer require --dev symfony/maker-bundle
```

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

### Install Assets to Web Directory

Source: https://symfony.com/bundles/FOSCKEditorBundle/current/installation.html

Install assets into the web directory based on the Symfony version.

```bash
$ php app/console assets:install web
```

```bash
$ php bin/console assets:install web
```

```bash
$ php bin/console assets:install public
```

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

### Install Swup dependencies

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

Commands to install the required Swup library and plugins via AssetMapper or NPM.

```bash
# If using Symfony AssetMapper:
php bin/console importmap:require swup @swup/fade-theme @swup/slide-theme @swup/forms-plugin @swup/debug-plugin

# If using NPM (e.g.: with Webpack Encore):
npm install swup @swup/fade-theme @swup/slide-theme @swup/forms-plugin @swup/debug-plugin
```

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

### Install via Composer

Source: https://symfony.com/bundles/StofDoctrineExtensionsBundle/current/installation.html

Use this command to download the bundle via Composer.

```bash
$ composer require stof/doctrine-extensions-bundle
```

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

### Install UX Packages

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

Install required Stimulus and UX packages via npm.

```bash
$ npm install @hotwired/stimulus @symfony/ux-leaflet-map
```

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

### Install DoctrineMigrationsBundle

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

Use Composer to add the bundle to your Symfony project.

```bash
$ composer require doctrine/doctrine-migrations-bundle "^3.0"
```

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

### Install Money PHP Library

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

Command to install the Money PHP library for object-based monetary handling.

```bash
$ composer require moneyphp/money
```

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

### Install Assets for WebpackEncore

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

Install necessary assets and restart the build process when using WebpackEncore.

```bash
$ npm install --force
$ npm run watch
```

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

### Example Manifest Output

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

The resulting manifest structure when using a CDN.

```json
{
  "build/app.js": "https://my-cool-app.com.global.prod.fastly.net/build/app-1a2b3c.js"
}
```

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

### JsonBuilder usage example

Source: https://symfony.com/bundles/FOSCKEditorBundle/current/usage/json-builder.html

A complete example demonstrating builder configuration, value setting, and resetting for multiple JSON outputs.

```php
use FOS\CKEditorBundle\Builder\JsonBuilder;

$builder = new JsonBuilder();

// {"0":"foo","1":bar}
echo $builder
    ->setJsonEncodeOptions(JSON_FORCE_OBJECT)
    ->setValues(['foo'])
    ->setValue('[1]', 'bar', false)
    ->build();

// {"foo":["bar"],"baz":bat}
echo $builder
    ->reset()
    ->setValues(['foo' => ['bar']])
    ->setValue('[baz]', 'bat', false)
    ->build();
```

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

### Install SensioFrameworkExtraBundle

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

Use Composer to add the bundle to your Symfony project.

```bash
$ composer require sensio/framework-extra-bundle
```

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

### Install Babel React preset

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

Install the necessary Babel preset to enable React support in Webpack Encore.

```bash
$ npm install -D @babel/preset-react --force
$ npm run watch
```

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

### Access Command Help

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

Display the full documentation and available options for the installation command.

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

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

### Install AWS SDK for PHP

Source: https://symfony.com/bundles/LiipImagineBundle/current/cache-resolver/aws_s3.html

Command to install the required AWS SDK dependency via Composer.

```bash
$ composer require aws/aws-sdk-php
```

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

### Install TOTP Bundle

Source: https://symfony.com/bundles/SchebTwoFactorBundle/current/providers/totp.html

Use Composer to add the TOTP provider to your project.

```bash
composer require scheb/2fa-totp
```

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

### Configure crop filter

Source: https://symfony.com/bundles/LiipImagineBundle/current/filters/sizing.html

Example configuration for the crop filter to define the cropping area and starting coordinates.

```yaml
# app/config/config.yml

liip_imagine:
    filter_sets:

        # name our filter set "my_crop_filter"
        my_crop_filter:
            filters:

                # use and setup the "crop" filter
                crop:

                    # set the size of the cropping area
                    size: [ 300, 600 ]

                    # set the starting coordinates of the crop
                    start: [ 040, 160 ]
```

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

### Configure LiipImagineBundle with The League FlysystemBundle

Source: https://symfony.com/bundles/LiipImagineBundle/current/data-loader/flysystem.html

Configuration example for setting up a Flysystem data loader using The League FlysystemBundle.

```yaml
# /config/liip_imagine.yaml

liip_imagine:
    loaders:
        profile_photos:
            flysystem:
                #⚠️ do not use the full flysystem service alias (which would be `flysystem.adapter.profile_photos.storage`) 
                filesystem_service: 'profile_photos.storage'
    data_loader: profile_photos


# /config/flysystem.yaml

flysystem:
    storages:
        profile_photos.storage:
            adapter: 'local'
            options:
                directory:  "path/to/profile/photos"
```

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

### Configure Composer for CKEditor Installation

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

Integrate the installation command into your composer routine to ensure CKEditor is managed automatically during install or update cycles.

```json
{
    "scripts": {
        "auto-scripts": {
            "cache:clear": "symfony-cmd",
            "ckeditor:install --clear=drop": "symfony-cmd",
            "assets:install --symlink --relative %PUBLIC_DIR%": "symfony-cmd"
        },
        "post-install-cmd": [
            "@auto-scripts"
        ],
        "post-update-cmd": [
            "@auto-scripts"
        ]
    }
}
```

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

### Configure LiipImagineBundle with OneupFlysystemBundle

Source: https://symfony.com/bundles/LiipImagineBundle/current/data-loader/flysystem.html

Configuration example for setting up a Flysystem data loader using the OneupFlysystemBundle.

```yaml
# /config/liip_imagine.yaml

liip_imagine:
    loaders:
        profile_photos:
            flysystem:
                filesystem_service: oneup_flysystem.profile_photos_filesystem
    data_loader: profile_photos


# /config/oneup_flysystem.yaml

oneup_flysystem:
    adapters:
        profile_photos:
            local:
                location:  "path/to/profile/photos"

    filesystems:
        profile_photos:
            adapter: profile_photos
```

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

### Install DoctrineFixturesBundle with Flex

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

Use this command if your project is configured with Symfony Flex.

```bash
$ composer require --dev orm-fixtures
```

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

### Initialize Stimulus Application

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

Start the Stimulus application from your entry file.

```javascript
import { startStimulusApp } from '@symfony/reprise/stimulus'

const app = startStimulusApp()
```

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

### Install Svelte Loader

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

Install the required loader for Svelte components.

```bash
$ npm install svelte-loader --save-dev
```

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

### Configure Live Component Test Client

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

Demonstrates how to authenticate a user, set route locales, and initialize a Live Component with a custom test client.

```php
// authenticate a user ($user is instance of UserInterface)
        $testComponent->actingAs($user);

        // set the '_locale' route parameter (if the component route is localized)
        $testComponent->setRouteLocale('fr');

        // customize the test client
        $client = self::getContainer()->get('test.client');

        // do some stuff with the client (ie login user via form)

        $testComponent = $this->createLiveComponent(
            name: 'MyComponent',
            data: ['foo' => 'bar'],
            client: $client,
        );
    }
}
```

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

### View Fixture Command Help

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

Displays available options and help documentation for the fixtures load command.

```bash
$ php bin/console doctrine:fixtures:load --help
```

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

### Final Class Example

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

Example of a class generated with the final keyword.

```php
final class MyVoter
{
    ...
}
```

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

### Download LiipImagineBundle

Source: https://symfony.com/bundles/LiipImagineBundle/current/installation.html

Execute this command in your project directory to add the bundle as a dependency.

```bash
composer require liip/imagine-bundle
```

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

### Full Controller Configuration Example

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

Demonstrates the usage of various annotations and attributes for routing, caching, templating, and security within a controller class.

```php
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;

/**
 * @Route("/blog")
 * @Cache(expires="tomorrow")
 */
class AnnotController
{
    /**
     * @Route("/")
     * @Template
     */
    public function index()
    {
        $posts = ...;

        return array('posts' => $posts);
    }

    /**
     * @Route("/{id}")
     * @Method("GET")
     * @ParamConverter("post", class="SensioBlogBundle:Post")
     * @Template("@SensioBlog/annot/show.html.twig", vars={"post"})
     * @Cache(smaxage="15", lastmodified="post.getUpdatedAt()", etag="'Post' ~ post.getId() ~ post.getUpdatedAt()")
     * @IsGranted("ROLE_SPECIAL_USER")
     * @Security("is_granted('ROLE_ADMIN') and is_granted('POST_SHOW', post)")
     */
    public function show(Post $post)
    {
    }
}
```

```php
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;

#[Route('/blog')]
#[Cache(expired: 'tomorrow')]
class AnnotController
{
    #[Route('/')]
    #[Template]
    public function index()
    {
        $posts = ...;

        return array('posts' => $posts);
    }

    #[Route('/{id}')]
    #[Method('GET')]
    #[ParamConverter('post', class: 'SensioBlogBundle:Post')]
    #[Template('@SensioBlog/annot/show.html.twig", vars: ['post'])]
    #[Cache(smaxage: 15, lastmodified: 'post.getUpdatedAt()', etag: "'Post' ~ post.getId() ~ post.getUpdatedAt()")]
    #[IsGranted('ROLE_SPECIAL_USER')]
    #[Security("is_granted('ROLE_ADMIN') and is_granted('POST_SHOW', post)")]
    public function show(Post $post)
    {
    }
}
```

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

### Install Chart.js Plugins

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

Install external Chart.js plugins via npm.

```bash
$ npm install chartjs-plugin-zoom -D
```

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

### Install KnpMenuBundle via Composer

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

Execute this command in your project root to download the bundle.

```bash
composer require knplabs/knp-menu-bundle
```

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

### Install Symfony Messenger

Source: https://symfony.com/bundles/LiipImagineBundle/current/optimizations/resolve-cache-images-in-background.html

Install the required messenger component via Composer.

```bash
composer require symfony/messenger
```

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

### Full UX Icons Configuration

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

Comprehensive configuration example covering local directories, Iconify settings, and custom icon set definitions.

```yaml
# config/packages/ux_icons.yaml
ux_icons:
    # The local directory where icons are stored
    icon_dir: '%kernel.project_dir%/assets/icons'

    # Default attributes to add to all icons
    default_icon_attributes:
        fill: currentColor
        'font-size': '1.25em'

    # Icon aliases (alias => icon name)
    aliases:
        dots: 'clarity:ellipsis-horizontal-line'
        'tabler:save': 'tabler:device-floppy'

    # Configuration for the "on demand" icons powered by Iconify.design
    iconify:
       enabled: true

       # Whether to use the "on demand" icons powered by Iconify.design
       on_demand: true

       # Whether to persist "on demand" icons to icon_dir (recommended in dev only)
       auto_lock: false

       # The endpoint for the Iconify API
       endpoint: 'https://api.iconify.design'

    # Whether to ignore errors when an icon is not found
    ignore_not_found: false

    # Icon sets configuration, array of prefix => icon set configuration
    icon_sets:
        # Icon set for "flags", can be used like this: ux_icon('flags:fr')
        flags:
            # It can either be mapped to a local directory...
            path: '%kernel.project_dir%/assets/images/flags'

            # ... or to an existing icon set identifier
            alias: 'lucide'

            # Override the default attributes (default_icon_attributes) for this icon set
            icon_attributes:
                class: 'flag'    # Replace the default class
                stroke: 'none'      # Add a new attribute
                fill: false         # Use "false" to remove a default attribute

            # Suffix-based attributes (following Iconify naming conventions)
            suffixes:
                16-solid:
                    icon_attributes:
                        fill: 'currentColor'
                20-solid:
                    icon_attributes:
                        fill: 'currentColor'
                solid:
                    icon_attributes:
                        fill: 'currentColor'
                '':
                    icon_attributes:
                        stroke: 'currentColor'
                        stroke-width: 1.5
                        fill: 'none'
```

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

### Final Entity Example

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

Example of a Doctrine entity generated with the final keyword.

```php
#[ORM\Entity(repositoryClass: TaskRepository::class)]
final class Task extends AbstractEntity
{
    ...
}
```

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

### Custom Template Example

Source: https://symfony.com/bundles/SonataAdminBundle/current/reference/action_create_edit.html

A simple Twig template example used with the TemplateType.

```twig
<a href="{{ url }}">{{ object.title }}</a>
```

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

### Create a map instance

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

Initialize a new map instance to start configuring your map.

```php
use Symfony\UX\Map\Map;

// Create a new map instance
$map = new Map();
```

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

### Full CarAdmin Implementation

Source: https://symfony.com/bundles/SonataAdminBundle/current/cookbook/recipe_custom_action.html

Complete example of an Admin class integrating custom routes and list field actions.

```php
// src/Admin/CarAdmin.php

namespace App\Admin;

use Sonata\AdminBundle\Admin\AbstractAdmin;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Route\RouteCollection;

final class CarAdmin extends AbstractAdmin
{
    protected function configureRoutes(RouteCollectionInterface $collection): void
    {
        $collection
            ->add('clone', $this->getRouterIdParameter().'/clone');
    }

    protected function configureListFields(ListMapper $list): void
    {
        $list
            ->addIdentifier('name')
            ->add('engine')
            ->add('rescueEngine')
            ->add('createdAt')
            ->add(ListMapper::NAME_ACTIONS, null, [
                'actions' => [
                    'show' => [],
                    'edit' => [],
                    'delete' => [],
                    'clone' => [
                        'template' => '@App/CRUD/list__action_clone.html.twig',
                    ]
                ]
            ]);
    }
}
```

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

### Install Stimulus Bridge dependency

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

Install the required bridge package for Webpack Encore.

```bash
$ npm install --save-dev @symfony/stimulus-bridge
```

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

### Install AWS SDK Dependency

Source: https://symfony.com/bundles/LiipImagineBundle/current/cache-resolver/amazons3.html

Install the required aws-sdk-php library via Composer.

```bash
composer require aws/aws-sdk-php
```

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

### Install CKEditor via Webpack Encore

Source: https://symfony.com/bundles/FOSCKEditorBundle/current/installation.html

Install CKEditor as a node module dependency.

```bash
# if you are using NPM as package manager
$ npm install --save ckeditor4@^4.13.0

# if you are using Yarn as package manager
$ yarn add ckeditor4@^4.13.0
```

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

### JSON payload example

Source: https://symfony.com/bundles/SchebTwoFactorBundle/current/api.html

Example of a JSON-encoded payload sent to the 2FA check path.

```json
{"data": {"authCode": "1234"}}
```

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

### Install Bootswatch via Composer

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

Use Composer to download the Bootswatch theme files.

```bash
$ composer require thomaspark/bootswatch
```

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

### Warm Up Cache Multiple Filters Output

Source: https://symfony.com/bundles/LiipImagineBundle/current/commands.html

Example output showing resolved URLs for multiple filters.

```text
http://localhost/media/cache/thumb1/path1
http://localhost/media/cache/thumb2/path1
```

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

### Install Mercure Bundle

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

Install the necessary dependency to enable Mercure support in your Symfony project.

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

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

### Dump JSON documentation with formatting options

Source: https://symfony.com/bundles/NelmioApiDocBundle/current/commands.html

Examples of generating pretty-formatted and minified JSON documentation.

```bash
$ php bin/console nelmio:apidoc:dump --format=json > json-pretty-formatted.json
$ php bin/console nelmio:apidoc:dump --format=json --no-pretty > json-no-pretty.json
```

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

### Enable the Bundle

Source: https://symfony.com/bundles/SchebTwoFactorBundle/current/installation.html

Register the bundle in the config/bundles.php file.

```php
return [
    // ...
    Scheb\TwoFactorBundle\SchebTwoFactorBundle::class => ['all' => true],
];
```

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

### Create a menu with translatable items

Source: https://symfony.com/bundles/KnpMenuBundle/current/i18n.html

Initialize a menu and add children that will be automatically translated by the bundle.

```php
$menu = $factory->createItem('root');

$menu->addChild('Home', ['route' => 'homepage']);
$menu->addChild('Login', ['route' => 'login']);
```

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

### Install PSR-6 Cache Dependency

Source: https://symfony.com/bundles/LiipImagineBundle/current/cache-resolver/psr_cache.html

Install the symfony/cache component to provide the required PSR-6 implementation.

```bash
$ composer require symfony/cache
```

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

### Run CKEditor Installation Command

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

Execute the base command to download the latest CKEditor full release into the bundle's public directory.

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

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

### Git rebase interactive editor example

Source: https://symfony.com/bundles/CMFRoutingBundle/current/contributing/commits.html

Example of the editor screen presented during an interactive rebase.

```text
pick 5d4530b port features from simple cms into routing bundle to simplify things
pick 1a0eea3 cs fixes and cleanups according to feedback
pick 8cbab56 convert settings to options
pick 8f3e4f9 cleanups for the options refactoring
```

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

### Configure Plugin Options

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

Example configuration for the zoom plugin in JavaScript and the corresponding PHP implementation.

```javascript
// ...
options: {
    plugins: {
        zoom: {
            zoom: {
              wheel: { enabled: true },
              pinch: { enabled: true },
              mode: 'xy',
            }
        }
    }
}
// ...
```

```php
$chart = $chartBuilder->createChart(Chart::TYPE_LINE);

// ...

$chart->setOptions([
    'plugins' => [
        'zoom' => [
            'zoom' => [
                'wheel' => ['enabled' => true],
                'pinch' => ['enabled' => true],
                'mode' => 'xy',
            ],
        ],
    ],
]);
```

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

### Install Tailwind via npm

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

Use npm to install Tailwind CSS when custom plugins are required.

```bash
$ npm add tailwindcss
```

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

### Dump HTML documentation with custom configuration

Source: https://symfony.com/bundles/NelmioApiDocBundle/current/commands.html

Generating static HTML documentation with specific assets mode and Swagger UI configuration.

```bash
$ php bin/console nelmio:apidoc:dump --format=html --html-config '{"assets_mode":"offline","server_url":"https://example.com","swagger_ui_config":{"supportedSubmitMethods":[]}}' > api.html
```

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

### Install External Tailwind Plugins

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

Use npm to install third-party Tailwind plugins before configuring them in your project.

```bash
$ npm install flowbite
```

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

### Install Symfony Mailer

Source: https://symfony.com/bundles/SchebTwoFactorBundle/current/providers/email.html

Install the Symfony Mailer component to support the default email sending implementation.

```bash
composer require symfony/mailer
```

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

### Configure Flysystem Resolver

Source: https://symfony.com/bundles/LiipImagineBundle/current/cache-resolver/flysystem.html

Example configuration for the LiipImagineBundle and OneupFlysystemBundle to set up a Flysystem-based cache resolver.

```yaml
# app/config/config.yml

liip_imagine:
    resolvers:
        profile_photos:
            flysystem:
                filesystem_service: oneup_flysystem.profile_photos_filesystem
                root_url:           "https://images.example.com"
                cache_prefix:       media/cache
                visibility:         public

oneup_flysystem:
    adapters:
        profile_photos:
            local:
                directory:  "path/to/profile/photos"

    filesystems:
        profile_photos:
            adapter: profile_photos
```

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

### Install Google Authenticator Provider

Source: https://symfony.com/bundles/SchebTwoFactorBundle/current/providers/google.html

Use Composer to install the required package for Google Authenticator support.

```bash
composer require scheb/2fa-google-authenticator
```

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

### Install Doctrine Cache Dependency

Source: https://symfony.com/bundles/LiipImagineBundle/current/cache-resolver/cache.html

Command to install the required Doctrine Cache library via Composer.

```bash
$ composer require doctrine/cache
```

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

### Install ExpressionLanguage Component

Source: https://symfony.com/bundles/EasyAdminBundle/current/security.html

Install the required Symfony component via Composer to enable expression-based permissions.

```bash
$ composer require symfony/expression-language
```

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

### Initialize a StaticContent document

Source: https://symfony.com/bundles/CMFRoutingBundle/current/quick_tour/the_model.html

Instantiate a StaticContent document and configure its basic properties within the load method.

```php
use Doctrine\ODM\PHPCR\DocumentManager;
use Symfony\Cmf\Bundle\ContentBundle\Doctrine\Phpcr\StaticContent;

// ...
public function load(ObjectManager $documentManager)
{
    if (!$documentManager instanceof DocumentManager) {
        throw new \RuntimeException(sprintf(
            'Fixture requires a PHPCR ODM DocumentManager instance, instance of "%s" given.',
            get_class($documentManager)
        ));
    }

    $content = new StaticContent();
    $content->setName('quick-tour'); // the name of the node
    $content->setTitle('Quick tour new Page');
    $content->setBody('I have added this page myself!');
}
```

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

### Detailed commit message example

Source: https://symfony.com/bundles/CMFRoutingBundle/current/contributing/commits.html

A concrete example of a commit message documenting bug fixes and breaking changes.

```text
[Initializer] Initializers use ManagerRegistry

Fixes: #1234, #4321

Initializers are now passed an instance of `ManagerRegistry` instead
of the `Phpcr\Session`. This means that initializers can retrieve both
the PHPCR session and the `DocumentManager`.

This PR also introduces a requirement that all initializers provide a name
which can be used in diagnostics.

BC Breaks
---------

- The `init` method of the InitializerInterface now accepts a
  `ManagerResistry` instead of a `PhpcrSession`. The PHPCR session can
  be retrieved using `$registry->getConnection` and the manager with
  `$registry->getManager()`;

- The first argument to the `GenericInitializer` constructor is now the
  name of the initializer.
```

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

### Dump Bundle Configuration

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

View the full configuration options available for the bundle.

```bash
$ php bin/console config:dump sensiolabs_typescript
```

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

### Configure Object GET Options via Constructor

Source: https://symfony.com/bundles/LiipImagineBundle/current/cache-resolver/aws_s3.html

Inject multiple GET options directly through the service constructor.

```yaml
# app/config/services.yml

services:
    acme.imagine.cache.resolver.aws_s3_resolver:
        class: Liip\ImagineBundle\Imagine\Cache\Resolver\AwsS3Resolver
        arguments:
            - "@acme.amazon_s3"
            - "%amazon_s3.bucket%"
            - "public-read" # Aws\S3\Enum\CannedAcl::PUBLIC_READ (default)
            - { Scheme: https }
        tags:
            - { name: "liip_imagine.cache.resolver", resolver: "aws_s3_resolver" }
```

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

### Install Icon Set Dependencies

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

Install the Symfony HTTP client to enable automatic downloading of remote icon sets.

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

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

### Install Custom CKEditor Build

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

Use a custom build ID from your build-config.js file to install a version generated via the online builder.

```bash
$ php bin/console ckeditor:install --release=custom --custom-build-id=574a82a0d3e9226d94b0e91d10eaa372
```

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

### Install Trusted Device Bundle

Source: https://symfony.com/bundles/SchebTwoFactorBundle/current/trusted_device.html

Use Composer to add the trusted device functionality to your project.

```bash
composer require scheb/2fa-trusted-device
```

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

### Get Help for Maker Commands

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

View optional arguments and options for a specific maker command.

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

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

### Configure Object GET Options via Service Call

Source: https://symfony.com/bundles/LiipImagineBundle/current/cache-resolver/aws_s3.html

Use a service call to set specific GET options like the request scheme.

```yaml
# app/config/services.yml

services:
    acme.imagine.cache.resolver.aws_s3_resolver:
        class: Liip\ImagineBundle\Imagine\Cache\Resolver\AwsS3Resolver
        arguments:
            - "@acme.amazon_s3"
            - "%amazon_s3.bucket%"
        calls:
             # This calls $service->setGetOption('Scheme', 'https');
             - [ setGetOption, [ Scheme, https ] ]
        tags:
            - { name: "liip_imagine.cache.resolver", resolver: "aws_s3_resolver" }
```

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

### Install Symfony UX Notify

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

Use Composer to add the bundle to your Symfony project.

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

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

### Example numeric block

Source: https://symfony.com/bundles/SonataAdminBundle/current/reference/templates.html

A simple numeric sequence block.

```text
1
2
3
4
5
```
Tokens:
Raw