Joomla! API

Download
Launch

JTwitterUsers

Extends \JTwitterObject

Twitter API Users class for the Joomla Platform.

deprecated
since

3.1.4
deprecated

4.0 Use the joomla/twitter package via Composer instead
package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry &$options = null, \JHttp $client = null, \JTwitterOAuth $oauth = null)
inherited
since

3.1.4

Arguments

$options

\Joomla\Registry\Registry

$client

\JHttpThe HTTP client object.

$oauth

\JTwitterOAuthThe OAuth client.

checkRateLimit

Method to check the rate limit for the requesting IP address

checkRateLimit(string $resource = null, string $action = null) : void
inherited
since

3.1.4
throws

\RuntimeException

Arguments

$resource

stringA resource or a comma-separated list of resource families you want to know the current rate limit disposition for.

$action

stringAn action for the specified resource, if only one resource is specified.

fetchUrl

Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.

fetchUrl(string $path, array $parameters = null) : string
inherited
since

3.1.4

Arguments

$path

stringURL to inflect

$parameters

arrayThe parameters passed in the URL.

Response

stringThe request URL.

getContributees

Method to get an array of users that the specified user can contribute to.

getContributees(mixed $user, boolean $entities = null, boolean $skipStatus = null) : array
since

3.1.4
throws

\RuntimeException

Arguments

$user

mixedEither an integer containing the user ID or a string containing the screen name.

$entities

booleanSet to true to return IDs as strings, false to return as integers.

$skipStatus

booleanWhen set to either true, t or 1 statuses will not be included in the returned user objects.

Response

arrayThe decoded JSON response

getContributors

Method to get an array of users who can contribute to the specified account.

getContributors(mixed $user, boolean $entities = null, boolean $skipStatus = null) : array
since

3.1.4
throws

\RuntimeException

Arguments

$user

mixedEither an integer containing the user ID or a string containing the screen name.

$entities

booleanSet to true to return IDs as strings, false to return as integers.

$skipStatus

booleanWhen set to either true, t or 1 statuses will not be included in the returned user objects.

Response

arrayThe decoded JSON response

getOption

Get an option from the JTwitterObject instance.

getOption(string $key) : mixed
inherited
since

3.1.4

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

getRateLimit

Method to retrieve the rate limit for the requesting IP address

getRateLimit(string $resource) : array
inherited
since

3.1.4

Arguments

$resource

stringA resource or a comma-separated list of resource families you want to know the current rate limit disposition for.

Response

arrayThe JSON response decoded

getSuggestions

Method access to Twitter's suggested user list.

getSuggestions(boolean $lang = null) : array
since

3.1.4

Arguments

$lang

booleanRestricts the suggested categories to the requested language.

Response

arrayThe decoded JSON response

getSuggestionsSlug

method to access the users in a given category of the Twitter suggested user list.

getSuggestionsSlug(string $slug, boolean $lang = null) : array
since

3.1.4

Arguments

$slug

stringThe short name of list or a category.

$lang

booleanRestricts the suggested categories to the requested language.

Response

arrayThe decoded JSON response

getSuggestionsSlugMembers

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

getSuggestionsSlugMembers(string $slug) : array
since

3.1.4

Arguments

$slug

stringThe short name of list or a category.

Response

arrayThe decoded JSON response

getUser

Method to get extended information of a given user, specified by ID or screen name as per the required id parameter.

getUser(mixed $user, boolean $entities = null) : array
since

3.1.4
throws

\RuntimeException

Arguments

$user

mixedEither an integer containing the user ID or a string containing the screen name.

$entities

booleanSet to true to return IDs as strings, false to return as integers.

Response

arrayThe decoded JSON response

getUserProfileBanner

Method to access the profile banner in various sizes for the user with the indicated screen_name.

getUserProfileBanner(mixed $user) : array
since

3.1.4

Arguments

$user

mixedEither an integer containing the user ID or a string containing the screen name.

Response

arrayThe decoded JSON response

getUsersLookup

Method to get up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two.

getUsersLookup(string $screenName = null, string $id = null, boolean $entities = null) : array
since

3.1.4
throws

\RuntimeException

Arguments

$screenName

stringA comma separated list of screen names, up to 100 are allowed in a single request.

$id

stringA comma separated list of user IDs, up to 100 are allowed in a single request.

$entities

booleanWhen set to either true, t or 1, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.

Response

arrayThe decoded JSON response

searchUsers

Method used to search for users

searchUsers(string $query, integer $page, integer $count, boolean $entities = null) : array
since

3.1.4
throws

\RuntimeException

Arguments

$query

stringThe search query to run against people search.

$page

integerSpecifies the page of results to retrieve.

$count

integerThe number of people to retrieve. Maximum of 20 allowed per page.

$entities

booleanWhen set to either true, t or 1, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.

Response

arrayThe decoded JSON response

sendRequest

Method to send the request.

sendRequest(string $path, string $method = 'GET', mixed $data = array(), array $headers = array()) : array
inherited
since

3.1.4
throws

\RuntimeException

Arguments

$path

stringThe path of the request to make

$method

stringThe request method.

$data

mixedEither an associative array or a string to be sent with the post request.

$headers

arrayAn array of name-value pairs to include in the header of the request

Response

arrayThe decoded JSON response

setOption

Set an option for the JTwitterObject instance.

setOption(string $key, mixed $value) : \JTwitterObject
inherited
since

3.1.4

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\JTwitterObjectThis object for method chaining.

Properties

options

Options for the Twitter object.

inherited
since

3.1.4

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

3.1.4

Type(s)

\JHttp

oauth

The OAuth client.

inherited
since

3.1.4

Type(s)

\JTwitterOAuth
  • \ \
  • \ JTwitterUsers