README

👁 GitHub Workflow Status
👁 Latest Version on Packagist
👁 Software License
👁 Total Downloads

Idempotency

Generate reproducible idempotency keys from any data format (JSON, XML, YAML, arrays, objects) regardless of key order.

Requirements

Requires PHP 8.4+

Installation

composer require cline/idempotency

Quick Start

use Cline\Idempotency\IdempotencyKey;

// Generate a key from any data
$key = IdempotencyKey::create(['name' => 'John', 'age' => 30]);
echo $key->toString(); // "e4a7f8b3c2d1a9f6..."

// Key order doesn't matter - same data produces same key
$key1 = IdempotencyKey::create(['name' => 'John', 'age' => 30]);
$key2 = IdempotencyKey::create(['age' => 30, 'name' => 'John']);
$key1->equals($key2); // true

Documentation

• Basic Usage - Getting started with idempotency keys
• Supported Formats - JSON, XML, YAML, arrays, objects, and scalars
• Hash Algorithms - SHA-256, SHA-512, SHA-1, and MD5
• Output Formats - Hex, binary, Base64, Base62, UUID, and versioned strings
• Custom Normalizers - Preprocessing data with custom normalizers
• Advanced Examples - Real-world usage patterns and techniques

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please use the GitHub security reporting form rather than the issue queue.

Credits

• Brian Faust
• All Contributors

License

The MIT License. Please see License File for more information.