README

Utility function/class to generate valid CPF (Brazilian personal ID).

PHP Support

Passing ✔	Passing ✔	Passing ✔	Passing ✔

Installation

# using Composer
$ composer require lacus/cpf-gen

Import

<?php
// Using class-based resource
use Lacus\CpfGen\CpfGenerator;

// Or using function-based one
use function Lacus\CpfGen\cpf_gen;

Usage

Object-Oriented Usage

$generator = new CpfGenerator();
$cpf = $generator->generate(); // returns '47844241055'

// With options
$cpf = $generator->generate(
    format: true
); // returns '478.442.410-55'

$cpf = $generator->generate(
    prefix: '528250911'
); // returns '52825091138'

$cpf = $generator->generate(
    prefix: '528250911',
    format: true
); // returns '528.250.911-38'

The options can be provided to the constructor or the generate() method. If passed to the constructor, the options will be attached to the CpfGenerator instance. When passed to the generate() method, it only applies the options to that specific call.

$generator = new CpfGenerator(format: true);

$cpf1 = $generator->generate(); // '478.442.410-55' (uses instance options)
$cpf2 = $generator->generate(format: false); // '47844241055' (overrides instance options)
$cpf3 = $generator->generate(); // '123.456.789-01' (uses instance options again)

Imperative programming

The helper function cpf_gen() is just a functional abstraction. Internally it creates an instance of CpfGenerator and calls the generate() method right away.

$cpf = cpf_gen(); // returns '47844241055'

$cpf = cpf_gen(format: true); // returns '478.442.410-55'

$cpf = cpf_gen(prefix: '528250911'); // returns '52825091138'

$cpf = cpf_gen(prefix: '528250911', format: true); // returns '528.250.911-38'

Generator Options

Contribution & Support

We welcome contributions! Please see our Contributing Guidelines for details. But if you find this project helpful, please consider:

• ⭐ Starring the repository
• 🤝 Contributing to the codebase
• 💡 Suggesting new features
• 🐛 Reporting bugs

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

See CHANGELOG for a list of changes and version history.

Made with ❤️ by Lacus Solutions