#LaraUtilX: Unleash the Power of Laravel with Utilities and Helpers

LaraUtilX is a comprehensive Laravel package designed to supercharge your development experience by providing a suite of utility classes, helpful traits, middleware, and more. Whether you're a seasoned Laravel developer or just getting started, LaraUtilX offers a collection of tools to streamline common tasks and enhance the functionality of your Laravel applications.

Version: 1.5.5
Laravel Support: Laravel 10, 11, 12, 13
PHP Support: PHP 8.1+
License: MIT

---

📘 Full Documentation
Explore full usage examples, configuration options, and best practices at:
👉 https://larautilx.omarchouman.com

---

#Key Features

1. CrudController: Simplify your CRUD operations with the generic CrudController that can be easily extended, allowing you to create, read, update, and delete records effortlessly.

2. ApiResponseTrait: Craft consistent and standardized API responses with the ApiResponseTrait. This trait provides helper methods for formatting JSON responses, making your API endpoints clean and well-structured.

3. FileProcessingTrait: Manage file uploads and deletions seamlessly with the FileProcessingTrait. This trait offers methods for uploading single or multiple files, deleting files, and now retrieving file contents.

4. CRUD Generator: Scaffold a complete API resource in one command with php artisan make:crud. Generates the model, controller, and migration from a field definition, with support for relationships, soft deletes, searchable fields, and automatic route registration.

5. SchedulerMonitor: Keep an eye on your scheduled tasks with the SchedulerUtil utility. Monitor upcoming scheduled events, check which tasks are due, and gain insights into the status of your scheduled jobs. Runs in a console context only, since Laravel does not populate the schedule during a web request.

6. FilteringUtil: Effortlessly filter data based on specified criteria with the FilteringUtil. This utility provides a convenient way to filter collections or arrays based on field names, operators, and values.

7. AccessLogMiddleware: LaraUtilX includes middleware components like the AccessLogMiddleware to log access to your application, adding an extra layer of security and accountability. Passwords and tokens are redacted from both the request body and the query string, at any nesting depth, and old rows can be pruned on a schedule. See Pruning access logs.

8. PaginationUtil: Seamlessly handle paginated data with LaraUtilX's PaginationUtil. This utility simplifies the process of paginating query results, allowing you to customize the number of items per page, navigate through paginated results effortlessly, and present data in a user-friendly manner.

9. CachingUtil: Optimize performance and reduce database queries using LaraUtilX's CachingUtil. Store and retrieve frequently accessed data with ease, taking advantage of features like customizable cache expiration and cache tags.

10. ConfigUtil: Manage your Laravel configuration settings effortlessly with the ConfigUtil. Retrieve, set defaults, and dynamically manipulate configuration data. Simplify the way you interact with your application's configuration, ensuring a clean and organized approach.

11. LLM Providers: Effortlessly integrate advanced AI-powered chat completions into your Laravel application with our LLM providers. Choose between OpenAI, Google Gemini, and Anthropic Claude through a unified interface. The OpenAI provider additionally requires composer require openai-php/client. Both providers support all major chat parameters, automatic retry logic, and structured responses. Generate dynamic, context-aware text completions for your users with just a few lines of code.

    • OpenAIProvider: Interact with OpenAI's GPT models (GPT-3.5, GPT-4, etc.)
    • GeminiProvider: Interact with Google's Gemini models (Gemini 2.0 Flash, etc.)
    • ClaudeProvider: Interact with Anthropic's Claude models. System messages are lifted into Anthropic's top-level system parameter automatically, so the same message array works across all three providers.
    • Configurable Provider Selection: Switch between providers via configuration
    • Unified Interface: Same API for both providers with automatic model selection

12. FeatureToggleUtil: Implement feature flags and toggles with ease using the FeatureToggleUtil. Enable or disable features dynamically based on configuration, user context, or environment settings. Perfect for A/B testing, gradual rollouts, and feature management.

13. LoggingUtil: Enhance your application's logging capabilities with the LoggingUtil. Create structured logs with JSON formatting, custom channels, and contextual information. Includes predefined methods for all log levels with automatic timestamp and environment tracking.

14. QueryParameterUtil: Parse and validate query parameters from HTTP requests with the QueryParameterUtil. Safely extract and filter query parameters based on allowed lists, improving API security and data handling.

15. RateLimiterUtil: Implement rate limiting for your APIs and endpoints using the RateLimiterUtil. Control request frequency, prevent abuse, and manage API usage with configurable limits and decay times.

16. Auditable Trait: Automatically track model changes with the Auditable trait. Log create, update, and delete operations with user context, old values, and new values. Sensitive attributes such as passwords and tokens are excluded from the trail by default, and both the exclusion list and the audit table name are configurable.

17. RejectCommonPasswords Rule: Strengthen password security with the RejectCommonPasswords validation rule. Prevent users from using common, easily guessable passwords with a comprehensive list of weak passwords.

18. XHelper: Reach for a grab-bag of small helpers via the XHelper class — array trimming and flattening, substring extraction, slugification, Carbon date parsing and human-readable diffs, and UUID generation.

#CRUD Generator

Scaffold a model, an API controller, and a migration in a single command:

php artisan make:crud Post --fields="title:string:required,body:text:nullable,price:decimal:required|min:0"

#Options

Existing files are never overwritten unless you pass --force; the command warns and skips instead.

