Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sony/cdn-purge-control-php
Multi CDN purge control library for PHP
https://github.com/sony/cdn-purge-control-php
aws-cloudfront cdn composer limelight php purge-contents
Last synced: 2 months ago
JSON representation
Multi CDN purge control library for PHP
- Host: GitHub
- URL: https://github.com/sony/cdn-purge-control-php
- Owner: sony
- License: mit
- Created: 2016-01-06T01:41:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-10-06T08:52:20.000Z (about 8 years ago)
- Last Synced: 2024-10-12T22:52:00.730Z (3 months ago)
- Topics: aws-cloudfront, cdn, composer, limelight, php, purge-contents
- Language: PHP
- Homepage:
- Size: 31.3 KB
- Stars: 8
- Watchers: 15
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CdnPurge, Multi CDN purge control library for PHP
=================================================
[](https://travis-ci.org/sony/cdn-purge-control-php)
[](https://packagist.org/packages/sony/cdn-purge-control-php)
[](https://github.com/sony/cdn-purge-control-php/blob/master/LICENSE)
**CdnPurge** is a lightweight PHP CDN client which makes it easier to purge contents for
multiple CDN providers. Currently, CdnPurge supports [AWS CloudFront](https://aws.amazon.com/cloudfront/)
and [Limelight](https://www.limelight.com/).
- 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](https://github.com/guzzle/guzzle) to make http rest api calls.
## Installing CdnPurge
The recommended way to install CdnPurge is through
[Composer](http://getcomposer.org).
```bash
# Install Composer
curl -sS https://getcomposer.org/installer | php
```
Next, run the Composer command to install the latest stable version of CdnPurge:
```bash
composer.phar require sony/cdn-purge-control-php
```
After installing, you need to require Composer's autoloader:
```php
require 'vendor/autoload.php';
```
You can then later update CdnPurge using composer:
```bash
composer.phar update
```
## Quick Examples
### Make purge request
```php
array(
'distribution_id' => 'your cloudfront distribution id'
),
'limelight' => array(
'shortname' => 'your limelight api shortname'
'publish_url' => 'your limelight publish url'
)
);
$credential = array(
'cloudfront' => array(
'key' => 'aws iam account access key id',
'secret' => 'aws iam account secret access key'
),
'limelight' => array(
'username' => 'limelight account username',
'shared_key' => 'limelight account shared key'
)
);
try {
// Make a purge request against AWS cloudfront
$cfClient = CdnPurgeFactory::build(CdnType::CLOUDFRONT, $credential, $config);
$cfRequestId = $client->createPurgeRequest(array(
'/my-path-1',
'/my-path-2'
));
// Make a purge request against Limelight
$llClient = CdnPurgeFactory::build(CdnType::LIMELIGHT, $credential, $config);
$llRequestId = $client->createPurgeRequest(array(
'http://my-limelight-domain/my-path-1',
'/my-path-2'
));
} catch (CdnPurge\CdnClientException $e) {
echo "An error occurred: " . $e->getMessage();
}
```
### Get purge status
```php
getPurgeStatus($requestId);
// 'InProgress' or 'Complete'
} catch (CdnPurge\CdnClientException $e) {
echo "There was an error getting purge status.\n";
}
```
See [example](https://github.com/sony/cdn-purge-control-php/tree/master/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](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/AWSCredentials.html) for details |
| cloudfront['secret'] | String | Yes | AWS IAM user Secret Access Key. See [here](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/AWSCredentials.html) 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
-----------
- [Running tests](https://github.com/sony/cdn-purge-control-php/blob/master/tests/README.md)
- [Generating documentation](https://github.com/sony/cdn-purge-control-php/blob/master/docs/README.md)
License
-------
The MIT License (MIT)
See [LICENSE](https://github.com/sony/cdn-purge-control-php/blob/master/LICENSE) for details.