Download the PHP package mmauksch/json-repositories without Composer

JSON File Repository

A lightweight PHP library implementing the repository pattern with JSON file persistence. This library provides an easy way to create repositories that store data in JSON files, making it ideal for integration tests, Symfony web tests, and application prototyping.

📋 Overview

JSON File Repository offers a simple solution for temporary data persistence without the need for a full database setup. It implements the standard repository pattern, providing familiar interfaces for storing, retrieving, and managing collections of objects.

⚠️ Note: This library is intended for testing and prototyping purposes only and is not suitable for production workloads.

🚀 Installation

Install the library via Composer:

🔧 Usage

Basic Usage

Extending AbstractRepository

Instead of using GenericJsonRepository as an instance, you can also extend the AbstractJsonRepository class to create your own repository implementation:

Using Traits Selectively

You can also build your own repository implementation by selectively importing the traits that provide specific functionality:

Using Filters

Using Sorters

Using with Symfony Tests

For Application Prototyping

You can also simply let the dependency injection container provide the filesystem and serializer. In Symfony YAML configuration:

🔄 Key Features

• Simple Repository Pattern Implementation - Follows standard repository interfaces
• JSON File Persistence - Stores entities as JSON files without database setup
• Flexible Storage Location - Configure where your JSON files are stored
• Advanced Filtering - Filter entities using both Filter objects and closures
• Custom Sorting - Sort entities using Sorter objects or custom comparison closures
• Type Safety - Repositories are typed to specific entity classes
• Symfony Integration - Works with Symfony Filesystem and Serializer components

💡 Best Practices

• Use a dedicated directory for test storage that is cleared between test runs
• For integration tests, create fresh repositories in your test setup
• Implement proper cleanup in tearDown() methods or use a test framework's isolation features
• Consider using memory-only repositories for very simple tests

🧪 When to Use

• ✅ Writing integration tests
• ✅ Developing Symfony web tests
• ✅ Prototyping applications or features
• ✅ Demos and proof of concepts
• ❌ Production applications
• ❌ High-performance requirements
• ❌ Applications with complex database requirements

📄 License

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

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.