Download the PHP package tychovbh/laravel-bluebillywig without Composer
On this page you can find all versions of the php package tychovbh/laravel-bluebillywig. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tychovbh/laravel-bluebillywig
More information about tychovbh/laravel-bluebillywig
Files in tychovbh/laravel-bluebillywig
Package laravel-bluebillywig
Short Description A BlueBillyWig bridge for Laravel 5
License MIT
Homepage https://github.com/tychovbh/laravel-bluebillywig
Informations about the package laravel-bluebillywig
Laravel Blue Billywig
Laravel Blue Billywig is created by, and is maintained by Tycho, and is a Laravel/Lumen package to connect with Blue Billywig API. Feel free to check out the contribution guidelines
Install
Laravel Blue Billywig requires PHP 7.1 or 7.2. This particular version supports Laravel 5.5 - 5.7 only and Lumen.
To get the latest version, simply require the project using Composer.
Once installed, if you are not using automatic package discovery, then you need to register the Tychovbh\Bluebillywig\BluebillywigServiceProvider
service provider in your config/app.php
.
In Lumen add de Service Provider in bootstrap/app.php
:
Configuration
Laravel Blue Billywig requires publication configuration.
To get started, you'll need to publish all vendor assets:
This will create a config/bluebillywig.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.
In lumen you have to create the configuration file manually since vendor:publish
is not available. Create the file config/bluebillywig.php
and copy paste the example file.
There are two config options:
Default publication Name
This option ('default'
) is where you may specify which of the publications below you wish to use as your default publication for all work. Of course, you may use many connections at once using the $bluebillywig->publication('my_publication')
method. The default value for this setting is 'public'
.
Bluebillywig Publications
This option ('publications'
) is where each of the publications are setup for your application. Example configuration has been included, but you may add as many publications as you would like.
Usage
Bluebillywig
This is the class of most interest. This will send authenticated requests to Blue Billywig API. Go to their documentation for all available endpoints.
Real Examples
Instantiate Bluebillywig class:
Available Bluebillywig methods:
You can send parameters with some of the requests:
You will need to handle Exceptions from Bluebillywig yourself:
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
For testing tests/feature/*
copy tests/.env.example
to tests/.env
and fill in your Blue Billywig testing account credentials.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.