Download the PHP package f9webltd/laravel-redirect-response-macros without Composer
On this page you can find all versions of the php package f9webltd/laravel-redirect-response-macros. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download f9webltd/laravel-redirect-response-macros
More information about f9webltd/laravel-redirect-response-macros
Files in f9webltd/laravel-redirect-response-macros
Package laravel-redirect-response-macros
Short Description Some useful redirect response macros for your Laravel application
License MIT
Homepage https://github.com/f9webltd/laravel-redirect-response-macros
Informations about the package laravel-redirect-response-macros
Laravel Redirect Response Macros
Some super useful redirect response macros to simplify your Laravel application.
Requirements
- PHP
^8.0
- Laravel
^8.12
,^9.0
,^10.0
or^11.0
Legacy Support
For legacy PHP / Laravel support, use package version 1.1.6
Installation
The package will automatically register itself.
Optionally publish language files by running: php artisan vendor:publish
and selecting the appropriate package.
Documentation
This package allows for concise controller redirections by setting default flash data. It works as Laravels RedirectResponse
class is "macroable".
For example the packages allows:
... instead of:
The former is of course much more concise and readable.
The package specifies several custom RedirectResponse
macros that can be used on any of the native Laravel helpers that return the redirect response object.
The following methods are available.
success()
Flash message key: success
Pass a message string to the macros.
info()
Flash message key: info
Pass a message string to the macros.
danger()
Flash message key: danger
Pass a message string to the macros.
warning()
Flash message key: warning
Pass a message string to the macros.
There are further helper method available, that set the same type of flash data, but in a more readable manner:
created()
Flash message key: success
Default message: The record was successfully created
Alternatively pass a url to display an message with a link to view the created record:
The flashed message will now be: The record was successfully created. <a href="/posts/1/edit" class="alert-link">View inserted record</a>
.
updated()
Flash message key: success
Default message: The record was successfully updated
To set a custom message, pass the desired text to the updated()
function.
deleted()
Flash message key: success
Default message: The record was successfully deleted
To set a custom message, pass the desired text to the deleted()
function.
error()
Flash message key: error
Specific message text should be passed.
The function can detect the presence of exception object and call getMessage()
as required:
errorNotFound()
Works in the same way as the error()
macro and is intended to make controllers more concise.
The default message is Sorry, the record could not be found.
.
authorized()
Flash message key: success
Default message: Welcome back, you have been securely logged in
A custom message can optionally be provided.
unAuthorized()
Works in the same way as the error()
macro and is intended to make controllers more concise.
The default message is You do not have permission to perform that action
.
IDE Autocompletion within PHPStorm
Autocompletion of "macroable" classes with PHPStorm currently difficult, which is a shame given how useful macroable classes actually are.
At present, the following process will trigger autocompletion in PHPStorm:
- Copy resources/_ide_helper_macros.php to a location within your project to allow PHP storm to index the additional class methods
- Optionally add
_ide_helper_macros.php
to your.gitignore
file
Contribution
Any ideas are welcome. Feel free to submit any issues or pull requests.
Testing
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.