rokka/laravel

A Laravel wrapper for the Rokka PHP client library

0.6.0 2024-08-22 19:36 UTC

Requires

• php: ^8.1
• illuminate/support: ^10.0|^11.0
• rokka/client: ^1.20
• rokka/client-cli: ^1.9.10

Requires (Dev)

• orchestra/testbench: ^8.0|^9.0
• phpunit/phpunit: ^10.5
• roave/security-advisories: dev-latest

MIT

• Raphaël Saunier

• image
• laravel
• resizing
• rokka

README

A thin wrapper around rokka-io/rokka-client-php with some convenience functions to play nice with Laravel.

Installation

Via Composer:

$ composer require rokka/laravel

If package auto discovery is disabled, you'll need to register the bundled service provider and the optional Facade inside config/app.php.

'providers' => [
  // ...
  Rokka\RokkaLaravel\RokkaLaravelServiceProvider::class,
]
'aliases' => [
  // ...
  'Rokka' => Rokka\RokkaLaravel\Facades\Rokka::class
]

Usage

⚠️ The API is still experimental and subject to change while we figure out the most ergonomic way to wrap the most commonly used functions inside rokka-io/rokka-client-php

Rokka Facade

The Rokka Facade provides a concise interface to Rokka's main classes.

• Rokka\Client\TemplateHelper to generate and manipulate URLs in controllers and templates
• Rokka\Client\Image to interact with images
• Rokka\Client\User to manage users

Calls can also be scoped to a specific organization with Rokka::org('env')->…

Rokka::getStackUrl('dba893', 'test-stack', 'jpg');
Rokka::images()->uploadSourceImage(…)
Rokka::manage()->createOrganization(…)
Rokka::org('my-org')->getStackUrl('dba893', 'test-stack', 'jpg');

rokka() helper function

Currently the rokka() function exposes the same methods as the Rokka facade.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

License

MIT. Please see the license file for more information.