nikolajlovenhardt/laravel-keen-io

Minimal configuration wrapper for Keen.io in Laravel 5.*

dev-master 2016-03-09 09:12 UTC

This package is not auto-updated.

Last update: 2022-06-25 06:17:14 UTC


README

Laravel 5.1 Latest Stable Version Total Downloads Latest Unstable Version License Build Status Code Climate Test Coverage

Installation

Install using composer

composer require nikolajlovenhardt/laravel-keen-io

Provider

Add the LaravelKeenIO\LaravelKeenIOProvider in config/app.php

[
    LaravelKeenIO\LaravelKeenIOProvider::class,
],

Then run php artisan vendor:publish to publishe the keen.io configuration file into config/keen-io.php and add your projects.

Facade (optional)

[
    'KeenIO' => LaravelKeenIO\Facades\KeenIOFacade::class,
],

Usage

This package is built as a configuration wrapper for keen-io/keen-io.

Dependency injection (Recommended)

Example:

<?php

namespace App\Controllers;

use LaravelKeenIO\Services\KeenIOService;
use LaravelKeenIO\Services\KeenIOServiceInterface;

class DemoController
{
    /** @var KeenIOServiceInterface */
    protected $keenIOService;

    public function __construct(KeenIOService $keenIOService)
    {
        $this->keenIOService = $keenIOService;
    }

    public function action()
    {
        /** @var KeenIOClient $keenIO */
        $keenIO = $this->keenIOService->client();

        echo 'KeenIOClient with the default project';
    }

    public function anotherAction()
    {
        $project = 'projectName';

        /** @var KeenIOClient $keenIO */
        $keenIO = $this->keenIOService->client($project);

        echo sprintf(
            'KeenIOClient with the \'%s\' project',
            $project
        );
    }
}

Facade

<?php

namespace App\Controllers;

use KeenIO;
use LaravelKeenIO\Services\KeenIOService;
use LaravelKeenIO\Services\KeenIOServiceInterface;

class DemoController
{
    public function action()
    {
        /** @var KeenIOClient $keenIO */
        $keenIO = KeenIO::client();

        echo 'KeenIOClient with the default project';
    }

    public function anotherAction()
    {
        $project = 'projectName';

        /** @var KeenIOClient $keenIO */
        $keenIO = KeenIO::client($project);

        echo sprintf(
            'KeenIOClient with the \'%s\' project',
            $project
        );
    }
}

Documentation

For more information on the usage of KeenIO, please refer to the documentation of the PHP client and the main keen.io documentation.