Service/Twitter.php

Show:

inherited

Classes
- \Zend_Service_Twitter

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: Twitter
Version: $Id$

\Zend_Service_Twitter
jump to top

Package: Zend_Service\Twitter

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                API_BASE_URI
                = 'https://api.twitter.com/1.1/'

Base URI for all API calls

 
                OAUTH_BASE_URI
                = 'https://api.twitter.com/oauth'

OAuth Endpoint

 
                STATUS_MAX_CHARACTERS
                = 246

246 is the current limit for a status message, 140 characters are displayed initially, with the remainder linked from the web UI or client. The limit is applied to a html encoded UTF-8 string (i.e. entities are counted in the limit which may appear unusual but is a security measure).

This should be reviewed in the future...

Properties

array $cookieJar

Details

Type: array

string $dateFormat = 'D, d M Y H:i:s T'

Date format for 'since' strings

Default value'D, d M Y H:i:s T'Details

Type: string

\Zend_Http_Client $httpClient = null

Default valuenullDetails

Type: \Zend_Http_Client

string $methodType

Current method type (for method proxying)

Details

Type: string

array $methodTypes = array('account', 'application', 'blocks', 'directmessages', 'favorites', 'friendships', 'search', 'statuses', 'users')

Types of API methods

Default valuearray('account', 'application', 'blocks', 'directmessages', 'favorites', 'friendships', 'search', 'statuses', 'users')Details

Type: array

\Zend_Oauth_Consumer $oauthConsumer = null

Oauth Consumer

Default valuenullDetails

Type: \Zend_Oauth_Consumer

array $options = array()

Options passed to constructor

Default valuearray()Details

Type: array

string $username

Username

Details

Type: string

Methods

__call(string $method, array $params) : mixed

Method overloading

Parameters

Name	Type	Description
$method	string
$params	array

Returns

Type	Description
mixed

Throws

Exception	Description
\Exception\BadMethodCallException	if unable to find method

__construct(null | array | \Zend_Config $options = null, null | \Zend_Oauth_Consumer $consumer = null, null | \Zend_Http_Client $httpClient = null) : void

Constructor

Parameters

Name	Type	Description
$options	null \| array \| \Zend_Config
$consumer	null \| \Zend_Oauth_Consumer
$httpClient	null \| \Zend_Http_Client

__get(string $type) : \Twitter

Proxy service methods

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
\Twitter

Throws

Exception	Description
\Exception\DomainException	If method not in method types list

accountVerifyCredentials() : \Zend_Service_Twitter_Response

Verify Account Credentials

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

applicationRateLimitStatus() : \Zend_Service_Twitter_Response

Returns the number of api requests you have left per hour.

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

Details

Todo: Have a separate payload object to represent rate limits

blocksCreate(integer | string $id) : \Zend_Service_Twitter_Response

Blocks the user specified in the ID parameter as the authenticating user.

Destroys a friendship to the blocked user if it exists.

Parameters

Name	Type	Description
$id	integer \| string	The ID or screen name of a user to block.

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Exception\DomainException	if unable to decode JSON payload

blocksDestroy(integer | string $id) : \Zend_Service_Twitter_Response

Un-blocks the user specified in the ID parameter for the authenticating user

Parameters

Name	Type	Description
$id	integer \| string	The ID or screen_name of the user to un-block.

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Exception\DomainException	if unable to decode JSON payload

blocksIds(integer $cursor = -1) : \Zend_Service_Twitter_Response

Returns an array of user ids that the authenticating user is blocking

Parameters

Name	Type	Description
$cursor	integer	Optional. Specifies the cursor position at which to begin listing ids; defaults to first "page" of results.

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Exception\DomainException	if unable to decode JSON payload

blocksList(integer $cursor = -1) : \Zend_Service_Twitter_Response

Returns an array of user objects that the authenticating user is blocking

Parameters

Name	Type	Description
$cursor	integer	Optional. Specifies the cursor position at which to begin listing ids; defaults to first "page" of results.

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Exception\DomainException	if unable to decode JSON payload

createUserParameter(int | string $id, array $params) : array

Create a parameter representing the user

Determines if $id is an integer, and, if so, sets the "user_id" parameter. If not, assumes the $id is the "screen_name".

Parameters

