API Documentation

Service/Twitter.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service
subpackage
Twitter
version
$Id: Twitter.php 22629 2010-07-18 14:22:49Z padraic $
Classes
Zend_Service_Twitter

Description

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.

Zend_Service_Twitter
jump to top

Extends from
Zend_Rest_Client
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service
subpackage
Twitter
Constants
STATUS_MAX_CHARACTERS
OAUTH_BASE_URI
Properties
$_cookieJar
$_dateFormat
$_username
$_methodType
$_oauthConsumer
$_methodTypes
$_options
$_localHttpClient
Methods
__construct
setLocalHttpClient
getLocalHttpClient
isAuthorised
getUsername
setUsername
__get
__call
_init
_setDate
statusPublicTimeline
statusFriendsTimeline
statusUserTimeline
statusShow
statusUpdate
statusReplies
statusDestroy
userFriends
userFollowers
userShow
directMessageMessages
directMessageSent
directMessageNew
directMessageDestroy
friendshipCreate
friendshipDestroy
friendshipExists
accountVerifyCredentials
accountEndSession
accountRateLimitStatus
favoriteFavorites
favoriteCreate
favoriteDestroy
blockCreate
blockDestroy
blockExists
blockBlocking
_validInteger
_validateScreenName
_prepare
_get
_post
_performPost

Description

Constants

STATUS_MAX_CHARACTERS
jump to class

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

Details

value
246

OAUTH_BASE_URI
jump to class

 OAUTH_BASE_URI = 'http://twitter.com/oauth'

OAuth Endpoint

Details

value
http://twitter.com/oauth

Properties

$_cookieJar
jump to class

Zend_Http_CookieJar $_cookieJar = ''

Details

$_cookieJar
Zend_Http_CookieJar
visibility
protected
default
final
false
static
false

$_dateFormat
jump to class

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

Date format for 'since' strings

Details

$_dateFormat
string
visibility
protected
default
D, d M Y H:i:s T
final
false
static
false

$_localHttpClient
jump to class

Zend_Http_Client $_localHttpClient = 'null'

Local HTTP Client cloned from statically set client

Details

$_localHttpClient
Zend_Http_Client
visibility
protected
default
null
final
false
static
false

$_methodType
jump to class

string $_methodType = ''

Current method type (for method proxying)

Details

$_methodType
string
visibility
protected
default
final
false
static
false

$_methodTypes
jump to class

array $_methodTypes = 'array'

Types of API methods

Details

$_methodTypes
array
visibility
protected
default
array
final
false
static
false

$_oauthConsumer
jump to class

Zend_Oauth_Consumer $_oauthConsumer = 'null'

Zend_Oauth Consumer

Details

$_oauthConsumer
Zend_Oauth_Consumer
visibility
protected
default
null
final
false
static
false

$_options
jump to class

array $_options = 'array'

Options passed to constructor

Details

$_options
array
visibility
protected
default
array
final
false
static
false

$_username
jump to class

string $_username = ''

Username

Details

$_username
string
visibility
protected
default
final
false
static
false

Methods

__call
jump to class

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

Method overloading

Arguments
$method
string
$params
array
Output
mixed
Details
visibility
public
final
false
static
false
throws
if unable to find method

__construct
jump to class

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

Constructor

Arguments
$options
array
Optional options array
$consumer
Details
visibility
public
final
false
static
false

__get
jump to class

__get( string $type ) : Zend_Service_Twitter

Proxy service methods

Arguments
$type
string
Output
Zend_Service_Twitter
Details
visibility
public
final
false
static
false
throws
If method not in method types list

_get
jump to class

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

Performs an HTTP GET request to the $path.

Arguments
$path
string
$query
array
Array of GET parameters
Output
Zend_Http_Response
Details
visibility
protected
final
false
static
false
throws

_init
jump to class

_init( ) : void

Initialize HTTP authentication

Details
visibility
protected
final
false
static
false

_performPost
jump to class

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

Arguments
$method
mixed
$data
mixed
Output
Zend_Http_Response
Details
visibility
protected
final
false
static
false

_post
jump to class

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

Performs an HTTP POST request to $path.

Arguments
$path
string
$data
mixed
Raw data to send
Output
Zend_Http_Response
Details
visibility
protected
final
false
static
false
throws

_prepare
jump to class

_prepare( string $path ) : void

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

Arguments
$path
string
The path to append to the URI
Details
visibility
protected
final
false
static
false
throws

_setDate
jump to class

_setDate( int|string $value ) : void

Set date header

Arguments
$value
intstring
Details
visibility
protected
final
false
static
false
deprecated
Not supported by Twitter since April 08, 2009

_validInteger
jump to class

_validInteger(  $int ) : integer

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

Arguments
$int
Output
integer
Details
visibility
protected
final
false
static
false
throws
if HTTP request fails or times out

_validateScreenName
jump to class

_validateScreenName( string $name ) : string

Validate a screen name using Twitter rules

Arguments
$name
string
Output
string
Details
visibility
protected
final
false
static
false
throws

