PHP code example of yeh110 / php-s3-lite

1. Go to this page and download the library: Download yeh110/php-s3-lite library. Choose the download type require.

2. Extract the ZIP file and open the index.php.

3. Add this code to the index.php.
    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

yeh110 / php-s3-lite example snippets



// 方式一:直接用自带自动加载(无需 Composer)
\S3Lite\ → src/)
// composer 


yeh110\S3Lite\S3Client;
use yeh110\S3Lite\S3Config;

$s3 = new S3Client(new S3Config(
    endpoint:  'https://s3.youdomain.com',
    accessKey: '你的AK',
    secretKey: '你的SK',
    // region: 'us-east-1',   // 默认值,服务端要求其他区域会自动纠偏
));

// 上传
$s3->put('ydrcm', 'docs/readme.txt', '你好', ['contentType' => 'text/plain; charset=utf-8']);

// 生成 1 小时有效的预览链接,交给前端或第三方
echo $s3->previewUrl('ydrcm', 'docs/readme.txt', 3600);

// 生成 10 分钟有效的直传地址,前端拿它直接 PUT
echo $s3->presignPut('ydrcm', 'uploads/a.jpg', 600);

$s3 = new S3Client(S3Config::fromArray([
    'endpoint'  => getenv('S3_ENDPOINT'),
    'accessKey' => getenv('S3_AK'),
    'secretKey' => getenv('S3_SK'),
]));

// 字符串
$s3->put('bucket', 'a.txt', '内容', [
    'contentType' => 'text/plain; charset=utf-8',
    'metadata'    => ['biz-id' => '1001'],   // 存为 x-amz-meta-biz-id
    'cacheControl' => 'public, max-age=300',
]);

// 本地文件(超过 multipartThreshold 自动分片)
$s3->putFile('bucket', 'a.zip', '/data/a.zip');

// 流(必须给出长度:S3 不支持 chunked 上传)
$fh = fopen('/data/a.bin', 'rb');
$s3->putStream('bucket', 'a.bin', $fh, filesize('/data/a.bin'));
fclose($fh);

// 显式分片,自定义分片大小(最小 5MiB)
$s3->multipartUpload('bucket', 'big.bin', '/data/big.bin', ['partSize' => 8 * 1024 * 1024]);

// 自动分派:字符串内容 / 本地路径 / URL / 资源
$s3->upload('bucket', 'key', $任意来源);

// 取到内存
$body = $s3->get('bucket', 'a.txt')->body;

// 落到本地文件(流式,不占内存)
$bytes = $s3->getToFile('bucket', 'big.zip', '/data/big.zip');

// 分段下载(断点续传、只取文件头尾)
$part = $s3->get('bucket', 'big.zip', ['range' => 'bytes=0-1023']);
$s3->getToFile('bucket', 'big.zip', '/data/part', ['range' => 'bytes=1048576-']);

// 服务端代理输出(Web 环境:浏览器直接看到内容 / 触发下载)
$s3->preview('private-bucket', 'a.pdf', ['filename' => '报告.pdf', 'passthroughRange' => true]);
$s3->download('private-bucket', 'a.zip', ['filename' => '归档.zip']);

$s3->presignGet('bucket', 'a.jpg', 3600);                    // 预览/读取
$s3->presignPut('bucket', 'uploads/a.jpg', 600);             // 直传
$s3->presignDelete('bucket', 'a.jpg', 600);                  // 让客户端删
$s3->presignUrl('GET', 'bucket', 'a.jpg', 3600, [            // 自定义查询参数
    'query' => ['response-cache-control' => 'no-cache'],
]);

$s3->previewUrl('bucket', 'a.txt', 3600, '季度 报告.txt');    // 内联打开,指定显示名
$s3->downloadUrl('bucket', 'a.txt', 3600, '季度 报告.txt');   // 点击即下载
$s3->publicUrl('bucket', 'a.jpg');                           // 公开桶直链(无签名)

// 抓取并转存,自动记录来源到 x-amz-meta-source-url
$s3->putFromUrl('bucket', 'avatar.jpg', 'https://example.com/a.jpg', [
    'maxBytes' => 20 * 1024 * 1024,                          // 超限直接中止
    'headers'  => ['Referer' => 'https://example.com/'],     // 需要防盗链的源站
    'metadata' => ['biz' => 'avatar'],
]);

// 只抓取到本地
$info = $s3->fetchToFile('https://example.com/a.jpg', '/tmp/a.jpg');
// ['bytes' => 32797, 'contentType' => 'image/jpeg', 'effectiveUrl' => ..., 'status' => 200]

$s3->listBuckets();                                          // ['ydrcm', 'ydrcm-private']
$s3->bucketExists('ydrcm');

$page = $s3->listObjects('ydrcm', [
    'prefix' => 'docs/', 'delimiter' => '/', 'maxKeys' => 100,
]);
// ['objects' => S3Object[], 'prefixes' => string[], 'truncated' => bool, 'nextToken' => ?string, 'keyCount' => int]

foreach ($s3->iterateObjects('ydrcm', ['prefix' => 'docs/']) as $object) { /* 自动翻页 */ }

$obj = $s3->head('ydrcm', 'docs/a.txt');   // 不存在返回 null
$s3->exists('ydrcm', 'docs/a.txt');
$s3->size('ydrcm', 'docs/a.txt');

$s3->copy('ydrcm', 'a.txt', 'ydrcm-private', 'backup/a.txt');
$s3->delete('ydrcm', 'a.txt');
$s3->deleteMany('ydrcm', ['a.txt', 'b.txt']);   // 返回成功条数

use yeh110\S3Lite\S3Exception;

try {
    $s3->get('ydrcm', 'not-exist.txt');
} catch (S3Exception $e) {
    $e->getMessage();        // S3 请求失败 [GET https://...] HTTP 404 NoSuchKey: ...
    $e->statusCode;          // 404
    $e->s3Code;              // NoSuchKey
    $e->requestId;           // 便于找服务端日志
    $e->isNotFound();        // true
    $e->isAccessDenied();    // false
    $e->isConflict();
}

new S3Config(..., caBundle: 'D:/php/extras/ssl/cacert.pem');
// 或临时:caBundle: '' 表示交给 curl 默认行为

// 权威判断(推荐)
$exists = $s3->listObjects('bucket', ['prefix' => $key, 'maxKeys' => 1])['keyCount'] > 0;
bash
git clone [email protected]:yeh110/php-s3-lite.git
bash
php examples/01_upload.php                 # 上传:字符串/文件/流/分片/自动分派
php examples/02_presign_direct_upload.php  # 预签名直传(含前端配合写法)
php examples/03_preview.php                # 预览:预签名链接 + 服务端代理
php examples/04_download.php               # 下载:内存/落盘/分段/链接/代理
php examples/05_fetch_remote.php           # 远程抓取转存
php examples/06_manage.php                 # 列举/元信息/复制/删除
bash
php tests/smoke.php
php tests/smoke.php --ak=xxx --sk=yyy                  # 也可以命令行传密钥
php tests/smoke.php --endpoint=http://127.0.0.1:9002   # 绕过 nginx 直连后端
S3_DEBUG=1 php tests/smoke.php                         # 打印每个请求