• Home
• TijsVerkoyen
• Twitter
• Twitter

PHP Class TijsVerkoyen\Twitter\Twitter

Datei anzeigen Open project: tijsverkoyen/twitteroauth Class Usage Examples

Protected Properties

Property	Type	Description
$consumerKey	string	The consumer key
$consumerSecret	string	The consumer secret
$curl	resource	A cURL instance
$oAuthToken	string	The oAuth-token
$oAuthTokenSecret	string	The oAuth-token-secret
$returnAsArray	boolean	The response should be cast as array or not
$timeOut	integer	The timeout
$userAgent	string	The user agent

Public Methods

Method	Description
__construct ( string $consumerKey, string $consumerSecret )	Default constructor
__destruct ( )	Default destructor
accountRemoveProfileBanner ( ) : boolean	Removes the uploaded profile banner for the authenticating user.
accountSettings ( ) : array	Returns settings (including current trend, geo and sleep time information) for the authenticating user.
accountSettingsUpdate ( string[optional] $trendLocationWoeId = null, bool[optional] $sleepTimeEnabled = null, string[optional] $startSleepTime = null, string[optional] $endSleepTime = null, string[optional] $timeZone = null, string[optional] $lang = null ) : array	Updates the authenticating user's settings.
accountUpdateDeliveryDevice ( string $device, bool[optional] $includeEntities = null ) : array	Sets which device Twitter delivers updates to for the authenticating user. Sending none as the device parameter will disable SMS updates.
accountUpdateProfile ( string[optional] $name = null, string[optional] $url = null, string[optional] $location = null, string[optional] $description = null, bool[optional] $includeEntities = null, bool[optional] $skipStatus = null ) : array	Sets values that users are able to set under the "Account" tab of their settings page. Only the parameters specified will be updated.
accountUpdateProfileBackgroundImage ( string $image, bool[optional] $tile = false, bool[optional] $includeEntities = null ) : array	Updates the authenticating user's profile background image.
accountUpdateProfileBanner ( )	Not implemented yet
accountUpdateProfileColors ( string[optional] $profileBackgroundColor = null, string[optional] $profileTextColor = null, string[optional] $profileLinkColor = null, string[optional] $profileSidebarFillColor = null, string[optional] $profileSidebarBorderColor = null, bool[optional] $includeEntities = null ) : array	Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com.
accountUpdateProfileImage ( string $image, bool[optional] $includeEntities = null ) : array	Updates the authenticating user's profile image.
accountVerifyCredentials ( bool[optional] $includeEntities = null, bool[optional] $skipStatus = null ) : array	Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid.
applicationRateLimitStatus ( array $resources = null ) : string	Returns the current rate limits for methods belonging to the specified resource families.
blocksCreate ( string[optional] $userId = null, string[optional] $screenName = null, bool[optional] $includeEntities = null, bool[optional] $skipStatus = null ) : array	Blocks the specified user from following the authenticating user. In addition the blocked user will not show in the authenticating users mentions or timeline (unless retweeted by another user). If a follow or friend relationship exists it is destroyed.
blocksDestroy ( string[optional] $userId = null, string[optional] $screenName = null, bool[optional] $includeEntities = null, bool[optional] $skipStatus = null ) : array	Un-blocks the user specified in the ID parameter for the authenticating user. Returns the un-blocked user in the requested format when successful. If relationships existed before the block was instated, they will not be restored.
blocksIds ( string[optional] $cursor = null, bool[optional] $stringifyIds = null ) : array	Returns an array of numeric user ids the authenticating user is blocking.
blocksList ( int[optional] $cursor = null, bool[optional] $includeEntities = null, bool[optional] $skipStatus = null ) : array	Not implemented yet
directMessages ( string[optional] $sinceId = null, string[optional] $maxId = null, int[optional] $count = null, int[optional] $page = null, bool[optional] $includeEntities = null, bool[optional] $skipStatus = null ) : array	Returns the 20 most recent direct messages sent to the authenticating user. Includes detailed information about the sender and recipient user. You can request up to 200 direct messages per call, up to a maximum of 800 incoming DMs.
directMessagesDestroy ( string $id, bool[optional] $includeEntities = null ) : array	Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.
directMessagesNew ( string[optional] $userId = null, string[optional] $screenName = null, string $text ) : array	Sends a new direct message to the specified user from the authenticating user. Requires both the user and text parameters and must be a POST. Returns the sent message in the requested format if successful.
directMessagesSent ( string[optional] $sinceId = null, string[optional] $maxId = null, int[optional] $count = null, int[optional] $page = null, bool[optional] $includeEntities = null ) : array	Returns the 20 most recent direct messages sent by the authenticating user. Includes detailed information about the sender and recipient user. You can request up to 200 direct messages per call, up to a maximum of 800 outgoing DMs.
directMessagesShow ( string $id ) : array
favoritesCreate ( string $id, bool[optional] $includeEntities = null ) : array	Favorites the status specified in the ID parameter as the authenticating user. Returns the favorite status when successful.
favoritesDestroy ( string $id, bool[optional] $includeEntities = null ) : array	Un-favorites the status specified in the ID parameter as the authenticating user. Returns the un-favorited status in the requested format when successful.
favoritesList ( string[otpional] $userId = null, string[otpional] $screenName = null, int[optional] $count = 20, string[otpional] $sinceId = null, string[otpional] $maxId = null, bool[optional] $includeEntities = null ) : array	Returns the 20 most recent Tweets favorited by the authenticating or specified user.
followersIds ( string[optional] $userId = null, string[optional] $screenName = null, string[optional] $cursor = null, bool[optional] $stringifyIds = true ) : array	Returns a cursored collection of user IDs for every user following the specified user.
followersList ( string[optional] $userId = null, string[optional] $screenName = null, int[optional] $cursor = null, bool[optional] $includeEntities = null, bool[optional] $skipStatus = null ) : array	Returns a cursored collection of user objects for users following the specified user.
friendsIds ( string[optional] $userId = null, string[optional] $screenName = null, string[optional] $cursor = null, bool[optional] $stringifyIds = null ) : array	Returns a cursored collection of user IDs for every user the specified user is following (otherwise known as their "friends").
friendsList ( string[optional] $userId = null, string[optional] $screenName = null, int[optional] $cursor = null, bool[optional] $includeEntities = null, bool[optional] $skipStatus = null ) : array	Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").
friendshipsCreate ( string[optional] $userId = null, string[optional] $screenName = null, bool[optional] $follow = false ) : array	Allows the authenticating users to follow the user specified in the ID parameter.
friendshipsDestroy ( string[optional] $userId = null, string[optional] $screenName = null ) : array	Allows the authenticating user to unfollow the user specified in the ID parameter.
friendshipsIncoming ( string[optional] $cursor = null, bool[optional] $stringifyIds = true ) : array	Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.
friendshipsLookup ( mixed[optional] $userIds = null, mixed[optional] $screenNames = null ) : array	Returns the relationships of the authenticating user to the comma-separated list of up to 100 screen_names or user_ids provided.
friendshipsOutgoing ( string[optional] $cursor = null, bool[optional] $stringifyIds = true ) : array	Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.
friendshipsShow ( string[optional] $sourceId = null, string[optional] $sourceScreenName = null, string[optional] $targetId = null, string[optional] $targetScreenName = null ) : array	Returns detailed information about the relationship between two arbitrary users.
friendshipsUpdate ( string[optional] $userId = null, string[optional] $screenName = null, bool[optional] $device = null, bool[optional] $retweets = null ) : array	Allows one to enable or disable retweets and device notifications from the specified user.
geoId ( string $id ) : array	Returns all the information about a known place.
geoPlace ( string $name, string $containedWithin, string $token, float $lat, float $long, array $attributes = null ) : array	Creates a new place at the given latitude and longitude.
geoReverseGeoCode ( float $lat, float $long, string[optional] $accuracy = null, string[optional] $granularity = null, int[optional] $maxResults = null ) : array	Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.
geoSearch ( float[optional] $lat = null, float[optional] $long = null, string[optional] $query = null, string[optional] $ip = null, string[optional] $granularity = null, string[optional] $accuracy = null, int[optional] $maxResults = null, string[optional] $containedWithin = null, array $attributes = null ) : array	Search for places that can be attached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name, this request will return a list of all the valid places that can be used as the place_id when updating a status.
geoSimilarPlaces ( float $lat, float $long, string $name, string[optional] $containedWithin = null, array $attributes = null ) : array	Locates places near the given coordinates which are similar in name.
getTimeOut ( ) : integer	Get the timeout
getUserAgent ( ) : string	Get the useragent that will be used. Our version will be prepended to yours.
helpConfiguration ( ) : array	Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.
helpLanguages ( ) : array	Returns the list of languages supported by Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two letter value to use if you include lang with any of your requests.
helpPrivacy ( ) : array	Returns Twitter's Privacy Policy
helpTos ( ) : array	Returns the Twitter Terms of Service in the requested format. These are not the same as the Developer Rules of the Road.
listSubscriptions ( )	Not implemented yet
listsCreate ( )	Not implemented yet
listsDestroy ( )	Not implemented yet
listsList ( )	Not implemented yet
listsMembers ( )	Not implemented yet
listsMembersCreate ( )	Not implemented yet
listsMembersCreateAll ( )	Not implemented yet
listsMembersDestroy ( )	Not implemented yet
listsMembersDestroyAll ( )	Not implemented yet
listsMembersShow ( )	Not implemented yet
listsMemberships ( )	Not implemented yet
listsShow ( )	Not implemented yet
listsStatuses ( )	Not implemented yet
listsSubscribers ( )	Not implemented yet
listsSubscribersCreate ( )	Not implemented yet
listsSubscribersDestroy ( )	Not implemented yet
listsSubscribersShow ( )	Not implemented yet
listsUpdate ( )	Not implemented yet
oAuthAccessToken ( string $token, string $verifier ) : array	Allows a Consumer application to exchange the OAuth Request Token for an OAuth Access Token.
oAuthAuthenticate ( string $token, bool[optional] $force = false, string[optional] $screen_name = false )	Allows a Consumer application to use an OAuth request_token to request user authorization.
oAuthAuthorize ( string $token )	Will redirect to the page to authorize the applicatione
oAuthRequestToken ( string[optional] $callbackURL = null ) : array	Allows a Consumer application to obtain an OAuth Request Token to request user authorization.
reportSpam ( string[optional] $screenName = null, string[optional] $userId = null ) : array	The user specified in the id is blocked by the authenticated user and reported as a spammer.
savedSearchesCreate ( string $query ) : array	Create a new saved search for the authenticated user. A user may only have 25 saved searches.
savedSearchesDestroy ( string $id ) : array	Destroys a saved search for the authenticating user. The authenticating user must be the owner of saved search id being destroyed.
savedSearchesList ( ) : array	Returns the authenticated user's saved search queries.
savedSearchesShow ( string $id ) : array	Retrieve the information for the saved search represented by the given id. The authenticating user must be the owner of saved search ID being requested.
searchTweets ( string $q, string[optional] $geocode = null, string[optional] $lang = null, string[optional] $locale = null, string[optional] $resultType = null, int[optional] $count = null, string[optional] $until = null, string[optional] $sinceId = null, string[optional] $maxId = null, bool[optional] $includeEntities = null ) : array	Returns tweets that match a specified query.
setOAuthToken ( string $token )	Set the oAuth-token
setOAuthTokenSecret ( string $secret )	Set the oAuth-secret
setTimeOut ( integer $seconds )	Set the timeout
setUserAgent ( string $userAgent )	Get the useragent that will be used. Our version will be prepended to yours.
site ( )	Not implemented yet
statusesDestroy ( string $id, bool[optional] $trimUser = null ) : array	Destroys the status specified by the required ID parameter. The authenticating user must be the author of the specified status. Returns the destroyed status if successful.
statusesFilter ( )	Not implemented yet
statusesFirehose ( )	Not implemented yet
statusesHomeTimeline ( int[optional] $count = null, string[optional] $sinceId = null, string[optional] $maxId = null, bool[optional] $trimUser = null, bool[optional] $excludeReplies = null, bool[optional] $contributorDetails = null, bool[optional] $includeEntities = null ) : array	Returns the 20 most recent statuses, including retweets if they exist, posted by the authenticating user and the user's they follow. This is the same timeline seen by a user when they login to twitter.com.
statusesMentionsTimeline ( int[optional] $count = null, string[optional] $sinceId = null, string[optional] $maxId = null, bool[optional] $trimUser = null, bool[optional] $contributorDetails = null, bool[optional] $includeEntities = null ) : array	Returns the 20 most recent mentions (tweets containing a users's @screen_name) for the authenticating user.
statusesOEmbed ( string[optional] $id = null, string[optional] $url = null, int[optional] $maxwidth = null, bool[optional] $hideMedia = null, bool[optional] $hideThread = null, bool[optional] $omitScript = null, string[optional] $align = null, string[optional] $related = null, string[optional] $lang = null ) : array
statusesRetweet ( string $id, bool[optional] $trimUser = null ) : array	Retweets a tweet. Returns the original tweet with retweet details embedded.
statusesRetweets ( string $id, int[optional] $count = null, bool[optional] $trimUser = null ) : array	Returns up to 100 of the first retweets of a given tweet.
statusesRetweetsOfMe ( int[optional] $count = null, string[optional] $sinceId = null, string[optional] $maxId = null, bool[optional] $trimUser = null, bool[optional] $includeEntities = null, bool[optional] $includeUserEntities = null ) : array	Returns the most recent tweets authored by the authenticating user that have recently been retweeted by others. This timeline is a subset of the user's GET statuses/user_timeline.
statusesSample ( )	Not implemented yet
statusesShow ( string $id, bool[optional] $trimUser = null, bool[optional] $includeMyRetweet = null, bool[optional] $includeEntities = null ) : array	Returns a single Tweet, specified by the id parameter. The Tweet's author will also be embedded within the tweet.
statusesUpdate ( string $status, string[optional] $inReplyToStatusId = null, float[optional] $lat = null, float[optional] $long = null, string[optional] $placeId = null, bool[optional] $displayCoordinates = null, bool[optional] $trimUser = null ) : array	Updates the authenticating user's status. A status update with text identical to the authenticating user's text identical to the authenticating user's current status will be ignored to prevent duplicates.
statusesUpdateWithMedia ( )	Not implemented yet
statusesUserTimeline ( string[optional] $userId = null, string[optional] $screenName = null, string[optional] $sinceId = null, int[optional] $count = null, string[optional] $maxId = null, bool[optional] $trimUser = null, bool[optional] $excludeReplies = null, bool[optional] $contributorDetails = null, bool[optional] $includeRts = null ) : array	Returns a collection of the most recent Tweets posted by the user indicated by the screen_name or user_id parameters.
trendsAvailable ( float[optional] $lat = null, float[optional] $long = null ) : array	Returns the locations that Twitter has trending topic information for.
trendsClosest ( float[optional] $lat = null, float[optional] $long = null ) : array	Returns the locations that Twitter has trending topic information for, closest to a specified location.
trendsPlace ( string $id, string[optional] $exclude = null ) : array	Returns the top 10 trending topics for a specific WOEID, if trending information is available for it.
user ( )	Not implemented yet
usersContributees ( string[optional] $userId = null, string[optional] $screenName = null, bool[optional] $includeEntities = null, bool[optional] $skipStatus = null ) : array	Returns a collection of users that the specified user can "contribute" to.
usersContributors ( string[optional] $userId = null, string[optional] $screenName = null, bool[optional] $includeEntities = null, bool[optional] $skipStatus = null ) : array	Returns a collection of users who can contribute to the specified account.
usersLookup ( mixed[optional] $userIds = null, mixed[optional] $screenNames = null, bool[optional] $includeEntities = null ) : array	Returns fully-hydrated user objects for up to 100 users per request, as specified by comma-separated values passed to the user_id and/or screen_name parameters.
usersProfileBanner ( string[optional] $userId = null, string[optional] $screenName = null ) : array	Returns a map of the available size variations of the specified user's profile banner. If the user has not uploaded a profile banner, a HTTP 404 will be served instead.
usersSearch ( string $q, int[optional] $page = null, int[optional] $count = null, bool[optional] $includeEntities = null ) : array	Run a search for users similar to the Find People button on Twitter.com; the same results returned by people search on Twitter.com will be returned by using this API.
usersShow ( string[optional] $userId = null, string[optional] $screenName = null, bool[optional] $includeEntities = null ) : array	Returns a variety of information about the user specified by the required user_id or screen_name parameter.
usersSuggestions ( string[optional] $lang = null ) : array	Access to Twitter's suggested user list. This returns the list of suggested user categories. The category can be used in usersSuggestionsSlug to get the users in that category.
usersSuggestionsSlug ( string $slug, string[optional] $lang = null ) : array	Access the users in a given category of the Twitter suggested user list.
usersSuggestionsSlugMembers ( string $slug ) : array	Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.

Protected Methods

Method	Description
buildQuery ( array $parameters ) : string	Format the parameters as a querystring
calculateBaseString ( string $url, string $method, array $parameters ) : string	All OAuth 1.0 requests use the same basic algorithm for creating a signature base string and a signature. The signature base string is composed of the HTTP method being used, followed by an ampersand ("&") and then the URL-encoded base URL being accessed, complete with path (but not query parameters), followed by an ampersand ("&"). Then, you take all query parameters and POST body parameters (when the POST body is of the URL-encoded type, otherwise the POST body is ignored), including the OAuth parameters necessary for negotiation with the request at hand, and sort them in lexicographical order by first parameter name and then parameter value (for duplicate parameters), all the while ensuring that both the key and the value for each parameter are URL encoded in isolation. Instead of using the equals ("=") sign to mark the key/value relationship, you use the URL-encoded form of "%3D". Each parameter is then joined by the URL-escaped ampersand sign, "%26".
calculateHeader ( array $parameters, string $url ) : string	Build the Authorization header
doCall ( string $url, array $parameters = null, bool[optional] $authenticate = false, bool[optional] $method = 'GET', string[optional] $filePath = null, bool[optional] $expectJSON = true, bool[optional] $returnHeaders = false ) : string	Make the call
doOAuthCall ( string $method, array $parameters = null ) : array	Make an call to the oAuth
getConsumerKey ( ) : string	Get the consumer key
getConsumerSecret ( ) : string	Get the consumer secret
getOAuthToken ( ) : string	Get the oAuth-token
getOAuthTokenSecret ( ) : string	Get the oAuth-token-secret
hmacsha1 ( string $key, string $data ) : string	Build the signature for the data
setConsumerKey ( string $key )	Set the consumer key
setConsumerSecret ( string $secret )	Set the consumer secret
setReturnAsArray ( boolean $value )	Set the response type
urlencode_rfc3986 ( mixed $value ) : string	URL-encode method for internal use

Method Details

Property Details