README

Pure PHP array anonymization with reusable profiles. The core supports nested map and list traversal, conditional rules, named replacement strategies, encoded documents, batches, and safe reports and audits. It requires PHP 8.5 and ext-mbstring.

Project Status

Project Info

Repo Status

License

This project is released under the MIT license.

See the LICENSE for more information.

Install

composer require php-anonymizer/anonymizer

Quick start

Profiles are registered with an immutable builder. The returned façade can be reused for independent inputs:

use PhpAnonymizer\Anonymizer\Application\Anonymization\AnonymizerBuilder;
use PhpAnonymizer\Anonymizer\Domain\Profile\ProfileDefinition;

$profile = ProfileDefinition::fromArray('customer', [
    'mode' => 'redact',
    'rules' => [['field' => 'email']],
]);
$anonymizer = AnonymizerBuilder::create()->withProfile($profile)->build();
$safe = $anonymizer->anonymize('customer', ['email' => 'ada@example.test']);

if ($safe !== ['email' => '[REDACTED]']) {
    throw new RuntimeException('The core quick-start example failed.');
}

In preserve mode, selected strings remain unchanged and other strings in the input tree are redacted. See the user guide for the complete walkthrough and the profile schema for rule syntax, matching behavior, and validation.

Core capabilities

anonymize() transforms associative arrays without changing their shape.
anonymizePayload() handles encoded maps; anonymizeDocument() also supports explicitly declared list roots.
anonymizeRecords() and anonymizeNdjson() process records lazily.
anonymizeWithReport() and anonymizeWithAudit() return paths or aggregate operational metadata without source or replacement values.
Strategies, codecs, transformations, and profile providers use the public, framework-free extension interfaces.

Packages

The PHP Anonymizer project is split into packages for core anonymization and optional integrations:

php-anonymizer/anonymizer — framework-independent core library.
php-anonymizer/anonymizer-bundle — Symfony Bundle integration.
php-anonymizer/anonymizer-faker — Faker-powered replacement strategies.
php-anonymizer/anonymizer-laravel — Laravel integration.
php-anonymizer/anonymizer-personas — reusable persona data for anonymized fixtures.
php-anonymizer/anonymizer-pseudonymization — pseudonymization strategies.
php-anonymizer/anonymizer-symfony-serializer — optional Symfony Serializer object adapter.

The builder does not scan for profiles or extensions. Register each profile, provider, or extension explicitly. For framework setup, install the Symfony Bundle or Laravel integration. Object anonymization is available through the optional Symfony Serializer adapter.

Read the extension author guide to implement custom ports. For changes from the previous API, see the 2.0 migration guide.

php-anonymizer / anonymizer

Package info

Security

Statistics