Stof Doctrine Extensions Bundle

https://symfony.com/bundles/StofDoctrineExtensionsBundle/current
Admin
A Symfony bundle that integrates DoctrineExtensions, providing features like tree handling,...
Tokens:2,529
Snippets:25
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install via Composer

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

Use this command to download the bundle into your project.

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

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

### Enable Specific Extensions - XML

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

XML configuration to enable specific Doctrine extensions for ORM entity managers. This example shows enabling 'tree' for 'default' and 'timestampable' for 'other'.

```xml
<!-- app/config/config.xml -->
<!-- (or config/packages/stof_doctrine_extensions.yaml) -->
<container xmlns:stof-doctrine_extensions="http://example.org/schema/dic/stof_doctrine_extensions">
    <stof-doctrine-extensions:config default-locale="en_US">
        <stof-doctrine-extensions:orm>
            <stof-doctrine-extensions:entity-manager
                id="default"
                tree="true"
                timestampable="false"
                translatable="false"
                blameable="false"
                sluggable="false"
                loggable="false"
                ip-traceable="false"
                sortable="false"
                softdeleteable="false"
                uploadable="false"
                reference-integrity="false"
            />
            <stof-doctrine-extensions:entity-manager
                id="other"
                timestampable="true"
            />
        </stof-doctrine-extensions:orm>
    </stof-doctrine-extensions:config>
</container>
```

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

### Disable SoftDeleteable Filter

Source: https://symfony.com/bundles/StofDoctrineExtensionsBundle/current/softdeleteable-filter.html

Disable the SoftDeleteable filter programmatically, for example, when an admin user needs to view deleted items. This requires access to the Doctrine entity manager.

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

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

### Enable Bundle in AppKernel

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

Register the bundle manually in the AppKernel.php file for projects not using Symfony Flex.

```php
// app/AppKernel.php

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

            new Stof\DoctrineExtensionsBundle\StofDoctrineExtensionsBundle(),
        );

        // ...
    }

    // ...
}
```

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

### Default Configuration - XML

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

XML equivalent of the default configuration, setting the default locale and configuring ORM and MongoDB managers.

```xml
<container xmlns:stof-doctrine-extensions="http://example.org/schema/dic/stof_doctrine_extensions">
    <stof-doctrine-extensions:config default-locale="en_US">
        <stof-doctrine-extensions:orm>
            <stof-doctrine-extensions:entity-manager id="default" />
        </stof-doctrine-extensions:orm>
        <stof-doctrine-extensions:mongodb>
            <stof-doctrine-extensions:document-manager id="default" />
        </stof-doctrine-extensions:mongodb>
    </stof-doctrine-extensions:config>
</container>
```

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

### Default Configuration - YAML

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

Sets the default locale and configures the uploadable extension with default paths and classes. Also includes basic ORM and MongoDB configurations.

```yaml
stof_doctrine_extensions:
    default_locale: en_US

    # Only used if you activated the Uploadable extension
    uploadable:
        # Default file path: This is one of the three ways you can configure the path for the Uploadable extension
        default_file_path:       "%kernel.project_dir%/public/uploads"

        # Mime type guesser class: Optional. By default, we provide an adapter for the one present in the Mime component of Symfony
        mime_type_guesser_class: Stof\DoctrineExtensionsBundle\Uploadable\MimeTypeGuesserAdapter

        # Default file info class implementing FileInfoInterface: Optional. By default we provide a class which is prepared to receive an UploadedFile instance.
        default_file_info_class: Stof\DoctrineExtensionsBundle\Uploadable\UploadedFileInfo
    orm:
        default: ~
    mongodb:
        default: ~
```

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

### Activate extensions for entity managers

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

Enable specific extensions for your entity managers within the bundle configuration.

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

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

### Override Tree and Timestampable Listeners (YAML)

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

Configure custom listeners for Tree and Timestampable extensions by providing the fully qualified class name in the YAML configuration file. This allows for custom logic within these extensions.

```yaml
# app/config/config.yml
# (or config/packages/stof_doctrine_extensions.yaml if you use Flex)
stof_doctrine_extensions:
    class:
        tree:           MyBundle\TreeListener
        timestampable:  MyBundle\TimestampableListener
        blameable:      ~
        sluggable:      ~
        translatable:   ~
        loggable:       ~
        softdeleteable: ~
        uploadable:     ~
```

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

