pugx / shortid-doctrine
Doctrine type for shortid-php
Requires
- php: ^8.1
- doctrine/orm: ^2.7 || ^3.0
- pugx/shortid-php: ^1.0
Requires (Dev)
- dg/bypass-finals: ^1.6
- phpunit/phpunit: ^9.6
This package is auto-updated.
Last update: 2024-10-20 09:46:14 UTC
README
A Doctrine field type for ShortId for PHP.
Installation
Run the following command:
composer require pugx/shortid-doctrine
Note: if you use Symfony, you should require pugx/shortid-doctrine-bundle instead.
Examples
To configure Doctrine to use shortid
as a field type, you'll need to set up
the following in your bootstrap:
<?php \Doctrine\DBAL\Types\Type::addType('shortid', 'PUGX\Shortid\Doctrine\ShortidType'); $entityManager->getConnection()->getDatabasePlatform()->registerDoctrineTypeMapping('shortid', 'shortid');
Then, in your entities, you may annotate properties by setting the @Column
type to shortid
.
You can generate a PUGX\Shortid\Shortid
object for the property in your constructor, or
use the built-in generator.
Example with ShortId created manually in constructor:
<?php use PUGX\Shortid\Shortid; /** * @Entity * @Table */ class Product { /** * @var Shortid * * @Id * @Column(type="shortid") * @GeneratedValue(strategy="NONE") */ private $id; public function __construct(?Shortid $id = null) { $this->id = $id ?? Shortid::generate(); } public function getId(): Shortid { return $this->id; } }
Example with auto-generated shortid:
<?php use PUGX\Shortid\Shortid; /** * @Entity * @Table */ class Product { /** * @var Shortid * * @Id * @Column(type="shortid") * @GeneratedValue(strategy="CUSTOM") * @CustomIdGenerator(class="PUGX\Shortid\Doctrine\Generator\ShortidGenerator") */ private $id; public function getId(): Shortid { return $this->id; } }
If you want to customize ShortId length, you can use the length
option in the Column annotation. Example:
<?php use PUGX\Shortid\Shortid; /** * @Entity * @Table */ class Product { /** * @var Shortid * * @Id * @Column(type="shortid", length=5) * @GeneratedValue(strategy="NONE") */ private $id; public function __construct() { $this->id = Shortid::generate(5); } }
If you want to customize alphabet and/or to use the built-in generator, you need to setup ShortId in your bootstrap:
<?php \Doctrine\DBAL\Types\Type::addType('shortid', 'PUGX\Shortid\Doctrine\ShortidType'); $entityManager->getConnection()->getDatabasePlatform()->registerDoctrineTypeMapping('shortid', 'shortid'); $factory = new \PUGX\Shortid\Factory(); // alphabet must be 64 characters long $factory->setAlphabet('é123456789àbcdefghìjklmnòpqrstùvwxyzABCDEFGHIJKLMNOPQRSTUVWX.!@|'); // length must be between 2 and 20 $factory->setLength(5); PUGX\Shortid\Shortid::setFactory($factory);
Then, you must pay attention to configure every ShortId property with the same length (5
in this example).