Tags
扩展 AbstractPackageJoomla 框架的 GitHub API 数据标签类。
此标签 API 仅处理标签对象 - 因此仅处理带注释的标签，而不是轻量级标签。
| 链接 | |
|---|---|
| 自从 |
1.0 |
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
继承
__get
魔术方法，用于延迟创建 API 对象
__get( name) : \Joomla\Github\AbstractPackage
继承
create
创建标签对象
create( owner, repo, tag, message, object, type, taggerName, taggerEmail, taggerDate) :
请注意，创建标签对象不会创建在 Git 中创建标签的引用。如果您想在 Git 中创建带注释的标签，您必须调用此方法来创建标签对象，然后创建 refs/tags/[tag] 引用。如果您想创建轻量级标签，您只需创建引用 - 此调用将是不必要的。
| 自从 |
1.0 |
|---|
参数
- owner
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- tag
string标签字符串。- message
string标签消息。- object
string正在标记的 git 对象的 SHA。- type
string我们正在标记的对象的类型。通常这是一个提交，但它也可以是一个树或一个 blob。- taggerName
string标签作者的姓名。- taggerEmail
string标签作者的电子邮件。- taggerDate
string此对象被标记的时间戳。
响应
object
fetchUrl
用于构建并返回请求的完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API url 添加到前面，以便为请求提供完整的 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
继承
get
获取标签。
get( owner, repo, sha) :
| 自从 |
1.0 |
|---|
参数
- owner
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- sha
string要设置引用的 SHA1 值。
响应
object
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
继承
属性
包
对象所在的包
继承
| 自从 |
1.0 |
|---|
类型
string
hookEvents
包含允许的挂钩事件的数组
继承
| 自从 |
1.5.2 |
|---|---|
| 链接 | |
| note |
从 1.4.0 到 1.5.1，它被称为 $events，由于与包子类的命名冲突而被重命名 |
类型
array<string|int, mixed>