l0wskilled/api-platform-traits

Package to ease the use of common properties

0.1.8 2020-04-21 10:26 UTC

Requires

• php: >=7.1
• api-platform/api-pack: ^1.2

Suggests

• doctrine/doctrine-bundle: to use the ORM extensions
• doctrine/mongodb-odm-bundle: to use the MongoDB ODM extensions
• stof/doctrine-extensions-bundle: to use the timestampable trait

MIT

• Hendrik Knigge

README

Package to ease the use of common properties needed for the api platform package.

You may want to have a look at: https://github.com/epubli/api-platform-test

Content of this package

• OrmIdentificatorTrait
• OrmTimestampableTrait
• OrmSoftDeletableTrait
• OdmIdentificatorTrait
• OdmTimestampableTrait
• OdmSoftDeletableTrait

Usage of ORM Timestampable and SoftDeletable

Add the stof doctrine extension:

composer require stof/doctrine-extensions-bundle

Edit the config file config/packages/stof_doctrine_extensions.yaml

It should look like this:

stof_doctrine_extensions:
    default_locale: en_US
    orm:
        default:
            softdeleteable: true
            timestampable: true

Here is an example class which implements these traits:

use Epubli\ApiPlatform\TraitBundle\OrmSoftDeletableTrait;
use Epubli\ApiPlatform\TraitBundle\OrmTimestampableTrait;
use Gedmo\Mapping\Annotation as Gedmo;

/**
 * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false, hardDelete=false)
 */
class Example
{
    use OrmTimestampableTrait;
    use OrmSoftDeletableTrait;
}