filepreviews / filepreviews-laravel
Laravel 5 service provider for FilePreviews.io
Requires
- php: >=5.5.9
- filepreviews/filepreviews: ~1.0
- illuminate/support: ~5.1
Requires (Dev)
- illuminate/routing: ~5.0
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
This package is not auto-updated.
Last update: 2024-12-11 19:10:06 UTC
README
Laravel 5 service provider for FilePreviews.io
Installation
$ composer require filepreviews/filepreviews-laravel
To use the FilePreviews Service Provider, you must register the provider when bootstrapping your Laravel application.
Find the providers
key in your config/app.php
and register the FilePreviews Service Provider.
'providers' => [ // ... FilePreviews\Laravel\FilePreviewsServiceProvider::class, ]
Find the aliases
key in your config/app.php
and add the FilePreviews facade alias.
'aliases' => [ // ... 'FilePreviews' => FilePreviews\Laravel\FilePreviewsFacade::class, ]
To customize the configuration file, publish the package configuration using Artisan.
$ php artisan vendor:publish
Update your settings in the generated config/filepreviews.php
configuration file.
<?php return [ 'api_key' => env('FILEPREVIEWS_API_KEY', ''), 'api_secret' => env('FILEPREVIEWS_API_SECRET', '') ];
Usage
In order to use the FilePreviews PHP client library within your app, you need to resolve it from the Laravel Service Container.
$fp = app('FilePreviews'); $fp->generate($url, $options);
Handling Webhooks
Point a route to the controller.
Route::post('filepreviews/webhook', '\FilePreviews\Laravel\WebhookController@handleWebhook');
Since FilePreviews webhooks need to bypass Laravel's CSRF verification, be sure to list the URI as an exception in your VerifyCsrfToken
middleware:
protected $except = [ 'filepreviews/webhook', ];