diff --git a/README.md b/README.md index 72bbbd1f..19b9472a 100644 --- a/README.md +++ b/README.md @@ -1,106 +1,141 @@ # COS-PHP-SDK-V5 -腾讯云COS-PHP-SDK-V5([XML API](https://cloud.tencent.com/document/product/436/7751)) + +腾讯云 COS-PHP-SDK-V5([XML API](https://cloud.tencent.com/document/product/436/7751)) [![Latest Stable Version](https://poser.pugx.org/qcloud/cos-sdk-v5/v/stable)](https://packagist.org/packages/qcloud/cos-sdk-v5) [![Total Downloads](https://img.shields.io/packagist/dt/qcloud/cos-sdk-v5.svg?style=flat)](https://packagist.org/packages/qcloud/cos-sdk-v5) [![Build Status](https://travis-ci.org/tencentyun/cos-php-sdk-v5.svg?branch=master)](https://travis-ci.org/tencentyun/cos-php-sdk-v5) [![codecov](https://codecov.io/gh/tencentyun/cos-php-sdk-v5/branch/master/graph/badge.svg)](https://codecov.io/gh/tencentyun/cos-php-sdk-v5) + ## 环境准备 -* PHP 5.6+ - 您可以通过`php -v`命令查看当前的 PHP 版本。 ->- 如果您的php版本 `>=5.3` 且 `<5.6` , 请使用 [ v1.3 ](https://github.com/tencentyun/cos-php-sdk-v5/tree/1.3) 版本 -* cURL 扩展 - 您可以通过`php -m`命令查看 cURL 扩展是否已经安装好。 ->- Ubuntu 系统中,您可以使用 apt-get 包管理器安装 PHP 的 cURL 扩展,安装命令如下。 +- PHP 5.6+ 您可以通过`php -v`命令查看当前的 PHP 版本。 + +> - 如果您的 php 版本 `>=5.3` 且 `<5.6` , 请使用 [v1.3](https://github.com/tencentyun/cos-php-sdk-v5/tree/1.3) 版本 + +- cURL 扩展 您可以通过`php -m`命令查看 cURL 扩展是否已经安装好。 + +> - Ubuntu 系统中,您可以使用 apt-get 包管理器安装 PHP 的 cURL 扩展,安装命令如下。 + ``` sudo apt-get install php-curl ``` ->- CentOS 系统中,您可以使用 yum 包管理器安装 PHP 的 cURL 扩展。 + +> - CentOS 系统中,您可以使用 yum 包管理器安装 PHP 的 cURL 扩展。 + ``` sudo yum install php-curl ``` ## SDK 安装 + SDK 安装有三种方式: -* Composer 方式 -* Phar 方式 -* 源码方式 + +- Composer 方式 +- Phar 方式 +- 源码方式 ### Composer 方式 + 推荐使用 Composer 安装 cos-php-sdk-v5,Composer 是 PHP 的依赖管理工具,允许您声明项目所需的依赖,然后自动将它们安装到您的项目中。 + > 您可以在 [Composer 官网](https://getcomposer.org/) 上找到更多关于如何安装 Composer,配置自动加载以及用于定义依赖项的其他最佳实践等相关信息。 -#### 安装步骤: +#### 安装步骤: + 1. 打开终端。 2. 下载 Composer,执行以下命令。 + ``` curl -sS https://getcomposer.org/installer | php ``` + 3. 创建一个名为`composer.json`的文件,内容如下。 -``` + +```json { "require": { "qcloud/cos-sdk-v5": "2.*" } } ``` + 4. 使用 Composer 安装,执行以下命令。 + ``` php composer.phar install ``` + 使用该命令后会在当前目录中创建一个 vendor 文件夹,里面包含 SDK 的依赖库和一个 autoload.php 脚本,方便在项目中调用。 -5. 通过 autoloader 脚本调用 cos-php-sdk-v5。 -``` -require '/path/to/sdk/vendor/autoload.php'; + +5. 通过 autoload.php 脚本调用 cos-php-sdk-v5。 + +```php +require '/path/to/vendor/autoload.php'; ``` 现在您的项目已经可以使用 COS 的 V5 版本 SDK 了。 ### Phar 方式 + Phar 方式安装 SDK 的步骤如下: + 1. 在 [GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 phar 文件。 -2. 在代码中引入 phar 文件: -``` -require '/path/to/cos-sdk-v5.phar'; +2. 在代码中引入 phar 文件: + +```php +require '/path/to/cos-sdk-v5.phar'; ``` ### 源码方式 + 源码方式安装 SDK 的步骤如下: -1. 在 [GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 cos-sdk-v5.tar.gz - 文件。 -2. 解压通过 autoload.php 脚本加载 SDK: -``` -require '/path/to/sdk/vendor/autoload.php'; + +1. 在 [GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 cos-sdk-v5.tar.gz 文件。 +2. 解压后通过 autoload.php 脚本加载 SDK: + +```php +require '/path/to/cos-php-sdk-v5/vendor/autoload.php'; ``` -## 快速入门 -可参照 Demo 程序,详见 [sample目录](https://github.com/tencentyun/cos-php-sdk-v5/tree/master/sample)。 +## 快速入门 + +可参照 Demo 程序,详见 [sample 目录](https://github.com/tencentyun/cos-php-sdk-v5/tree/master/sample)。 ## 接口文档 -php sdk 接口文档,详见https://cloud.tencent.com/document/product/436/12267 + +PHP SDK 接口文档,详见 [https://cloud.tencent.com/document/product/436/12267](https://cloud.tencent.com/document/product/436/12267) ### 配置文件 + ```php -$cosClient = new Qcloud\Cos\Client(array('region' => '', - 'credentials'=> array( - 'secretId' => '', - 'secretKey' => ''))); +$cosClient = new Qcloud\Cos\Client(array( + 'region' => '', + 'credentials' => array( + 'secretId' => '', + 'secretKey' => '' + ) +)); ``` 若您使用 [临时密钥](https://cloud.tencent.com/document/product/436/14048) 初始化,请用下面方式创建实例。 -``` -$cosClient = new Qcloud\Cos\Client(array('region' => '', - 'credentials'=> array( - 'secretId' => '', +```php +$cosClient = new Qcloud\Cos\Client(array( + 'region' => '', + 'credentials' => array( + 'secretId' => '', 'secretKey' => '', - 'token' => ''))); + 'token' => '' + ) +)); ``` ### 上传文件 -* 使用putObject接口上传文件(最大5G) -* 使用Upload接口分块上传文件 + +- 使用 putObject 接口上传文件(最大 5G) +- 使用 Upload 接口分块上传文件 + ```php # 上传文件 ## putObject(上传接口,最大支持上传5G文件) @@ -199,8 +234,10 @@ try { ``` ### 下载文件 -* 使用getObject接口下载文件 -* 使用getObjectUrl接口获取文件下载URL + +- 使用 getObject 接口下载文件 +- 使用 getObjectUrl 接口获取文件下载 URL + ```php # 下载文件 ## getObject(下载文件) @@ -263,4 +300,3 @@ try { print_r($e); } ``` -