All notable changes to toon-php will be documented in this file.
This release fixes the compare method to properly showcase TOON's token savings benefits by always using the most efficient format.
Legacy Version: For PHP 7.0-8.0 support. For the latest version with modern PHP features (PHP 8.1+), see v2.x.
Toon::compare()now always usescompact()format instead of accepting an\$optionsparameter- Removed confusing
\$optionsparameter to simplify API - Ensures
comparemethod consistently demonstrates TOON's best-case token savings - Updated docblock to clarify that compact format is used for comparison
The compare method is designed to showcase TOON's benefits over JSON. This fix ensures that:
- Comparisons always use the most token-efficient format (compact)
- Users see optimal, consistent token savings when using
compare() - The API is simpler and less error-prone
### Automatic (Composer selects v1.x for PHP 7.0-8.0)
composer require iamgerwin/toon-php
### Force v1.x
composer require iamgerwin/toon-php:^1.0- ✅ Complete TOON encoding/decoding for PHP 7.0-8.0
- ✅ 30-60% Token Savings vs JSON
- ✅ Zero Dependencies (pure PHP)
- ✅ PHPStan Level 6 (strict static analysis)
- ✅ 100% Test Coverage (32 tests, 66 assertions)
- ✅ PSR-12 Compliant
- ✅ Traditional PHP Syntax (compatible with PHP 7.0)
No breaking changes. Simply update:
composer update iamgerwin/toon-phpFull Changelog: https://github.com/iamgerwin/toon-php/compare/v1.0.1...v1.0.2
Latest Release | PHP 8.1-8.4 Support
Bug fix release for the compare method to properly showcase TOON's token savings benefits.
Toon::compare()now always usescompact()format instead of accepting an$optionsparameter- Removed confusing
$optionsparameter to simplify the API - Ensures
comparemethod consistently demonstrates TOON's best-case token savings - Updated docblock to clarify that compact format is used for comparison
The compare method is designed to showcase TOON's benefits over JSON. This fix ensures that:
- Comparisons always use the most token-efficient format (compact)
- Users see optimal, consistent token savings when using
compare() - The API is simpler and less error-prone
# Automatic (recommended for PHP 8.1+)
composer require iamgerwin/toon-php
# Force v2.x
composer require iamgerwin/toon-php:^2.0
- ✅ Full Enum Support (BackedEnum, UnitEnum)
- ✅ Modern PHP 8.1+ Syntax (constructor promotion, match expressions, arrow functions)
- ✅ 30-60% Token Savings vs JSON
- ✅ Zero Dependencies (pure PHP)
- ✅ PHPStan Level 6 (strict static analysis)
- ✅ 100% Test Coverage (29 tests, 63 assertions)
- ✅ PSR-12 Compliant
Latest Release | PHP 8.1-8.4 Support
Enhanced documentation release with comprehensive API reference and examples for better developer experience.
- Comprehensive DOCUMENTATION.md with complete API reference
- Detailed examples covering all features and use cases
- Performance benchmarks and cost calculations
- Best practices guide for optimal usage
- Error handling documentation with troubleshooting tips
- Enhanced documentation structure for better user onboarding
- Improved code examples with real-world scenarios (ChatGPT integration, e-commerce, user profiles)
- ✅ Full Enum Support (BackedEnum, UnitEnum)
- ✅ Modern PHP 8.1+ Syntax (constructor promotion, match expressions, arrow functions)
- ✅ 30-60% Token Savings vs JSON
- ✅ Zero Dependencies (pure PHP)
- ✅ PHPStan Level 6 (strict static analysis)
- ✅ 100% Test Coverage (29 tests, 63 assertions)
- ✅ PSR-12 Compliant
# Automatic (recommended for PHP 8.1+)
composer require iamgerwin/toon-php
# Force v2.x
composer require iamgerwin/toon-php:^2.0
Based on official TOON benchmarks:
| Use Case | JSON Tokens | TOON Tokens | Savings |
|---|---|---|---|
| E-commerce Orders | 3,245 | 2,170 | 33.1% |
| User Lists | 150 | 82 | 45.3% |
| Product Catalogs | 320 | 180 | 43.8% |
At OpenAI's GPT-4 pricing ($0.03/1K tokens):
- 1M API calls = $3,000 (JSON) → $1,500 (TOON)
- Annual savings: $1,500+
use iamgerwin\Toon\Toon;
// Encode with enum support (PHP 8.1+)
enum Status: string {
case Active = 'active';
case Pending = 'pending';
}
$order = [
'id' => 123,
'status' => Status::Active,
'amount' => 99.99
];
$toon = Toon::encode($order);
// Output:
// id: 123
// status: active
// amount: 99.99
// Tabular format for uniform datasets
$users = [
['id' => 1, 'name' => 'Alice', 'role' => 'admin'],
['id' => 2, 'name' => 'Bob', 'role' => 'user'],
];
echo Toon::tabular($users);
// Output:
// [2]{id,name,role}:
// 1,Alice,admin
// 2,Bob,user
- README
- DOCUMENTATION - NEW
- CHANGELOG
- v2.x (This Release): PHP 8.1-8.4 with modern features - Recommended
- v1.x: PHP 7.0-8.0 compatibility - Legacy Support
Made with ❤️ for the PHP and AI community
- Comprehensive DOCUMENTATION.md with complete API reference
- Detailed examples for all features and use cases
- Performance benchmarks and cost calculations
- Best practices guide
- Error handling documentation
- Enhanced documentation structure for better user onboarding
- Improved code examples with real-world scenarios
Legacy Support for PHP 7.0-8.0 | For modern features, see v2.x
A lightweight, blazing-fast TOON (Token-Oriented Object Notation) library for PHP that cuts your LLM API costs by 30-60%. This is the legacy version supporting PHP 7.0 through 8.0.
- PHP Support: 7.0, 7.1, 7.2, 7.3, 7.4, 8.0
- Branch: legacy
- Status: 🔧 Legacy Support (Maintenance Mode)
# Automatic (Composer selects v1.x for PHP 7.0-8.0)
composer require iamgerwin/toon-php
# Force v1.x
composer require iamgerwin/toon-php:^1.0
- ✅ Complete TOON encoding/decoding for PHP 7.0-8.0
- ✅ 30-60% Token Savings vs JSON
- ✅ Zero Dependencies (pure PHP)
- ✅ PHPStan Level 6 (strict static analysis)
- ✅ 100% Test Coverage (32 tests, 66 assertions)
- ✅ PSR-12 Compliant
- ✅ Traditional PHP Syntax (compatible with PHP 7.0)
- ❌ No Enum Support (PHP 8.1+ feature)
- Uses traditional syntax (no constructor promotion, match expressions, or arrow functions)
Same token savings as v2.x:
| Use Case | JSON Tokens | TOON Tokens | Savings |
|---|---|---|---|
| E-commerce Orders | 3,245 | 2,170 | 33.1% |
| User Lists | 150 | 82 | 45.3% |
| Product Catalogs | 320 | 180 | 43.8% |
At OpenAI's GPT-4 pricing ($0.03/1K tokens):
- 1M API calls = $3,000 (JSON) → $1,500 (TOON)
- Annual savings: $1,500+
use iamgerwin\Toon\Toon;
// Simple encoding (no enums)
$order = [
'id' => 123,
'status' => 'active', // String instead of enum
'amount' => 99.99
];
$toon = Toon::encode($order);
// Output:
// id: 123
// status: active
// amount: 99.99
// Tabular format
$users = [
['id' => 1, 'name' => 'Alice', 'role' => 'admin'],
['id' => 2, 'name' => 'Bob', 'role' => 'user'],
];
echo Toon::tabular($users);
// Output:
// [2]{id,name,role}:
// 1,Alice,admin
// 2,Bob,user
- v2.x: PHP 8.1-8.4 with modern features - Recommended
- v1.x (This Release): PHP 7.0-8.0 compatibility - Legacy Support
If you're on PHP 8.1+, upgrade to v2.x for:
- ✅ Full enum support
- ✅ Modern PHP syntax
- ✅ Active development
- Removed enum support (PHP 8.1+ feature)
- Traditional constructor syntax (no property promotion)
- Docblock type annotations instead of
mixedtype hints - If/else conditionals instead of match expressions
- Traditional closures instead of arrow functions
strpos()instead ofstr_contains()- ToonDelimiter as constants class instead of enum
See CHANGELOG.md for complete details.
Legacy Support for PHP 7.0-8.0 | Made with ❤️ for the PHP and AI community
Recommended for all new projects | PHP 8.1-8.4
A lightweight, blazing-fast TOON (Token-Oriented Object Notation) library for PHP that cuts your LLM API costs by 30-60%.
- PHP Support: 8.1, 8.2, 8.3, 8.4
- Branch: main
- Status: ✅ Latest & Default
# Automatic (recommended)
composer require iamgerwin/toon-php
# Force v2.x
composer require iamgerwin/toon-php:^2.0
- Updated PHP requirement to 8.1+ for enum support
- Enhanced documentation with version strategy
- Clarified versioning: v2.x (PHP 8.1+) is recommended & default, v1.x (PHP 7.0-8.0) for legacy support
- ✅ Full Enum Support (BackedEnum, UnitEnum)
- ✅ Modern PHP 8.1+ Syntax (constructor promotion, match expressions, arrow functions)
- ✅ 30-60% Token Savings vs JSON
- ✅ Zero Dependencies (pure PHP)
- ✅ PHPStan Level 6 (strict static analysis)
- ✅ 100% Test Coverage (29 tests, 63 assertions)
- ✅ PSR-12 Compliant
Based on official TOON benchmarks:
| Use Case | JSON Tokens | TOON Tokens | Savings |
|---|---|---|---|
| E-commerce Orders | 3,245 | 2,170 | 33.1% |
| User Lists | 150 | 82 | 45.3% |
| Product Catalogs | 320 | 180 | 43.8% |
At OpenAI's GPT-4 pricing ($0.03/1K tokens):
- 1M API calls = $3,000 (JSON) → $1,500 (TOON)
- Annual savings: $1,500+
use iamgerwin\Toon\Toon;
// Encode with enum support (PHP 8.1+)
enum Status: string {
case Active = 'active';
case Pending = 'pending';
}
$order = [
'id' => 123,
'status' => Status::Active,
'amount' => 99.99
];
$toon = Toon::encode($order);
// Output:
// id: 123
// status: active
// amount: 99.99
// Tabular format
$users = [
['id' => 1, 'name' => 'Alice', 'role' => 'admin'],
['id' => 2, 'name' => 'Bob', 'role' => 'user'],
];
echo Toon::tabular($users);
// Output:
// [2]{id,name,role}:
// 1,Alice,admin
// 2,Bob,user
- v2.x (This Release): PHP 8.1-8.4 with modern features - Recommended
- v1.x: PHP 7.0-8.0 compatibility - Legacy Support
See CHANGELOG.md for complete details.
Made with ❤️ for the PHP and AI community
- Updated PHP requirement to 8.1+ for enum support
- Updated README with version strategy documentation
- Clarified versioning: v2.x (PHP 8.1+) is recommended & default, v1.x (PHP 7.0-8.0) for legacy support
Legacy PHP support release for PHP 7.0-8.0
- Complete TOON encoding and decoding for PHP 7.0-8.0
- Support for all PHP data types (except Enums - PHP 8.1+ only)
- Multiple formatting modes (compact, readable, tabular)
- Helper functions for common operations
- PHPStan level 6 compliance
- PSR-12 code style
- Comprehensive test coverage (32 tests)
- PHP 7.0-8.0 compatibility
- Removed enum support (PHP 8.1+ feature)
- Converted constructor property promotion to traditional syntax
- Replaced
mixedtype hints with docblock annotations - Replaced match expressions with if/else statements
- Replaced arrow functions with traditional closures
- Replaced
str_contains,str_starts_with,str_ends_withwithstrpos - Enum class converted to constants class
- Full PHP 7.0 compatibility maintained
A lightweight, fast, and feature-rich TOON (Token-Oriented Object Notation) library for PHP. Optimized for LLM contexts with 30-60% token savings compared to JSON.
- 🚀 Complete TOON format encoding/decoding
- 🔒 Type safe with PHPStan level 9
- 📦 Zero dependencies
- 🎯 30-60% token savings vs JSON
- 🧪 100% test coverage (33 tests passing)
- 🎨 Multiple formatting modes (compact, readable, tabular)
- ✨ PHP 8.0-8.4 support
- Complete TOON serialization and deserialization
- Support for all PHP data types (primitives, arrays, objects, DateTime, Enums)
- Multiple encoding modes with customizable options
- Helper functions for common operations
- Comprehensive test suite with Pest
- PSR-12 code style compliance
- PHPStan level 9 static analysis
composer require iamgerwin/toon-php
use iamgerwin\Toon\Toon;
$data = ['name' => 'John', 'age' => 30];
$toon = Toon::encode($data);
$decoded = Toon::decode($toon);
See README.md for full documentation.
Made with ❤️ for the PHP and AI community
Initial release with full TOON format support for PHP 8.0+
- Complete TOON encoding and decoding
- Support for all PHP data types
- Multiple formatting modes (compact, readable, tabular)
- Helper functions for common operations
- PHPStan level 9 compliance
- PSR-12 code style
- Comprehensive test coverage
- PHP 8.0-8.4 support