Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joomla-framework/twitter-api

[DEPRECATED] Joomla Framework Twitter Package
https://github.com/joomla-framework/twitter-api

joomla joomla-framework php twitter

Last synced: 4 days ago
JSON representation

[DEPRECATED] Joomla Framework Twitter Package

Awesome Lists containing this project

README 

        
## The Twitter Package [![Build Status](https://travis-ci.org/joomla-framework/twitter-api.png?branch=master)](https://travis-ci.org/joomla-framework/twitter-api)



### Deprecated



The `joomla/twitter` package is deprecated with no further updates planned.



### Using the Twitter Package



The Twitter package is designed to be a straightforward interface for working with Twitter. It is based on the REST API. You can find documentation on the API at [https://dev.twitter.com/docs/api](https://dev.twitter.com/docs/api).



#### Instantiating Twitter



Instantiating Twitter is easy:



```php

use Joomla\Twitter\Twitter;



$twitter = new Twitter;

```



This creates a basic Twitter object that can be used to access resources on twitter.com, using an active access token.



Generating an access token can be done by instantiating OAuth.



Create a Twitter application at [https://dev.twitter.com/apps](https://dev.twitter.com/apps) in order to request permissions. Instantiate OAuth, passing the options needed. By default you have to set and send headers manually in your application, but if you want this to be done automatically you can set option 'sendheaders' to true.



```php

use Joomla\Http\Http;

use Joomla\Twitter\Twitter;

use Joomla\Twitter\OAuth;



$options = array(

    'consumer_key' => $consumer_key,

    'consumer_secret' => $consumer_secret,

    'callback' => $callback_url,

    'sendheaders' => true

);



$client = new Http;

$application = $this->getApplication();



$oauth = new OAuth($options, $client, $application->input, $application);



$twitter = new Twitter($oauth);

```



Now you can authenticate and request the user to authorise your application in order to get an access token, but if you already have an access token stored you can set it to the OAuth object and if it's still valid your application will use it.



```php

// Set the stored access token.

$oauth->setToken($token);



$access_token = $oauth->authenticate();

```



When calling the authenticate() method, your stored access token will be used only if it's valid, a new one will be created if you don't have an access token or if the stored one is not valid. The method will return a valid access token that's going to be used.



#### Accessing the Twitter API's objects



The Twitter package covers almost all Resources of the REST API 1.1:

* Block object interacts with Block resources.

* DirectMessages object interacts with Direct Messages resources.

* Favorites object interacts with Favorites resources.

* Followers object interacts with the Followers resources.

* Friends object interacts with Friends resources.

* Help object interacts with Help resources.

* Lists object interacts with Lists resources.

* Media object interacts with multimedia resources.

* Mute object interacts with resources related to muting users.

* Places object interacts with Places and Geo resources.

* Profile object interacts with some resources from Accounts.

* Search object interacts with Search and Saved Searches resources.

* Statuses object interacts with Timelines and Tweets resources.

* Trends object interacts with Trends resources.

* Users object interacts with Users and Suggested Users resources.



Once a Twitter object has been created, it is simple to use it to access Twitter:



```php

$users = $twitter->users->getUser($user);

```



This will retrieve extended information of a given user, specified by ID or screen name.



#### A More Complete Example



Below is an example demonstrating more of the Twitter package.



```php

use Joomla\Http\Http;

use Joomla\Twitter\Twitter;

use Joomla\Twitter\OAuth;



$token = array(

	'key' => "app_id",

	'secret' => "app_secret",

);

$my_url = 'http://localhost/twitter_test.php';



$options = array(

    'consumer_key' => $consumer_key,

    'consumer_secret' => $consumer_secret,

    'callback' => $callback_url,

    'sendheaders' => true

);



$client = new Http;

$application = $this->getApplication();



$oauth = new OAuth($options, $client, $application->input, $application);

$oauth->setToken($token);

$oauth->authenticate();



$twitter = new Twitter($oauth);



$statuses = $twitter->statuses;

$response = $statuses->tweet("The Twitter Package is amazing #joomla");

```



#### More Information



The following resources contain more information:

* [Joomla! API Reference](http://api.joomla.org)

* [Twitter REST API Reference](https://dev.twitter.com/docs/api)

* [Web Application using JTwitter package](https://gist.github.com/3258852)



## Installation via Composer



Add `"joomla/twitter": "2.0.*@dev"` to the require block in your composer.json and then run `composer install`.



```json

{

	"require": {

		"joomla/twitter": "2.0.*@dev"

	}

}

```



Alternatively, you can simply run the following from the command line:



```sh

composer require joomla/twitter "2.0.*@dev"

```