pfazzi/isbn-doctrine

Allow the use of a pfazzi/isbn as Doctrine field type.

v0.1.2 2019-05-13 22:29 UTC

Requires

• php: ^7.2
• doctrine/orm: ^2.5
• pfazzi/isbn: ^0.1.0

Requires (Dev)

• jakub-onderka/php-parallel-lint: ^1.0
• phpstan/phpstan-shim: 0.9.1
• squizlabs/php_codesniffer: ^3.0

MIT

• Patrick Luca Fazzi

README

The pfazzi/isbn-doctrine package provides the ability to use pfazzi/isbn as a Doctrine field type.

Installation

The preferred method of installation is via Packagist and Composer. Run the following command to install the package and add it as a requirement to your project's composer.json:

composer require pfazzi/isbn-doctrine

Examples

Configuration

To configure Doctrine to use pfazzi/isbn as a field type, you'll need to set up the following in your bootstrap:

\Doctrine\DBAL\Types\Type::addType('isbn', 'Pfazzi\Isbn\Doctrine\IsbnType');

In Symfony:

# app/config/config.yml
doctrine:
   dbal:
       types:
           isbn: Pfazzi\Isbn\Doctrine\IsbnType

Then, in your models, you may annotate properties by setting the @Column type to isbn. Doctrine will handle the rest.

/**
 * @ORM\Entity()
 */
class Book
{
    /**
     * @ORM\Id()
     * @ORM\Column(type="isbn")
     *
     * @var Isbn
     */
    private $isbn;
    
    public function __construct(Isbn $isbn)
    {
        $this->isbn = $isbn;
    }

    public function getIsbn(): Isbn
    {
        return $this->isbn;
    }
}