Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JGithubPackageAuthorization
+ Graphe d'héritage de JGithubPackageAuthorization:

Fonctions membres publiques

 create (array $scopes=array(), $note='', $url='')
 
 delete ($id)
 
 edit ($id, array $scopes=array(), array $addScopes=array(), array $removeScopes=array(), $note='', $url='')
 
 get ($id)
 
 getList ()
 
 getRateLimit ()
 
 getAuthorizationLink ($clientId, $redirectUri='', $scope='', $state='')
 
 requestToken ($clientId, $clientSecret, $code, $redirectUri='', $format='')
 
- Fonctions membres publiques hérités de JGithubPackage
 __get ($name)
 
- Fonctions membres publiques hérités de JGithubObject
 __construct (Registry $options=null, JGithubHttp $client=null)
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JGithubObject
 fetchUrl ($path, $page=0, $limit=0)
 
 processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)
 
- Attributs protégés hérités de JGithubPackage
 $name = ''
 
 $packages = array()
 
- Attributs protégés hérités de JGithubObject
 $options
 
 $client
 

Description détaillée

GitHub API Authorization class for the Joomla Platform.

https://developer.github.com/v3/oauth/

Depuis
3.1.4
Obsolète:
4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

◆ create()

create ( array  $scopes = array(),
  $note = '',
  $url = '' 
)

Method to create an authorization.

Paramètres
array$scopesA list of scopes that this authorization is in.
string$noteA note to remind you what the OAuth token is for.
string$urlA URL to remind you what app the OAuth token is for.
Exceptions
DomainException
Depuis
3.1.4
Renvoie
object

Références $data, $path, $url, et json_encode.

◆ delete()

delete (   $id)

Method to delete an authorization

Paramètres
integer$idID of the authorization to delete
Exceptions
DomainException
Depuis
3.1.4
Renvoie
object

Références $id, et $path.

◆ edit()

edit (   $id,
array  $scopes = array(),
array  $addScopes = array(),
array  $removeScopes = array(),
  $note = '',
  $url = '' 
)

Method to edit an authorization.

Paramètres
integer$idID of the authorization to edit
array$scopesReplaces the authorization scopes with these.
array$addScopesA list of scopes to add to this authorization.
array$removeScopesA list of scopes to remove from this authorization.
string$noteA note to remind you what the OAuth token is for.
string$urlA URL to remind you what app the OAuth token is for.
Exceptions
RuntimeException
DomainException
Depuis
3.1.4
Renvoie
object

Références $data, $id, $path, $url, et json_encode.

◆ get()

get (   $id)

Method to get details about an authorised application for the authenticated user.

Paramètres
integer$idID of the authorization to retrieve
Exceptions
DomainException
Depuis
3.1.4
Note
This method will only accept Basic Authentication
Renvoie
object

Références $id, et $path.

◆ getAuthorizationLink()

getAuthorizationLink (   $clientId,
  $redirectUri = '',
  $scope = '',
  $state = '' 
)
  1. Request authorization on GitHub.
Paramètres
string$clientIdThe client ID you received from GitHub when you registered.
string$redirectUriURL in your app where users will be sent after authorization.
string$scopeComma separated list of scopes.
string$stateAn unguessable random string. It is used to protect against cross-site request forgery attacks.
Depuis
3.3 (CMS)
Renvoie
JUri

Références $clientId, $redirectUri, $state, et $uri.

◆ getList()

getList ( )

Method to get the authorised applications for the authenticated user.

Exceptions
DomainException
Depuis
3.1.4
Note
This method will only accept Basic Authentication
Renvoie
object

Références $path.

◆ getRateLimit()

getRateLimit ( )

Method to get the rate limit for the authenticated user.

Exceptions
DomainException
Depuis
3.1.4
Renvoie
object

Références $path.

◆ requestToken()

requestToken (   $clientId,
  $clientSecret,
  $code,
  $redirectUri = '',
  $format = '' 
)
  1. Request the access token.
Paramètres
string$clientIdThe client ID you received from GitHub when you registered.
string$clientSecretThe client secret you received from GitHub when you registered.
string$codeThe code you received as a response to Step 1.
string$redirectUriURL in your app where users will be sent after authorization.
string$formatThe response format (json, xml, ).
Exceptions
UnexpectedValueException
Depuis
3.3 (CMS)
Renvoie
string

Références $clientId, $data, $format, $redirectUri, $uri, et false.


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