Référence de la classe JTwitter

Liste de tous les membres

Fonctions membres publiques
	__construct (JTwitterOAuth $oauth=null, JRegistry $options=null, JHttp $client=null)
	__get ($name)
	getOption ($key)
	setOption ($key, $value)

Attributs protégés
	$options
	$client
	$oauth
	$friends
	$users
	$help
	$statuses
	$search
	$favorites
	$directMessages
	$lists
	$places
	$trends
	$block
	$profile

---

Description détaillée

Définition à la ligne 19 du fichier twitter.php.

---

Documentation des constructeurs et destructeur

JTwitter::__construct	(	JTwitterOAuth	$oauth = null,
		JRegistry	$options = null,
		JHttp	$client = null
	)

Constructor.

Paramètres:

JTwitterOauth	$oauth	The oauth client.
JRegistry	$options	Twitter options object.
JHttp	$client	The HTTP client object.

Depuis:

12.3

Définition à la ligne 120 du fichier twitter.php.

        {
                $this->oauth = $oauth;
                $this->options = isset($options) ? $options : new JRegistry;
                $this->client  = isset($client) ? $client : new JHttp($this->options);

                // Setup the default API url if not already set.
                $this->options->def('api.url', 'https://api.twitter.com/1.1');
        }

---

Documentation des fonctions membres

JTwitter::__get

(

$name

)

Magic method to lazily create API objects

Paramètres:

string

$name

Name of property to retrieve

Renvoie:

JTwitterObject Twitter API object (statuses, users, favorites, etc.).

Depuis:

12.3

Exceptions:

InvalidArgumentException

Définition à la ligne 140 du fichier twitter.php.

        {
                $class = 'JTwitter' . ucfirst($name);

                if (class_exists($class))
                {
                        if (false == isset($this->$name))
                        {
                                $this->$name = new $class($this->options, $this->client, $this->oauth);
                        }

                        return $this->$name;
                }

                throw new InvalidArgumentException(sprintf('Argument %s produced an invalid class name: %s', $name, $class));
        }

JTwitter::getOption

(

$key

)

Get an option from the JTwitter instance.

Paramètres:

string

$key

The name of the option to get.

Renvoie:

mixed The option value.

Depuis:

12.3

Définition à la ligne 166 du fichier twitter.php.

        {
                return $this->options->get($key);
        }

JTwitter::setOption	(		$key,
			$value
	)

Set an option for the JTwitter instance.

Paramètres:

string	$key	The name of the option to set.
mixed	$value	The option value to set.

Renvoie:

JTwitter This object for method chaining.

Depuis:

12.3

Définition à la ligne 181 du fichier twitter.php.

        {
                $this->options->set($key, $value);

                return $this;
        }

---

Documentation des données membres

JTwitter::$block

protected

Définition à la ligne 103 du fichier twitter.php.

JTwitter::$client

protected

Définition à la ligne 31 du fichier twitter.php.

JTwitter::$directMessages

protected

Définition à la ligne 79 du fichier twitter.php.

JTwitter::$favorites

protected

Définition à la ligne 73 du fichier twitter.php.

JTwitter::$friends

protected

Définition à la ligne 43 du fichier twitter.php.

JTwitter::$help

protected

Définition à la ligne 55 du fichier twitter.php.

JTwitter::$lists

protected

Définition à la ligne 85 du fichier twitter.php.

JTwitter::$oauth

protected

Définition à la ligne 37 du fichier twitter.php.

JTwitter::$options

protected

Définition à la ligne 25 du fichier twitter.php.

JTwitter::$places

protected

Définition à la ligne 91 du fichier twitter.php.

JTwitter::$profile

protected

Définition à la ligne 109 du fichier twitter.php.

JTwitter::$search

protected

Définition à la ligne 67 du fichier twitter.php.

JTwitter::$statuses

protected

Définition à la ligne 61 du fichier twitter.php.

JTwitter::$trends

protected

Définition à la ligne 97 du fichier twitter.php.

JTwitter::$users

protected

Définition à la ligne 49 du fichier twitter.php.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• jplatform-13.1/joomla/twitter/twitter.php