PHP code example of mahmoud-almalah / laravel-api-helpers

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

mahmoud-almalah / laravel-api-helpers example snippets

use MahmoudAlmalah\LaravelApiHelpers\Responses\CollectionResponse;
use App\Http\Resources\UserResource;

return new CollectionResponse(
    key: 'users',
    collection: UserResource::collection($users), // Collection or Paginator
    meta: $users instanceof \Illuminate\Contracts\Pagination\Paginator ? $users : null,
    message: 'Users retrieved successfully'
);

use MahmoudAlmalah\LaravelApiHelpers\Responses\ModelResponse;
use App\Http\Resources\UserResource;

return new ModelResponse(
    key: 'user',
    resource: new UserResource($user),
    message: 'User fetched successfully'
);

use MahmoudAlmalah\LaravelApiHelpers\Responses\MessageResponse;

return new MessageResponse(
    data: ['additional' => 'info'],
    message: 'Operation completed'
);

use MahmoudAlmalah\LaravelApiHelpers\Responses\FormRequestResponse;

return new FormRequestResponse($validator->errors()->toArray());

use MahmoudAlmalah\LaravelApiHelpers\Requests\BaseRequest;

class UserRequest extends BaseRequest
{
    public function rules(): array
    {
        return [/* ... */];
    }
}

'localization' => [
    'status' => env('API_LOCALIZATION_STATUS', true), // Enable or disable localization
    'locales' => ['en', 'ar'], // Supported locales
],

Route::middleware(['api-localization'])->get('/demo', fn () => response()->json([
    'locale' => app()->getLocale(),
]));

bash
php artisan vendor:publish --tag=laravel-api-platform-config

bash
php artisan vendor:publish --tag=laravel-api-platform-config

src/
├── Helpers/
│   ├── ApiResponseHelpers.php
│   Middleware/
│   ├── ApiLocalizationMiddleware.php
├── Responses/
│   ├── CollectionResponse.php
│   ├── ModelResponse.php
│   ├── MessageResponse.php
│   └── FormRequestResponse.php
├── Requests/
│   ├── BaseRequest.php
└── Providers/
    └── LaravelApiHelpersServiceProvider.php