### Enable Specific Extensions - YAML

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

Enables specific Doctrine extensions for the 'default' and 'other' ORM entity managers. Note that listeners are not enabled by default.

```yaml
# app/config/config.yml
# (or config/packages/stof_doctrine_extensions.yaml)
stof_doctrine_extensions:
    default_locale: en_US
    orm:
        default:
            tree: true
            timestampable: false # not needed: listeners are not enabled by default
            translatable: false
            blameable: false
            sluggable: false
            loggable: false
            ip_traceable: false
            sortable: false
            softdeleteable: false
            uploadable: false
            reference_integrity: false
        other:
            timestampable: true
```

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

### Handle file uploads with Uploadable extension

Source: https://symfony.com/bundles/StofDoctrineExtensionsBundle/current/uploadable-extension.html

Use the Uploadable manager to mark an entity for upload after a form is submitted and validated. Ensure the entity property is mapped to an UploadedFile instance.

```php
$document = new Document();
$form = $this->createFormBuilder($document)
    ->add('name')
    ->add('myFile')
    ->getForm()
;

$form->handleRequest($request);

if ($form->isSubmitted() && $form->isValid()) {
    $em = $this->getDoctrine()->getManager();
    $em->persist($document);

    $uploadableManager = $this->get('stof_doctrine_extensions.uploadable.manager');

    // Here, "getMyFile" returns the "UploadedFile" instance that the form bound in your $myFile property
    $uploadableManager->markEntityToUpload($document, $document->getMyFile());

    $em->flush();

    return $this->redirect($this->generateUrl('...'));
}

return $this->render('...', array('form' => $form->createView()));
```

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

### Register Doctrine extension mappings

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

Register the mapping for extensions like Translatable, Translator, Loggable, and Tree in your Doctrine configuration.

```yaml
# app/config/config.yml
# (or config/packages/doctrine.yaml)
doctrine:
    orm:
        entity_managers:
            default:
                mappings:
                    gedmo_translatable:
                        type: attribute
                        prefix: Gedmo\Translatable\Entity
                        dir: "%kernel.project_dir%/vendor/gedmo/doctrine-extensions/src/Translatable/Entity"
                        alias: GedmoTranslatable # (optional) it will default to the name set for the mapping
                        is_bundle: false
                    gedmo_translator:
                        type: attribute
                        prefix: Gedmo\Translator\Entity
                        dir: "%kernel.project_dir%/vendor/gedmo/doctrine-extensions/src/Translator/Entity"
                        alias: GedmoTranslator # (optional) it will default to the name set for the mapping
                        is_bundle: false
                    gedmo_loggable:
                        type: attribute
                        prefix: Gedmo\Loggable\Entity
                        dir: "%kernel.project_dir%/vendor/gedmo/doctrine-extensions/src/Loggable/Entity"
                        alias: GedmoLoggable # (optional) it will default to the name set for the mapping
                        is_bundle: false
                    gedmo_tree:
                        type: attribute
                        prefix: Gedmo\Tree\Entity
                        dir: "%kernel.project_dir%/vendor/gedmo/doctrine-extensions/src/Tree/Entity"
                        alias: GedmoTree # (optional) it will default to the name set for the mapping
                        is_bundle: false
```

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

### Override Tree and Timestampable Listeners (XML)

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

Configure custom listeners for Tree and Timestampable extensions using XML configuration. Specify the custom class names for the desired extensions within thestof-doctrine-extensions:config section.

```xml
<!-- app/config/config.xml -->
<!-- (or config/packages/stof_doctrine_extensions.yaml if you use Flex) -->
<container xmlns:stof-doctrine_extensions="http://example.org/schema/dic/stof_doctrine_extensions">
    <stof-doctrine-extensions:config>
        <stof-doctrine-extensions:class
            tree="MyBundle\TreeListener"
            timestampable="MyBundle\TimestampableListener"
        />
    </stof-doctrine-extensions:config>
</container>
```

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

### Enable SoftDeleteable Filter in Doctrine Configuration

Source: https://symfony.com/bundles/StofDoctrineExtensionsBundle/current/softdeleteable-filter.html

Configure your Doctrine ORM to enable the SoftDeleteable filter. This is typically done in your application's configuration file.

```yaml
# 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
```
Tokens:
Raw