Class JTwitterObject

Twitter API object class for the Joomla Platform.

Direct known subclasses

JTwitterBlock, JTwitterDirectmessages, JTwitterTrends, JTwitterUsers, JTwitterFavorites, JTwitterFriends, JTwitterHelp, JTwitterLists, JTwitterPlaces, JTwitterProfile, JTwittersearch, JTwitterStatuses

Abstract
Package: Joomla\Platform\Twitter
Deprecated: 4.0 Use the joomla/twitter package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/twitter/object.php

Methods summary

`public`	# `__construct( Joomla\Registry\Registry & $options = null, JHttp $client = null, JTwitterOAuth $oauth = null )` Constructor. Constructor. Parameters `$options` `Joomla\Registry\Registry` - &$options Twitter options object. `$client` `JHttp` - $client The HTTP client object. `$oauth` `JTwitterOAuth` - $oauth The OAuth client. Since 12.3
`public`	# `checkRateLimit( string $resource = null, string $action = null )` Method to check the rate limit for the requesting IP address Method to check the rate limit for the requesting IP address Parameters `$resource` `string` - $resource A resource or a comma-separated list of resource families you want to know the current rate limit disposition for. `$action` `string` - $action An action for the specified resource, if only one resource is specified. Throws `RuntimeException` Since 12.3
`public string`	# `fetchUrl( string $path, array $parameters = null )` 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. 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. Parameters `$path` `string` - $path URL to inflect `$parameters` `array` - $parameters The parameters passed in the URL. Returns `string` - The request URL. Since 12.3
`public array`	# `getRateLimit( string $resource )` Method to retrieve the rate limit for the requesting IP address Method to retrieve the rate limit for the requesting IP address Parameters `$resource` `string` - $resource A resource or a comma-separated list of resource families you want to know the current rate limit disposition for. Returns `array` - The JSON response decoded Since 12.3
`public array`	# `sendRequest( string $path, string $method = 'GET', mixed $data = array(), array $headers = array() )` Method to send the request. Method to send the request. Parameters `$path` `string` - $path The path of the request to make `$method` `string` - $method The request method. `$data` `mixed` - $data Either an associative array or a string to be sent with the post request. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`public mixed`	# `getOption( string $key )` Get an option from the JTwitterObject instance. Get an option from the JTwitterObject instance. Parameters `$key` `string` - $key The name of the option to get. Returns `mixed` - The option value. Since 12.3
`public JTwitterObject`	# `setOption( string $key, mixed $value )` Set an option for the JTwitterObject instance. Set an option for the JTwitterObject instance. Parameters `$key` `string` - $key The name of the option to set. `$value` `mixed` - $value The option value to set. Returns `JTwitterObject` - This object for method chaining. Since 12.3

Magic methods summary

Properties summary

`protected Joomla\Registry\Registry`	`$options`	# Options for the Twitter object. Options for the Twitter object. Since 12.3
`protected JHttp`	`$client`	# The HTTP client object to use in sending HTTP requests. The HTTP client object to use in sending HTTP requests. Since 12.3
`protected JTwitterOAuth`	`$oauth`	# The OAuth client. The OAuth client. Since 12.3

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JTwitterObject

Direct known subclasses

Methods summary

Parameters

Since

Parameters

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since