JTwitterBlock
Extends \JTwitterObjectTwitter API Block class for the Joomla Platform.
| since |
3.1.4 |
|---|---|
| deprecated |
4.0 Use the |
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry &$options = null, \JHttp $client = null, \JTwitterOAuth $oauth = null)
| since |
3.1.4 |
|---|
Arguments
- $options
- $client
\JHttpThe HTTP client object.- $oauth
\JTwitterOAuthThe OAuth client.
block
Method to block the specified user from following the authenticating user.
block(mixed $user, boolean $entities = null, boolean $skipStatus = null) : array
| since |
3.1.4 |
|---|---|
| throws |
|
Arguments
- $user
mixedEither an integer containing the user ID or a string containing the screen name.- $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.- $skipStatus
booleanWhen set to either true, t or 1 statuses will not be included in the returned user objects.
Response
arrayThe decoded JSON response
checkRateLimit
Method to check the rate limit for the requesting IP address
checkRateLimit(string $resource = null, string $action = null) : void
| since |
3.1.4 |
|---|---|
| throws |
|
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
| since |
3.1.4 |
|---|
Arguments
- $path
stringURL to inflect- $parameters
arrayThe parameters passed in the URL.
Response
stringThe request URL.
getBlocking
Method to get the user ids the authenticating user is blocking.
getBlocking(boolean $stringifyIds = null, integer $cursor = null) : array
| since |
3.1.4 |
|---|
Arguments
- $stringifyIds
booleanProvide this option to have ids returned as strings instead.- $cursor
integerCauses the list of IDs to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first "page."
Response
arrayThe decoded JSON response
getOption
Get an option from the JTwitterObject instance.
getOption(string $key) : mixed
| 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
| 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
sendRequest
Method to send the request.
sendRequest(string $path, string $method = 'GET', mixed $data = array(), array $headers = array()) : array
| since |
3.1.4 |
|---|---|
| throws |
|
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
| 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.
unblock
Method to unblock the specified user from following the authenticating user.
unblock(mixed $user, boolean $entities = null, boolean $skipStatus = null) : array
| since |
3.1.4 |
|---|---|
| throws |
|
Arguments
- $user
mixedEither an integer containing the user ID or a string containing the screen name.- $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.- $skipStatus
booleanWhen set to either true, t or 1 statuses will not be included in the returned user objects.
Response
arrayThe decoded JSON response
Properties
client
The HTTP client object to use in sending HTTP requests.
| since |
3.1.4 |
|---|
Type(s)
\JHttp