PHPackages                             adcog-cpi/doctrine-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. adcog-cpi/doctrine-bundle

ActiveSymfony-bundle[Database & ORM](/categories/database)

adcog-cpi/doctrine-bundle
=========================

EBDoctrineBundle

0.0.13(9y ago)091MITPHPPHP >=5.5

Since Sep 28Pushed 3y ago2 watchersCompare

[ Source](https://github.com/adcog-cpi/doctrine-bundle)[ Packagist](https://packagist.org/packages/adcog-cpi/doctrine-bundle)[ Docs](https://github.com/emmanuelballery/EBDoctrineBundle.git)[ RSS](/packages/adcog-cpi-doctrine-bundle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (4)Versions (14)Used By (0)

EBDoctrineBundle
================

[](#ebdoctrinebundle)

Set of Doctrine tools.

Configuration
-------------

[](#configuration)

```
# Default configuration for "EBDoctrineBundle"
eb_doctrine:
    filesystem:

        # Web file path.
        web_path:             /files # Example: /files

        # Secured file path.
        secured_path:         '%kernel.root_dir%/cache/%kernel.environment%/files' # Example: /var/my-data

        # Wether env is used in paths
        use_env_discriminator:  true # Example: true

        # Wether class is used in paths
        use_class_discriminator:  true # Example: true

        # File tree depth
        depth:                0 # Example: 5
    loggable:

        # Persisted message or translation key.
        persisted:            'L''élément %%entity%% a été créé avec succès !' # Example: L'élément %%entity%% a été créé avec succès !

        # Updated message or translation key.
        updated:              'L''élément %%entity%% a été modifié avec succès !' # Example: L'élément %%entity%% a été modifié avec succès !

        # Removed message or translation key.
        removed:              'L''élément %%entity%% a été supprimé avec succès !' # Example: L'élément %%entity%% a été supprimé avec succès !
    paginator:

        # Default paginator limit
        default_limit:        null # Example: 10

        # Maximum paginator limit
        max_limit:            null # Example: 100

        # Wether we have to use the output walker
        use_output_walker:    false # Example: false

```

Usage
-----

[](#usage)

### Track `created` date

[](#track-created-date)

- Implement `EB\DoctrineBundle\Entity\CreatedInterface`
- Use `EB\DoctrineBundle\Entity\Doctrine\CreatedTrait`
- The creation date will always be saved in the `created` field

### Track `updated` date

[](#track-updated-date)

- Implement `EB\DoctrineBundle\Entity\UpdatedInterface`
- Use `EB\DoctrineBundle\Entity\Doctrine\UpdatedTrait`
- The update date will always be saved in the `updated` field
- This date will be `null` when this entity has never been updated

### Generate `slug`

[](#generate-slug)

- Implement `EB\DoctrineBundle\Entity\SlugInterface`
- Use `EB\DoctrineBundle\Entity\Doctrine\SlugTrait`
- Define your own `getStringToSlug` method telling the listener what string needs to be cleaned
- The slug will always be saved in the `slug` field
- The command `eb:doctrine:fix` is able to re-evaluate each slug field in your database

### Generate `salt`

[](#generate-salt)

- Implement `EB\DoctrineBundle\Entity\SaltInterface`
- Use `EB\DoctrineBundle\Entity\Doctrine\SaltTrait`
- The salt will always be saved in the `salt` field
- Currently the salt is a sha512 hash (see `EB\DoctrineBundle\Salt\SaltGenerator`)

### Save a file with an entity

[](#save-a-file-with-an-entity)

- Implement one of these interfaces :
    - `EB\DoctrineBundle\Entity\FileInterface` (if you don't want a direct access via your webserver)
    - `EB\DoctrineBundle\Entity\FileReadableInterface` (stored in your web folder, add an URI path)
    - `EB\DoctrineBundle\Entity\FileVersionableInterface` (track different file versions)
- Use those traits :
    - `EB\DoctrineBundle\Entity\Doctrine\FileTrait`
    - `EB\DoctrineBundle\Entity\Doctrine\FileReadableTrait`
    - `EB\DoctrineBundle\Entity\Doctrine\FileVersionableTrait`
- Add an `\SplFileInfo` or an `UploadedFile` to your entity using `setFile` method
- `EB\DoctrineBundle\Entity\FileListener` will automatically :
    - Save this file in the filesystem (using the entity ID and your configuration)
    - Save its `filename`, `extension`, `size` and `mime`
    - Save a `uniqid` (this is a trick to create mapped updates when using forms with unmapped `file` field)
    - Add a `path`, the current realpath of the file in the filesystem
    - Add an `uri`, from the web directory
    - Increase `version` if necessary
    - Delete the file in the filesystem when the entity is removed

### Deal with users

[](#deal-with-users)

- Implement one of these interfaces :
    - `EB\DoctrineBundle\Entity\UserInterface`
    - `EB\DoctrineBundle\Entity\UserLoginInterface`
    - `EB\DoctrineBundle\Entity\UserPasswordDateInterface`
- Use those traits :
    - `EB\DoctrineBundle\Entity\Doctrine\UserTrait`
    - `EB\DoctrineBundle\Entity\Doctrine\UserAdvancedTrait`
    - `EB\DoctrineBundle\Entity\Doctrine\UserLoginTrait`
    - `EB\DoctrineBundle\Entity\Doctrine\UserPasswordDateTrait`
- The `rawPassword` will always be encoded into a `password` when saved
- Add all required fields and methods to create a user
- Track current and previous login dates
- Track password update date

### Use Doctrine events to populate session flash bag messages

[](#use-doctrine-events-to-populate-session-flash-bag-messages)

- Implement `EB\DoctrineBundle\Entity\LoggableInterface`
- Configure :
    - Persisted message : '%entity% saved !'
    - Updated message : '%entity% updated !'
    - Removed message : '%entity% removed !'
- All doctrine events will be written in user session flashbag

You can simply display those messages using Twig :

```
    {% for level,flashes in app.session.flashBag.all() %}

            {% for flash in flashes %}
                {{ flash }}
            {% endfor %}

    {% endfor %}
```

From EBStringBundle
-------------------

[](#from-ebstringbundle)

This bundle helps me to deal with strings (for blog title in uri for example).

### Controller

[](#controller)

```