cancio-labs/cpf-value-object

A class that represents a CPF (Brazilian ID)

1.0.0 2024-06-30 17:18 UTC

Requires

• php: >=7.4
• cancio-labs/cpf-validation-function: ^1.0

Requires (Dev)

• phpunit/phpunit: ^9.6

GPL-3.0-or-later

• Nilo Soares
• Cancio Labs
• NSCPS Solutions

• Value Object
• cpf
• brasil

README

This tiny package contains a class that represents a CPF (Brazilian ID).

Requirements

PHP 7.4 or greater is required, nothing else.

Installation

composer require cancio-labs/cpf-value-object

How to use it

use CancioLabs\ValueObject\Cpf\Cpf;

$cpf = new Cpf('170.317.330-90'); // or '17031733090'
echo $cpf; // outputs 17031733090
echo $cpf->getRaw(); // outputs 17031733090
echo $cpf->getFormatted(); // outputs 170.317.330-90

The CPF class will validate the given string and throw an exception if it's not a valid CPF.

Running Tests

• From the project root, run: vendor/bin/phpunit .