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 JGithubPackageRepositories
+ Graphe d'héritage de JGithubPackageRepositories:

Fonctions membres publiques

 getListOwn ($type='all', $sort='full_name', $direction='')
 
 getListUser ($user, $type='all', $sort='full_name', $direction='')
 
 getListOrg ($org, $type='all')
 
 getList ($id=0)
 
 create ($name, $org='', $description='', $homepage='', $private=false, $hasIssues=false, $hasWiki=false, $hasDownloads=false, $teamId=0, $autoInit=false, $gitignoreTemplate='')
 
 get ($owner, $repo)
 
 edit ($owner, $repo, $name, $description='', $homepage='', $private=false, $hasIssues=false, $hasWiki=false, $hasDownloads=false, $defaultBranch='')
 
 getListContributors ($owner, $repo, $anon=false)
 
 getListLanguages ($owner, $repo)
 
 getListTeams ($owner, $repo)
 
 getListTags ($owner, $repo)
 
 getListBranches ($owner, $repo)
 
 getBranch ($owner, $repo, $branch)
 
 delete ($owner, $repo)
 
- 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)
 

Attributs protégés

 $name = 'Repositories'
 
 $packages = array('collaborators', 'comments', 'commits', 'contents', 'downloads', 'forks', 'hooks', 'keys', 'merging', 'statuses')
 
- Attributs protégés hérités de JGithubPackage
 $name = ''
 
 $packages = array()
 
- Attributs protégés hérités de JGithubObject
 $options
 
 $client
 

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)
 

Documentation des fonctions membres

◆ create()

create (   $name,
  $org = '',
  $description = '',
  $homepage = '',
  $private = false,
  $hasIssues = false,
  $hasWiki = false,
  $hasDownloads = false,
  $teamId = 0,
  $autoInit = false,
  $gitignoreTemplate = '' 
)

Create a new repository for the authenticated user or an organization. OAuth users must supply repo scope.

Paramètres
string$nameThe repository name.
string$orgThe organization name (if needed).
string$descriptionThe repository description.
string$homepageThe repository homepage.
boolean$privateSet true to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.
boolean$hasIssuesSet true to enable issues for this repository, false to disable them.
boolean$hasWikiSet true to enable the wiki for this repository, false to disable it.
boolean$hasDownloadsSet true to enable downloads for this repository, false to disable them.
integer$teamIdThe id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.
boolean$autoInittrue to create an initial commit with empty README.
string$gitignoreTemplateDesired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, “Haskell” Ignored if auto_init parameter is not provided.
Renvoie
object

Références $data, $description, $name, $path, et json_encode.

◆ delete()

delete (   $owner,
  $repo 
)

Delete a Repository.

Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.

Paramètres
string$ownerRepository owner.
string$repoRepository name.
Renvoie
object

Références $path.

◆ edit()

edit (   $owner,
  $repo,
  $name,
  $description = '',
  $homepage = '',
  $private = false,
  $hasIssues = false,
  $hasWiki = false,
  $hasDownloads = false,
  $defaultBranch = '' 
)

Edit a repository.

Paramètres
string$ownerRepository owner.
string$repoRepository name.
string$nameThe repository name.
string$descriptionThe repository description.
string$homepageThe repository homepage.
boolean$privateSet true to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.
boolean$hasIssuesSet true to enable issues for this repository, false to disable them.
boolean$hasWikiSet true to enable the wiki for this repository, false to disable it.
boolean$hasDownloadsSet true to enable downloads for this repository, false to disable them.
string$defaultBranchUpdate the default branch for this repository
Renvoie
object

Références $data, $description, $name, $path, et json_encode.

◆ get()

get (   $owner,
  $repo 
)

Get a repository.

Paramètres
string$ownerRepository owner.
string$repoRepository name.
Renvoie
object

Références $path.

◆ getBranch()

getBranch (   $owner,
  $repo,
  $branch 
)

Get a Branch.

Paramètres
string$ownerRepository owner.
string$repoRepository name.
string$branchBranch name.
Renvoie
object

Références $path.

◆ getList()

getList (   $id = 0)

List all repositories.

This provides a dump of every repository, in the order that they were created.

Paramètres
integer$idThe integer ID of the last Repository that you’ve seen.
Exceptions
RuntimeException
Renvoie
object

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

◆ getListBranches()

getListBranches (   $owner,
  $repo 
)

List Branches.

Paramètres
string$ownerRepository owner.
string$repoRepository name.
Renvoie
object

Références $path.

◆ getListContributors()

getListContributors (   $owner,
  $repo,
  $anon = false 
)

List contributors.

Paramètres
string$ownerRepository owner.
string$repoRepository name.
boolean$anonSet to 1 or true to include anonymous contributors in results.
Renvoie
object

Références $path.

◆ getListLanguages()

getListLanguages (   $owner,
  $repo 
)

List languages.

List languages for the specified repository. The value on the right of a language is the number of bytes of code written in that language.

Paramètres
string$ownerRepository owner.
string$repoRepository name.
Renvoie
object

Références $path.

◆ getListOrg()

getListOrg (   $org,
  $type = 'all' 
)

List organization repositories.

List repositories for the specified org.

Paramètres
string$orgThe name of the organization.
string$typeSort type. all, public, private, forks, sources, member. Default: all.
Exceptions
RuntimeException
Renvoie
object

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

◆ getListOwn()

getListOwn (   $type = 'all',
  $sort = 'full_name',
  $direction = '' 
)

List your repositories.

List repositories for the authenticated user.

Paramètres
string$typeSort type. all, owner, public, private, member. Default: all.
string$sortSort field. created, updated, pushed, full_name, default: full_name.
string$directionSort direction. asc or desc, default: when using full_name: asc, otherwise desc.
Exceptions
RuntimeException
Renvoie
object

Références $direction, $path, et $type.

◆ getListTags()

getListTags (   $owner,
  $repo 
)

List Tags.

Paramètres
string$ownerRepository owner.
string$repoRepository name.
Renvoie
object

Références $path.

◆ getListTeams()

getListTeams (   $owner,
  $repo 
)

List Teams

Paramètres
string$ownerRepository owner.
string$repoRepository name.
Renvoie
object

Références $path.

◆ getListUser()

getListUser (   $user,
  $type = 'all',
  $sort = 'full_name',
  $direction = '' 
)

List user repositories.

List public repositories for the specified user.

Paramètres
string$userThe user name.
string$typeSort type. all, owner, member. Default: all.
string$sortSort field. created, updated, pushed, full_name, default: full_name.
string$directionSort direction. asc or desc, default: when using full_name: asc, otherwise desc.
Exceptions
RuntimeException
Renvoie
object

Références $direction, $path, $type, et $user.

Documentation des champs

◆ $name

$name = 'Repositories'
protected

◆ $packages

$packages = array('collaborators', 'comments', 'commits', 'contents', 'downloads', 'forks', 'hooks', 'keys', 'merging', 'statuses')
protected

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