graham-campbell/cloudflare

CloudFlare Provides A Simple CloudFlare Module For Laravel 5

Installs: 29

Dependents: 0

Stars: 12

Watchers: 1

Language: PHP

v0.3.0-alpha 2015-03-15 20:21 UTC

README

Laravel CloudFlare was created by, and is maintained by Graham Campbell, and provides a simple CloudFlare module for Laravel 5. Feel free to check out the releases, license, and contribution guidelines.

Laravel CloudFlare

Build Status Coverage Status Quality Score Software License Latest Version

Installation

PHP 5.5+ or HHVM 3.6+, and Composer are required.

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

"graham-campbell/cloudflare": "~1.0"

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

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

  • 'GrahamCampbell\CloudFlare\CloudFlareServiceProvider'

Configuration

Laravel CloudFlare supports optional configuration.

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

$ php artisan vendor:publish

This will create a config/cloudflare.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 a few config options:

API Key

This option ('key') defines the api key to use to make calls to CloudFlare's API. The default value for this setting is ''.

Email

This option ('email') defines the email address to use to make calls to CloudFlare's API. The default value for this setting is ''.

Zone

This option ('zone') defines the zone to read analytics information for. The default value for this setting is ''.

Cache Driver

This option ('cache') defines the cache driver to be used. It may be the name of any driver set in config/cache.php. Setting it to null will use the driver you have set as default in config/cache.php. The default value for this setting is null.

Middleware

This option ('middlware') defines the middleware to be put in front of the endpoints provided by this package. A common use will be for your own authentication middleware. The default value for this setting is [].

Layout

This option ('layout') defines the layout to extend when building views. The default value for this setting is 'layouts.default'.

Usage

Laravel CloudFlare is designed to work with Bootstrap CMS. In order for it to work in any Laravel application, you must ensure that you know how to use my Laravel Core package as configuration and knowledge of the app:install and app:update commands is required.

Laravel CloudFlare will register two routes. 'cloudflare' (cloudflare.index) should be accessed to show the CloudFlare statistics page, and 'cloudflare/data' (cloudflare.data) is internally used by this package.

License

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