[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Service/ -> Twitter.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 1033 lines (32 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Service_Twitter:: (43 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()


Class: Zend_Service_Twitter  - X-Ref


__construct(array $options = null, Zend_Oauth_Consumer $consumer = null)   X-Ref
Constructor

param: array $options Optional options array
return: void

setLocalHttpClient(Zend_Http_Client $client)   X-Ref
Set local HTTP client as distinct from the static HTTP client
as inherited from Zend_Rest_Client.

param: Zend_Http_Client $client
return: self

getLocalHttpClient()   X-Ref
Get the local HTTP client as distinct from the static HTTP client
inherited from Zend_Rest_Client

return: Zend_Http_Client

isAuthorised()   X-Ref
Checks for an authorised state

return: bool

getUsername()   X-Ref
Retrieve username

return: string

setUsername($value)   X-Ref
Set username

param: string $value
return: Zend_Service_Twitter

__get($type)   X-Ref
Proxy service methods

param: string $type
return: Zend_Service_Twitter

__call($method, $params)   X-Ref
Method overloading

param: string $method
param: array $params
return: mixed

_init()   X-Ref
Initialize HTTP authentication

return: void

_setDate($value)   X-Ref
Set date header

param: int|string $value
return: void

statusPublicTimeline()   X-Ref
Public Timeline status

return: Zend_Rest_Client_Result

statusFriendsTimeline(array $params = array()   X-Ref
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

param: array $params
return: void

statusUserTimeline(array $params = array()   X-Ref
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

return: Zend_Rest_Client_Result

statusShow($id)   X-Ref
Show a single status

param: int $id Id of status to show
return: Zend_Rest_Client_Result

statusUpdate($status, $inReplyToStatusId = null)   X-Ref
Update user's current status

param: string $status
param: int $in_reply_to_status_id
return: Zend_Rest_Client_Result

statusReplies(array $params = array()   X-Ref
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

return: Zend_Rest_Client_Result

statusDestroy($id)   X-Ref
Destroy a status message

param: int $id ID of status to destroy
return: Zend_Rest_Client_Result

userFriends(array $params = array()   X-Ref
User friends

param: int|string $id Id or username of user for whom to fetch friends
return: Zend_Rest_Client_Result

userFollowers($lite = false)   X-Ref
User Followers

param: bool $lite If true, prevents inline inclusion of current status for followers; defaults to false
return: Zend_Rest_Client_Result

userShow($id)   X-Ref
Show extended information on a user

param: int|string $id User ID or name
return: Zend_Rest_Client_Result

directMessageMessages(array $params = array()   X-Ref
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

param: array $params
return: Zend_Rest_Client_Result

directMessageSent(array $params = array()   X-Ref
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

param: array $params
return: Zend_Rest_Client_Result

directMessageNew($user, $text)   X-Ref
Send a direct message to a user

param: int|string $user User to whom to send message
param: string $text Message to send to user
return: Zend_Rest_Client_Result

directMessageDestroy($id)   X-Ref
Destroy a direct message

param: int $id ID of message to destroy
return: Zend_Rest_Client_Result

friendshipCreate($id)   X-Ref
Create friendship

param: int|string $id User ID or name of new friend
return: Zend_Rest_Client_Result

friendshipDestroy($id)   X-Ref
Destroy friendship

param: int|string $id User ID or name of friend to remove
return: Zend_Rest_Client_Result

friendshipExists($id)   X-Ref
Friendship exists

param: int|string $id User ID or name of friend to see if they are your friend
return: Zend_Rest_Client_result

accountVerifyCredentials()   X-Ref
Verify Account Credentials

return: Zend_Rest_Client_Result

accountEndSession()   X-Ref
End current session

return: true

accountRateLimitStatus()   X-Ref
Returns the number of api requests you have left per hour.

return: Zend_Rest_Client_Result

favoriteFavorites(array $params = array()   X-Ref
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

param: array $params
return: Zend_Rest_Client_Result

favoriteCreate($id)   X-Ref
Mark a status as a favorite

param: int $id Status ID you want to mark as a favorite
return: Zend_Rest_Client_Result

favoriteDestroy($id)   X-Ref
Remove a favorite

param: int $id Status ID you want to de-list as a favorite
return: Zend_Rest_Client_Result

blockCreate($id)   X-Ref
Blocks the user specified in the ID parameter as the authenticating user.
Destroys a friendship to the blocked user if it exists.

param: integer|string $id       The ID or screen name of a user to block.
return: Zend_Rest_Client_Result

blockDestroy($id)   X-Ref
Un-blocks the user specified in the ID parameter for the authenticating user

param: integer|string $id       The ID or screen_name of the user to un-block.
return: Zend_Rest_Client_Result

blockExists($id, $returnResult = false)   X-Ref
Returns if the authenticating user is blocking a target user.

param: string|integer $id    The ID or screen_name of the potentially blocked user.
param: boolean $returnResult Instead of returning a boolean return the rest response from twitter
return: Boolean|Zend_Rest_Client_Result

blockBlocking($page = 1, $returnUserIds = false)   X-Ref
Returns an array of user objects that the authenticating user is blocking

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

_validInteger($int)   X-Ref
Protected function to validate that the integer is valid or return a 0

param: $int
return: integer

_validateScreenName($name)   X-Ref
Validate a screen name using Twitter rules

param: string $name
return: string

_prepare($path)   X-Ref
Call a remote REST web service URI and return the Zend_Http_Response object

param: string $path            The path to append to the URI
return: void

_get($path, array $query = null)   X-Ref
Performs an HTTP GET request to the $path.

param: string $path
param: array  $query Array of GET parameters
return: Zend_Http_Response

_post($path, $data = null)   X-Ref
Performs an HTTP POST request to $path.

param: string $path
param: mixed $data Raw data to send
return: Zend_Http_Response

_performPost($method, $data = null)   X-Ref
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.

param: mixed $method
param: mixed $data
return: Zend_Http_Response



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1