php artisan make:crud Post \
    --fields="title:string:required,body:text:nullable" \
    --belongs-to=User \
    --has-many=Comment \
    --searchable=title,body \
    --soft-deletes \
    --register-routes

#Pruning access logs

AccessLog is prunable, but php artisan model:prune on its own will never find it: without --model the command only scans app/Models, so a model living in vendor/ is never discovered. Name it explicitly:

use Illuminate\Support\Facades\Schedule;

Schedule::command('model:prune', [
    '--model' => [\LaraUtilX\Models\AccessLog::class],
])->daily();

--model limits that run to the models you list, so keep this schedule separate from any model:prune you already run for your own models rather than merging them into one command.

Retention is configurable, and null keeps rows indefinitely:

'access_log' => [
    'retention_days' => 30,
],

#Customising package classes

Package classes are not publishable. A published copy keeps its LaraUtilX namespace while landing in app/, where Composer's PSR-4 mapping expects App\, so the copy is never autoloaded and every call still resolves to the package. Extend or wrap instead:

namespace App\Support;

use LaraUtilX\Utilities\CachingUtil;

class AppCache extends CachingUtil
{
    // override what you need
}

Configuration, migrations, and the CRUD generator stubs remain publishable, since those are data rather than autoloaded classes.

#Sorting in CrudController

CrudController accepts sort_by and sort_direction query parameters, but only for columns you explicitly allow. This keeps a caller from ordering by columns they should never be able to observe, such as password hashes or tokens:

class PostController extends CrudController
{
    protected array $sortableFields = ['title', 'created_at'];
}

A sort_by value outside $sortableFields is ignored rather than rejected. When the list is empty, no sorting is applied at all.

Controllers produced by make:crud carry the same protection through a $sortable allow-list written into the generated index() method. It defaults to id, your declared --fields, and created_at, with credential-looking columns such as password and api_token left out. Pass --sortable= to set the list yourself:

php artisan make:crud Post --fields="title:string,body:text" --sortable="title,created_at"

#Test Suite

LaraUtilX comes with a comprehensive test suite that ensures reliability and quality. The test suite includes both unit tests and feature tests covering all utilities, traits, and components.

#Running Tests

#Prerequisites

Make sure you have installed the development dependencies:

composer install

#Run All Tests

./vendor/bin/phpunit

#Run Specific Test Suites

# Run only unit tests
./vendor/bin/phpunit --testsuite Unit

# Run only feature tests
./vendor/bin/phpunit --testsuite Feature

#Run Specific Test Classes

# Run tests for a specific utility
./vendor/bin/phpunit tests/Unit/Utilities/CachingUtilTest.php

# Run tests for a specific trait
./vendor/bin/phpunit tests/Unit/Traits/ApiResponseTraitTest.php

#Run Tests with Coverage

./vendor/bin/phpunit --coverage-html coverage

#Test Coverage

The test suite provides comprehensive coverage for:

• Utilities: All utility classes with their methods and edge cases
• Traits: All traits with their functionality and integration
• Enums: All enum values and behaviors
• Rules: Validation rules with various input scenarios
• Feature Tests: Integration scenarios and performance tests

#Test Structure

tests/
├── TestCase.php                    # Base test case with Laravel setup
├── Unit/                          # Unit tests for individual components
│   ├── Console/
│   │   └── MakeCrudCommandTest.php
│   ├── Enums/
│   │   └── LogLevelTest.php
│   ├── Rules/
│   │   └── RejectCommonPasswordsTest.php
│   ├── Traits/
│   │   ├── ApiResponseTraitTest.php
│   │   ├── AuditableTest.php
│   │   └── FileProcessingTraitTest.php
│   └── Utilities/
│       ├── CachingUtilTest.php
│       ├── ConfigUtilTest.php
│       ├── FeatureToggleUtilTest.php
│       ├── FilteringUtilTest.php
│       ├── LoggingUtilTest.php
│       ├── PaginationUtilTest.php
│       ├── QueryParameterUtilTest.php
│       ├── RateLimiterUtilTest.php
│       └── SchedulerUtilTest.php
└── Feature/                       # Integration tests
    ├── Http/
    │   └── Controllers/
    │       └── CrudControllerTest.php
    └── Traits/
        └── ApiResponseTraitFeatureTest.php

#How to Get Started

1. Install LaraUtilX using Composer:

   composer require omarchouman/lara-util-x
   

2. Explore the included utilities, traits, and middleware in your Laravel project.
3. Customize and extend LaraUtilX to match the specific needs of your application.

#Development & Contributing

LaraUtilX is actively maintained and welcomes contributions! The package includes a comprehensive test suite to ensure reliability and quality.

#Development Setup

1. Clone the repository
2. Install dependencies: composer install
3. Run tests: ./vendor/bin/phpunit
4. Check code coverage: ./vendor/bin/phpunit --coverage-html coverage

#Writing Tests

When contributing new features:

• Write unit tests for individual components
• Write feature tests for integration scenarios
• Maintain high test coverage (90%+)
• Follow the AAA pattern: Arrange, Act, Assert
• Test edge cases and error conditions

#Code Quality

• Follow PSR-12 coding standards
• Use descriptive variable and method names
• Include comprehensive docblocks
• Handle errors gracefully
• Write clean, maintainable code

Save time, enhance code readability, and boost your Laravel projects with LaraUtilX – the toolkit every Laravel developer deserves.