graham-campbell/cloudflare-api

This package is abandoned and no longer maintained. No replacement package was suggested.

CloudFlare API Is A CloudFlare API Client For Laravel 5

v0.7.0-alpha 2015-02-05 21:11 UTC

README

Laravel CloudFlare API was created by, and is maintained by Graham Campbell, and is a CloudFlare API client for Laravel 5. It utilises Guzzle 5, and my Laravel Manager package. Feel free to check out the change log, releases, license, api docs, and contribution guidelines.

WARNING

This package is no longer maintained.

Laravel CloudFlare API

Build Status Coverage Status Quality Score Software License Latest Version

Installation

PHP 5.4+ or HHVM 3.3+, and Composer are required.

To get the latest version of Laravel CloudFlare API, simply add the following line to the require block of your composer.json file:

"graham-campbell/cloudflare-api": "0.7.*"

You'll then need to run composer install or composer update to download it and have the autoloader updated.

Once Laravel CloudFlare API is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

  • 'GrahamCampbell\CloudFlareAPI\CloudFlareAPIServiceProvider'

You can register the CloudFlareAPI facade in the aliases key of your config/app.php file if you like.

  • 'CloudFlareAPI' => 'GrahamCampbell\CloudFlareAPI\Facades\CloudFlareAPI'

Configuration

Laravel CloudFlare API requires connection configuration.

To get started, you'll need to publish all vendor assets:

$ php artisan vendor:publish

This will create a config/cloudflareapi.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

There are two config options:

Default Connection Name

This option ('default') is where you may specify which of the connections below you wish to use as your default connection for all work. Of course, you may use many connections at once using the manager class. The default value for this setting is 'main'.

CloudFlare Connections

This option ('connections') is where each of the connections are setup for your application. Example configuration has been included, but you may add as many connections as you would like.

Usage

There is currently no usage documentation besides the API Documentation for Laravel CloudFlare API.

License

Laravel CloudFlare API is licensed under The MIT License (MIT).