schulzefelix/laravel-stat-search-analytics

A Laravel API Wrapper For STAT Search Analytics.

A Laravel API Wrapper For STAT Search Analytics.

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

For information about STAT Search Analytics see https://getstat.com/, _(*2)

Install

This package can be installed through Composer., _(*3)

``` bash $ composer require schulzefelix/laravel-stat-search-analytics, <sub>(*4)</sub>

In Laravel 5.5 the package will autoregister the service provider. In Laravel 5.4 you must install this service provider.
```php
// config/app.php
'providers' => [
    ...
    SchulzeFelix\Stat\StatServiceProvider::class,
    ...
];

In Laravel 5.5 the package will autoregister the facade. In Laravel 5.4 you must install the facade manually., <sub>(*5)</sub>

// config/app.php
'aliases' => [
    ...
    'Stat' => SchulzeFelix\Stat\StatFacade::class,
    ...
];

You can publish the config file of this package with this command:, <sub>(*6)</sub>

``` bash php artisan vendor:publish --provider="SchulzeFelix\Stat\StatServiceProvider", <sub>(*7)</sub>

## Usage

- [Introduction](#introduction)
- [Projects Methods](#projects-methods)
    - [List All Projects](#projects-list)
    - [Create A Projects](#projects-create)
    - [Update A Projects](#projects-update)
    - [Delete A Projects](#projects-delete)


<a name="introduction"></a>
## Introduction

The responses of this packages are combinations of Laravel Collections, objects for each kind of data object and [Carbon](https://github.com/briannesbitt/Carbon) instances for date fields.

<a name="projects-methods"></a>
## Projects Methods

<a name="projects-list"></a>
### List All Projects
The list methods returns a collection of all projects.
``` php
$projects = Stat::projects()->list();

, <sub>(*8)</sub>

Create A Project

To create a project just pass the name of the project. The response will we a StatProject instance. ``` php $project = Stat::projects()->create('Cheese Cake Factory');, <sub>(*9)</sub>

$project->toArray();, <sub>(*10)</sub>

/* [ 'id' => 615, 'name' => 'Cheese Cake Factory', 'total_sites' => 0, 'created_at' => 2016-11-01, 'updated_at' => 2016-11-01, ] */, <sub>(*11)</sub>

<a name="projects-update"></a>
### Update A Project
To update the name of a project just pass the project ID and the new name. The response will we a StatProject instance.
``` php
$project = Stat::projects()->update(615, 'Cheese Cake Bakery');

$project->toArray();

/*
[
    'id' => 615,
    'name' => 'Cheese Cake Bakery',
    'total_sites' => 5,
    'created_at' => 2016-11-01,
    'updated_at' => 2016-11-03,
]
*/

, <sub>(*12)</sub>

Delete A Project

To delete a project just pass the project ID. The response the project ID. ``` php $project = Stat::projects()->delete(615);, <sub>(*13)</sub>

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash
$ vendor/bin/phpunit

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*14)</sub>

Credits

• Felix Schulze
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*15)</sub>