JGithubPackageRepositories
Extends \JGithubPackageGitHub API Activity class for the Joomla Platform.
since |
3.3 |
---|---|
deprecated |
4.0 Use the |
documentation | |
property-read |
GitHub API object for collaborators. GitHub API object for comments. GitHub API object for commits. GitHub API object for contents. GitHub API object for downloads. GitHub API object for forks. GitHub API object for hooks. GitHub API object for keys. GitHub API object for merging. GitHub API object for statuses. |
package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null)
since |
1.7.3 |
---|
Arguments
- $options
\Joomla\Registry\Registry
GitHub options object.- $client
\JGithubHttp
The HTTP client object.
__get
Magic method to lazily create API objects
__get(string $name) : \JGithubPackage
since |
3.3 |
---|---|
throws |
|
Arguments
- $name
string
Name of property to retrieve
Response
\JGithubPackage
GitHub API package object.
create
Create a new repository for the authenticated user or an organization.
create(string $name, string $org = '', string $description = '', string $homepage = '', boolean $private = false, boolean $hasIssues = false, boolean $hasWiki = false, boolean $hasDownloads = false, integer $teamId, boolean $autoInit = false, string $gitignoreTemplate = '') : object
OAuth users must supply repo scope.
Arguments
- $name
string
The repository name.- $org
string
The organization name (if needed).- $description
string
The repository description.- $homepage
string
The repository homepage.- $private
boolean
Set true to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.- $hasIssues
boolean
Set true to enable issues for this repository, false to disable them.- $hasWiki
boolean
Set true to enable the wiki for this repository, false to disable it.- $hasDownloads
boolean
Set true to enable downloads for this repository, false to disable them.- $teamId
integer
The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.- $autoInit
boolean
true to create an initial commit with empty README.- $gitignoreTemplate
string
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.
Response
object
delete
Delete a Repository.
delete(string $owner, string $repo) : object
Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.
Response
object
edit
Edit a repository.
edit(string $owner, string $repo, string $name, string $description = '', string $homepage = '', boolean $private = false, boolean $hasIssues = false, boolean $hasWiki = false, boolean $hasDownloads = false, string $defaultBranch = '') : object
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.- $name
string
The repository name.- $description
string
The repository description.- $homepage
string
The repository homepage.- $private
boolean
Set true to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.- $hasIssues
boolean
Set true to enable issues for this repository, false to disable them.- $hasWiki
boolean
Set true to enable the wiki for this repository, false to disable it.- $hasDownloads
boolean
Set true to enable downloads for this repository, false to disable them.- $defaultBranch
string
Update the default branch for this repository
Response
object
fetchUrl
Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
fetchUrl(string $path, integer $page, integer $limit) : string
since |
1.7.3 |
---|
Arguments
- $path
string
URL to inflect- $page
integer
Page to request- $limit
integer
Number of results to return per page
Response
string
The request URL.
get
Get a repository.
get(string $owner, string $repo) : object
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.
Response
object
getBranch
Get a Branch.
getBranch(string $owner, string $repo, string $branch) : object
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.- $branch
string
Branch name.
Response
object
getList
List all repositories.
getList(integer $id) : object
This provides a dump of every repository, in the order that they were created.
throws |
|
---|
Arguments
- $id
integer
The integer ID of the last Repository that you’ve seen.
Response
object
getListBranches
List Branches.
getListBranches(string $owner, string $repo) : object
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.
Response
object
getListContributors
List contributors.
getListContributors(string $owner, string $repo, boolean $anon = false) : object
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.- $anon
boolean
Set to 1 or true to include anonymous contributors in results.
Response
object
getListLanguages
List languages.
getListLanguages(string $owner, string $repo) : object
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.
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.
Response
object
getListOrg
List organization repositories.
getListOrg(string $org, string $type = 'all') : object
List repositories for the specified org.
throws |
|
---|
Arguments
- $org
string
The name of the organization.- $type
string
Sort type. all, public, private, forks, sources, member. Default: all.
Response
object
getListOwn
List your repositories.
getListOwn(string $type = 'all', string $sort = 'full_name', string $direction = '') : object
List repositories for the authenticated user.
throws |
|
---|
Arguments
- $type
string
Sort type. all, owner, public, private, member. Default: all.- $sort
string
Sort field. created, updated, pushed, full_name, default: full_name.- $direction
string
Sort direction. asc or desc, default: when using full_name: asc, otherwise desc.
Response
object
getListTags
List Tags.
getListTags(string $owner, string $repo) : object
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.
Response
object
getListTeams
List Teams
getListTeams(string $owner, string $repo) : object
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.
Response
object
getListUser
List user repositories.
getListUser(string $user, string $type = 'all', string $sort = 'full_name', string $direction = '') : object
List public repositories for the specified user.
throws |
|
---|
Arguments
- $user
string
The user name.- $type
string
Sort type. all, owner, member. Default: all.- $sort
string
Sort field. created, updated, pushed, full_name, default: full_name.- $direction
string
Sort direction. asc or desc, default: when using full_name: asc, otherwise desc.
Response
object
processResponse
Process the response and decode it.
processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
throws |
|
---|---|
since |
3.3.0 |
Arguments
- $response
\JHttpResponse
The response.- $expectedCode
integer
The expected "good" code.- $decode
boolean
If the should be response be JSON decoded.
Response
mixed
Properties
name
since |
3.3 |
---|
Type(s)
string
packages
since |
3.3 |
---|
Type(s)
array
client
The HTTP client object to use in sending HTTP requests.
collaborators
GitHub API object for collaborators.
Type(s)
\JGithubPackageRepositoriesCollaborators
comments
GitHub API object for comments.
Type(s)
\JGithubPackageRepositoriesComments
commits
GitHub API object for commits.
Type(s)
\JGithubPackageRepositoriesCommits
contents
GitHub API object for contents.
Type(s)
\JGithubPackageRepositoriesContents
downloads
GitHub API object for downloads.
Type(s)
\JGithubPackageRepositoriesDownloads
forks
GitHub API object for forks.
Type(s)
\JGithubPackageRepositoriesForks
hooks
GitHub API object for hooks.
Type(s)
\JGithubPackageRepositoriesHooks
keys
GitHub API object for keys.
Type(s)
\JGithubPackageRepositoriesKeys
merging
GitHub API object for merging.
Type(s)
\JGithubPackageRepositoriesMerging
statuses
GitHub API object for statuses.
Type(s)
\JGithubPackageRepositoriesStatuses