README
, (*1)
The RequestLab Estat library provides a way to use the Mediametrie Estat API.
It's inspired by the Wid'op Google Analytics library, (*2)
Documentation
Installation
To install the RequestLab Estat library, you will need Composer. It's a PHP 5.3+
dependency manager which allows you to declare the dependent libraries your project needs and it will install &
autoload them for you., (*3)
Set up Composer
Composer comes with a simple phar file. To easily access it from anywhere on your system, you can execute:, (*4)
$ curl -s https://getcomposer.org/installer | php
$ sudo mv composer.phar /usr/local/bin/composer
Define dependencies
Create a composer.json file at the root directory of your project and simply require the
requestlab/estat package:, (*5)
{
"require": {
"requestlab/estat": "*"
}
}
Install dependencies
Now, you have define your dependencies, you can install them:, (*6)
$ composer install
Composer will automatically download your dependencies & create an autoload file in the vendor directory., (*7)
Autoload
So easy, you just have to require the generated autoload file and you are already ready to play:, (*8)
``` php
, (*9)
The RequestLab Estat library follows the [PSR-0 Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md).
If you prefer install it manually, it can be autoload by any convenient autoloader.
### Usage
#### Query
First, in order to request the Estat Query service, simply create a request and configure it according to your needs:
``` php
setStartDate(new \DateTime('-1 Day'));
$query->setEndDate(new \DateTime('-1 Day'));
$query->setSerial(254054201858);
$query->setIndicator('WEB_4NIVEAUX_NIVEAU4');
?>
Client
A client allows you to request the service with your login and password., (*10)
``` php
setLogin('Login');
$client->setPassword('Password');
?>, (*11)
#### Service
``` php
query($query);
?>
Response
The response is a RequestLab\Estat\Response object which wraps all available informations:, (*12)
php
getData();
$totals = $response->getTotals();
?>, (*13)
Testing
The library is fully unit tested by PHPUnit. To execute the test suite, check the travis configuration., (*14)
Contribute
The library is open source, propose a PR!, (*15)
License
The RequestLab Estat library is under the MIT license. For the full copyright and license information, please
read the LICENSE file that was distributed with this
source code., (*16)
Wallogit.com
