Chinac COS SDK for PHP

概述

华云对象存储（Chinac Object Storage Service，简称COS），是华云对外提供的海量、安全、低成本、高可靠的云存储服务。用户可以通过调用API，在任何应用、任何时间、任何地点上传和下载数据，也可以通过用户Web控制台对数据进行简单的管理。COS适合存放任意文件类型，适合各种网站、开发企业及开发者使用。

运行环境

• PHP 5.3+
• cURL extension

提示：

• Ubuntu下可以使用apt-get包管理器安装php的cURL扩展 sudo apt-get install php5-curl

安装方法

1. 如果您通过composer管理您的项目依赖，可以在你的项目根目录运行：

    $ composer require chinacos/cos-php-sdk
   

   或者在你的composer.json中声明对COS-PHP-SDK的依赖：

    "require": {
        "chinacos/cos-sdk-php": "~2.0"
    }
   

   然后通过composer install安装依赖。composer安装完成后，在您的PHP代码中引入依赖即可：

    require_once __DIR__ . '/vendor/autoload.php';
   

2. 您也可以直接下载已经打包好的[phar文件][releases-page]，然后在你 的代码中引入这个文件即可：

    require_once '/path/to/cos-sdk-php.phar';
   

3. 下载SDK源码，在您的代码中引入SDK目录下的autoload.php文件：

    require_once '/path/to/cos-sdk/autoload.php';
   

快速使用

常用类

类名	解释
COS\CosClient	COS客户端类，用户通过CosClient的实例调用接口
COS\Core\CosException	COS异常类，用户在使用的过程中，只需要注意这个异常

CosClient初始化

SDK的COS操作通过CosClient类完成的，下面代码创建一个CosClient对象:

<?php
$accessKeyId = "<您从COS获得的AccessKeyId>"; ;
$accessKeySecret = "<您从COS获得的AccessKeySecret>";
$endpoint = "<您选定的COS数据中心访问域名，例如cos-cn-hangzhou.chinac.com>";
try {
	$cosClient = new CosClient($accessKeyId, $accessKeySecret, $endpoint);
} catch (CosException $e) {
	print $e->getMessage();
}

文件操作

文件(又称对象,Object)是COS中最基本的数据单元，您可以把它简单地理解为文件，用下面代码可以实现一个Object的上传：

<?php
$bucket = "<您使用的Bucket名字，注意命名规范>";
$object = "<您使用的Object名字，注意命名规范>";
$content = "Hello, COS!"; // 上传的文件内容
try {
	$cosClient->putObject($bucket, $object, $content);
} catch (CosException $e) {
	print $e->getMessage();
} 

存储空间操作

存储空间(又称Bucket)是一个用户用来管理所存储Object的存储空间,对于用户来说是一个管理Object的单元，所有的Object都必须隶属于某个Bucket。您可以按照下面的代码新建一个Bucket：

<?php
$bucket = "<您使用的Bucket名字，注意命名规范>";
try {
	$cosClient->createBucket($bucket);
} catch (CosException $e) {
	print $e->getMessage();
}

返回结果处理

CosClient提供的接口返回返回数据分为两种：

• Put，Delete类接口，接口返回null，如果没有CosException，即可认为操作成功
• Get，List类接口，接口返回对应的数据，如果没有CosException，即可认为操作成功，举个例子：

<?php
$bucketListInfo = $cosClient->listBuckets();
$bucketList = $bucketListInfo->getBucketList();
foreach($bucketList as $bucket) {
	print($bucket->getLocation() . "\t" . $bucket->getName() . "\t" . $bucket->getCreatedate() . "\n");
}

上面代码中的$bucketListInfo的数据类型是 COS\Model\BucketListInfo

运行Sample程序

1. 设置环境变量：COS_ACCESS_KEY_ID, COS_ACCESS_KEY_SECRET, COS_ENDPOINT, COS_TEST_BUCKET
2. 修改 samples/Config.php， 补充配置信息
3. 执行 cd samples/ && php RunAll.php

运行单元测试

1. 修改 tests/COS/Tests/Config.php， 补充配置信息
2. 执行 ./vendor/bin/phpunit tests/COS/Tests/

联系我们

华云COS官方网站