Joomla! API

Extends AbstractPackage

GitHub API Activity class for the Joomla Framework.

since	1.0
documentation	http://developer.github.com/v3/repos
property-read Branches	GitHub API object for branches. GitHub API object for collaborators. GitHub API object for comments. GitHub API object for commits. GitHub API object for contents. GitHub API object for deployments. 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 pages. GitHub API object for releases. GitHub API object for statistics. GitHub API object for statuses.
package	Joomla Framework

Methods

Constructor.

__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :

inherited

since	1.0

Arguments

options: Registry|nullGitHub options object.
client: Http|nullThe HTTP client object.

Response

mixed

Magic method to lazily create API objects

__get( name) : \Joomla\Github\AbstractPackage

inherited

since	1.0
throws	`InvalidArgumentException`

Arguments

name: stringName of property to retrieve

Response

AbstractPackageGitHub API package object.

Create.

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

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

since	1.0

Arguments

name: stringThe repository name.
org: stringThe organization name (if needed).
description: stringThe repository description.
homepage: stringThe repository homepage.
private: boolSet true to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.
hasIssues: boolSet true to enable issues for this repository, false to disable them.
hasWiki: boolSet true to enable the wiki for this repository, false to disable it.
hasDownloads: boolSet true to enable downloads for this repository, false to disable them.
teamId: intThe id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.
autoInit: booltrue to create an initial commit with empty README.
gitignoreTemplate: stringDesired 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 a Repository.

delete( owner,  repo) :

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

since	1.0

Arguments

owner: stringRepository owner.
repo: stringRepository name.

Response

object

Edit.

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

since	1.0

Arguments

owner: stringRepository owner.
repo: stringRepository name.
name: stringThe repository name.
description: stringThe repository description.
homepage: stringThe repository homepage.
private: boolSet true to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.
hasIssues: boolSet true to enable issues for this repository, false to disable them.
hasWiki: boolSet true to enable the wiki for this repository, false to disable it.
hasDownloads: boolSet true to enable downloads for this repository, false to disable them.
defaultBranch: stringUpdate the default branch for this repository

Response

object

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( path,  page,  limit) : \Joomla\Uri\Uri

inherited

since	1.0

Arguments

path: stringURL to inflect
page: intPage to request
limit: intNumber of results to return per page

Response

Uri

Get.

get( owner,  repo) :

since	1.0

Arguments

owner: stringRepository owner.
repo: stringRepository name.

Response

object

List all public repositories.

getList( id) :

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

since	1.0
throws	`RuntimeException`

Arguments

id: intThe integer ID of the last Repository that you’ve seen.

Response

object

List contributors.

getListContributors( owner,  repo,  anon = false) :

since	1.0

Arguments

owner: stringRepository owner.
repo: stringRepository name.
anon: boolSet to 1 or true to include anonymous contributors in results.

Response

object

List languages.

getListLanguages( owner,  repo) :

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.

since	1.0

Arguments

owner: stringRepository owner.
repo: stringRepository name.

Response

object

List organization repositories.

getListOrg( org,  type = 'all') :

List repositories for the specified org.

since	1.0
throws	`RuntimeException`

Arguments

org: stringThe name of the organization.
type: stringSort type. all, public, private, forks, sources, member. Default: all.

Response

object

List your repositories.

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

List repositories for the authenticated user.

since	1.0
throws	`RuntimeException`

Arguments

type: stringSort type. all, owner, public, private, member. Default: all.
sort: stringSort field. created, updated, pushed, full_name, default: full_name.
direction: stringSort direction. asc or desc, default: when using full_name: asc, otherwise desc.

Response

object

List Tags.

getListTags( owner,  repo) :

since	1.0

Arguments

owner: stringRepository owner.
repo: stringRepository name.

Response

object

List Teams

getListTeams( owner,  repo) :

since	1.0

Arguments

owner: stringRepository owner.
repo: stringRepository name.

Response

object

List user repositories.

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

List public repositories for the specified user.

since	1.0
throws	`RuntimeException`

Arguments

user: stringThe user name.
type: stringSort type. all, owner, member. Default: all.
sort: stringSort field. created, updated, pushed, full_name, default: full_name.
direction: stringSort direction. asc or desc, default: when using full_name: asc, otherwise desc.

Response

object

Process the response and decode it.

processResponse(\Joomla\Http\Response response,  expectedCode = 200) :

inherited

since	1.0
throws	`UnexpectedResponseException`

Arguments

response: ResponseThe response.
expectedCode: intThe expected "good" code.

Response

mixed

Properties

GitHub API object for branches.

Type(s)

Branches

GitHub API object for collaborators.

Type(s)

Collaborators

GitHub API object for comments.

Type(s)

Comments

GitHub API object for commits.

Type(s)

Commits

GitHub API object for contents.

Type(s)

Contents

GitHub API object for deployments.

Type(s)

Deployments

GitHub API object for downloads.

Type(s)

Downloads

GitHub API object for forks.

Type(s)

Forks

GitHub API object for hooks.

Type(s)

Hooks

GitHub API object for keys.

Type(s)

Keys

GitHub API object for merging.

Type(s)

Merging

GitHub API object for pages.

Type(s)

Pages

GitHub API object for releases.

Type(s)

Releases

GitHub API object for statistics.

Type(s)

Statistics

GitHub API object for statuses.

Type(s)

Statuses

Options for the GitHub object.

inherited

since	1.0

Type(s)

Registry

The HTTP client object to use in sending HTTP requests.

inherited

since	1.0

Type(s)

Http

The package the object resides in

inherited

since	1.0

Type(s)

string

Array containing the allowed hook events

inherited

since	1.5.2
link
note	From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses

Type(s)

array<string|int, mixed>

Repositories

Methods

__construct

Arguments

Response

__get

Arguments

Response

create

Arguments

Response

delete

Arguments

Response

edit

Arguments

Response

fetchUrl

Arguments

Response

get

Arguments

Response

getList

Arguments

Response

getListContributors

Arguments

Response

getListLanguages

Arguments

Response

getListOrg

Arguments

Response

getListOwn

Arguments

Response

getListTags

Arguments

Response

getListTeams

Arguments

Response

getListUser

Arguments

Response

processResponse

Arguments

Response

Properties

branches

Type(s)

collaborators

Type(s)

comments

Type(s)

commits

Type(s)

contents

Type(s)

deployments

Type(s)

downloads

Type(s)

forks

Type(s)

hooks

Type(s)

keys

Type(s)

merging

Type(s)

pages

Type(s)

releases

Type(s)

statistics

Type(s)

statuses