iivannov/larasquare

Simple and extensible Foursquare API PHP Client with Laravel Support based on Guzzle 6

Larasquare

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

Simple and extensible Foursquare API PHP Client with Laravel Facade and ServiceProvider based on Guzzle 6 Currently it supports only userless endpoint requests., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require iivannov/larasquare, <sub>(*4)</sub>

## Usage with Laravel

To use the Laravel Facade you need to add the ServiceProvider and Facade classes in your `config\app.php`

``` php

'providers' => [
    ...
    Iivannov\Larasquare\Provider\LarasquareServiceProvider::class,
];

'aliases' => [
    ...
    'Larasquare' => Iivannov\Larasquare\Facade\Larasquare::class
];

You need to add your Foursquare client ID and secret in config\services.php, <sub>(*5)</sub>

``` php 'foursquare' => [ 'clientId' => YOUR_FOURSQUARE_CLIENT_ID, 'clientSecret' => YOUR_FOURSQUARE_CLIENT_SECRET ], <sub>(*6)</sub>

After this you can directly use the Laravel Facade


``` php
$venues = Larasquare::venues($searchQuery);

Standard Usage

``` php $config = [ clientId = YOUR_FOURSQUARE_CLIENT_ID, clientSecretT = YOUR_FOURSQUARE_CLIENT_SECRET, apiUrl = FOURSQUARE_API_URL, //optional version = SUPPORTED_VERSION, //optional, format: YYYYMMDD ];, <sub>(*7)</sub>

$foursquare = new Foursquare($config);, <sub>(*8)</sub>

$venues = $foursquare->venues($searchQuery);, <sub>(*9)</sub>

## Query filters

If you need to generate, filter or transform your search query you can extract all the logic in a separate class that implements the `Iivannov\Larasquare\Filter\FilterContract`
and then just inject it with `setFilter()` method.

```php
$venues = Larasquare::setFilter(new MyFilter())->venues();

Put your filter logic in the parse() method. It will automatically receive the query passed in the search methods. You can overwrite values, generate values from your custom array or whatever you need. The returned array will be sent with the Foursquare request., <sub>(*10)</sub>

/**
* Generate, transform or filter your search query
*
* @param $query
* @return array
*/
public function parse($query = [])
{
    return [
        'll' => $query['location']['lat'] . ',' . $query['location']['lon'],
        'query' => $query['searchTerm'],
        'near' => $_GET['nearLocation'],
        'radius' => 200
    ];
}

Methods

** Endpoints not covered by this library ** You can use the request method to query a Foursquare endpoint., <sub>(*11)</sub>

// get venue photos
$response = Larasquare::request("venues/$venueId/photos")

// get details about a tip,
$response = Larasquare::request("tips/$tipId")

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

//Laravel
$venues = Larasquare::venues($query);

** Get a single venue **, <sub>(*13)</sub>

$venues = Larasquare::venue($venueId);

** Other venues methods **, <sub>(*14)</sub>

// get suggestion @see https://developer.foursquare.com/docs/venues/suggestcompletion
$venues = Larasquare::suggest($searchQuery);

// get trending @see https://developer.foursquare.com/docs/venues/trending
$venues = Larasquare::trending($searchQuery);

License

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