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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: Twitter
Version: $Id: Twitter.php 25267 2013-02-25 17:03:45Z rob $

\Zend_Service_Twitter
jump to top

Package: Zend\Service\Twitter

Parent(s): \Zend_Rest_Client < \Zend_Service_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                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...

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

OAuth Endpoint

Properties

\Zend_Http_CookieJar $_cookieJar =

Details

Type: \Zend_Http_CookieJar

array $_data = array()

inherited

Data for the query

Inherited from: \Zend_Rest_Client::$$_data

Default valuearray()Details

Type: array
Inherited_from: \Zend_Rest_Client::$$_data

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

staticinherited

HTTP Client used to query all web services

Inherited from: \Zend_Service_Abstract::$$_httpClient \Zend_Rest_Client::$$_httpClient

Default valuenullDetails

Type: \Zend_Http_Client
Inherited_from: \Zend_Service_Abstract::$$_httpClient
Inherited_from: \Zend_Rest_Client::$$_httpClient

\Zend_Http_Client $_localHttpClient = null

Local HTTP Client cloned from statically set client

Default valuenullDetails

Type: \Zend_Http_Client

string $_methodType =

Current method type (for method proxying)

Details

Type: string

array $_methodTypes = array('status', 'user', 'directMessage', 'friendship', 'account', 'favorite', 'block')

Types of API methods

Default valuearray('status', 'user', 'directMessage', 'friendship', 'account', 'favorite', 'block')Details

Type: array

bool $_noReset = false

inherited

Flag indicating the Zend_Http_Client is fresh and needs no reset.

<p>true if you do not want a reset. Default false.</p>Inherited from: \Zend_Rest_Client::$$_noReset

Must be set explicitly if you want to keep preset parameters.

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Rest_Client::$$_noReset

\Zend_Oauth_Consumer $_oauthConsumer = null

Zend_Oauth Consumer

Default valuenullDetails

Type: \Zend_Oauth_Consumer

array $_options = array()

Options passed to constructor

Default valuearray()Details

Type: array

\Zend_Uri_Http $_uri = null

inherited

Zend_Uri of this web service

Inherited from: \Zend_Rest_Client::$$_uri

Default valuenullDetails

Type: \Zend_Uri_Http
Inherited_from: \Zend_Rest_Client::$$_uri

string $_username =

Username

Details

Type: string

Methods

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

Method overloading

Allows calling REST actions as object methods; however, you must follow-up by chaining the request with a request to an HTTP request method (post, get, delete, put):

$response = $rest->sayHello('Foo', 'Manchu')->get();

Or use them together, but in sequential calls:

$rest->sayHello('Foo', 'Manchu');
$response = $rest->get();

Parameters

Name	Type	Description
$method	string
$params	array

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Service_Twitter_Exception	if unable to find method

__construct(array $options = null, $consumer = null) : void

Constructor

Parameters

Name	Type	Description
$options	array	Optional options array
$consumer

__get(string $type) : \Zend_Service_Twitter

Proxy service methods

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
\Zend_Service_Twitter

Throws

Exception	Description
\Zend_Service_Twitter_Exception	If method not in method types list

_get(string $path, array $query = null) : \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

_init() : void

Initialize HTTP authentication

_performPost(mixed $method, mixed $data = null) : \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

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) : void

Call a remote REST web service URI and return the Zend_Http_Response object

Parameters

Name	Type	Description
$path	string	The path to append to the URI

Throws

Exception	Description
\Zend_Rest_Client_Exception

_prepareRest(string $path) : void

inherited

Call a remote REST web service URI and return the Zend_Http_Response object

Inherited from: \Zend_Rest_Client::_prepareRest()

Parameters

Name	Type	Description
$path	string	The path to append to the URI

Throws

Exception	Description
\Zend_Rest_Client_Exception

_setDate(int | string $value) : void

Set date header

Parameters

Name	Type	Description
$value	int \| string

Details

Deprecated: Not supported by Twitter since April 08, 2009

_validInteger(mixed $int) : integer

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

Parameters

Name	Type	Description
$int	mixed

Returns

Type	Description
integer

_validateScreenName(string $name) : string

Validate a screen name using Twitter rules

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Service_Twitter_Exception

accountEndSession() : true

End current session

Returns

Type	Description
true

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

