Stars: 209
Forks: 22
Pull Requests: 39
Issues: 13
Watchers: 25
Last Updated: 2022-12-14 20:19:45
Library to provide Brazilian Documents as Value Objects in PHP
License:
Languages: PHP
A PHP library to provide Brazilian Documents safer, easier and fun!
Install the library using composer. Add the following to your composer.json
:
{
"require": {
"brazanation/documents": "2.1.*"
}
}
Now run the install
command.
$ composer.phar install
or
$ composer require brazanation/documents 2.1.*
Registration of individuals or Tax Identification
use Brazanation\Documents\Cpf;
$document = Cpf::createFromString('06843273173');
if (false === $document) {
echo "Not Valid";
}
echo $document; // prints 06843273173
echo $document->format(); // prints 068.432.731-73
or
use Brazanation\Documents\Cpf;
use Brazanation\Documents\Exception\InvalidDocument as InvalidDocumentException;
try {
$document = new Cpf('06843273173');
echo $document; // prints 06843273173
echo $document->format(); // prints 068.432.731-73
} catch (InvalidDocumentException $e) {
echo $e->getMessage();
}
Company Identification or National Register of Legal Entities
use Brazanation\Documents\Cnpj;
$document = Cnpj::createFromString('99999090910270');
if (false === $document) {
echo "Not Valid";
}
echo $document; // prints 99999090910270
echo $document->format(); // prints 99.999.090/9102-70
National Driving License
use Brazanation\Documents\Cnh;
$document = Cnh::createFromString('83592802666');
if (false === $document) {
echo "Not Valid";
}
echo $document; // prints 83592802666
echo $document->format(); // prints 83592802666
Sped Access Key
Available models:
use Brazanation\Documents\Sped\NFe;
$document = NFe::createFromString('52060433009911002506550120000007801267301613');
if (false === $document) {
echo "Not Valid";
}
echo $document; // prints 52060433009911002506550120000007801267301613
echo $document->format(); // prints 5206 0433 0099 1100 2506 5501 2000 0007 8012 6730 1613
or generate your number
try {
$nfeKey = NFe::generate(
52,
$generatedAt,
new Cnpj('33009911002506'),
12,
780,
EmissionType::normal(),
26730161
);
echo $accessKey; // prints 52060433009911002506550120000007801267301613
}catch (InvalidDocumentException $e){
echo $e->getMessage();
}
Social Integration Program and Training Program of the Heritage of Public Servant
use Brazanation\Documents\PisPasep;
$document = PisPasep::createFromString('518.23129.49-1');
if (false === $document) {
echo "Not Valid";
}
echo $document; // prints 51823129491
echo $document->format(); // prints 518.23129.49-1
Voter Registration
use Brazanation\Documents\Voter;
$document = Voter::createFromString('106644440302', 20, 42);
if (false === $document) {
echo "Not Valid";
}
echo $document; // prints 106644440302
echo $document->getSection(); // prints 0020
echo $document->getZone(); // prints 042
State Registration
use Brazanation\Documents\StateRegistration;
// for Commercial São Paulo
$state = StateRegistration::SP('110.042.490.114');
echo $state; // prints 110042490114
echo $state->format(); // prints 110.042.490.114
// for Rural Producer São Paulo
$state = StateRegistration::SP('P011004243002');
echo $state; // prints P011004243002
echo $state->format(); // prints P-01100424.3/002
or
use Brazanation\Documents\StateRegistration;
$document = StateRegistration::createFromString('P011004243002', 'SP');
if (false === $document) {
echo "Not Valid";
}
National Health Card
use Brazanation\Documents\Cns;
$document = Cns::createFromString('242912018460005');
if (false === $document) {
echo "Not Valid";
}
echo $document; // prints 242912018460005
echo $document->format(); // prints 242 9120 1846 0005
National Registry of Motor Vehicles
use Brazanation\Documents\Renavam;
$document = Renavam::createFromString('61855253306');
if (false === $document) {
echo "Not Valid";
}
echo $document; // prints 61855253306
echo $document->format(); // prints 6185.525330-6
Numbers of legal proceedings related to Judiciary assessments
use Brazanation\Documents\JudiciaryProcess;
$document = JudiciaryProcess::createFromString('0048032982009809');
if (false === $document) {
echo "Not Valid";
}
echo $document; //prints 0048032982009809
echo $document->format(); //prints 0048032.98.2009.8.09.0000
Number of registration in "Superintendência da Zona Franca de Manaus" (Free Comercial Zones)
use Brazanation\Documents\Suframa;
$document = Suframa::createFromString('201111019');
if (false === $document) {
echo "Not Valid";
}
echo $document; //prints 201111019
echo $document->format(); //prints 20.1111.019
MIT, hell yeah!