Référence de la classe JGithubStatuses

Graphe d'héritage de JGithubStatuses:

Graphe de collaboration de JGithubStatuses:

Liste de tous les membres

Fonctions membres publiques
	create ($user, $repo, $sha, $state, $targetUrl=null, $description=null)
	getList ($user, $repo, $sha)
Fonctions membres publiques inherited from JGithubObject
	__construct (JRegistry $options=null, JGithubHttp $client=null)

Additional Inherited Members
Fonctions membres protégées inherited from JGithubObject
	fetchUrl ($path, $page=0, $limit=0)
	processResponse (JHttpResponse $response, $expectedCode=200)
Attributs protégés inherited from JGithubObject
	$options
	$client

---

Description détaillée

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

---

Documentation des fonctions membres

JGithubStatuses::create	(		$user,
			$repo,
			$sha,
			$state,
			$targetUrl = null,
			$description = null
	)

Method to create a status.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$sha	The SHA1 value for which to set the status.
string	$state	The state (pending, success, error or failure).
string	$targetUrl	Optional target URL.
string	$description	Optional description for the status.

Renvoie:

object

Depuis:

12.3

Définition à la ligne 35 du fichier statuses.php.

        {
                // Build the request path.
                $path = '/repos/' . $user . '/' . $repo . '/statuses/' . $sha;

                if (!in_array($state, array('pending', 'success', 'error', 'failure')))
                {
                        throw new InvalidArgumentException('State must be one of pending, success, error or failure.');
                }

                // Build the request data.
                $data = array(
                        'state' => $state
                );

                if (!is_null($targetUrl))
                {
                        $data['target_url'] = $targetUrl;
                }

                if (!is_null($description))
                {
                        $data['description'] = $description;
                }

                // Send the request.
                $response = $this->client->post($this->fetchUrl($path), json_encode($data));

                // Validate the response code.
                if ($response->code != 201)
                {
                        // Decode the error response and throw an exception.
                        $error = json_decode($response->body);
                        throw new DomainException($error->message, $response->code);
                }

                return json_decode($response->body);
        }

JGithubStatuses::getList	(		$user,
			$repo,
			$sha
	)

Method to list statuses for an SHA.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$sha	SHA1 for which to get the statuses.

Renvoie:

array

Depuis:

12.3

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

        {
                // Build the request path.
                $path = '/repos/' . $user . '/' . $repo . '/statuses/' . $sha;

                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));

                // Validate the response code.
                if ($response->code != 200)
                {
                        // Decode the error response and throw an exception.
                        $error = json_decode($response->body);
                        throw new DomainException($error->message, $response->code);
                }

                return json_decode($response->body);
        }

---

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

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