Skip to content
Library to provide Brazilian documents as Doctrine Types
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.gitignore
.scrutinizer.yml
.styleci.yml
.travis.yml
LICENSE
README.md
composer.json
phpunit.xml.dist

README.md

Doctrine Types for Brazilian Documents

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
You can’t perform that action at this time.