brazanation/document-doctrine-types

Library to provide Document as Doctrine Types

v0.1.0 2017-08-11 21:39 UTC

This package is auto-updated.

Last update: 2020-10-03 22:56:45 UTC


README

Build Status StyleCI Scrutinizer Code Quality Code Coverage

Installation

composer require brazanation/document-doctrine-types ^0.1

How to Use?

First of all, register the Document Types after Doctrine Connection.

// bootstrap.php

// ... other code
$connection = \Doctrine\DBAL\DriverManager::getConnection($conn, $config, new \Doctrine\Common\EventManager());

\Brazanation\Doctrine\TypeExtension::register($connection);

// ... more code

Define the entity's property as the document

/**
 * @Entity @Table(name="persons")
 */
class Person
{
    /**
     * @Id
     * @Column(type="cpf")
     * @var \Brazanation\Documents\Cpf
     */
    private $cpf;

    public function __construct(\Brazanation\Documents\Cpf $cpf)
    {
        $this->cpf = $cpf;
    }

    public function getCpf()
    {
        return $this->cpf;
    }
}

Available Types

Type Name Description
cnh National Driving License
cnpj Company Identification or National Register of Legal Entities
cns National Health Card
cpf Registration of individuals or Tax Identification
pispasep Social Integration Program and Training Program of the Heritage of Public Servant
renavam National Registry of Motor Vehicles