Markdown

扩展 AbstractPackage

GitHub API Markdown 类。

链接

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 包对象。

fetchUrl

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

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

1.0

参数

路径

string要改变的 URL

int要请求的页码

限制

int每页返回的结果数量

响应

Uri

processResponse

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

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

1.0

抛出

UnexpectedResponseException

参数

响应

Response响应。

预期代码

int预期的“良好”代码。

响应

混合

render

呈现任意 Markdown 文档。

render( text,  mode = 'gfm',  context = null) : 

1.0

抛出

UnexpectedResponseException

InvalidArgumentException

参数

文本

string正在解析的文本对象。

模式

string解析模式;有效选项为“markdown”或“gfm”。

上下文

string可选的存储库上下文,仅在“gfm”模式下使用。

响应

string格式化的 HTML

属性

选项

GitHub 对象的选项。

继承

1.0

类型

Registry

客户端

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

继承

1.0

类型

Http

对象所在的包

继承

1.0

类型

字符串

hookEvents

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

继承

1.5.2

链接
注意

从 1.4.0 到 1.5.1,它被命名为 $events,它被重命名是因为与包子类的命名冲突

类型

array<string|int, mixed>