README

A Laravel package providing comprehensive helper functions for handling API and web responses, authentication, code generation, date formatting, file uploads, and more.

Requirements

• PHP >= 8.2
• Laravel 11.x or 12.x

Installation

Step 1: Install via Composer

composer require mainul/custom-helpers

Step 2: Publish Configuration (Optional)

Publish the configuration file to customize package settings:

php artisan vendor:publish --tag=helper-functions-config

This will create a config/helper-functions.php file where you can customize:

• Route settings (prefix, middleware)
• Default error messages
• API detection patterns
• And more

Step 3: Publish Routes (Optional)

If you want to customize the routes, publish the route files:

php artisan vendor:publish --tag=helper-functions-routes

This will create:

• routes/helper-functions-web.php
• routes/helper-functions-api.php

You can then update the routes in these files and disable the package routes in config/helper-functions.php:

'routes' => [
    'web' => [
        'enabled' => false, // Disable package web routes
    ],
    'api' => [
        'enabled' => false, // Disable package API routes
    ],
],

Configuration

After publishing the config file, you can customize the package in config/helper-functions.php:

Routes Configuration

'routes' => [
    'web' => [
        'enabled' => true,              // Enable/disable web routes
        'prefix' => null,               // Route prefix
        'middleware' => ['web'],        // Middleware groups
    ],
    'api' => [
        'enabled' => true,              // Enable/disable API routes
        'prefix' => 'api',              // Route prefix
        'middleware' => ['api'],        // Middleware groups
    ],
],

CustomHelper Configuration

'custom_helper' => [
    'default_error_message' => 'Something went wrong. Please try again.',
    'no_data_message' => 'No Data found.',
    'default_success_message' => 'Operation completed successfully.',
    'api_guard' => 'sanctum',           // Auth guard for API
    'default_guard' => null,            // Default auth guard
],

Usage

Using the CustomHelper Class

use Mainul\CustomHelperFunctions\Helpers\CustomHelper;

// Return data for web or API
return CustomHelper::returnDataForWebOrApi($data, 'users.index', $errorMessage);

// Return success message
return CustomHelper::returnSuccessMessage('User created successfully');

// Check authentication
if (CustomHelper::authCheck()) {
    $user = CustomHelper::loggedUser();
}

// Generate code (OTP)
$otp = CustomHelper::generateCode(6, 'number');

// Get session code
$sessionCode = CustomHelper::getSessionCode('mobile_123');

Available Methods

Response Methods

Request Detection Methods

Authentication Methods

Code Generation Methods

Date & Time Methods

File Methods

Artisan Command Methods

Controller Methods (CustomHelperController)

Adding Custom Routes

Option 1: Edit Package Routes Directly (Not Recommended)

Edit src/routes/web.php or src/routes/api.php:

use Illuminate\Support\Facades\Route;
use Mainul\CustomHelperFunctions\Helpers\CustomHelper;

Route::get('/your-route', function () {
    // Your logic here
});

Option 2: Publish and Customize Routes (Recommended)

1. Publish routes:

php artisan vendor:publish --tag=helper-functions-routes

1. Edit published routes in routes/helper-functions-web.php or routes/helper-functions-api.php

2. Disable package routes in config/helper-functions.php:

'routes' => [
    'web' => ['enabled' => false],
    'api' => ['enabled' => false],
],

1. Load your custom routes in app/Providers/AppServiceProvider.php:

public function boot()
{
    $this->loadRoutesFrom(base_path('routes/helper-functions-web.php'));
    $this->loadRoutesFrom(base_path('routes/helper-functions-api.php'));
}

Optional Dependencies

The package works with these optional packages:

• brian2694/laravel-toastr - For flash messages (optional)

If this package is not installed, the package will skip the related functionality.

License

MIT

Support

For issues and feature requests, please use the GitHub issue tracker.