下载
扩展 AbstractPackageJoomla 框架的 GitHub API 存储库下载类。
下载 API 仅用于软件包下载。如果您想获取源代码包，您应该使用 http://developer.github.com/v3/repos/contents/#get-archive-link 代替。
| 文档 |
https://developer.github.com/v3/repos/downloads |
|---|---|
| 自 |
1.0 |
| 已弃用 |
应该使用 Releases API 代替 |
| 软件包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
用于延迟创建 API 对象的魔法方法
__get( name) : \Joomla\Github\AbstractPackage
create
创建新的下载（第 1 部分：创建资源）。
create( owner, repo, name, size, description = '', contentType = '') :
创建新的下载是一个两步过程。您必须首先创建一个新的下载资源。
| 注意 |
此 API 端点不再存在于 GitHub |
|---|---|
| 自 |
1.0 |
| 抛出 |
|
| 已弃用 |
应该使用 Releases API 代替 |
参数
- owner
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- name
string名称。- size
string文件大小（以字节为单位）。- description
string描述。- contentType
string内容类型。
响应
void
delete
删除下载。
delete( owner, repo, id) :
| 自 |
1.0 |
|---|---|
| 已弃用 |
应该使用 Releases API 代替 |
参数
- owner
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- id
int下载的 ID。
响应
对象
fetchUrl
用于构建并返回完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API URL 添加到前面以获得完整的请求 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取单个下载。
get( owner, repo, id) :
| 自 |
1.0 |
|---|---|
| 已弃用 |
应该使用 Releases API 代替 |
参数
- owner
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- id
int下载的 ID。
响应
对象
getList
列出存储库的下载。
getList( owner, repo) :
| 自 |
1.0 |
|---|---|
| 已弃用 |
应该使用 Releases API 代替 |
参数
- owner
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
upload
创建新的下载（第 2 部分：将文件上传到 s3）。
upload( key, acl, successActionStatus, filename, awsAccessKeyId, policy, signature, contentType, file) :
现在您已创建下载资源，您可以使用响应中的信息将文件上传到 s3。这可以使用 POST 到您在创建响应中获得的 s3_url 来完成。以下是一个使用 curl 的简要示例
curl
-F "key=downloads/octocat/Hello-World/new_file.jpg"
-F "acl=public-read"
-F "success_action_status=201"
-F "Filename=new_file.jpg"
-F "AWSAccessKeyId=1ABCDEF..."
-F "Policy=ewogIC..."
-F "Signature=mwnF..."
-F "Content-Type=image/jpeg"
-F "file=@new_file.jpg"
https://github.s3.amazonaws.com/
注意传递这些字段的顺序很重要！请严格按照上面显示的顺序进行操作。所有显示的参数都是必需的，如果您排除或修改它们，您的上传将失败，因为这些值是通过策略进行哈希和签名的。
有关使用 REST API 与 s3 交互的更多信息，请访问以下网站：http://docs.amazonwebservices.com/AmazonS3/latest/API/
| 注意 |
此 API 端点不再存在于 GitHub |
|---|---|
| 自 |
1.0 |
| 抛出 |
|
| 已弃用 |
应该使用 Releases API 代替 |
参数
- key
string响应中 path 字段的值。- acl
string响应中 acl 字段的值。- successActionStatus
string201，或您想要返回的内容。- filename
string响应中 name 字段的值。- awsAccessKeyId
string响应中 accesskeyid 字段的值。- policy
string响应中 policy 字段的值。- signature
string响应中 signature 字段的值。- contentType
string响应中 mime_type 字段的值。- file
string本地文件。示例假定文件存在于您运行 curl 命令的目录中。是的，@ 很重要。
响应
void
属性
软件包
对象所在的软件包
| 自 |
1.0 |
|---|
类型
string
hookEvents
包含允许的钩子事件的数组
| 自 |
1.5.2 |
|---|---|
| link | |
| 注意 |
从 1.4.0 到 1.5.1，它被称为 $events，由于与软件包子类的命名冲突，它被重命名了 |
类型
array<string|int, mixed>