Name	Type	Description
$id	int \| string
$params	array

Returns

Type	Description
array

directMessagesDestroy(int $id) : \Zend_Service_Twitter_Response

Destroy a direct message

Parameters

Name	Type	Description
$id	int	ID of message to destroy

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

directMessagesMessages(array $options = array()) : \Zend_Service_Twitter_Response

Retrieve direct messages for the current user

$options may include one or more of the following keys - count: return page X of results - since_id: return statuses only greater than the one specified - max_id: return statuses with an ID less than (older than) or equal to that specified - include_entities: setting to false will disable embedded entities - skip_status:setting to true, "t", or 1 will omit the status in returned users

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

directMessagesNew(int | string $user, string $text) : \Zend_Service_Twitter_Response

Send a direct message to a user

Parameters

Name	Type	Description
$user	int \| string	User to whom to send message
$text	string	Message to send to user

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Exception\InvalidArgumentException	if message is empty
\Exception\OutOfRangeException	if message is too long
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

directMessagesSent(array $options = array()) : \Zend_Service_Twitter_Response

Retrieve list of direct messages sent by current user

$options may include one or more of the following keys - count: return page X of results - page: return starting at page - since_id: return statuses only greater than the one specified - max_id: return statuses with an ID less than (older than) or equal to that specified - include_entities: setting to false will disable embedded entities

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

favoritesCreate(int $id) : \Zend_Service_Twitter_Response

Mark a status as a favorite

Parameters

Name	Type	Description
$id	int	Status ID you want to mark as a favorite

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

favoritesDestroy(int $id) : \Zend_Service_Twitter_Response

Remove a favorite

Parameters

Name	Type	Description
$id	int	Status ID you want to de-list as a favorite

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

favoritesList( $options = array()) : \Zend_Service_Twitter_Response

Fetch favorites

$options may contain one or more of the following: - user_id: Id of a user for whom to fetch favorites - screen_name: Screen name of a user for whom to fetch favorites - count: number of tweets to attempt to retrieve, up to 200 - since_id: return results only after the specified tweet id - max_id: return results with an ID less than (older than) or equal to the specified ID - include_entities: when set to false, entities member will be omitted

Parameters

Name	Type	Description
$options

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

friendshipsCreate(int | string $id, array $params = array()) : \Zend_Service_Twitter_Response

Create friendship

Parameters

Name	Type	Description
$id	int \| string	User ID or name of new friend
$params	array	Additional parameters to pass

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

friendshipsDestroy(int | string $id) : \Zend_Service_Twitter_Response

Destroy friendship

Parameters

Name	Type	Description
$id	int \| string	User ID or name of friend to remove

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

get(string $path, array $query = array()) : \Zend_Http_Response

Performs an HTTP GET request to the $path.

Parameters

Name	Type	Description
$path	string
$query	array	Array of GET parameters

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Http_Client_Exception

getHttpClient() : \Zend_Http_Client

Get the HTTP client

Lazy loads one if none present

Returns

Type	Description
\Zend_Http_Client

getUsername() : string

Retrieve username

Returns

Type	Description
string

init() : void

Initialize HTTP authentication

Throws

Exception	Description
\Exception\DomainException	if unauthorised

isAuthorised() : bool

Checks for an authorised state

Returns

Type	Description
bool

performPost(mixed $method, mixed $data, $client) : \Zend_Http_Response

Perform a POST or PUT

Performs a POST or PUT request. Any data provided is set in the HTTP client. String data is pushed in as raw POST data; array or object data is pushed in as POST parameters.

Parameters

Name	Type	Description
$method	mixed
$data	mixed
$client

Returns

Type	Description
\Zend_Http_Response

post(string $path, mixed $data = null) : \Zend_Http_Response

Performs an HTTP POST request to $path.

Parameters

Name	Type	Description
$path	string
$data	mixed	Raw data to send

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Http_Client_Exception

prepare(string $path, \Zend_Http_Client $client) : void

Call a remote REST web service URI

Parameters

Name	Type	Description
$path	string	The path to append to the URI
$client	\Zend_Http_Client

Throws

Exception	Description
\Zend_Http_Client_Exception

searchTweets(string $query, array $options = array()) : \Zend_Service_Twitter_Response

Search tweets

