ali1/cakephp-cloudflare-api

A CakePHP component to use the CloudFlare in PHP

CloudFlare API plugin for CakePHP 2.0+

This plugin is a (very) thin veil over vexxhost's CloudFlare-API for use in CakePHP controllers. Please use composer to install so that the required dependencies are installed, _(*1)

Composer Installation

• Add to composer, this will also install the Amazon SDK for PHP as a dependency, _(*2)

  "ali1/cakephp-cloudflare-api": "dev-master"

Non-composer Installation

• Place the contents of this repo in Plugin/CloudFlareApi
• Download the contents of https://github.com/vexxhost/CloudFlare-API into Plugin/CloudFlareApi/Vendor/vexxhost/cloud-flare-api

Configuration

• You must add configuration to bootstrap.php., _(*3)

  Configure::write('CloudFlareApi.email', 'CLOUDFLARE EMAIL');
  Configure::write('CloudFlareApi.apiKey', 'CLOUDFLARE API KEY');

  • Don't forget to replace the placeholder text with your actual keys!

• Add the component to a controller, _(*4)

  public $components = array('CloudFlareApi.CloudFlareApi');

Example

• Remove a file from the cache, _(*5)

  $this->CloudFlareApi->zone_file_purge('mydomain.com', 'http://forum.mydomain.com/images/logo.png');

• From a model or shell, _(*6)

  if (!isset($this->CloudFlareApi)) {
      App::import('Component', 'CloudFlareApi.CloudFlareApi');
      $collection = new ComponentCollection();
      $Controller =& new Controller();
      $this->CloudFlareApi = new CloudFlareApiComponent($collection);
      $this->CloudFlareApi->initialize($Controller);
  }
  $this->CloudFlareApi->zone_file_purge('mydomain.com', 'http://forum.mydomain.com/images/logo.png');

• From a console, _(*7)

  Console/cake CloudFlareApi.call fpurge_ts mydomain.com Console/cake CloudFlareApi.call zone_file_purge mydomain.com http://forum.mydomain.com/images/logo.png, _(*8)

Notes

You can find the method definitions here: https://github.com/vexxhost/CloudFlare-API/blob/master/class_cloudflare.php, _(*9)