StofDoctrineExtensionsBundle

To use the SoftDeleteable behavior, you must enable the corresponding Doctrine filter in your configuration. This ensures that entities marked as deleted are automatically excluded from queries.

If you are using Symfony Flex, add the configuration to config/packages/doctrine.yaml. If you are using the traditional app/config/config.yml, add it there instead.

Note: If you use multiple entity managers, ensure you register the filter for the specific entity manager you are using.

# app/config/config.yml
# (or config/packages/doctrine.yaml if you use Flex)
doctrine:
    orm:
        entity_managers:
            default:
                filters:
                    softdeleteable:
                        class: Gedmo\SoftDeleteable\Filter\SoftDeleteableFilter
                        enabled: true

If your Symfony project (version 3.4 or higher) uses Symfony Flex, you can install and automatically configure the bundle by running a single Composer command. Flex will handle downloading, registering, and configuring the bundle for you.

$ composer require stof/doctrine-extensions-bundle

If you need to access entities that have been soft-deleted (for example, in an admin panel), you can disable the softdeleteable filter at runtime using the Doctrine Filter collection.

$filters = $em->getFilters();
$filters->disable('softdeleteable');

You can replace the default Gedmo listeners (or the bundle's translation listeners) with your own custom implementations. To do this, provide the fully qualified class name of your custom listener in the stof_doctrine_extensions.class configuration section. If you want to keep the default listener for a specific extension, use the tilde (~) character.

# config/packages/stof_doctrine_extensions.yaml
stof_doctrine_extensions:
    class:
        tree:           MyBundle\TreeListener
        timestampable:  MyBundle\TimestampableListener
        blameable:      ~
        sluggable:      ~
        translatable:   ~
        loggable:       ~
        softdeleteable: ~
        uploadable:     ~

If your project does not use Symfony Flex, you must manually download and register the bundle following these two steps:

Step 1: Download the Bundle

Run the following command in your project directory to download the latest stable version:

$ composer require stof/doctrine-extensions-bundle

Step 2: Enable the Bundle

Manually register the bundle in your app/AppKernel.php file by adding new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle() to the $bundles array within the registerBundles() method.

// app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...

            new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        );

        // ...
    }

    // ...
}

You must explicitly activate extensions for each entity manager (ORM) or document manager (MongoDB) you wish to use. The bundle requires a default_locale (defaults to en) to be used when a translation is missing for the requested language.

In YAML, use the stof_doctrine_extensions key. In XML, use the stof-doctrine-extensions namespace.

# app/config/config.yml
# (or config/packages/stof_doctrine_extensions.yaml)
stof_doctrine_extensions:
    default_locale: en_US

    # Only used if you activated the Uploadable extension
    uploadable:
        default_file_path:       "%kernel.project_dir%/public/uploads"
        mime_type_guesser_class: Stof\DoctrineExtensionsBundle\Uploadable\MimeTypeGuesserAdapter
        default_file_info_class: Stof\DoctrineExtensionsBundle\Uploadable\UploadedFileInfo

    orm:
        default: ~
    mongodb:
        default: ~

If the uploadable extension is activated, you can customize its behavior using the following keys:

• default_file_path: The path where files will be stored. One of three ways to configure the path.
• mime_type_guesser_class: (Optional) The class used to guess MIME types. Defaults to a Symfony Mime component adapter.
• default_file_info_class: (Optional) The class implementing FileInfoInterface used to handle file info. Defaults to Stof\DoctrineExtensionsBundle\Uploadable\UploadedFileInfo which is prepared for UploadedFile instances.

The bundle is configured under the stof_doctrine_extensions key in your Symfony configuration files (e.g., config/packages/stof_doctrine_extensions.yaml).

Global settings include:

• default_locale: The default locale used for translations (defaults to en).
• translation_fallback: Whether to fallback to the default locale if a translation is missing.
• persist_default_translation: Whether to persist the default translation.
• skip_translation_on_load: Whether to skip translation loading on entity load.
• metadata_cache_pool: The cache pool used for metadata.