jprodrigues70/laravel-ghass

使用 GitHub 作为文件服务器

0.2.0 2021-01-02 00:52 UTC

This package is auto-updated.

Last update: 2024-09-29 05:36:17 UTC


README

# GHASS

GHASS 是一个 PHP GitHub API 客户端,用于轻松管理 GitHub 仓库中的文件(私有或公共)。

入门指南

composer require jprodrigues70/laravel-ghass

配置 .env 文件

GHASS_REPO=organization/project
GHASS_TOKEN=yourgithubaccesstoken
GHASS_BRANCH=master

使用方法

<?php

$ghass = new \Ghass\Ghass();
$data = $ghass->file('index.html');
$ghass->delete('index.html', $data['sha']);

SHA

SHA 是一个代码,用于识别 GitHub 上的文件、文件夹等。它在 PUT、DELETE 和 GET 操作中极为必要。

如果您想使用 Ghass 来管理大于 1 兆字节的文件,您需要将每个文件的 sha 键存储在某种类型的数据库中。如果您要管理的文件大小不超过 1 兆字节,可以使用 Ghass 的 file 方法获取文件的 内容以及 sha。

文件

获取仓库中文件的内容。此方法支持大小不超过 1 兆字节的文件。

$ghass->file($path);

GET

获取仓库中文件的内容。响应中的内容始终是 Base64 编码的。此方法支持大小不超过 100 兆字节的文件。

$ghass->get($sha);

POST

在仓库中创建一个新文件。它需要 Base64 编码的数据。

$commitMessage 是可选的。

$ghass->post($path, $data, $commitMessage);

PUT

更新仓库中现有的文件。它需要 Base64 编码的数据。

PUT 无法重命名文件。如果您想重命名文件,需要删除旧文件并创建新文件。

$commitMessage 是可选的。

$ghass->put($path, $data, $sha, $commitMessage = '');

DELETE

删除仓库中的文件。

$commitMessage 是可选的。

$ghass->delete($path, $sah, $commitMessage = '');