Joomla! 框架 3.x API » \Joomla\Github\Package\Issues\Labels

文档	http://developer.github.com/v3/issues/labels/
自	1.0
包	Joomla 框架

构造函数。

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

继承

自	1.0

参数

options: Registry|nullGitHub 选项对象。
client: Http|nullHTTP 客户端对象。

响应

混合

用于延迟创建 API 对象的魔术方法

__get( name) : \Joomla\Github\AbstractPackage

继承

自	1.0
抛出	`InvalidArgumentException`

参数

name: string要检索的属性名称

响应

AbstractPackageGitHub API 包对象。

将标签添加到问题中。

add( owner,  repo,  number, mixed||string|int labels) :

自	1.0

参数

owner: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。
number: string问题编号。
labels: array<string|int, mixed>要添加的标签数组。

响应

object

创建一个标签。

create( owner,  repo,  name,  color) :

自	1.0
抛出	`DomainException`

参数

owner: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。
name: string标签名称。
color: string标签颜色。

响应

object

删除标签。

delete( owner,  repo,  name) :

自	1.0

参数

owner: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。
name: string标签名称。

响应

object

用于构建并返回请求完整 URL 的方法。如果需要，此方法会添加适当的分页详细信息，并预先添加 API URL，以便为请求生成完整的 URL。

fetchUrl( path,  page,  limit) : \Joomla\Uri\Uri

继承

自	1.0

参数

path: string要变形的 URL
page: int要请求的页面
limit: int每页返回的结果数

响应

Uri

获取单个标签。

get( user,  repo,  name) :

自	1.0

参数

user: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。
name: string要获取的标签名称。

响应

object

列出此存储库的所有标签。

getList( owner,  repo) : mixed||string|int

自	1.0

参数

owner: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。

响应

array<string|int, mixed>

列出问题中的标签。

getListByIssue( owner,  repo,  number) :

自	1.0

参数

owner: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。
number: int问题编号。

响应

object

获取里程碑中每个问题的标签。

getListByMilestone( owner,  repo,  number) :

自	1.0

参数

owner: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。
number: string问题编号。

响应

object

处理响应并对其进行解码。

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

继承

自	1.0
抛出	`UnexpectedResponseException`

参数

response: Response响应。
expectedCode: int预期的“良好”代码。

响应

混合

从问题中删除所有标签。

removeAllFromIssue( owner,  repo,  number) :

自	1.0

参数

owner: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。
number: string问题编号。

响应

object

从问题中删除标签。

removeFromIssue( owner,  repo,  number,  name) :

自	1.0

参数

owner: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。
number: string问题编号。
name: string要删除的标签名称。

响应

object

替换问题的所有标签。

replace( owner,  repo,  number, mixed||string|int labels) :

发送空数组 ([]) 将从问题中删除所有标签。

自	1.0

参数

owner: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。
number: string问题编号。
labels: array<string|int, mixed>新标签

响应

object

更新标签。

update( user,  repo,  label,  name,  color) :

自	1.0

参数

user: stringGitHub 存储库所有者的名称。
repo: stringGitHub 存储库的名称。
label: string标签名称。
name: string新的标签名称。
color: string新的标签颜色。

响应

object

GitHub 对象的选项。

继承

自	1.0

类型

Registry

用于发送 HTTP 请求的 HTTP 客户端对象。

继承

自	1.0

类型

Http

对象所在的包

继承

自	1.0

类型

string

包含允许的挂钩事件的数组

继承

自	1.5.2
link
note	从 1.4.0 到 1.5.1，此命名为 $events，由于与包子类存在命名冲突，因此将其重命名

类型

array<string|int, mixed>

标签

方法

__construct

参数

响应

__get

参数

响应

add

参数

响应

create

参数

响应

delete

参数

响应

fetchUrl

参数

响应

get

参数

响应

getList

参数

响应

getListByIssue

参数

响应

getListByMilestone

参数

响应

processResponse

参数

响应

removeAllFromIssue

参数

响应

removeFromIssue

参数

响应

replace

参数

响应

update

参数

响应

属性

options

类型

client

类型

包

类型

hookEvents

类型