$options may include any of the following: - geocode: a string of the form "latitude, longitude, radius" - lang: restrict tweets to the two-letter language code - locale: query is in the given two-letter language code - result_type: what type of results to receive: mixed, recent, or popular - count: number of tweets to return per page; up to 100 - until: return tweets generated before the given date - since_id: return resutls with an ID greater than (more recent than) the given ID - max_id: return results with an ID less than (older than) the given ID - include_entities: whether or not to include embedded entities

Parameters

Name	Type	Description
$query	string
$options	array

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

setHttpClient(\Zend_Http_Client $client) : \Zend_Service_Twitter

Set HTTP client

Parameters

Name	Type	Description
$client	\Zend_Http_Client

Returns

Type	Description
\Zend_Service_Twitter

Details

Fluent: This method is part of a fluent interface and will return the same instance

setUsername(string $value) : \Zend_Service_Twitter

Set username

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Service_Twitter

Details

Fluent: This method is part of a fluent interface and will return the same instance

statusesDestroy(int $id) : \Zend_Service_Twitter_Response

Destroy a status message

Parameters

Name	Type	Description
$id	int	ID of status to destroy

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

statusesHomeTimeline( $options = array()) : \Zend_Service_Twitter_Response

Friend Timeline Status

$options may include one or more of the following keys - count: number of tweets to attempt to retrieve, up to 200 - since_id: return results only after the specified tweet id - max_id: return results with an ID less than (older than) or equal to the specified ID - trim_user: when set to true, "t", or 1, user object in tweets will include only author's ID. - contributor_details: when set to true, includes screen_name of each contributor - include_entities: when set to false, entities member will be omitted - exclude_replies: when set to true, will strip replies appearing in the timeline

Parameters

Name	Type	Description
$options

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

statusesMentionsTimeline(array $options = array()) : \Zend_Service_Twitter_Response

Get status replies

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

statusesSample() : \Zend_Service_Twitter_Response

Public Timeline status

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

statusesShow(int $id) : \Zend_Service_Twitter_Response

Show a single status

Parameters

Name	Type	Description
$id	int	Id of status to show

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

statusesUpdate(string $status, null | int $inReplyToStatusId = null) : \Zend_Service_Twitter_Response

Update user's current status

Parameters

Name	Type	Description
$status	string
$inReplyToStatusId	null \| int

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\OutOfRangeException	if message is too long
\Exception\InvalidArgumentException	if message is empty
\Exception\DomainException	if unable to decode JSON payload

Details

Todo: Support additional parameters supported by statuses/update endpoint

statusesUserTimeline( $options = array()) : \Zend_Service_Twitter_Response

User Timeline status

$options may include one or more of the following keys - user_id: Id of a user for whom to fetch favorites - screen_name: Screen name of a user for whom to fetch favorites - count: number of tweets to attempt to retrieve, up to 200 - since_id: return results only after the specified tweet id - max_id: return results with an ID less than (older than) or equal to the specified ID - trim_user: when set to true, "t", or 1, user object in tweets will include only author's ID. - exclude_replies: when set to true, will strip replies appearing in the timeline - contributor_details: when set to true, includes screen_name of each contributor - include_rts: when set to false, will strip native retweets

Parameters

Name	Type	Description
$options

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

usersSearch(string $query, array $options = array()) : \Zend_Service_Twitter_Response

Search users

$options may include any of the following: - page: the page of results to retrieve - count: the number of users to retrieve per page; max is 20 - include_entities: if set to boolean true, include embedded entities

Parameters

Name	Type	Description
$query	string
$options	array

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

usersShow(int | string $id) : \Zend_Service_Twitter_Response

Show extended information on a user

Parameters

Name	Type	Description
$id	int \| string	User ID or name

Returns

Type	Description
\Zend_Service_Twitter_Response

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Exception\DomainException	if unable to decode JSON payload

validInteger( $int) : integer

Protected function to validate that the integer is valid or return a 0

Parameters

Name	Type	Description
$int

Returns

Type	Description
integer

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

validateScreenName(string $name) : string

Validate a screen name using Twitter rules

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

Throws

Exception	Description
\Exception\InvalidArgumentException

Service/Twitter.php

\Zend_Service_Twitterjump to top

Constants

Properties

Methods

\Zend_Service_Twitter
jump to top