Download the PHP package norris1z/hubtel-ussd without Composer
On this page you can find all versions of the php package norris1z/hubtel-ussd. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package hubtel-ussd
Hubtel USSD
Based on Hubtel's USSD API
About
This package helps you to build maintainable and scalable USSD applications by breaking down your "long switch" statement USSD application into modules
Getting Started
Check out this link to know how you can acquire a USSD code from Hubtel.
Installing
Install the package from composer
Usage
Setup a route
to respond to all Hubtel's
requests.
Note that Hubtel
sends no csrf
tokens hence disable csrf
protection for that route
.
For Laravel
, add the route
to the except
array in the VerifyCsrfToken
middleware.
Hubtel\USSD\Request::class
is a class which represents the request from Hubtel
. It has methods for all the parameters listed on Hubtel's Documentation Page
.
View Source Request.php
Hubtel\USSD\Response::class
is a class which represents the response sent to Hubtel
. It has methods for all the parameters listed on Hubtel's Documentation Page
.
View Source Response.php
RequestTypes::class
has two properties, RESPONSE
and RELEASE
for indicating the type of response in a sequence.
USSD::class
is a class with one static method process
which takes two parameters a Request (an instance of Hubtel\USSD\Reqeust)
and
an array
of sequence (any class that implements the Hubtel\USSD\SequenceInterface)
;
All seqeunces
must have implement the SequenceInterface
and hence have a handle
method and must return an instance of Hubtel\USSD\Response (Response)
.
The USSD::process
method automagically injects a Request
parameter into the handle
method of each sequence
. This Request
is an
instace of Hubtel\USSD\Request
which grants access to all properties and methods in the request
.
Visit Hubtel's USSD Api documentation page for the list of methods on the request and response classes
Examples
Feel free to submit pull-requests for examples with other frameworks :blush:
Running the tests
composer test
Authors
- Norris Oduro - Norris1z
License
This project is licensed under the MIT License