Joomla! API

Download
Launch

JTwittersearch

Extends \JTwitterObject

Twitter API Search 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.

createSavedSearch

Method to create a new saved search for the authenticated user.

createSavedSearch(string $query) : array
since

3.1.4

Arguments

$query

stringThe query of the search the user would like to save.

Response

arrayThe decoded JSON response

deleteSavedSearch

Method to delete a saved search for the authenticating user.

deleteSavedSearch(integer $id) : array
since

3.1.4

Arguments

$id

integerThe ID of the saved search.

Response

arrayThe decoded JSON response

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.

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

getSavedSearches

Method to get the authenticated user's saved search queries.

getSavedSearches() : array
since

3.1.4

Response

arrayThe decoded JSON response

getSavedSearchesById

Method to get the information for the saved search represented by the given id.

getSavedSearchesById(integer $id) : array
since

3.1.4

Arguments

$id

integerThe ID of the saved search.

Response

arrayThe decoded JSON response

search

Method to get tweets that match a specified query.

search(string $query, string $callback = null, string $geocode = null, string $lang = null, string $locale = null, string $resultType = null, integer $count = 15, string $until = null, integer $sinceId, integer $maxId, boolean $entities = null) : array
since

3.1.4

Arguments

$query

stringSearch query. Should be URL encoded. Queries will be limited by complexity.

$callback

stringIf supplied, the response will use the JSONP format with a callback of the given name

$geocode

stringReturns tweets by users located within a given radius of the given latitude/longitude. The parameter value is specified by "latitude,longitude,radius", where radius units must be specified as either "mi" (miles) or "km" (kilometers).

$lang

stringRestricts tweets to the given language, given by an ISO 639-1 code.

$locale

stringSpecify the language of the query you are sending (only ja is currently effective). This is intended for language-specific clients and the default should work in the majority of cases.

$resultType

stringSpecifies what type of search results you would prefer to receive. The current default is "mixed."

$count

integerThe number of tweets to return per page, up to a maximum of 100. Defaults to 15.

$until

stringReturns tweets generated before the given date. Date should be formatted as YYYY-MM-DD.

$sinceId

integerReturns results with an ID greater than (that is, more recent than) the specified ID.

$maxId

integerReturns results with an ID less than (that is, older than) or equal to the specified ID.

$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 discrete structure, including: urls, media 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
  • \ \
  • \ JTwittersearch