Download the PHP package heidelpay/php-customer-messages without Composer
On this page you can find all versions of the php package heidelpay/php-customer-messages. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download heidelpay/php-customer-messages
More information about heidelpay/php-customer-messages
Files in heidelpay/php-customer-messages
Package php-customer-messages
Short Description A libary for heidelpay messages.
License Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
Homepage https://dev.heidelpay.de
Informations about the package php-customer-messages
heidelpay Customer Messages
ATTENTION: This package is abandoned and replaced by heidelpay/php-message-code-mapper.
This library provides user-friendly output of (error)-messages coming from the heidelpay API.
1. Installation
Composer
manual Installation
Download the latest release from github and unpack it into a folder of your choice inside your project.
2. Implementation
Composer
manual Installation
Of course, the path needs to match the path from step 1.
3. Usage
Assuming you have received an error code from one of our modules or the
heidelpay PHP API and stored it in a variable called $errorcode
.
To get a message from that code, create a CustomerMessage
instance:
The constructor takes two (optional) arguments:
- The locale (e.g. 'en_US', 'de_DE')
- The path to the locales path (for example you want to use your own locale files) containing the .csv files with the codes and messages.
We provide 'de_DE' and 'en_US' locale files with this package. You can find them in the lib/locales folder. If you want to use one of these, the path doesn't need to be provided in the constructor.
By default, 'en_US' is used as the locale.
Now you can return or print out the message by calling the getNessage()
method:
Error codes are accepted in either the 'XXX.XXX.XXX' or 'HP-Error-XXX.XXX.XXX' format.