# php-sdk
**Repository Path**: YuJian11/php-sdk
## Basic Information
- **Project Name**: php-sdk
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-13
- **Last Updated**: 2024-10-13
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 又拍云 SDK for PHPer
[](https://scrutinizer-ci.com/g/upyun/php-sdk/build-status/master) [](https://scrutinizer-ci.com/g/upyun/php-sdk/?branch=master) [](https://scrutinizer-ci.com/g/upyun/php-sdk/?branch=master)
又拍云 PHP SDK,封装了[又拍云功能丰富的开放 API](http://docs.upyun.com/api/) ,帮助开发者快速对接文件云端存储、图片音视频云处理、智能鉴黄等功能
- [功能列表](#list)
- [使用说明](#use-instructions)
- [安装](#install)
- [文档](#doc)
- [示例](#usage)
- [贡献代码](#contribute)
- [社区](#community)
- [许可证](#license)
## 功能列表
SDK 包含如下功能
- 基于 [rest api](http://docs.upyun.com/api/rest_api/)
- 文件上传下载、目录创建删除等云存储基本操作
- [断点续传](http://docs.upyun.com/api/rest_api/#_3)
- 基于 [form api](http://docs.upyun.com/api/form_api/)
- 文件客户端上传 见`examples/client-upload`
- 上传预处理操作
- [同步音频处理](http://docs.upyun.com/cloud/sync_audio/)
- [文档转换](http://docs.upyun.com/cloud/uconvert/)
- [异步图片音视频处理](http://docs.upyun.com/api/form_api/#_7)
- [异步图片智能鉴黄](http://docs.upyun.com/ai/audit/)
- [异步云处理](http://docs.upyun.com/cloud/)
- [视频音频](http://docs.upyun.com/cloud/av/)异步转码、切片、截图、水印、剪辑、拼接等功能
- [文件异步解压缩](http://docs.upyun.com/cloud/unzip/)
- [文件异步拉取](http://docs.upyun.com/cloud/spider/)
- [异步图片拼接](http://docs.upyun.com/cloud/async_image/)
- [同步视频处理](http://docs.upyun.com/cloud/sync_video/):m3u8 文件同步拼接剪辑、其他视频文件同步截图功能
- [缓存刷新](http://docs.upyun.com/api/purge/)
*功能列表中的异步操作,均可以设置异步回调通知地址,接收异步处理结果*
*如果需要测试回调功能,可以通过[又拍云回调服务](https://hooks.upyun.com/)创建一个临时回调地址*
## 使用说明
### 安装
#### PHP >= 5.5
1.使用 `composer` 安装
推荐使用该方法安装,成为优雅的 PHPer :fire:
建议使用速度很快的国内[全量镜像](https://pkg.phpcomposer.com/#how-to-use-packagist-mirror)([又拍云赞助](https://pkg.phpcomposer.com/#donation))
```
composer require upyun/sdk
```
2.如果不适应 `composer` 管理,可以直接下载[压缩包](https://github.com/upyun/php-sdk/releases)(注意需要下载 `php-sdk-版本号.zip` 格式的 zip 压缩包,不是 Source code 源码压缩包),解压后,项目中添加如下代码:
```
require_once '/path/to/php-sdk/vendor/autoload.php';
```
### 文档
详细文档见 [doc.md](doc.md)
### 示例
先初始化又拍云服务配置:
```php
require_once('vendor/autoload.php'); // 只针对使用 composer 安装
// require_once '/path/to/php-sdk/vendor/autoload.php'; // 针对压缩包安装
use Upyun\Upyun;
use Upyun\Config;
$serviceConfig = new Config('yourServiceName', 'yourOperatorName', 'yourOperatorPwd');
$client = new Upyun($serviceConfig);
```
#### 字符串写入又拍云服务器
```
$client->write('/save/path', 'file content');
```
#### 文件流写入又拍云服务器
```
$file = fopen('/local/path/file', 'r');
$client->write('/save/path', $file);
```
#### 使用并行式断点续传上传文件
```
$serviceConfig->setUploadType('BLOCK_PARALLEL');
$client = new Upyun($serviceConfig);
$file = fopen('/local/path/file', 'r');
$client->write('/save/path', $file);
```
#### 上传图片并转换格式为 `png`,详见[上传作图](http://docs.upyun.com/cloud/image/#_2)
```
$file = fopen('/local/path/image.jpg', 'r');
$client->write('/save/image.png', $file, array('x-gmkerl-thumb' => '/format/png'));
```
#### 下载文件并保存到本地
```
$saveLocal = fopen('/local/path/image.jpg', 'w');
// 第二个参数不传时,read 方法将直接返回文件内容
$client->read('/remote/server/image.png', $saveLocal);
```
## 贡献代码
1. Fork
2. 为新特性创建一个新的分支
3. 发送一个 pull request 到 master 分支
## 社区
- [问答社区](http://segmentfault.com/upyun)
- [微博](http://weibo.com/upaiyun)
## 许可证
UPYUN PHP-SDK 基于 MIT 开源协议