Référence de la classe JGithubForks

Graphe d'héritage de JGithubForks:

Graphe de collaboration de JGithubForks:

Liste de tous les membres

Fonctions membres publiques
	create ($user, $repo, $org= '')
	getList ($user, $repo, $page=0, $limit=0)
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 forks.php.

---

Documentation des fonctions membres

JGithubForks::create	(		$user,
			$repo,
			$org = ''
	)

Method to fork a repository.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$org	The organization to fork the repo into. By default it is forked to the current user.

Renvoie:

object

Depuis:

11.4

Exceptions:

DomainException

Définition à la ligne 33 du fichier forks.php.

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

                if (strlen($org) > 0)
                {
                        $data = json_encode(
                                array('org' => $org)
                        );
                }
                else
                {
                        $data = json_encode(array());
                }

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

                // Validate the response code.
                if ($response->code != 202)
                {
                        // 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);
        }

JGithubForks::getList	(		$user,
			$repo,
			$page = 0,
			$limit = 0
	)

Method to list forks for a repository.

Paramètres:

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$page	Page to request
integer	$limit	Number of results to return per page

Renvoie:

array

Depuis:

11.4

Exceptions:

DomainException

Définition à la ligne 76 du fichier forks.php.

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

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

                // 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/forks.php