rokka/client-bundle

Defines services for accessing the Rokka image service in the symfony framework

1.1.0 2017-12-08 15:40 UTC

README

StyleCI Latest Stable Version

A Symfony bundle for the Rokka image service.

Installation Symfony version <= 3

Require the bundle using composer:

composer require rokka/client-bundle

Add it to app/AppKernel.php

        $bundles = array(
            ...
            new Rokka\RokkaClientBundle\RokkaClientBundle(),
        );

Configure the bundle with the parameters below.

Installation Symfony version >= 4

The rokka Symfony bundle comes with a flex recipe.

Do the following.

composer config extra.symfony.allow-contrib true
composer require rokka/client-bundle

Then you can add your api key and organization to the .env file or edit config/packages/rokka.yaml.

Configuration

Enter your api key and organization strings.

rokka_client:
    api_key: 'key-here'
    organization: 'my-organization'
    
    # Optional, not needed for most users
    #base_url: https://api.rokka.io

base_url is to override the API location. We use this for testing mainly, so no need to change it ever.

Usage

The bundle will create two services for you, rokka.client.image and rokka.client.user. These give you access to the basic functionality from the rokka/client library, pre-configured with your credentials.

This bundle also provides console commands to interact with rokka.io. If you only want a CLI for rokka, you can also install the rokka PHP CLI tool as stand-alone phar.

See the official documentation for further information on how to use rokka.