accountRateLimitStatus() : \Zend_Rest_Client_Result

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

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

accountVerifyCredentials() : \Zend_Rest_Client_Result

Verify Account Credentials

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

blockBlocking(integer $page = 1, boolean $returnUserIds = false) : \Zend_Rest_Client_Result

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

Parameters

Name	Type	Description
$page	integer	Optional. Specifies the page number of the results beginning at 1. A single page contains 20 ids.
$returnUserIds	boolean	Optional. Returns only the userid's instead of the whole user object

Returns

Type	Description
\Zend_Rest_Client_Result

blockCreate(integer | string $id) : \Zend_Rest_Client_Result

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_Rest_Client_Result

blockDestroy(integer | string $id) : \Zend_Rest_Client_Result

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_Rest_Client_Result

blockExists(string | integer $id, boolean $returnResult = false) : Boolean | \Zend_Rest_Client_Result

Returns if the authenticating user is blocking a target user.

Parameters

Name	Type	Description
$id	string \| integer	The ID or screen_name of the potentially blocked user.
$returnResult	boolean	Instead of returning a boolean return the rest response from twitter

Returns

Type	Description
Boolean \| \Zend_Rest_Client_Result

directMessageDestroy(int $id) : \Zend_Rest_Client_Result

Destroy a direct message

Parameters

Name	Type	Description
$id	int	ID of message to destroy

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

directMessageMessages(array $params = array()) : \Zend_Rest_Client_Result

Retrieve direct messages for the current user

$params may include one or more of the following keys - since_id: return statuses only greater than the one specified - page: return page X of results

Parameters

Name	Type	Description
$params	array

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

directMessageNew(int | string $user, string $text) : \Zend_Rest_Client_Result

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_Rest_Client_Result

Throws

Exception	Description
\Zend_Service_Twitter_Exception	if message is too short or too long
\Zend_Http_Client_Exception	if HTTP request fails or times out

directMessageSent(array $params = array()) : \Zend_Rest_Client_Result

Retrieve list of direct messages sent by current user

$params may include one or more of the following keys - since_id: return statuses only greater than the one specified - page: return page X of results

Parameters

Name	Type	Description
$params	array

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

favoriteCreate(int $id) : \Zend_Rest_Client_Result

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_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

favoriteDestroy(int $id) : \Zend_Rest_Client_Result

Remove a favorite

Parameters

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

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

favoriteFavorites(array $params = array()) : \Zend_Rest_Client_Result

Fetch favorites

$params may contain one or more of the following: - 'id': Id of a user for whom to fetch favorites - 'page': Retrieve a different page of resuls

Parameters

Name	Type	Description
$params	array

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

friendshipCreate(int | string $id) : \Zend_Rest_Client_Result

Create friendship

Parameters

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

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

friendshipDestroy(int | string $id) : \Zend_Rest_Client_Result

Destroy friendship

Parameters

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

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

friendshipExists(int | string $id) : \Zend_Rest_Client_result

Friendship exists

Parameters

Name	Type	Description
$id	int \| string	User ID or name of friend to see if they are your friend

Returns

Type	Description
\Zend_Rest_Client_result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

getHttpClient() : \Zend_Http_Client

staticfinalinherited

Gets the HTTP client object.

Inherited from: \Zend_Service_Abstract::getHttpClient()\Zend_Rest_Client::getHttpClient()

Returns

Type	Description
\Zend_Http_Client

getLocalHttpClient() : \Zend_Http_Client

Get the local HTTP client as distinct from the static HTTP client inherited from Zend_Rest_Client

Returns

Type	Description
\Zend_Http_Client

getUri() : \Zend_Uri_Http

inherited

Retrieve the current request URI object

Inherited from: \Zend_Rest_Client::getUri()

Returns

Type	Description
\Zend_Uri_Http

getUsername() : string

Retrieve username

Returns

Type	Description
string

isAuthorised() : bool

Checks for an authorised state

Returns

Type	Description
bool

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

inherited

Performs an HTTP DELETE request to $path.

Inherited from: \Zend_Rest_Client::restDelete()

Parameters

Name	Type	Description
$path	string
$data

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Http_Client_Exception

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

inherited

Performs an HTTP GET request to the $path.

Inherited from: \Zend_Rest_Client::restGet()

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

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

inherited

Performs an HTTP POST request to $path.

