Download the PHP package sony/cdn-purge-control-php without Composer
On this page you can find all versions of the php package sony/cdn-purge-control-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package cdn-purge-control-php
CdnPurge, Multi CDN purge control library for PHP
CdnPurge is a lightweight PHP CDN client which makes it easier to purge contents for multiple CDN providers. Currently, CdnPurge supports AWS CloudFront and Limelight.
- Simple common interface to purge contents against multiple CDNs and get purge status.
- Easily extensible to other CDN providers.
- Easy code maintenance.
- Requires PHP >= 5.5 compiled with cURL extension and cURL 7.16.2+ compiled with a TLS backend (e.g. NSS or OpenSSL).
- Uses Guzzle to make http rest api calls.
Installing CdnPurge
The recommended way to install CdnPurge is through Composer.
Next, run the Composer command to install the latest stable version of CdnPurge:
After installing, you need to require Composer's autoloader:
You can then later update CdnPurge using composer:
Quick Examples
Make purge request
Get purge status
See example for a running example of how to use this library.
Specifying credentials
Credentials are specified as an array.
AWS CloudFront
Credential key | Type | Required | Description |
---|---|---|---|
cloudfront['key'] | String | Yes | AWS IAM user Access Key Id. See here for details |
cloudfront['secret'] | String | Yes | AWS IAM user Secret Access Key. See here for details |
Limelight
Credential key | Type | Required | Description |
---|---|---|---|
limelight['username'] | String | Yes | Limelight account username |
limelight['shared_key'] | String | Yes | Limelight account share key |
Specifying configurations
Configurations are specified as an array.
AWS CloudFront
Config key | Type | Required | Description |
---|---|---|---|
cloudfront['distribution_id'] | String | Yes | AWS CloudFront Distribution Id |
http['proxy'] | String | No | Specify http proxy for the client. For example: 'my-company.proxy.com:1234' |
Limelight
Config key | Type | Required | Description |
---|---|---|---|
limelight['shortname'] | String | Yes | Limelight api shortname |
limelight['publish_url'] | String | No | Limelight publish url. This is prepended to the purge path if the path doesn't start with 'http' or 'https' |
limelight['evict'] | Boolean | No | If true, matching cache objects are evicted (deleted), otherwise invalidated. Default is false |
limelight['exact'] | Boolean | No | If true, paths to be purged are treated as an exact public URL. Optional. Default is false. Default is false |
limelight['incqs'] | Boolean | No | If true, pattern is allowed to match query string part of URL, otherwise query string is stripped before matching. Default is false |
limelight['email'] | Array | No | Array of email info to send purge completion details to |
limelight['email']['subject'] | String | No | Subject of sent mail |
limelight['email']['to'] | String | Yes | Email recipient address. A comma is used to separate multiple recipients |
limelight['email']['cc'] | String | No | Email carbon copy. A comma is used to separate multiple recipients |
limelight['email']['bcc'] | String | No | Email blind carbon copy. A comma is used to separate multiple recipients |
limelight['callback'] | Array | No | HTTP(S) callback URL for purge request state transition notifications |
limelight['callback']['url'] | String | Yes | Callback url |
http['proxy'] | String | No | Specify http proxy for the client. For example: 'my-company.proxy.com:1234' |
Development
License
The MIT License (MIT)
See LICENSE for details.