Repositories
扩展自 AbstractPackageJoomla 框架的 GitHub API 活动类。
| 自 |
1.0 |
|---|---|
| 文档 |
http://developer.github.com/v3/repos |
| 属性读取 Branches |
GitHub API 对象，用于分支。 GitHub API 对象，用于协作者。 GitHub API 对象，用于评论。 GitHub API 对象，用于提交。 GitHub API 对象，用于内容。 GitHub API 对象，用于部署。 GitHub API 对象，用于下载。 GitHub API 对象，用于 fork。 GitHub API 对象，用于钩子。 GitHub API 对象，用于密钥。 GitHub API 对象，用于合并。 GitHub API 对象，用于页面。 GitHub API 对象，用于版本。 GitHub API 对象，用于统计数据。 GitHub API 对象，用于状态。 |
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
用于延迟创建 API 对象的魔法方法
__get( name) : \Joomla\Github\AbstractPackage
create
创建。
create( name, org = '', description = '', homepage = '', private = false, hasIssues = false, hasWiki = false, hasDownloads = false, teamId, autoInit = false, gitignoreTemplate = '') :
为经过身份验证的用户或组织创建新的存储库。OAuth 用户必须提供 repo 范围。
| 自 |
1.0 |
|---|
参数
- name
string存储库名称。- org
string组织名称（如果需要）。- description
string存储库描述。- homepage
string存储库主页。- private
bool设置为 true 以创建私有存储库，设置为 false 以创建公共存储库。创建私有存储库需要付费的 GitHub 帐户。- hasIssues
bool设置为 true 以为此存储库启用问题，设置为 false 以禁用问题。- hasWiki
bool设置为 true 以为此存储库启用 wiki，设置为 false 以禁用 wiki。- hasDownloads
bool设置为 true 以为此存储库启用下载，设置为 false 以禁用下载。- teamId
int将被授予对该存储库访问权限的团队的 ID。这仅在组织中创建存储库时有效。- autoInit
bool设置为 true 以使用空的 README 创建初始提交。- gitignoreTemplate
string要应用的所需语言或平台 .gitignore 模板。使用模板名称，不带扩展名。例如，“Haskell” 如果未提供 auto_init 参数，则被忽略。
响应
object
delete
删除存储库。
delete( owner, repo) :
删除存储库需要管理员访问权限。如果使用 OAuth，则需要 delete_repo 范围。
| 自 |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
object
edit
编辑。
edit( owner, repo, name, description = '', homepage = '', private = false, hasIssues = false, hasWiki = false, hasDownloads = false, defaultBranch = '') :
| 自 |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。- name
string存储库名称。- description
string存储库描述。- homepage
string存储库主页。- private
bool设置为 true 以创建私有存储库，设置为 false 以创建公共存储库。创建私有存储库需要付费的 GitHub 帐户。- hasIssues
bool设置为 true 以为此存储库启用问题，设置为 false 以禁用问题。- hasWiki
bool设置为 true 以为此存储库启用 wiki，设置为 false 以禁用 wiki。- hasDownloads
bool设置为 true 以为此存储库启用下载，设置为 false 以禁用下载。- defaultBranch
string更新该存储库的默认分支。
响应
object
fetchUrl
用于构建并返回请求的完整请求 URL 的方法。如果需要，此方法将添加适当的分页详细信息，并将 API url 添加到请求的完整 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取。
get( owner, repo) :
| 自 |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
object
getList
列出所有公共存储库。
getList( id) :
这提供了所有存储库的转储，按照创建它们的顺序。
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- id
int您看到的最后一个存储库的整数 ID。
响应
object
getListContributors
列出贡献者。
getListContributors( owner, repo, anon = false) :
| 自 |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。- anon
bool设置为 1 或 true 以在结果中包含匿名贡献者。
响应
object
getListLanguages
列出语言。
getListLanguages( owner, repo) :
列出指定存储库的语言。语言右侧的值是在该语言中编写的代码的字节数。
| 自 |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
object
getListOrg
列出组织存储库。
getListOrg( org, type = 'all') :
列出指定组织的存储库。
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- org
string组织的名称。- type
string排序类型。all、public、private、forks、sources、member。默认：all。
响应
object
getListOwn
列出您的存储库。
getListOwn( type = 'all', sort = 'full_name', direction = '') :
列出经过身份验证用户的存储库。
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- type
string排序类型。all、owner、public、private、member。默认：all。- sort
string排序字段。created、updated、pushed、full_name，默认：full_name。- direction
string排序方向。asc 或 desc，默认：使用 full_name 时为 asc，否则为 desc。
响应
object
getListTags
列出标签。
getListTags( owner, repo) :
| 自 |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
object
getListTeams
列出团队
getListTeams( owner, repo) :
| 自 |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
object
getListUser
列出用户存储库。
getListUser( user, type = 'all', sort = 'full_name', direction = '') :
列出指定用户的公共存储库。
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- user
string用户名。- type
string排序类型。all、owner、member。默认：all。- sort
string排序字段。created、updated、pushed、full_name，默认：full_name。- direction
string排序方向。asc 或 desc，默认：使用 full_name 时为 asc，否则为 desc。
响应
object
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
属性
branches
collaborators
comments
commits
contents
deployments
downloads
forks
hooks
keys
merging
pages
releases
statistics
statuses
包
对象所在的包
| 自 |
1.0 |
|---|
类型
string
hookEvents
包含允许的钩子事件的数组
| 自 |
1.5.2 |
|---|---|
| link | |
| note |
从 1.4.0 到 1.5.1，这被称为 $events，由于与包子类的命名冲突，它被重命名了 |
类型
array<string|int, mixed>