endroid/twitter

1.3.4 2017-04-29 22:36 UTC

README

By endroid

Latest Stable Version Build Status Total Downloads Monthly Downloads License

This library helps making requests to the Twitter API and provides a Symfony Bundle which allows configuration and service retrieval via the service container. The only things you need are the keys which you can find in the developer console.

Installation

Use Composer to install the library.

$ composer require endroid/twitter

Get consumer access key and token from Twitter

Register your application at http://apps.twitter.com/app

Usage

use Endroid\Twitter\Twitter;

// If you want to fetch the Twitter API with "application only" authentication, $accessToken and $accessTokenSecret are optional
$twitter = new Twitter($consumerKey, $consumerSecret, $accessToken, $accessTokenSecret);

// Retrieve the user's timeline
$tweets = $twitter->getTimeline([
    'count' => 5
]);

// Or retrieve the timeline using the generic query method
$response = $twitter->query('/statuses/user_timeline', 'GET', 'json', $parameters);
$tweets = json_decode($response->getContent());

Symfony integration

Register the Symfony bundle in the kernel.

// app/AppKernel.php

public function registerBundles()
{
    $bundles = [
        // ...
        new Endroid\Twitter\Bundle\EndroidTwitterBundle(),
    ];
}

The default parameters can be overridden via the configuration.

endroid_twitter:
    consumer_key: '...'
    consumer_secret: '...'
    access_token: '...'
    access_token_secret: '...'

Now you can retrieve the client as follows.

$twitter = $this->get('endroid.twitter');

Versioning

Version numbers follow the MAJOR.MINOR.PATCH scheme. Backwards compatibility breaking changes will be kept to a minimum but be aware that these can occur. Lock your dependencies for production and test your code when upgrading.

License

This bundle is under the MIT license. For the full copyright and license information please view the LICENSE file that was distributed with this source code.