|
1 | 1 | # COS-PHP-SDK-V5 |
2 | | -腾讯云COS-PHP-SDK-V5([XML API](https://cloud.tencent.com/document/product/436/7751)) |
| 2 | + |
| 3 | +腾讯云 COS-PHP-SDK-V5([XML API](https://cloud.tencent.com/document/product/436/7751)) |
3 | 4 |
|
4 | 5 | [](https://packagist.org/packages/qcloud/cos-sdk-v5) |
5 | 6 | [](https://packagist.org/packages/qcloud/cos-sdk-v5) |
6 | 7 | [](https://travis-ci.org/tencentyun/cos-php-sdk-v5) |
7 | 8 | [](https://codecov.io/gh/tencentyun/cos-php-sdk-v5) |
| 9 | + |
8 | 10 | ## 环境准备 |
9 | | -* PHP 5.6+ |
10 | | - 您可以通过`php -v`命令查看当前的 PHP 版本。 |
11 | | ->- 如果您的php版本 `>=5.3` 且 `<5.6` , 请使用 [ v1.3 ](https://github.com/tencentyun/cos-php-sdk-v5/tree/1.3) 版本 |
12 | | -* cURL 扩展 |
13 | | - 您可以通过`php -m`命令查看 cURL 扩展是否已经安装好。 |
14 | 11 |
|
15 | | ->- Ubuntu 系统中,您可以使用 apt-get 包管理器安装 PHP 的 cURL 扩展,安装命令如下。 |
| 12 | +- PHP 5.6+ 您可以通过`php -v`命令查看当前的 PHP 版本。 |
| 13 | + |
| 14 | +> - 如果您的 php 版本 `>=5.3` 且 `<5.6` , 请使用 [v1.3](https://github.com/tencentyun/cos-php-sdk-v5/tree/1.3) 版本 |
| 15 | +
|
| 16 | +- cURL 扩展 您可以通过`php -m`命令查看 cURL 扩展是否已经安装好。 |
| 17 | + |
| 18 | +> - Ubuntu 系统中,您可以使用 apt-get 包管理器安装 PHP 的 cURL 扩展,安装命令如下。 |
| 19 | +
|
16 | 20 | ``` |
17 | 21 | sudo apt-get install php-curl |
18 | 22 | ``` |
19 | | ->- CentOS 系统中,您可以使用 yum 包管理器安装 PHP 的 cURL 扩展。 |
| 23 | + |
| 24 | +> - CentOS 系统中,您可以使用 yum 包管理器安装 PHP 的 cURL 扩展。 |
| 25 | +
|
20 | 26 | ``` |
21 | 27 | sudo yum install php-curl |
22 | 28 | ``` |
23 | 29 |
|
24 | 30 | ## SDK 安装 |
| 31 | + |
25 | 32 | SDK 安装有三种方式: |
26 | | -* Composer 方式 |
27 | | -* Phar 方式 |
28 | | -* 源码方式 |
| 33 | + |
| 34 | +- Composer 方式 |
| 35 | +- Phar 方式 |
| 36 | +- 源码方式 |
29 | 37 |
|
30 | 38 | ### Composer 方式 |
| 39 | + |
31 | 40 | 推荐使用 Composer 安装 cos-php-sdk-v5,Composer 是 PHP 的依赖管理工具,允许您声明项目所需的依赖,然后自动将它们安装到您的项目中。 |
| 41 | + |
32 | 42 | > 您可以在 [Composer 官网](https://getcomposer.org/) 上找到更多关于如何安装 Composer,配置自动加载以及用于定义依赖项的其他最佳实践等相关信息。 |
33 | 43 |
|
34 | | -#### 安装步骤: |
| 44 | +#### 安装步骤: |
| 45 | + |
35 | 46 | 1. 打开终端。 |
36 | 47 | 2. 下载 Composer,执行以下命令。 |
| 48 | + |
37 | 49 | ``` |
38 | 50 | curl -sS https://getcomposer.org/installer | php |
39 | 51 | ``` |
| 52 | + |
40 | 53 | 3. 创建一个名为`composer.json`的文件,内容如下。 |
41 | | -``` |
| 54 | + |
| 55 | +```json |
42 | 56 | { |
43 | 57 | "require": { |
44 | 58 | "qcloud/cos-sdk-v5": "2.*" |
45 | 59 | } |
46 | 60 | } |
47 | 61 | ``` |
| 62 | + |
48 | 63 | 4. 使用 Composer 安装,执行以下命令。 |
| 64 | + |
49 | 65 | ``` |
50 | 66 | php composer.phar install |
51 | 67 | ``` |
| 68 | + |
52 | 69 | 使用该命令后会在当前目录中创建一个 vendor 文件夹,里面包含 SDK 的依赖库和一个 autoload.php 脚本,方便在项目中调用。 |
53 | | -5. 通过 autoloader 脚本调用 cos-php-sdk-v5。 |
54 | | -``` |
55 | | -require '/path/to/sdk/vendor/autoload.php'; |
| 70 | + |
| 71 | +5. 通过 autoload.php 脚本调用 cos-php-sdk-v5。 |
| 72 | + |
| 73 | +```php |
| 74 | +require '/path/to/vendor/autoload.php'; |
56 | 75 | ``` |
57 | 76 |
|
58 | 77 | 现在您的项目已经可以使用 COS 的 V5 版本 SDK 了。 |
59 | 78 |
|
60 | 79 | ### Phar 方式 |
| 80 | + |
61 | 81 | Phar 方式安装 SDK 的步骤如下: |
| 82 | + |
62 | 83 | 1. 在 [GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 phar 文件。 |
63 | | -2. 在代码中引入 phar 文件: |
64 | | -``` |
65 | | -require '/path/to/cos-sdk-v5.phar'; |
| 84 | +2. 在代码中引入 phar 文件: |
| 85 | + |
| 86 | +```php |
| 87 | +require '/path/to/cos-sdk-v5.phar'; |
66 | 88 | ``` |
67 | 89 |
|
68 | 90 | ### 源码方式 |
| 91 | + |
69 | 92 | 源码方式安装 SDK 的步骤如下: |
70 | | -1. 在 [GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 cos-sdk-v5.tar.gz |
71 | | - 文件。 |
72 | | -2. 解压通过 autoload.php 脚本加载 SDK: |
73 | | -``` |
74 | | -require '/path/to/sdk/vendor/autoload.php'; |
| 93 | + |
| 94 | +1. 在 [GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 cos-sdk-v5.tar.gz 文件。 |
| 95 | +2. 解压后通过 autoload.php 脚本加载 SDK: |
| 96 | + |
| 97 | +```php |
| 98 | +require '/path/to/cos-php-sdk-v5/vendor/autoload.php'; |
75 | 99 | ``` |
76 | 100 |
|
77 | | -## 快速入门 |
78 | | -可参照 Demo 程序,详见 [sample目录](https://github.com/tencentyun/cos-php-sdk-v5/tree/master/sample)。 |
| 101 | +## 快速入门 |
| 102 | + |
| 103 | +可参照 Demo 程序,详见 [sample 目录](https://github.com/tencentyun/cos-php-sdk-v5/tree/master/sample)。 |
79 | 104 |
|
80 | 105 | ## 接口文档 |
81 | | -php sdk 接口文档,详见https://cloud.tencent.com/document/product/436/12267 |
| 106 | + |
| 107 | +PHP SDK 接口文档,详见 [https://cloud.tencent.com/document/product/436/12267](https://cloud.tencent.com/document/product/436/12267) |
82 | 108 |
|
83 | 109 | ### 配置文件 |
| 110 | + |
84 | 111 | ```php |
85 | | -$cosClient = new Qcloud\Cos\Client(array('region' => '<Region>', |
86 | | - 'credentials'=> array( |
87 | | - 'secretId' => '<SecretId>', |
88 | | - 'secretKey' => '<SecretKey>'))); |
| 112 | +$cosClient = new Qcloud\Cos\Client(array( |
| 113 | + 'region' => '<Region>', |
| 114 | + 'credentials' => array( |
| 115 | + 'secretId' => '<SecretId>', |
| 116 | + 'secretKey' => '<SecretKey>' |
| 117 | + ) |
| 118 | +)); |
89 | 119 | ``` |
90 | 120 |
|
91 | 121 | 若您使用 [临时密钥](https://cloud.tencent.com/document/product/436/14048) 初始化,请用下面方式创建实例。 |
92 | 122 |
|
93 | | -``` |
94 | | -$cosClient = new Qcloud\Cos\Client(array('region' => '<Region>', |
95 | | - 'credentials'=> array( |
96 | | - 'secretId' => '<SecretId>', |
| 123 | +```php |
| 124 | +$cosClient = new Qcloud\Cos\Client(array( |
| 125 | + 'region' => '<Region>', |
| 126 | + 'credentials' => array( |
| 127 | + 'secretId' => '<SecretId>', |
97 | 128 | 'secretKey' => '<SecretKey>', |
98 | | - 'token' => '<XCosSecurityToken>'))); |
| 129 | + 'token' => '<XCosSecurityToken>' |
| 130 | + ) |
| 131 | +)); |
99 | 132 | ``` |
100 | 133 |
|
101 | 134 | ### 上传文件 |
102 | | -* 使用putObject接口上传文件(最大5G) |
103 | | -* 使用Upload接口分块上传文件 |
| 135 | + |
| 136 | +- 使用 putObject 接口上传文件(最大 5G) |
| 137 | +- 使用 Upload 接口分块上传文件 |
| 138 | + |
104 | 139 | ```php |
105 | 140 | # 上传文件 |
106 | 141 | ## putObject(上传接口,最大支持上传5G文件) |
@@ -199,8 +234,10 @@ try { |
199 | 234 | ``` |
200 | 235 |
|
201 | 236 | ### 下载文件 |
202 | | -* 使用getObject接口下载文件 |
203 | | -* 使用getObjectUrl接口获取文件下载URL |
| 237 | + |
| 238 | +- 使用 getObject 接口下载文件 |
| 239 | +- 使用 getObjectUrl 接口获取文件下载 URL |
| 240 | + |
204 | 241 | ```php |
205 | 242 | # 下载文件 |
206 | 243 | ## getObject(下载文件) |
@@ -263,4 +300,3 @@ try { |
263 | 300 | print_r($e); |
264 | 301 | } |
265 | 302 | ``` |
266 | | - |
|
0 commit comments