proprietes-privees/eb-doctrinebundle

EBDoctrineBundle

EBDoctrineBundle

Set of Doctrine tools., _(*1)

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

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

• 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

• 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

• 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

• 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

• 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

• 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 :, _(*2)

    {% for level,flashes in app.session.flashBag.all() %}
        <ul class="alert alert-{{ level }}">
            {% for flash in flashes %}
                <li>{{ flash }}</li>
            {% endfor %}
        </ul>
    {% endfor %}

From EBStringBundle

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

Controller

``` php <?php // SomeController.php, <sub>(*4)</sub>

/** @var EB\DoctrineBundle\Converter\StringConverter $string */ $string = $this->get('eb_string');, <sub>(*5)</sub>

// Create a clean URI using an article title for example $string->uri('Lorem Ipsum Dolor Sit'); // "lorem-ipsum-dolor-sit" $string->uri('Lôrém Ïpsum Dõlor Sït'); // "lorem-ipsum-dolor-sit" $string->uri('Lorem_Ipsum_Dolor_Sit'); // "lorem_ipsum_dolor_sit" $string->uri('Lorem-Ipsum-Dolor-Sit'); // "lorem-ipsum-dolor-sit" $string->uri('Lorem.Ipsum.Dolor.Sit'); // "lorem.ipsum.dolor.sit" $string->uri('-Lorem Ipsum Dolor Sit'); // "lorem-ipsum-dolor-sit" $string->uri('Lorem Ipsum Dolor Sit-'); // "lorem-ipsum-dolor-sit", <sub>(*6)</sub>

// Create a clean cut string $string->uri('LoremIpsumDolorSit',15); // "LoremIpsumDolor ..." $string->uri('Lorem Ipsum Dolor Sit',15); // "Lorem Ipsum ..." $string->uri('Lôrém Ïpsum Dõlor Sït',15); // "Lôrém Ïpsum ..." $string->uri('Lôrém Ïpsum Dõlor Sït',15,' (...)'); // "Lôrém Ïpsum (...)", <sub>(*7)</sub>

// Help create a search index for your objects $string->search('Lorem Ipsum Dolor Sit'); // "lorem ipsum dolor sit" $string->search('Lôrém Ïpsum Dõlor Sït'); // "lorem ipsum dolor sit" $string->search('Lorem-Ipsum-Dolor-Sit'); // "lorem ipsum dolor sit" $string->search('Lorem Ipsum Dolor Sit Lorem'); // "lorem ipsum dolor sit" $string->search('Lorem Ipsum Dolor Si'); // "lorem ipsum dolor", <sub>(*8)</sub>

// Camelize a string $string->camelize('Lorem Ipsum Dolor Sit'); // "loremIpsumDolorSit" $string->camelize('Lorem_Ipsum_Dolor_Sit'); // "loremIpsumDolorSit" $string->camelize('Lôrém Ïpsum Dõlor Sït'); // "loremIpsumDolorSit" $string->camelize('Lôrém_Ïpsum_Dõlor_Sït'); // "loremIpsumDolorSit" $string->camelize('loremIpsumDolorSit'); // "loremipsumdolorsit", <sub>(*9)</sub>

// Underscore a string $string->underscore('Lorem Ipsum Dolor Sit'); // "lorem_ipsum_dolor_sit" $string->underscore('Lôrém Ïpsum Dõlor Sït'); // "lorem_ipsum_dolor_sit" $string->underscore('lorem_ipsum_dolor_sit'); // "lorem_ipsum_dolor_sit" ```, <sub>(*10)</sub>

Twig

``` jinja {# SomeTemplate.html.twig #}, <sub>(*11)</sub>

{# Create a clean URI using an article title for example #} uri('Lorem Ipsum Dolor Sit') {# "lorem-ipsum-dolor-sit" #} uri('Lôrém Ïpsum Dõlor Sït') {# "lorem-ipsum-dolor-sit" #} uri('Lorem_Ipsum_Dolor_Sit') {# "lorem_ipsum_dolor_sit" #} uri('Lorem-Ipsum-Dolor-Sit') {# "lorem-ipsum-dolor-sit" #} uri('Lorem.Ipsum.Dolor.Sit') {# "lorem.ipsum.dolor.sit" #} uri('-Lorem Ipsum Dolor Sit') {# "lorem-ipsum-dolor-sit" #} uri('Lorem Ipsum Dolor Sit-') {# "lorem-ipsum-dolor-sit" #}, <sub>(*12)</sub>

{# Create a clean cut string #} cut('LoremIpsumDolorSit',15) {# "LoremIpsumDolor ..." #} cut('Lorem Ipsum Dolor Sit',15) {# "Lorem Ipsum ..." #} cut('Lôrém Ïpsum Dõlor Sït',15) {# "Lôrém Ïpsum ..." #} cut('Lôrém Ïpsum Dõlor Sït',15,' (...)') {# "Lôrém Ïpsum (...)" #}, <sub>(*13)</sub>

{# Help create a search index for your objects #} search('Lorem Ipsum Dolor Sit') {# "lorem ipsum dolor sit" #} search('Lôrém Ïpsum Dõlor Sït') {# "lorem ipsum dolor sit" #} search('Lorem-Ipsum-Dolor-Sit') {# "lorem ipsum dolor sit" #} search('Lorem Ipsum Dolor Sit Lorem') {# "lorem ipsum dolor sit" #} search('Lorem Ipsum Dolor Si') {# "lorem ipsum dolor" #}, <sub>(*14)</sub>

{# Camelize a string #} camelize('Lorem Ipsum Dolor Sit') {# "loremIpsumDolorSit" #} camelize('Lorem_Ipsum_Dolor_Sit') {# "loremIpsumDolorSit" #} camelize('Lôrém Ïpsum Dõlor Sït') {# "loremIpsumDolorSit" #} camelize('Lôrém_Ïpsum_Dõlor_Sït') {# "loremIpsumDolorSit" #} camelize('loremIpsumDolorSit') {# "loremipsumdolorsit" #}, <sub>(*15)</sub>

{# Underscrore a string #} underscore('Lorem Ipsum Dolor Sit') {# "lorem_ipsum_dolor_sit" #} underscore('Lôrém Ïpsum Dõlor Sït') {# "lorem_ipsum_dolor_sit" #} underscore('lorem_ipsum_dolor_sit') {# "lorem_ipsum_dolor_sit" #} ````, <sub>(*16)</sub>