accountEndSession
jump to class

accountEndSession( ) : true

End current session

Output
true
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

accountRateLimitStatus
jump to class

accountRateLimitStatus( ) : Zend_Rest_Client_Result

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

Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

accountVerifyCredentials
jump to class

accountVerifyCredentials( ) : Zend_Rest_Client_Result

Verify Account Credentials

Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

blockBlocking
jump to class

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

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

Arguments
$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
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false

blockCreate
jump to class

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.

Arguments
$id
integerstring
The ID or screen name of a user to block.
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false

blockDestroy
jump to class

blockDestroy( integer|string $id ) : Zend_Rest_Client_Result

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

Arguments
$id
integerstring
The ID or screen_name of the user to un-block.
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false

blockExists
jump to class

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

Returns if the authenticating user is blocking a target user.

Arguments
$id
stringinteger
The ID or screen_name of the potentially blocked user.
$returnResult
boolean
Instead of returning a boolean return the rest response from twitter
Output
Boolean|Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false

directMessageDestroy
jump to class

directMessageDestroy( int $id ) : Zend_Rest_Client_Result

Destroy a direct message

Arguments
$id
int
ID of message to destroy
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

directMessageMessages
jump to class

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

Arguments
$params
array
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

directMessageNew
jump to class

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

Send a direct message to a user

Arguments
$user
intstring
User to whom to send message
$text
string
Message to send to user
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if message is too short or too long
throws
if HTTP request fails or times out

directMessageSent
jump to class

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

Arguments
$params
array
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

favoriteCreate
jump to class

favoriteCreate( int $id ) : Zend_Rest_Client_Result

Mark a status as a favorite

Arguments
$id
int
Status ID you want to mark as a favorite
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

favoriteDestroy
jump to class

favoriteDestroy( int $id ) : Zend_Rest_Client_Result

Remove a favorite

Arguments
$id
int
Status ID you want to de-list as a favorite
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

favoriteFavorites
jump to class

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

Arguments
$params
array
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

friendshipCreate
jump to class

friendshipCreate( int|string $id ) : Zend_Rest_Client_Result

Create friendship

Arguments
$id
intstring
User ID or name of new friend
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

friendshipDestroy
jump to class

friendshipDestroy( int|string $id ) : Zend_Rest_Client_Result

Destroy friendship

Arguments
$id
intstring
User ID or name of friend to remove
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

friendshipExists
jump to class

friendshipExists( int|string $id ) : Zend_Rest_Client_result

Friendship exists

Arguments
$id
intstring
User ID or name of friend to see if they are your friend
Output
Zend_Rest_Client_result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

getLocalHttpClient
jump to class

getLocalHttpClient( ) : Zend_Http_Client

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

Output
Zend_Http_Client
Details
visibility
public
final
false
static
false

getUsername
jump to class

getUsername( ) : string

Retrieve username

Output
string
Details
visibility
public
final
false
static
false

isAuthorised
jump to class

isAuthorised( ) : bool

Checks for an authorised state

Output
bool
Details
visibility
public
final
false
static
false

setLocalHttpClient
jump to class

setLocalHttpClient( Zend_Http_Client $client ) : self

Set local HTTP client as distinct from the static HTTP client as inherited from Zend_Rest_Client.

Arguments
$client
Zend_Http_Client
Output
self
Details
visibility
public
final
false
static
false

setUsername
jump to class

setUsername( string $value ) : Zend_Service_Twitter

Set username

Arguments
$value
string
Output
Zend_Service_Twitter
Details
visibility
public
final
false
static
false

statusDestroy
jump to class

statusDestroy( int $id ) : Zend_Rest_Client_Result

Destroy a status message

Arguments
$id
int
ID of status to destroy
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

statusFriendsTimeline
jump to class

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

Arguments
$params
array
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

statusPublicTimeline
jump to class

statusPublicTimeline( ) : Zend_Rest_Client_Result

Public Timeline status

Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

statusReplies
jump to class

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

Arguments
$params
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

statusShow
jump to class

statusShow( int $id ) : Zend_Rest_Client_Result

Show a single status

Arguments
$id
int
Id of status to show
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

statusUpdate
jump to class

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

Update user's current status

Arguments
$status
string
$inReplyToStatusId
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out
throws
if message is too short or too long

statusUserTimeline
jump to class

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: specfies 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

Arguments
$params
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

userFollowers
jump to class

userFollowers( bool $lite = false ) : Zend_Rest_Client_Result

User Followers

Arguments
$lite
bool
If true, prevents inline inclusion of current status for followers; defaults to false
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

userFriends
jump to class

userFriends(  $params = array ) : Zend_Rest_Client_Result

User friends

Arguments
$params
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out

userShow
jump to class

userShow( int|string $id ) : Zend_Rest_Client_Result

Show extended information on a user

Arguments
$id
intstring
User ID or name
Output
Zend_Rest_Client_Result
Details
visibility
public
final
false
static
false
throws
if HTTP request fails or times out
Documentation was generated by DocBlox.