Inherited from: \Zend_Rest_Client::restPost()

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

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

inherited

Performs an HTTP PUT request to $path.

Inherited from: \Zend_Rest_Client::restPut()

Parameters

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

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Http_Client_Exception

setHttpClient(\Zend_Http_Client $httpClient) : void

staticfinalinherited

Sets the HTTP client object to use for retrieving the feeds.

Inherited from: \Zend_Service_Abstract::setHttpClient()\Zend_Rest_Client::setHttpClient()

If none is set, the default Zend_Http_Client will be used.

Parameters

Name	Type	Description
$httpClient	\Zend_Http_Client

setLocalHttpClient(\Zend_Http_Client $client) : \Zend_Service_Twitter

Set local HTTP client as distinct from the static HTTP client as inherited from Zend_Rest_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

setNoReset(boolean $bool = true) : void

inherited

Tells Zend_Rest_Client not to reset all parameters on it's Zend_Http_Client.

Inherited from: \Zend_Rest_Client::setNoReset()

If you want no reset, this must be called explicitly before every request for which you do not want to reset the parameters. Parameters will accumulate between requests, but as soon as you do not call this function prior to any request, all preset parameters will be reset as by default.

Parameters

Name	Type	Description
$bool	boolean

setUri(string | \Zend_Uri_Http $uri) : \Zend_Rest_Client

inherited

Set the URI to use in the request

Inherited from: \Zend_Rest_Client::setUri()

Parameters

Name	Type	Description
$uri	string \| \Zend_Uri_Http	URI for the web service

Returns

Type	Description
\Zend_Rest_Client

setUsername(string $value) : \Zend_Service_Twitter

Set username

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Service_Twitter

statusDestroy(int $id) : \Zend_Rest_Client_Result

Destroy a status message

Parameters

Name	Type	Description
$id	int	ID of status to destroy

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

statusFriendsTimeline(array $params = array()) : void

Friend Timeline Status

$params may include one or more of the following keys - id: ID of a friend whose timeline you wish to receive - count: how many statuses to return - since_id: return results only after the specific tweet - page: return page X of results

Parameters

Name	Type	Description
$params	array

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

statusPublicTimeline() : \Zend_Rest_Client_Result

Public Timeline status

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

statusReplies( $params = array()) : \Zend_Rest_Client_Result

Get status replies

$params may include one or more of the following keys - since_id: return results only after the specified tweet id - page: return page X of results

Parameters

Name	Type	Description
$params

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

statusShow(int $id) : \Zend_Rest_Client_Result

Show a single status

Parameters

Name	Type	Description
$id	int	Id of status to show

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

statusUpdate(string $status, $inReplyToStatusId = null) : \Zend_Rest_Client_Result

Update user's current status

Parameters

Name	Type	Description
$status	string
$inReplyToStatusId

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out
\Zend_Service_Twitter_Exception	if message is too short or too long

statusUserTimeline( $params = array()) : \Zend_Rest_Client_Result

User Timeline status

$params may include one or more of the following keys - id: ID of a friend whose timeline you wish to receive - since_id: return results only after the tweet id specified - page: return page X of results - count: how many statuses to return - max_id: returns only statuses with an ID less than or equal to the specified ID - user_id: specifies the ID of the user for whom to return the user_timeline - screen_name: specfies the screen name of the user for whom to return the user_timeline - include_rts: whether or not to return retweets - trim_user: whether to return just the user ID or a full user object; omit to return full object - include_entities: whether or not to return entities nodes with tweet metadata

Parameters

Name	Type	Description
$params

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

userFollowers(bool $lite = false) : \Zend_Rest_Client_Result

User Followers

Parameters

Name	Type	Description
$lite	bool	If true, prevents inline inclusion of current status for followers; defaults to false

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

userFriends( $params = array()) : \Zend_Rest_Client_Result

User friends

Parameters

Name	Type	Description
$params

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

userShow(int | string $id) : \Zend_Rest_Client_Result

Show extended information on a user

Parameters

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

Returns

Type	Description
\Zend_Rest_Client_Result

Throws

Exception	Description
\Zend_Http_Client_Exception	if HTTP request fails or times out

Service/Twitter.php

\Zend_Service_Twitterjump to top

Constants

Properties

Methods

\Zend_Service_Twitter
jump to top