Download the PHP package nejcc/laravel-querylayer without Composer

Laravel QueryLayer

A powerful and flexible repository pattern implementation for Laravel applications. This package provides a clean and maintainable way to handle database operations in your Laravel projects, with built-in singleton pattern support for efficient repository management.

Features

• 🚀 Quick repository creation for any Eloquent model
• 🔄 Full CRUD operations out of the box
• 📦 Type-safe with PHP 8.0+ features and generics support
• 🎯 Query builder access for complex queries
• 📱 Pagination support
• 🛠️ Extensible base repository for custom implementations
• 💡 IDE-friendly with comprehensive PHPDoc annotations
• 🔒 Singleton pattern implementation for efficient resource usage
• 🗑️ Soft delete support for models using SoftDeletes
• 🔄 Database transaction support for reliable operations
• 🔗 Eager loading support for optimized relationship queries
• 🧹 Automatic query scope reset for cleaner code

Requirements

• PHP 8.0 or higher
• Laravel 8.0 or higher

Installation

You can install the package via composer:

The package will automatically register its service provider.

Quick Start

Using the Facade

The simplest way to create a repository for any model:

Creating Custom Repositories

For more complex scenarios, extend the BaseRepository:

Available Methods

The repository provides a comprehensive set of methods for database operations:

Method Chaining

The repository supports fluent method chaining for building complex queries:

Singleton Pattern

The package implements the singleton pattern for repository instances. This means:

• Each model class gets a single repository instance
• Subsequent calls to LaravelQuerylayer::repository() with the same model return the same instance
• This helps reduce memory usage and improves performance
• Perfect for dependency injection and service container usage

Soft Deletes

If your model uses Laravel's SoftDeletes trait, the repository automatically supports:

• Regular queries will exclude soft deleted records
• Use withTrashed() to include soft deleted records
• Use onlyTrashed() to get only soft deleted records
• Restore soft deleted records with restore(id)
• Permanently delete with forceDelete(id)

Transactions

For data integrity, the repository provides transaction support:

• Wrap multiple operations in transaction(function() { ... })
• Use createOrFail() to ensure a record is created or transaction fails
• Use updateOrFail() to ensure an update succeeds or transaction fails

Eager Loading

Optimize database queries by eager loading relationships:

• Use with('relation') to load a single relation
• Use with(['relation1', 'relation2']) to load multiple relations
• Chain with other methods: with('posts')->where(['active' => true])->get()

Direct Database Access with db()

In addition to the Eloquent query builder accessible via query(), the repository provides raw database access through the db() method:

The db() method provides:

• Direct access to Laravel's Query Builder for raw SQL operations
• Perfect for complex joins, aggregations, and statistical queries
• Useful for bulk operations that would be inefficient with Eloquent
• Access to advanced SQL features not available in Eloquent

When to use db() vs query():

• Use query() when you need model features like relationships, accessors/mutators, and model events
• Use db() when you need raw performance, complex joins, or SQL-specific functionality
• Choose db() for statistical queries and reporting where you don't need full model instances

You can find more examples of using the db() method in the demo repositories:

• UserRepository - examples of grouping and counting
• PostRepository - examples of joins and complex filtering
• CommentRepository - examples of aggregation and bulk operations

Testing

The package includes a comprehensive test suite. Run the tests with:

Code Style

This package follows the PSR-12 coding standard. Format your code using Laravel Pint:

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Nejcc
• All Contributors

License

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

Model Interface

You can also use the repository functionality directly on your models by implementing the ModelInterface and using the HasRepository trait:

Now you can use repository methods directly on your model:

This approach gives you the flexibility to use repository methods either through the repository class or directly on your models.