https://github.com/nixilla/twitter-api-consumer

Twitter API consumer in PHP
https://github.com/nixilla/twitter-api-consumer

Last synced: 6 months ago
JSON representation

Twitter API consumer in PHP

• Host: GitHub
• URL: https://github.com/nixilla/twitter-api-consumer
• Owner: nixilla
• Created: 2013-04-19T10:55:58.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-10-09T09:26:31.000Z (over 11 years ago)
• Last Synced: 2024-09-26T09:19:13.929Z (8 months ago)
• Language: PHP
• Size: 215 KB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
Twitter API Consumer

====================

|Travis|_

.. |Travis| image:: https://travis-ci.org/nixilla/twitter-api-consumer.png?branch=master

.. _Travis: https://travis-ci.org/nixilla/twitter-api-consumer

This is the small library to make calls to Twitter API. It uses `kriswallsmith/buzz`_ for HTTP.

.. _kriswallsmith/buzz: https://github.com/kriswallsmith/Buzz

Twitter API supports OAuth2 but for `application-only authentication`_.

This library currently supports OAuth2, but there are plans for OAuth1a too.

.. _`application-only authentication`: https://dev.twitter.com/docs/auth/application-only-auth

The concept for this library is to use Twitter API with as small as 4 lines of code

.. code:: php

    prepare('/1.1/search/tweets.json','GET', array('q' => '#twitterapi'));

    $result = $consumer->execute($query);

If you're using Symfony2 and Dependecy Injection you can even do this is 3 lines

.. code:: php

    container->get('twitter.consumer');

    $query = $consumer->prepare('/1.1/search/tweets.json','GET', array('q' => '#twitterapi'));

    $result = $consumer->execute($query);

By default the $result variable contains Result object implementing ArrayAccess, Countable, Iterator interfaces,

with the structure equivalent to json response from the Twitter API. It gets it from DefaultConverter class.

However you can change it, by using converters. Converter is the special class that implements ConverterInterface

with just one method "convert". It gets raw input as a parameter, which by default is json string.

You can inject converter class for given API method into $consumer object like this:

.. code:: php

    setConverter('/1.1/search/tweets.json', new \TwitterSearchConverter());

And converter class is very simple and can look like this:

.. code:: php

     $result['statuses'], 'metainfo' => $result['search_metadata']);

        }

    }

Of course you can do more complicated conversion, like creating and persisting database objects and return for example

Doctrine ArrayCollection.

The whole point of converter class is to externalize data conversion from one format to another

and give you control over it. You can (and you should) inject converters via DI in Symfony2 like this

(this is just an example):

.. code:: yaml

    twitter.consumer:

        class: %twitter.oauth2.consumer.class%

        arguments: [ @buzz, %twitter.app_id%, %twitter.secret% ]

        calls:

            - [ setConverter , ["/1.1/search/tweets.json", "@tweet.converter" ] ]

You can also paginate over the result. All you need to do is to make sure that your converter class returns following key:

.. code:: php

    convert($json_string);

    assertNotNull($result['metainfo']['next_results']);

The class TwitterSearchConverter above is the example converter which you can use for result pagination. This is how you do it:

.. code:: php

    prepare('/1.1/search/tweets.json','GET', array('q' => '#twitterapi'));

    $api_calls = 0;

    $result = $consumer->execute($query);

    $api_calls++;

    do

    {

        printf("Queried %s times, last time found %s tweets\n", $api_calls, count($result));

        foreach($result as $key => $tweet)

            echo $tweet['text'] . "\n";

    }

    while(($result = $consumer->execute($result->nextQuery())) && $api_calls++);

Installation

============

Via composer (don't use 0.2 - it's broken).

.. code-block:: json

    {

        "require": {

            "nixilla/twitter-api-consumer": "~0.3"

        }

    }

Tests

=====

This is copy/paste command

.. code:: sh

    git clone https://github.com/nixilla/twitter-api-consumer.git && \

    cd twitter-api-consumer && \

    mkdir bin && \

    curl -sS https://getcomposer.org/installer | php -- --install-dir=bin && \

    ./bin/composer.phar install --dev && \

    ./bin/phpunit