Download the PHP
package wpcs/php-api-wrapper without Composer
On this page you can find all versions of the php package
wpcs/php-api-wrapper. It is possible to download/install
these versions without Composer. Possible dependencies are resolved
automatically.
Vendor wpcs Package php-api-wrapper Short Description A PHP API wrapper to easily communicate with the WPCS.io API. License
MIT
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.
A PHP API wrapper to easily communicate with the WPCS.io API.
Authentication
In order to use the package, you need to authenticate with the WPCS API. You can create an API key/secret pair in the console to use for this wrapper.
There are two ways to authenticate the requests with this package: using constants or the builder functions.
Configuring authentication with builder functions
There are three functions to use to authenticate your requests: setRegion(string $region), setApiKey(string $key) and setApiSecret(string $secret)
Example:
This allows you to use your own secrets management.
Constants
If you are using, for example, WordPress, it is common to place secrets in the wp-config.php file as constants. You can do this for the wrapper as well. The three required constants are WPCS_API_REGION, WPCS_API_KEY and WPCS_API_SECRET. When these are defined, you do not need to use the builder functions to setup authentication.
Example:
Example usage
A request to the WPCS API to create a new version might look like this (when not using the constants to authenticate). This request will create a version, based on the last snapshot of the current production version in WPCS in a product that resides in the US1 region.
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 wpcs/php-api-wrapper contains the following files
Loading the files please wait ....
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.