Class JGithubPackageRepositories

GitHub API Activity class for the Joomla Platform.

JGithubPackageRepositories

Package: Joomla\Platform\GitHub
Deprecated: 4.0 Use the joomla/github package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 3.3 (CMS)
Documentation: https://developer.github.com/v3/repos
Located at joomla/github/package/repositories.php

Methods summary

`public object`	# `getListOwn( string $type = 'all', string $sort = 'full_name', string $direction = '' )` List your repositories. List your repositories. List repositories for the authenticated user. Parameters `$type` `string` - $type Sort type. all, owner, public, private, member. Default: all. `$sort` `string` - $sort Sort field. created, updated, pushed, full_name, default: full_name. `$direction` `string` - $direction Sort direction. asc or desc, default: when using full_name: asc, otherwise desc. Returns `object` Throws `RuntimeException`
`public object`	# `getListUser( string $user, string $type = 'all', string $sort = 'full_name', string $direction = '' )` List user repositories. List user repositories. List public repositories for the specified user. Parameters `$user` `string` - $user The user name. `$type` `string` - $type Sort type. all, owner, member. Default: all. `$sort` `string` - $sort Sort field. created, updated, pushed, full_name, default: full_name. `$direction` `string` - $direction Sort direction. asc or desc, default: when using full_name: asc, otherwise desc. Returns `object` Throws `RuntimeException`
`public object`	# `getListOrg( string $org, string $type = 'all' )` List organization repositories. List organization repositories. List repositories for the specified org. Parameters `$org` `string` - $org The name of the organization. `$type` `string` - $type Sort type. all, public, private, forks, sources, member. Default: all. Returns `object` Throws `RuntimeException`
`public object`	# `getList( integer $id = 0 )` List all repositories. List all repositories. This provides a dump of every repository, in the order that they were created. Parameters `$id` `integer` - $id The integer ID of the last Repository that you’ve seen. Returns `object` Throws `RuntimeException`
`public object`	# `create( string $name, string $org = '', string $description = '', string $homepage = '', boolean $private = false, boolean $has_issues = false, boolean $has_wiki = false, boolean $has_downloads = false, integer $team_id = 0, boolean $auto_init = false, string $gitignore_template = '' )` Create a new repository for the authenticated user or an organization. OAuth users must supply repo scope. Create a new repository for the authenticated user or an organization. OAuth users must supply repo scope. Parameters `$name` `string` - $name The repository name. `$org` `string` - $org The organization name (if needed). `$description` `string` - $description The repository description. `$homepage` `string` - $homepage The repository homepage. `$private` `boolean` - $private Set true to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. `$has_issues` `boolean` - $has_issues Set true to enable issues for this repository, false to disable them. `$has_wiki` `boolean` - $has_wiki Set true to enable the wiki for this repository, false to disable it. `$has_downloads` `boolean` - $has_downloads Set true to enable downloads for this repository, false to disable them. `$team_id` `integer` - $team_id The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization. `$auto_init` `boolean` - $auto_init true to create an initial commit with empty README. `$gitignore_template` `string` - $gitignore_template Desired 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. Returns `object`
`public object`	# `get( string $owner, string $repo )` Get a repository. Get a repository. Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. Returns `object`
`public object`	# `edit( string $owner, string $repo, string $name, string $description = '', string $homepage = '', boolean $private = false, boolean $has_issues = false, boolean $has_wiki = false, boolean $has_downloads = false, string $default_branch = '' )` Edit a repository. Edit a repository. Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. `$name` `string` - $name The repository name. `$description` `string` - $description The repository description. `$homepage` `string` - $homepage The repository homepage. `$private` `boolean` - $private Set true to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. `$has_issues` `boolean` - $has_issues Set true to enable issues for this repository, false to disable them. `$has_wiki` `boolean` - $has_wiki Set true to enable the wiki for this repository, false to disable it. `$has_downloads` `boolean` - $has_downloads Set true to enable downloads for this repository, false to disable them. `$default_branch` `string` - $default_branch Update the default branch for this repository Returns `object`
`public object`	# `getListContributors( string $owner, string $repo, boolean $anon = false )` List contributors. List contributors. Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. `$anon` `boolean` - $anon Set to 1 or true to include anonymous contributors in results. Returns `object`
`public object`	# `getListLanguages( string $owner, string $repo )` List languages. 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. Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. Returns `object`
`public object`	# `getListTeams( string $owner, string $repo )` List Teams List Teams Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. Returns `object`
`public object`	# `getListTags( string $owner, string $repo )` List Tags. List Tags. Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. Returns `object`
`public object`	# `getListBranches( string $owner, string $repo )` List Branches. List Branches. Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. Returns `object`
`public object`	# `getBranch( string $owner, string $repo, string $branch )` Get a Branch. Get a Branch. Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. `$branch` `string` - $branch Branch name. Returns `object`
`public object`	# `delete( string $owner, string $repo )` Delete a Repository. Delete a Repository. Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required. Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. Returns `object`

Methods inherited from JGithubPackage

__get()

Methods inherited from JGithubObject

__construct(), fetchUrl(), processResponse()

Magic methods summary

Properties summary

`protected string`	`$name`	# Since 3.3 (CMS)
`protected array`	`$packages`	# Since 3.3 (CMS)

Properties inherited from JGithubObject

$client, $options

Magic properties

`public read-only JGithubPackageRepositoriesCollaborators`	`$collaborators`	# GitHub API object for collaborators. GitHub API object for collaborators.
`public read-only JGithubPackageRepositoriesComments`	`$comments`	# GitHub API object for comments. GitHub API object for comments.
`public read-only JGithubPackageRepositoriesCommits`	`$commits`	# GitHub API object for commits. GitHub API object for commits.
`public read-only JGithubPackageRepositoriesContents`	`$contents`	# GitHub API object for contents. GitHub API object for contents.
`public read-only JGithubPackageRepositoriesDownloads`	`$downloads`	# GitHub API object for downloads. GitHub API object for downloads.
`public read-only JGithubPackageRepositoriesForks`	`$forks`	# GitHub API object for forks. GitHub API object for forks.
`public read-only JGithubPackageRepositoriesHooks`	`$hooks`	# GitHub API object for hooks. GitHub API object for hooks.
`public read-only JGithubPackageRepositoriesKeys`	`$keys`	# GitHub API object for keys. GitHub API object for keys.
`public read-only JGithubPackageRepositoriesMerging`	`$merging`	# GitHub API object for merging. GitHub API object for merging.
`public read-only JGithubPackageRepositoriesStatuses`	`$statuses`	# GitHub API object for statuses. GitHub API object for statuses.

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubPackageRepositories

Methods summary

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from JGithubPackage

Methods inherited from JGithubObject

Magic methods summary

Properties summary

Since

Since

Properties inherited from JGithubObject

Magic properties