Joomla! API

下载
启动

Contents

扩展 AbstractPackage

Joomla 框架的 GitHub API 存储库内容类。

这些 API 方法允许您以 Base64 编码的内容检索存储库中文件的內容。有关请求原始或其他格式，请参阅媒体类型。

链接
自

1.0
包

Joomla 框架

方法

__construct

构造函数。

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

1.0

参数

选项

Registry|nullGitHub 选项对象。

客户端

Http|nullHTTP 客户端对象。

响应

混合

__get

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

__get( name) : \Joomla\Github\AbstractPackage
继承
自

1.0
抛出

InvalidArgumentException

参数

名称

string要检索的属性的名称

响应

AbstractPackageGitHub API 包对象。

create

创建一个文件。

create( owner,  repo,  path,  message,  content,  branch = 'master',  authorName = '',  authorEmail = '',  committerName = '',  committerEmail = '') :

此方法在存储库中创建一个新文件。

可选参数 作者部分是可选的，如果省略，将使用提交者信息填充。如果省略提交者信息，将使用经过身份验证的用户的身份信息。

您必须为名称和电子邮件提供值，无论您选择使用作者还是提交者。否则，您将收到 500 状态代码。

自

1.0
抛出

UnexpectedValueException

参数

所有者

string存储库的所有者。

回购

string存储库名称。

路径

string内容路径。

消息

string提交消息。

内容

string新文件内容，Base64 编码。

分支

string分支名称。如果未提供，将使用存储库的默认分支（通常为 master）。

作者姓名

string提交作者的姓名

作者电子邮件

string提交作者的电子邮件

提交者姓名

string提交提交者的姓名

提交者电子邮件

string提交提交者的电子邮件

响应

对象

delete

删除文件。

delete( owner,  repo,  path,  message,  sha,  branch = 'master',  authorName = '',  authorEmail = '',  committerName = '',  committerEmail = '') :

此方法删除存储库中的文件。

自

1.0
抛出

UnexpectedValueException

参数

所有者

string存储库的所有者。

回购

string存储库名称。

路径

string内容路径。

消息

string提交消息。

SHA

string要替换的文件的 Blob SHA。

分支

string分支名称。如果未提供，将使用存储库的默认分支（通常为 master）。

作者姓名

string提交作者的姓名

作者电子邮件

string提交作者的电子邮件

提交者姓名

string提交提交者的姓名

提交者电子邮件

string提交提交者的电子邮件

响应

对象

fetchUrl

用于构建和返回请求的完整请求 URL 的方法。此方法将根据需要添加适当的分页详细信息，并将 API URL 添加到前面，以使请求的完整 URL。

fetchUrl( path,  page,  limit) : \Joomla\Uri\Uri
继承
自

1.0

参数

路径

string要变形的 URL

页

int要请求的页码

限制

int每页返回的结果数

响应

URI

get

获取内容。

get( owner,  repo,  path,  ref = '') :

此方法返回存储库中任何文件或目录的内容。

自

1.0

参数

所有者

stringGitHub 存储库所有者的名称。

回购

stringGitHub 存储库的名称。

路径

string内容路径。

参考

string提交/分支/标签的字符串名称。默认为 master。

响应

对象

getArchiveLink

获取归档链接。

getArchiveLink( owner,  repo,  archiveFormat = 'zipball',  ref = '') :

此方法将返回 302 到一个 URL，用于下载存储库的 tarball 或 zipball 归档文件。请确保您的 HTTP 框架配置为跟随重定向，否则您需要使用 Location 标头发出第二个 GET 请求。

注意：对于私有存储库，这些链接是临时的，并且会很快过期。

要使用 curl 跟踪重定向，请使用 -L 开关：curl -L https://api.github.com/repos/pengwynn/octokit/tarball > octokit.tar.gz

自

1.0
抛出

UnexpectedValueException

参数

所有者

stringGitHub 存储库所有者的名称。

回购

stringGitHub 存储库的名称。

归档格式

stringtarball 或 zipball。

参考

string提交/分支/标签的字符串名称。默认为 master。

响应

对象

getReadme

获取自述文件。

getReadme( owner,  repo,  ref = '') :

此方法返回存储库的首选自述文件。

自

1.0
抛出

UnexpectedValueException

参数

所有者

stringGitHub 存储库所有者的名称。

回购

stringGitHub 存储库的名称。

参考

string提交/分支/标签的字符串名称。默认为 master。

响应

对象

processResponse

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

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

1.0
抛出

UnexpectedResponseException

参数

响应

Response响应。

预期代码

int预期“良好”代码。

响应

混合

update

更新文件。

update( owner,  repo,  path,  message,  content,  sha,  branch = 'master',  authorName = '',  authorEmail = '',  committerName = '',  committerEmail = '') :

此方法更新存储库中的文件。

可选参数 作者部分是可选的，如果省略，将使用提交者信息填充。如果省略提交者信息，将使用经过身份验证的用户的身份信息。

您必须为名称和电子邮件提供值，无论您选择使用作者还是提交者。否则，您将收到 500 状态代码。

自

1.0
抛出

UnexpectedValueException

参数

所有者

string存储库的所有者。

回购

string存储库名称。

路径

string内容路径。

消息

string提交消息。

内容

string新文件内容，Base64 编码。

SHA

string要替换的文件的 Blob SHA。

分支

string分支名称。如果未提供，将使用存储库的默认分支（通常为 master）。

作者姓名

string提交作者的姓名

作者电子邮件

string提交作者的电子邮件

提交者姓名

string提交提交者的姓名

提交者电子邮件

string提交提交者的电子邮件

响应

对象

属性

选项

GitHub 对象的选项。

继承
自

1.0

类型

注册表

客户端

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

继承
自

1.0

类型

Http

包

对象所在的包

继承
自

1.0

类型

字符串

hookEvents

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

继承
自

1.5.2
链接
注意

从 1.4.0 到 1.5.1，它被称为 $events，由于与包子类的命名冲突，它被重命名了

类型

array<string|int, mixed>
  • \ Joomla
  • \ Github
  • \ 包
  • \ 存储库
  • \ Contents