This package is a template used to create API responses which can be overwritten as per the developer's requirements.
In order to install the package use the command specified below -
composer require arhamlabs/error-handler
In config/app.php append the class in the providers array to publish the package service provider
Arhamlabs\ApiResponse\ApiResponseServiceProvider::class
Refer the image given below -
To publish the packages resources and configs run the command below
php artisan vendor:publish --provider="Arhamlabs\ApiResponse\ApiResponseServiceProvider"
Developers have the option to enable notifications (implements queues) through emails and slack channels in case of a code breakage or server errors. Once you have published the package resource you can see a new config file being created (config/apiResponse.php) to customize your notification options. You can open the config file which will have an array of params that will be required to enable notifications.
Note: You may need to create a script to run queue (supervisor or cron jobs) in order for the notifications to work
for more information of queues refer laravel documentation for queues and supervisor
After installing the package, you may need to import the package in the file you want to use. Use the following import syntax
use Arhamlabs\ApiResponse\ApiResponse;
For using the package refer the image given below -
In the above example, we can see a function getResponse being called, this function returns a body response in a certain format that contains data and acknowledgement to users on success, whereas debugging information on errors.
public function getResponse($statusCode=null, $data=null, $message=null, $file=null, $line=null, $errors=null)
This parameter is the error code that we get in the response, typically 200 on success, 500 on error an so on. If this parameter is not defined, then the function sent a default status code of 500
Typically defined when we need to send some data along with the response (mostly used in status code 200).
Message parameter contains a string that summarizes the response status.
The file in which the error has occurred can be specified in this parameter
We can also provide the line on which the error has occurred by $e->getLine() function in catch block (where $e is the object on class Exception)
This parameter can either be a string or an array errors, this is made standardized so that the front end team don't have to code for different type of datatype and structures
In a scenario where the developer needs to use their own response and user message instead of the default configured messages, we may use this function to set those parameters in the response.
public function setCustomResponse($messageTitle=null, $messageText=null, $primaryAction=null, $primaryActionLabel=null, $secondaryAction=null, $secondaryActionLabel=null)
First parameter is the message title that is shown to the user.
This is the text that is shown to the user.
The primary action is something that the user needs to do after they get a response from the api for instance - if a user tries to login with incorrect credentials, the primary action for this response was dismiss and try again with different credentials.
The name on the widget that triggers the primary action
The secondary action is an alternative action that a user can proceed with like cancel or dismiss and so on.
The name on the widget that triggers the secondary action
Where the developer needs to override default errors execution for instance, if a developer is not using default request files for validation and need to validate inside a controller itself, in this situation they may have to overwrite the errors to the validator errors before throwing to the catch block. Here the set custom error function may be useful.
public function setCustomErrors($errors)
The parameter passed to overwrite the default error, this can be either a string or an array (preferably validators errors object)