PUGX/shortid-doctrine-bundle

Documentation
=============

## Installation

Run from terminal:

```bash
$ composer require pugx/shortid-doctrine-bundle
```

If you don't use Flex, you need to manually enable bundle in your kernel:

```php
<?php
// app/AppKernel.php
public function registerBundles()
{
    $bundles = [
        // ...
        new PUGX\Shortid\Doctrine\Bundle\PUGXShortidDoctrineBundle(),
    ];
}
```

## Usage

You can use the `shortid` type in your entity.
Example:

```php
<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity()
 * @ORM\Table()
 */
class Book
{
    /**
     * @ORM\Column(type="shortid")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="CUSTOM")
     * @ORM\CustomIdGenerator(class="PUGX\Shortid\Doctrine\Generator\ShortidGenerator")
     */
    protected $id;
}
```

## Optional configuration

If you want to globally configure ShortId, you can set a configuration like in this example:

```yaml
pugx_shortid_doctrine:
    global_config:
        length: 8
        alphabet: "é123456789àbcdefghìjklmnòpqrstùvwxyzABCDEFGHIJKLMNOPQRSTUVWX.!@|"
```

The `length` option must be between 2 and 20 (default is 7), while `alphabet` must be 64 characters long.

>Be aware: if you change `length` in this way, you **must** specify `length` option in every column definition.
>Moreover, you'll need to manually set column definition for ManyToOne mappings.
>For example: `<join-column column-definition="CHAR(8) COLLATE utf8_bin NOT NULL"/>`

You can also configure `readable` option instead of `alphabet`. Example:

```yaml
pugx_shortid_doctrine:
    global_config:
        readable: true
```