cancio-labs / cpf-value-object
A class that represents a CPF (Brazilian ID)
Installs: 17
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
pkg:composer/cancio-labs/cpf-value-object
Requires
- php: >=7.4
- cancio-labs/cpf-validation-function: ^1.0
Requires (Dev)
- phpunit/phpunit: ^9.6
This package is not auto-updated.
Last update: 2025-10-06 21:51:27 UTC
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 .