rokka/laravel

A Laravel wrapper for the Rokka PHP client library

Maintainers

Details

github.com/rokka-io/rokka-laravel-package

Homepage

Source

Issues

Installs: 15 004

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 6

Forks: 0

Open Issues: 0

0.6.0 2024-08-22 19:36 UTC

Requires

Requires (Dev)

MIT 6598de7c6ebb202f5780abc56ee1d75c80c722f5

imagelaravelresizingrokka

This package is auto-updated.

Last update: 2024-11-22 20:23:32 UTC

README

Total Downloads Latest Stable Version License

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 rokka@rokka.io instead of using the issue tracker.

License

MIT. Please see the license file for more information.