Download the PHP package planetthecloud/mofh-callback-client without Composer
On this page you can find all versions of the php package planetthecloud/mofh-callback-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download planetthecloud/mofh-callback-client
More information about planetthecloud/mofh-callback-client
Files in planetthecloud/mofh-callback-client
Package mofh-callback-client
Short Description API Callback client for MyOwnFreeHost in PHP
License Apache-2.0
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package mofh-callback-client
MyOwnFreeHost API Callback Client
An API callback client to parse the callback from MyOwnFreeHost.
Installation
This package is best installed through Composer:
Usage
The create method accepts the following parameters:
- ip: IP address of MyOwnFreeHost.
Where to find the IP address of MyOwnFreeHost?
You can find the IP address from the Reseller Panel. Login and go to API -> Setup WHM API -> Select the domain you want to configure, and copy the IP address shown beside "MyOwnFreeHost IP address to connect to".
Callback Handlers
The following methods accepts a callable as the parameter.
These methods will be called accordingly with the callback from MyOwnFreeHost.
Here are the list of the methods and the parameters that will be given to the callable:
- onAccountActivated
- username: vPanel username of the account.
- raw: Raw callback data.
- onAccountSuspended
- username: vPanel username of the account.
- reason: Reason for suspension.
- raw: Raw callback data.
- common_reason: Common reason for suspension, see
parseCommonSuspensionReasonsection below.
- onAccountReactivated
- username: vPanel username of the account.
- raw: Raw callback data.
- onSqlServer
- username: vPanel username of the account.
- cluster: sql cluster of the account.
- raw: Raw callback data.
- onAccountDeleted
- username: vPanel username of the account.
- raw: Raw callback data.
Handler
The handle method accepts the following parameters:
- data: Callback data from MyOwnFreeHost.
- ip: (optional) IP address of the caller. NOT MyOwnFreeHost's IP.
Inspect Callback
There are also methods to inspect the callback before and after it is handled.
The following methods accepts a callbable as the parameter:
beforeCallback: called before the callback is handled.afterCallback: called after the callback is handled.
The callable will be given the following parameters:
- data: Callback data from MyOwnFreeHost.
- ip: (optional) IP address of the caller. NOT MyOwnFreeHost's IP.
on the beforeCallback method, you can set $this->shouldHandle = false to prevent the callback from being handled. It is not recommended to log the callback with beforeCallback as it is executed before any validation is performed.
Parsing Common Suspension Reason
The parseCommonSuspensionReason method accepts the following parameters:
- reason: Raw suspension reason from MyOwnFreeHost. Which will either return null if the reason is not related to daily suspension, or the reason itself in a short form (eg. DAILY_HIT, DAILY_CPU, DAILY_IO, DAILY_EP).
Example
Exceptions
The following exceptions are thrown by the handle method:
- InvalidCallbackParameters: Thrown when the callback data is invalid.
- IpAddressMismatched: Thrown when the IP address of the caller does not match the allowed IP address given in the
createmethod.
Support
Support is offered for problems related to errors/bugs that may be present in the library.
If you seek programming support, this is not the place.
License
Copyright 2022 PlanetTheCloud
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
