Référence de la classe JGithub

Liste de tous les membres

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

Attributs protégés
	$options
	$client
	$gists
	$issues
	$pulls
	$refs
	$forks
	$commits
	$milestones
	$statuses
	$account
	$hooks
	$users
	$meta

---

Description détaillée

Définition à la ligne 32 du fichier github.php.

---

Documentation des constructeurs et destructeur

JGithub::__construct	(	JRegistry	$options = null,
		JGithubHttp	$client = null
	)

Constructor.

Paramètres:

JRegistry	$options	GitHub options object.
JGithubHttp	$client	The HTTP client object.

Depuis:

11.3

Définition à la ligne 126 du fichier github.php.

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

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

---

Documentation des fonctions membres

JGithub::__get

(

$name

)

Magic method to lazily create API objects

Paramètres:

string

$name

Name of property to retrieve

Renvoie:

JGithubObject GitHub API object (gists, issues, pulls, etc).

Depuis:

11.3

Exceptions:

InvalidArgumentException

Définition à la ligne 145 du fichier github.php.

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

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

                        return $this->$name;
                }

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

JGithub::getOption

(

$key

)

Get an option from the JGitHub instance.

Paramètres:

string

$key

The name of the option to get.

Renvoie:

mixed The option value.

Depuis:

11.3

Définition à la ligne 171 du fichier github.php.

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

JGithub::setOption	(		$key,
			$value
	)

Set an option for the JGitHub instance.

Paramètres:

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

Renvoie:

JGitHub This object for method chaining.

Depuis:

11.3

Définition à la ligne 186 du fichier github.php.

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

                return $this;
        }

---

Documentation des données membres

JGithub::$account

protected

Définition à la ligne 98 du fichier github.php.

JGithub::$client

protected

Définition à la ligne 44 du fichier github.php.

JGithub::$commits

protected

Définition à la ligne 80 du fichier github.php.

JGithub::$forks

protected

Définition à la ligne 74 du fichier github.php.

JGithub::$gists

protected

Définition à la ligne 50 du fichier github.php.

JGithub::$hooks

protected

Définition à la ligne 104 du fichier github.php.

JGithub::$issues

protected

Définition à la ligne 56 du fichier github.php.

JGithub::$meta

protected

Définition à la ligne 116 du fichier github.php.

JGithub::$milestones

protected

Définition à la ligne 86 du fichier github.php.

JGithub::$options

protected

Définition à la ligne 38 du fichier github.php.

JGithub::$pulls

protected

Définition à la ligne 62 du fichier github.php.

JGithub::$refs

protected

Définition à la ligne 68 du fichier github.php.

JGithub::$statuses

protected

Définition à la ligne 92 du fichier github.php.

JGithub::$users

protected

Définition à la ligne 110 du fichier github.php.

---

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

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