Statistics
扩展自 AbstractPackageJoomla 框架的 GitHub API 类。
存储库统计信息 API 允许您获取 GitHub 用于可视化不同类型存储库活动的数据。
| 链接 | |
|---|---|
| 自 |
1.0 |
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
魔术方法，用于延迟创建 API 对象
__get( name) : \Joomla\Github\AbstractPackage
fetchUrl
构建并返回请求的完整请求 URL 的方法。此方法将根据需要添加适当的分页详细信息，并将 API URL 添加到请求的开头，以形成完整的请求 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
getActivityData
获取过去一年的提交活动数据。
getActivityData( owner, repo) :
返回过去一年的提交活动，按周分组。days 数组是每天的提交组，从星期日开始。
| 自 |
1.0 |
|---|
参数
- 所有者
string存储库的所有者。- 存储库
string存储库名称。
响应
对象
getCodeFrequency
获取每周的添加和删除次数。
getCodeFrequency( owner, repo) :
响应返回每周对推送到存储库的添加和删除次数的汇总。
| 自 |
1.0 |
|---|
参数
- 所有者
string存储库的所有者。- 存储库
string存储库名称。
响应
对象
getListContributors
获取包含添加、删除和提交次数的贡献者列表。
getListContributors( owner, repo) :
响应包括：total - 贡献者创作的提交总数。
每周哈希
w - 星期开始 a - 添加数 d - 删除数 c - 提交数
| 自 |
1.0 |
|---|
参数
- 所有者
string存储库的所有者。- 存储库
string存储库名称。
响应
对象
getParticipation
获取存储库所有者和其他所有人的每周提交次数。
getParticipation( owner, repo) :
返回“所有者”的总提交次数和“所有”中的总提交次数。“所有”是所有人的组合，包括过去 52 周中的所有者。如果您想获取非所有者的提交次数，您可以从所有者中减去所有。
数组顺序是最早的星期（索引 0）到最新的星期。
| 自 |
1.0 |
|---|
参数
- 所有者
string存储库的所有者。- 存储库
string存储库名称。
响应
对象
getPunchCard
获取每天每小时的提交次数。
getPunchCard( owner, repo) :
响应每个数组包含日期号、小时数和提交次数
0-6：星期日 - 星期六 0-23：一天中的小时数 提交次数
例如，[2, 14, 25] 表示在星期二下午 2:00 有 25 个总提交次数。所有时间都基于各个提交的时间区域。
| 自 |
1.0 |
|---|
参数
- 所有者
string存储库的所有者。- 存储库
string存储库名称。
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
属性
包
对象所在的包
| 自 |
1.0 |
|---|
类型
字符串
hookEvents
包含允许的挂钩事件的数组
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 注意 |
从 1.4.0 到 1.5.1，此名称为 $events，由于与包子类的命名冲突，因此已重命名 |
类型
array<string|int, mixed>