Download the PHP package liquidweb/php-stormondemand without Composer

On this page you can find all versions of the php package liquidweb/php-stormondemand. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of liquidweb/php-stormondemand

Informations about the package php-stormondemand

php-stormondemand

php-stormondemand provides the PHP programmer a library to interact with Liquid Web's Storm API via the StormAPI class.

Platforms Supported

Regardless of whether you are using Liquid Web Storm Servers or Storm on Demand, the API, and subsequently this library, will work.

API Versions Supported

The php-stormondemand library will work with any current or future version of the Storm API. Currently, the two versions are:

Requirements

The php-stormondemand library requires that cURL support be enabled in PHP (see http://www.php.net/manual/en/book.curl.php for more information).

Basic Usage

The following is an example script (located in the examples/ directory) that shows basic use:

Alternatively, the parameter(s) can be passed upon instantiation as so:

PHPDoc blocks are utilized so that code hinting can be used if your IDE supports it.

Instantiated Method Summary

The following is just a quick summary of methods that the library provides when a StormAPI object is instatiated, their function, and their parameters.

__construct($apiUser, $apiPass, $apiMethod, $paramsArray = FALSE, $apiVersion = "v1") The magic constructor method that is called upon instantiation of a StormAPI object. If you want to pass along a specific version of the API, but don't want to (or can't) pass along parameters upon construction, specify a boolean (I prefer FALSE) for $paramsArray.

bulkParams($paramsArray) Allows the passing of multiple parameters via an associative array.

addParam($parameter, $value) Adds specifies the parameter and its value to be passed along with the API request.

removeParam($parameter) Removes the specified parameter from being passed along with the API request.

listParams() Lists any parameters that are currently set.

listMethodParams() Parses the API documentation and provides parameters associated with the method that is currently being used. Additionally, it shows the optionality of the parameter.

clearParams() Clears out all of the parameters that may be currently set.

newMethod($apiMethod, $clearparams = TRUE) Changes the API method to call. Also clears out the parameters by default unless overridden.

listMethods() Returns a listing of all the API methods available for the version of the API that is being used.

debugInfo() More of a convenience method that outputs some information that might be useful for debugging purposes.

request($displayFriendly = FALSE) The method that makes the actual request.

When passed with $displayFriendly being FALSE, an associative array is returned from the decoded JSON output from the API.

When $displayFriendly is TRUE, the return is an array consisting of two keys, 'raw' and 'display'. The "display friendly" version of the output is good when a quick glance at the data is needed, as it is displayed in a format with breadcrumbs so you can easilly tell where the data is at.

storeRequest($key) This method stores the results of an API request by the supplied key.

returnRequests($key, $displayFriendly) This method returns all of the stored requests if $key is not supplied, or the request for a particular supplied key.

The $displayFriendly argument functions just like its counterpart in the request() method.

listRequestKeys() This method lists they keys for stored requests.

removeRequest($key) This method removes the stored request for the key given.

Static Method Summary

The following are static methods that don't require an instantiated object to run. They have equivalent wrapper methods for instantiated objects to take currently set values as well.

listMethodParamsStatic($apiMethod, $apiVersion = 'v1') Parses the API documentation and provides parameters associated with the method and version that is passed in. Additionally, it shows the optionality of the parameter.

listMethodsStatic($apiVersion = 'v1') Returns a listing of all the API methods available for the version of the API that is passed in.

All versions of php-stormondemand with dependencies

PHP Build Version
Package Version
Requires ext-curl Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package liquidweb/php-stormondemand contains the following files

Loading the files please wait ....