Skip to content

xxtime/flysystem-aliyun-oss

Repository files navigation

Aliyun OSS Adapter For Flysystem.

Latest Stable Version Build Status Total Downloads License Author Code Climate

AliYun OSS Storage adapter for flysystem - a PHP filesystem abstraction.

Installation

composer require xxtime/flysystem-aliyun-oss

Logs

1.3.0
  1. some args name changed
  2. default region oss-cn-hangzhou
1.7.0
  1. support flysystem v3
  2. support oss-sdk-php 2.6
  3. support PHP8

Usage

use League\Flysystem\Filesystem;
use Xxtime\Flysystem\Aliyun\OssAdapter;

$aliyun = new OssAdapter([
    'accessId'       => '<aliyun access id>',
    'accessSecret'   => '<aliyun access secret>',
    'bucket'         => '<bucket name>',
    'endpoint'       => '<endpoint address>',
    // 'timeout'        => 3600,
    // 'connectTimeout' => 10,
    // 'isCName'        => false,
    // 'token'          => '',
]);
$filesystem = new Filesystem($aliyun);


// Write Files
$filesystem->write('path/to/file.txt', 'contents');
// get RAW data from aliYun OSS
$raw = $aliyun->supports->getFlashData();

// Write Use writeStream
$stream = fopen('local/path/to/file.txt', 'r+');
$filesystem->writeStream('path/to/file.txt', $stream);

// Update Files
$filesystem->update('path/to/file.txt', 'new contents');

// Check if a file exists
$exists = $filesystem->has('path/to/file.txt');

// Read Files
$contents = $filesystem->read('path/to/file.txt');

// Delete Files
$filesystem->delete('path/to/file.txt');

// Rename Files
$filesystem->rename('filename.txt', 'newname.txt');

// Copy Files
$filesystem->copy('filename.txt', 'duplicate.txt');


// list the contents (not support recursive now)
$filesystem->listContents('path', false);
// 说明:此方法返回从阿里云接口返回的原生数据,仅可调用一次
// DESC: this function return AliYun RAW data
$raw = $aliyun->supports->getFlashData();

Document

  1. Region And Endpoint Table
  2. Aliyun OSS PHP SDK Document

Reference

http://flysystem.thephpleague.com/api/
https://github.com/thephpleague/flysystem