Trees

扩展自 AbstractPackage

Joomla 框架的 GitHub API 数据树类。

链接

1.0

Joomla 框架

方法

__construct

构造函数。

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

1.0

参数

options

Registry|nullGitHub 选项对象。

client

Http|nullHTTP 客户端对象。

响应

混合

__get

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

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

1.0

抛出

InvalidArgumentException

参数

name

string要检索的属性名称

响应

AbstractPackageGitHub API 包对象。

create

创建树。

create( owner,  repo, mixed||string|int tree,  baseTree = '') : 

树创建 API 也会采用嵌套条目。如果同时指定了树和修改该树的嵌套路径,它将用新的路径内容覆盖该树的内容,并写出一个新的树。

树的参数

tree.path 树中引用的文件的字符串 tree.mode 文件模式的字符串 - 文件为 100644(blob),可执行文件为 100755(blob),子目录为 040000(tree),子模块为 160000(commit)或符号链接路径的 blob 为 120000(blob) tree.type blob、tree、commit 的字符串 tree.sha 树中对象的 SHA1 校验和 ID 的字符串 tree.content 您希望此文件具有的内容的字符串 - GitHub 将写入此 blob 并使用该 SHA 作为此条目的 SHA。使用此项或 tree.sha

1.0

参数

owner

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

tree

array<string|int, mixed>指定树结构的哈希对象(路径、模式、类型和 sha)数组

baseTree

string您要使用新数据更新的树的 SHA1。

响应

object

fetchUrl

构建并返回请求的完整请求 URL 的方法。此方法将根据需要添加适当的分页详细信息,并将 API URL 放在前面以获得请求的完整 URL。

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

1.0

参数

path

string要变形的 URL

page

int要请求的页码

limit

int每页返回的结果数

响应

Uri

get

获取树

get( owner,  repo,  sha) : 

1.0

参数

owner

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

sha

string要设置引用的 SHA1 值。

响应

object

getRecursively

递归获取树

getRecursively( owner,  repo,  sha) : 

1.0

参数

owner

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

sha

string要设置引用的 SHA1 值。

响应

object

processResponse

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

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

1.0

抛出

UnexpectedResponseException

参数

response

Response响应。

expectedCode

int预期的“良好”代码。

响应

混合

属性

options

GitHub 对象的选项。

继承

1.0

类型

Registry

client

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

继承

1.0

类型

Http

对象所在的包

继承

1.0

类型

string

hookEvents

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

继承

1.5.2

链接
注意

从 1.4.0 到 1.5.1,此名称为 $events,由于与包子类的命名冲突,因此已重命名

类型

array<string|int, mixed>