matraux / json-orm
A PHP 8.4+ library for converting JSON data to typed entities and back, with support for lazy-loading collections.
Requires
- php: ^8.4
- nette/utils: *
Requires (Dev)
- contributte/qa: ^0.3.2
- nette/neon: ^3.4
- nette/tester: ^2.5
- phpstan/phpstan: ^2.1
- tracy/tracy: ^2.10
This package is auto-updated.
Last update: 2025-07-25 21:35:36 UTC
README
Introduction
A PHP 8.4+ library for converting JSON data to typed entities and back, with support for lazy-loading collections, immutable data structures, and structured entity design. Useful for structured JSON APIs, configuration parsing, and object-based manipulation of hierarchical JSON data.
Features
- Object-oriented JSON mapping
- Conversion from JSON to typed entities and back
- Lazy-loading collections for efficient memory usage
- Entity objects are mutable and can be freely modified after creation
- Strict type support with automatic casting
- Native support for nested structures and arrays
- Easy integration with configuration or API responses
Installation
composer require matraux/json-orm
Requirements
version | PHP | Note |
---|---|---|
1.1.0 | 8.3+ | Initial commit |
1.2.0 | 8.4+ | Performance optimization |
1.3.0 | 8.4+ | Performance optimization |
1.4.1 | 8.4+ | 50%+ performance boost via metadata caching |
Examples
See Definitions for how to define your own entities and collections.
See Read for full reading examples.
use Matraux\JsonORM\Json\JsonReader; // Load data from JSON string or file $reader = JsonReader::fromJson('[{"CUSTOM_ID":1,"name":"First"}]'); // Create typed collection from JSON $collection = CommonCollection::create($reader); $entity = $collection[0]; echo $entity->name; // "First"
See Write for writing examples.
// Create collection and insert entity $collection = CommonCollection::create(); $entity = $collection->createEntity(); $entity->name = 'Example'; echo json_encode($collection); // '[{"name":"Example"}]'
Development
See Development for debug, test instructions, static analysis, and coding standards.
Support
For bug reports and feature requests, please use the issue tracker.