Download the PHP package hughcube/laravel-knight without Composer

Laravel Knight

Introduction

Laravel Knight is a powerful helper extension for the Laravel PHP framework, designed to provide a more robust and efficient development experience. It aims to streamline the development process, optimize code structure, and offer a range of feature-rich tools to enhance the performance, maintainability, and reliability of Laravel applications. With Laravel Knight, developers can build feature-rich web applications faster, reduce redundant work, and handle common challenges like data concurrency more effectively.

Features

• Enhanced Eloquent Models: Provides advanced caching mechanisms, optimistic locking, and convenient data manipulation methods.
• Optimized Query Builder: Extends Laravel's query builder with powerful search and filtering capabilities.
• Controller Utilities: Offers helpful methods for caching controller actions and managing request parameters.
• Robust Caching: Implements intelligent caching strategies to reduce database load and improve response times.
• Optimistic Locking: A built-in solution to prevent data conflicts in concurrent update scenarios.
• Code Quality Tools Integration: Integrates with PHPUnit, PHPStan, and PHP_CodeSniffer for robust testing and code analysis.

Installing

Usage

Laravel Knight provides several powerful Traits and classes to enhance your Laravel application.

1. Model Enhancements (HughCube\Laravel\Knight\Database\Eloquent\Model & Traits)

You can extend HughCube\Laravel\Knight\Database\Eloquent\Model or use specific traits in your Eloquent Models to gain additional functionalities.

Basic Model Usage (with Caching)

Extend HughCube\Laravel\Knight\Database\Eloquent\Model to get caching and other utilities. You need to implement getCache() method to provide a cache store.

Optimistic Locking

To add optimistic locking to any Eloquent Model, simply use the OptimisticLock trait and ensure your database table has a data_version column (unsigned big integer with a default value, e.g., 1).

2. Query Builder Enhancements (HughCube\Laravel\Knight\Database\Eloquent\Traits\Builder)

This trait extends Laravel's Eloquent Query Builder with additional helpful methods. These methods are available when you use HughCube\Laravel\Knight\Database\Eloquent\Model or when you explicitly use the Builder trait in your custom query builders.

3. Controller Utilities (HughCube\Laravel\Knight\Routing\Controller & HughCube\Laravel\Knight\Knight\Routing\Action)

Extend HughCube\Laravel\Knight\Routing\Controller or use the Action trait in your controllers to leverage caching and other request-related utilities.

Contributing

You can contribute in one of three ways:

1. File bug reports using the issue tracker.
2. Answer questions or fix bugs on the issue tracker.
3. Contribute new features or update the wiki.

The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.

License

Laravel Knight is open-sourced software licensed under the MIT license.