2017 © Pedro Peláez
 

library foursquare

Foursquare API Client

image

thetwelvelabs/foursquare

Foursquare API Client

  • Sunday, July 27, 2014
  • by chriswoodford
  • Repository
  • 7 Watchers
  • 37 Stars
  • 34,490 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 19 Forks
  • 0 Open issues
  • 7 Versions
  • 6 % Grown

The README.md

Foursquare API Client

A(nother) PHP Foursquare API client https://developer.foursquare.com/docs/, (*1)

Installation

Composer is currently the only way to install the foursquare client into your project., (*2)

Create your composer.json file

  {
      "require": {
          "thetwelvelabs/foursquare": "0.2.*"
      }
  }

Download composer into your application root

  $ curl -s http://getcomposer.org/installer | php

Install your dependencies

  $ php composer.phar install

Usage

Select your preferred HTTP Client (CurlHttpClient is the default)

  $client = new \TheTwelve\Foursquare\HttpClient\CurlHttpClient($pathToCertificateFile);

Select your preferred Redirector (HeaderRedirector is the default)

  $redirector = new \TheTwelve\Foursquare\Redirector\HeaderRedirector();

Note: The redirector is optional and is only needed if you need Foursquare authentication, (*3)

Instantiate the API Gateway Factory

  $factory = new \TheTwelve\Foursquare\ApiGatewayFactory($client, $redirector);

  // Required for most requests
  $factory->setClientCredentials('CLIENT_ID', 'CLIENT_SECRET');

  // Optional (only use these if you know what you're doing)
  $factory->setEndpointUri('https://api.foursquare.com');
  $factory->useVersion(2);
  $factory->verifiedOn(new \DateTime());

Begin authentication with Foursquare

  $auth = $factory->getAuthenticationGateway(
      'https://foursquare.com/oauth2/authorize',
      'https://foursquare.com/oauth2/access_token',
      'YOUR_REDIRECT_URL'
  );

  $auth->initiateLogin();

Foursquare redirects the user back to you after a successful login

  $code = $_GET['code'];

  // You should do some input sanitization to $code here, just in case

  $token = $auth->authenticateUser($code);

Update the API Gateway Factory with your OAuth token

  $factory->setToken($token);

Get an instance of an endpoint gateway

  $gateway = $factory->getUsersGateway();

Get data from Foursquare

  $user = $gateway->getUser();

Search venues

  $gateway = $factory->getVenuesGateway();

  $venues = $gateway->search(array(
    'll' => '40.727198,-73.992289',
    'query' => 'Starbucks',
    'radius' => 1000,
    'intent' => 'checkin'
  ));

Working With Symfony / Silex

If you're working with Symfony or Silex, you can use the Symfony HttpClient and Redirector, (*4)

  $client = new \TheTwelve\Foursquare\HttpClient\SymfonyHttpClient($pathToCertificateFile);
  $redirector = new \TheTwelve\Foursquare\Redirector\SymfonyRedirector();

If you're working with Silex, there is a Service Provider available at https://github.com/chriswoodford/FoursquareServiceProvider, (*5)

Using the CurlHttpClient

If you're using the CurlHttpClient, you will probably want to include the cacert.pem file that can be found at http://curl.haxx.se/docs/caextract.html, (*6)

You can add this as a dependency in your composer file. Your composer.json might look something like this:, (*7)

  {
      "require": {
          "thetwelvelabs/foursquare": "0.2.*",
          "haxx-se/curl": "1.0.0"
      },
      "repositories": [
          {
              "type": "package",
              "package": {
                  "name": "haxx-se/curl",
                  "version": "1.0.0",
                  "dist": {
                      "url": "http://curl.haxx.se/ca/cacert.pem",
                      "type": "file"
                  }
              }
          }
      ]
  }

You will be able to find the cacert.pem file in vendor/haxx-se/curl/cacert.pem, (*8)

Contributing

See CONTRIBUTING.md, (*9)

License

This library is released under the MIT License., (*10)

The Versions

27/07 2014

dev-master

9999999-dev http://thetwelvelabs.com

Foursquare API Client

  Sources   Download

MIT

The Requires

  • php >=5.3.3
  • ext-curl *

 

The Development Requires

foursquare

27/07 2014

v0.2.2

0.2.2.0 http://thetwelvelabs.com

Foursquare API Client

  Sources   Download

MIT

The Requires

  • php >=5.3.3
  • ext-curl *

 

The Development Requires

foursquare

23/10 2013

v0.2.1

0.2.1.0 http://thetwelvelabs.com

Foursquare API Client

  Sources   Download

MIT

The Requires

  • php >=5.3.3
  • ext-curl *

 

The Development Requires

foursquare

01/05 2013

v0.2.0

0.2.0.0 http://thetwelvelabs.com

Foursquare API Client

  Sources   Download

MIT

The Requires

  • php >=5.3.3
  • ext-curl *

 

The Development Requires

foursquare

08/03 2013

v0.1.2

0.1.2.0 http://thetwelvelabs.com

Foursquare API Client

  Sources   Download

MIT

The Requires

  • php >=5.3.3
  • ext-curl *

 

foursquare

07/03 2013

v0.1.1

0.1.1.0 http://thetwelvelabs.com

Foursquare API Client

  Sources   Download

MIT

The Requires

  • php >=5.3.3
  • ext-curl *

 

foursquare

26/02 2013

v0.1.0

0.1.0.0 http://thetwelvelabs.com

Foursquare API Client

  Sources   Download

MIT

The Requires

  • php >=5.3.3
  • ext-curl *

 

foursquare