No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
src
.gitignore
changelog.md
composer.json
composer.lock
license.md
phpunit.xml
readme.md

readme.md

Rokka Laravel Client

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\Facade::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.