Download the PHP package jessesoeteman/api-handler without Composer
On this page you can find all versions of the php package jessesoeteman/api-handler. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jessesoeteman/api-handler
More information about jessesoeteman/api-handler
Files in jessesoeteman/api-handler
Package api-handler
Short Description This class can be used to manage the status of an api request.
License MIT
Informations about the package api-handler
APIHandler
This class can be used to manage the status of an api request.
Requirements
There are a couple things you will need in order to use this php class.
- php 8.0
- composer
How to use APIHandler?
Require APIHandler
If you have composer initialized you can run this command in you terminal to download APIHandler.
Require the autoloader and APIHandler
You will need to require the autoloader in your code, after that you can 'use' the APIReturn class.
Basic usage
Declare the class
To start you will need to initialize the class. The class needs one parameter that tells one of the following request types:
- get_request
- post_request
In this example we will use a GET request.
If the request type is not right the class will echo and exit:
Error Handling
Let's say the an error occured, we can then add the error to the errors array. The first parameter can be a string or an array, this contains the error you want to add. The second parameter is a boolean (false on default), if the boolean is true, the script will echo a json object and exit.
In the 3 examples above the class will echo the following and exit the script:
Succesfull request
If the request was succesfull and no errors occured the class will echo that there was a succes:
This example will give the following output:
License
This project is licensed under the MIT License - see the LICENSE file for details