https://github.com/bestyii/yii2-flysystem-obs
基于flysystem的华为云对象存储 obs 组件
https://github.com/bestyii/yii2-flysystem-obs
Last synced: about 2 months ago
JSON representation
基于flysystem的华为云对象存储 obs 组件
- Host: GitHub
- URL: https://github.com/bestyii/yii2-flysystem-obs
- Owner: bestyii
- License: bsd-3-clause
- Created: 2022-08-16T07:34:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-17T10:40:29.000Z (over 2 years ago)
- Last Synced: 2025-01-30T08:31:22.095Z (4 months ago)
- Language: PHP
- Size: 5.86 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 华为对象存储服务(OBS)
[](https://packagist.org/packages/bestyii/yii2-flysystem-obs)
[](https://packagist.org/packages/bestyii/yii2-flysystem-obs)
[](https://packagist.org/packages/bestyii/yii2-flysystem-obs)
## 安装
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist bestyii/yii2-flysystem-obs "*"
```
or add
```
"bestyii/yii2-flysystem-obs": "*"
```
to the require section of your `composer.json` file.
### 配置
配置文件中加入
```php
return [
//...
'components' => [
//...
'fs' => [
'class' => 'bestyii\flysystem\obs\ObsFilesystem',
'key' => 'your-key',
'secret' => 'your-secret',
'bucket' => 'your-bucket',
'region' => 'cn-north-4',
'endpoint' => 'http://my-custom-url',
// 'isCname' => true //default: false
// 'prefix' => 'your-prefix',
// 'options' => [
// 'url'>'your-url'
// ],
],
],
];
```
## Usage
### Writing files
To write file
```php
Yii::$app->fs->write('filename.ext', 'contents');
```
To write file using stream contents
```php
$stream = fopen('/path/to/somefile.ext', 'r+');
Yii::$app->fs->writeStream('filename.ext', $stream);
```
### Updating files
To update file
```php
Yii::$app->fs->update('filename.ext', 'contents');
```
To update file using stream contents
```php
$stream = fopen('/path/to/somefile.ext', 'r+');
Yii::$app->fs->updateStream('filename.ext', $stream);
```
### Writing or updating files
To write or update file
```php
Yii::$app->fs->put('filename.ext', 'contents');
```
To write or update file using stream contents
```php
$stream = fopen('/path/to/somefile.ext', 'r+');
Yii::$app->fs->putStream('filename.ext', $stream);
```
### Reading files
To read file
```php
$contents = Yii::$app->fs->read('filename.ext');
```
To retrieve a read-stream
```php
$stream = Yii::$app->fs->readStream('filename.ext');
$contents = stream_get_contents($stream);
fclose($stream);
```
### Checking if a file exists
To check if a file exists
```php
$exists = Yii::$app->fs->has('filename.ext');
```
### Deleting files
To delete file
```php
Yii::$app->fs->delete('filename.ext');
```
### Reading and deleting files
To read and delete file
```php
$contents = Yii::$app->fs->readAndDelete('filename.ext');
```
### Renaming files
To rename file
```php
Yii::$app->fs->rename('filename.ext', 'newname.ext');
```
### Getting files mimetype
To get file mimetype
```php
$mimetype = Yii::$app->fs->getMimetype('filename.ext');
```
### Getting files timestamp
To get file timestamp
```php
$timestamp = Yii::$app->fs->getTimestamp('filename.ext');
```
### Getting files size
To get file size
```php
$timestamp = Yii::$app->fs->getSize('filename.ext');
```
### Creating directories
To create directory
```php
Yii::$app->fs->createDir('path/to/directory');
```
Directories are also made implicitly when writing to a deeper path
```php
Yii::$app->fs->write('path/to/filename.ext');
```
### Deleting directories
To delete directory
```php
Yii::$app->fs->deleteDir('path/to/filename.ext');
```
### Managing visibility
Visibility is the abstraction of file permissions across multiple platforms. Visibility can be either public or private.
```php
use League\Flysystem\AdapterInterface;
Yii::$app->fs->write('filename.ext', 'contents', [
'visibility' => AdapterInterface::VISIBILITY_PRIVATE
]);
```
You can also change and check visibility of existing files
```php
use League\Flysystem\AdapterInterface;
if (Yii::$app->fs->getVisibility('filename.ext') === AdapterInterface::VISIBILITY_PRIVATE) {
Yii::$app->fs->setVisibility('filename.ext', AdapterInterface::VISIBILITY_PUBLIC);
}
```
### Listing contents
To list contents
```php
$contents = Yii::$app->fs->listContents();
foreach ($contents as $object) {
echo $object['basename']
. ' is located at' . $object['path']
. ' and is a ' . $object['type'];
}
```
By default Flysystem lists the top directory non-recursively. You can supply a directory name and recursive boolean to get more precise results
```php
$contents = Yii::$app->fs->listContents('path/to/directory', true);
```
### Listing paths
To list paths
```php
$paths = Yii::$app->fs->listPaths();
foreach ($paths as $path) {
echo $path;
}
```
### Listing with ensured presence of specific metadata
To list with ensured presence of specific metadata
```php
$listing = Yii::$app->fs->listWith(
['mimetype', 'size', 'timestamp'],
'optional/path/to/directory',
true
);
foreach ($listing as $object) {
echo $object['path'] . ' has mimetype: ' . $object['mimetype'];
}
```
### Getting file info with explicit metadata
To get file info with explicit metadata
```php
$info = Yii::$app->fs->getWithMetadata('path/to/filename.ext', ['timestamp', 'mimetype']);
echo $info['mimetype'];
echo $info['timestamp'];
```