# php-filesystem

**Repository Path**: liuxiaojinla/php-filesystem

## Basic Information

- **Project Name**: php-filesystem
- **Description**: 基于league/flysystem进行二次的封装，适配国内主流对象存储厂商（阿里云、腾讯云、七牛云），一套API通用于腾讯云、阿里云、七牛云
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: v3.0
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 1
- **Created**: 2019-06-24
- **Last Updated**: 2023-10-19

## Categories & Tags

**Categories**: web-dev-toolkits

**Tags**: None

## README

# php-filesystem

## 介绍
基于`league/flysystem`进行二次的封装，适配国内主流对象存储厂商（阿里云、腾讯云、七牛云），一套API通用于腾讯云、阿里云、七牛云。

为了减少项目不必要的安装依赖，阿里云、腾讯云、七牛云等相关依赖默认不会导入，请按需要手动安装相关依赖。

### 依赖包
- `qiniu/php-sdk`七牛云存储SDK依赖包",
- `qcloud/cos-sdk-v5`腾讯云COS存储SDK依赖包", 
- `aliyuncs/oss-sdk-php`阿里云OSS存储SDK依赖包"

## 安装教程

`composer require xin/filesystem`

## 使用说明

```php
$fs = Factory::aliyun([
	'ak'     => '...',
	'sk'     => '...',
	'bucket' => '',
]);

// 上传文件
$result = $fs->put('test.txt', file_get_contents('./test.txt'));
var_dump($result);

// 上传字符串
$result = $fs->put('test.txt', 'hello world');
var_dump($result);

// 重命名文件
$fs->rename('test.txt', 'helloworld.txt');
var_dump('rename file ok.');

// 文件详细信息
$result = $fs->getMetadata('helloworld.txt');
var_dump($result);

// 删除文件
$fs->delete('helloworld.txt');
var_dump('delete file ok.');

// 文件列表
$result = $fs->listContents('/');
var_dump($result);
```

## 适配清单
- 阿里云
- 腾讯云
- 七牛云