, (*1)
moves-api-php
PHP client for Moves API., (*2)
Inspired by moves Ruby Gem., (*3)
Installation
Recommend way to install this package with Composer. Add borivojevic/moves-api-php to your composer.json file., (*4)
``` json
{
"require": {
"borivojevic/moves": "1.1.0"
}
}, (*5)
To install composer run:
curl -s http://getcomposer.org/installer | php, (*6)
To install composer dependences run:
php composer.phar install, (*7)
You can autoload all dependencies by adding this to your code:
require 'vendor/autoload.php';, (*8)
### Usage ###
The main entry point of the library is the Moves\Moves class. API methods require to be signed with valid access token parameter which you have to provide as a first argument of the constructor.
```php
$Moves = new \Moves\Moves($accessToken);
Get Profile, (*9)
$Moves->profile();
Daily summaries, (*10)
$Moves->dailySummary(); # current day
$Moves->dailySummary('2013-11-20'); # any day
$Moves->dailySummary('2013-W48'); # any week
$Moves->dailySummary('2013-11'); # any month
# Date range - max 31 days
$Moves->dailySummary('2013-11-10', '2013-11-20');
$Moves->dailySummary(array('from' => '2013-11-10', 'to' => '2013-11-20'));
$Moves->dailySummary(array('pastDays' => 3)); # past 3 days
# also supports DateTime objects
$Moves->dailySummary(new DateTime('2013-11-20'));
$Moves->dailySummary(new DateTime('2013-11-10'), new DateTime('2013-11-20'));
$Moves->dailySummary(array('from' => new DateTime('2013-11-10'), 'to' => new DateTime('2013-11-20')));
Daily activities, (*11)
$Moves->dailyActivities(); # current day
$Moves->dailyActivities('2013-11-20'); # any day
$Moves->dailyActivities('2013-W48'); # any week
# Date range - max 7 days
$Moves->dailyActivities('2013-11-10', '2013-11-20');
$Moves->dailyActivities(array('from' => '2013-11-10', 'to' => '2013-11-20'));
$Moves->dailyActivities(array('pastDays' => 3)); # past 3 days
Daily places, (*12)
$Moves->dailyPlaces(); # current day
$Moves->dailyPlaces('2013-11-20'); # any day
$Moves->dailyPlaces('2013-W48'); # any week
# Date range - max 7 days
$Moves->dailyPlaces('2013-11-10', '2013-11-20');
$Moves->dailyPlaces(array('from' => '2013-11-10', 'to' => '2013-11-20'));
$Moves->dailyPlaces(array('pastDays' => 3)); # past 3 days
Daily storyline, (*13)
$Moves->dailyStoryline(); # current day
$Moves->dailyStoryline('2013-11-20'); # any day
$Moves->dailyStoryline('2013-W48'); # any week
# Date range - max 7 days
$Moves->dailyStoryline('2013-11-10', '2013-11-20');
$Moves->dailyStoryline(array('from' => '2013-11-10', 'to' => '2013-11-20'));
$Moves->dailyStoryline(array('pastDays' => 3)); # past 3 days
# Get daily storyline with track points
$Moves->dailyStoryline(array('trackPoints' => 'true'));
$Moves->dailyStoryline('2013-11-10', array('trackPoints' => 'true'));
Versioning
The library uses Semantic Versioning, (*14)
Copyright and License
The library is licensed under the MIT license., (*15)