Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.7 KB

readme.md

File metadata and controls

51 lines (33 loc) · 2.7 KB

Build Status Coverage Status Dependency Status

Latest Stable Version Total Downloads Latest Unstable Version License

Bitdeli Badge

#Cloudflare API V4 PHP wrapper

A work in progress library for the Cloudflare API. The documentation for the API can be found at https://api.cloudflare.com.

I have implemented all of the methods from the available documentation but if there are more just let me please https://github.com/cloudflare

##Installation Installation should be done via composer, details of how to install composer can be found at https://getcomposer.org/

Add "jamesryanbell/cloudflare": "dev-master" to your composer.json file

Run composer update to install the latest version.

##Usage

In situations where you want to make multiple calls to the API across different services it's easier to create a connection to the api first and then pass that around the other services e.g.

    use Cloudflare\Zone\Dns;

    // Create a connection to the Cloudflare API which you can
    // then pass into other services, e.g. DNS, later on
    $client = new Cloudflare\Api('email@example.com', 'API_KEY');

    // Create a new DNS record
    $dns = new Cloudflare\Zone\Dns($client);
    $dns->create('12345678901234567890', 'A', 'name.com', '127.0.0.1', 120);

If you are just performing a single action then you can connect to the API directly when you instantiate the class e.g.

    use Cloudflare\Zone\Dns;

    // Create a connection to the Cloudflare API which you can
    // then pass into other services, e.g. DNS, later on
    $dns = new Cloudflare\Zone\Dns('email@example.com', 'API_KEY');
    $dns->create('12345678901234567890', 'TXT', 'name.com', '127.0.0.1', 120);

#License MIT