{"id":13704692,"url":"https://github.com/aliyun/aliyun-oss-php-sdk","last_synced_at":"2026-01-11T16:53:41.624Z","repository":{"id":2604016,"uuid":"46963511","full_name":"aliyun/aliyun-oss-php-sdk","owner":"aliyun","description":"Aliyun OSS SDK for PHP","archived":false,"fork":false,"pushed_at":"2024-02-28T11:23:27.000Z","size":1596,"stargazers_count":988,"open_issues_count":70,"forks_count":352,"subscribers_count":53,"default_branch":"master","last_synced_at":"2024-04-14T07:49:31.336Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aliyun.png","metadata":{"files":{"readme":"README-CN.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-11-27T06:27:28.000Z","updated_at":"2024-05-19T11:45:00.731Z","dependencies_parsed_at":"2023-12-07T10:30:54.549Z","dependency_job_id":"b372f1a5-7dfa-465d-8b19-97e9aa5e4312","html_url":"https://github.com/aliyun/aliyun-oss-php-sdk","commit_stats":{"total_commits":263,"total_committers":19,"mean_commits":"13.842105263157896","dds":0.7908745247148289,"last_synced_commit":"572d0f8e099e8630ae7139ed3fdedb926c7a760f"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aliyun%2Faliyun-oss-php-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aliyun%2Faliyun-oss-php-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aliyun%2Faliyun-oss-php-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aliyun%2Faliyun-oss-php-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aliyun","download_url":"https://codeload.github.com/aliyun/aliyun-oss-php-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224440051,"owners_count":17311580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T21:01:18.257Z","updated_at":"2026-01-11T16:53:41.610Z","avatar_url":"https://github.com/aliyun.png","language":"PHP","funding_links":[],"categories":["配置 Configuration","第三方API( Third Party APIs )"],"sub_categories":["第三方api Third Party APIs"],"readme":"# Aliyun OSS SDK for PHP\n\n[![Latest Stable Version](https://poser.pugx.org/aliyuncs/oss-sdk-php/v/stable)](https://packagist.org/packages/aliyuncs/oss-sdk-php)\n[![Build Status](https://travis-ci.org/aliyun/aliyun-oss-php-sdk.svg?branch=master)](https://travis-ci.org/aliyun/aliyun-oss-php-sdk)\n[![Coverage Status](https://coveralls.io/repos/github/aliyun/aliyun-oss-php-sdk/badge.svg?branch=master)](https://coveralls.io/github/aliyun/aliyun-oss-php-sdk?branch=master)\n\n## [README of English](https://github.com/aliyun/aliyun-oss-php-sdk/blob/master/README.md)\n\n## 关于 OSS SDK for PHP V2\n\u003e - OSS SDK for PHP V2([alibabacloud-oss-php-sdk-v2](https://github.com/aliyun/alibabacloud-oss-php-sdk-v2)) 测试版已发布, 是对V1（aliyun-oss-php-sdk）代码库的重大改写。\n\u003e - V2是一个全新的版本，简化了底层操作例如身份验证、自动请求重试及错误处理等；提供了灵活友好的参数配置以及丰富的高级接口，例如分页器、传输管理器等，全面提升了开发效率和体验。\n\n\n## 概述\n\n阿里云对象存储（Object Storage Service，简称OSS），是阿里云对外提供的海量、安全、低成本、高可靠的云存储服务。用户可以通过调用API，在任何应用、任何时间、任何地点上传和下载数据，也可以通过用户Web控制台对数据进行简单的管理。OSS适合存放任意文件类型，适合各种网站、开发企业及开发者使用。\n\n\n## 运行环境\n- PHP 5.3+\n- cURL extension\n\n提示：\n\n- Ubuntu下可以使用apt-get包管理器安装php的cURL扩展 `sudo apt-get install php5-curl`\n\n## 安装方法\n\n1. 如果您通过composer管理您的项目依赖，可以在你的项目根目录运行：\n\n        $ composer require aliyuncs/oss-sdk-php\n\n   或者在你的`composer.json`中声明对Aliyun OSS SDK for PHP的依赖：\n\n        \"require\": {\n            \"aliyuncs/oss-sdk-php\": \"~2.0\"\n        }\n\n   然后通过`composer install`安装依赖。composer安装完成后，在您的PHP代码中引入依赖即可：\n\n        require_once __DIR__ . '/vendor/autoload.php';\n\n2. 您也可以直接下载已经打包好的[phar文件][releases-page]，然后在你\n   的代码中引入这个文件即可：\n\n        require_once '/path/to/oss-sdk-php.phar';\n\n3. 下载SDK源码，在您的代码中引入SDK目录下的`autoload.php`文件：\n\n        require_once '/path/to/oss-sdk/autoload.php';\n\n## 快速使用\n\n### 常用类\n\n| 类名 | 解释 |\n|:------------------|:------------------------------------|\n|OSS\\OssClient | OSS客户端类，用户通过OssClient的实例调用接口 |\n|OSS\\Core\\OssException | OSS异常类，用户在使用的过程中，只需要注意这个异常|\n\n### OssClient初始化\n\nSDK的OSS操作通过OssClient类完成的，下面代码创建一个OssClient对象:\n\n```php\n\u003c?php\n$accessKeyId = \"\u003c您从OSS获得的AccessKeyId\u003e\"; ;\n$accessKeySecret = \"\u003c您从OSS获得的AccessKeySecret\u003e\";\n$endpoint = \"\u003c您选定的OSS数据中心访问域名，例如oss-cn-hangzhou.aliyuncs.com\u003e\";\ntry {\n    $ossClient = new OssClient($accessKeyId, $accessKeySecret, $endpoint);\n} catch (OssException $e) {\n    print $e-\u003egetMessage();\n}\n```\n\n### 文件操作\n\n文件(又称对象,Object)是OSS中最基本的数据单元，您可以把它简单地理解为文件，用下面代码可以实现一个Object的上传：\n\n```php\n\u003c?php\n$bucket = \"\u003c您使用的Bucket名字，注意命名规范\u003e\";\n$object = \"\u003c您使用的Object名字，注意命名规范\u003e\";\n$content = \"Hello, OSS!\"; // 上传的文件内容\ntry {\n    $ossClient-\u003eputObject($bucket, $object, $content);\n} catch (OssException $e) {\n    print $e-\u003egetMessage();\n}\n```\n\n### 存储空间操作\n\n存储空间(又称Bucket)是一个用户用来管理所存储Object的存储空间,对于用户来说是一个管理Object的单元，所有的Object都必须隶属于某个Bucket。您可以按照下面的代码新建一个Bucket：\n\n```php\n\u003c?php\n$bucket = \"\u003c您使用的Bucket名字，注意命名规范\u003e\";\ntry {\n    $ossClient-\u003ecreateBucket($bucket);\n} catch (OssException $e) {\n    print $e-\u003egetMessage();\n}\n```\n\n### 返回结果处理\n\nOssClient提供的接口返回返回数据分为两种：\n\n* Put，Delete类接口，接口返回null，如果没有OssException，即可认为操作成功\n* Get，List类接口，接口返回对应的数据，如果没有OssException，即可认为操作成功，举个例子：\n\n```php\n\u003c?php\n$bucketListInfo = $ossClient-\u003elistBuckets();\n$bucketList = $bucketListInfo-\u003egetBucketList();\nforeach($bucketList as $bucket) {\n    print($bucket-\u003egetLocation() . \"\\t\" . $bucket-\u003egetName() . \"\\t\" . $bucket-\u003egetCreateDate() . \"\\n\");\n}\n```\n上面代码中的$bucketListInfo的数据类型是 `OSS\\Model\\BucketListInfo`\n\n\n### 运行Sample程序\n\n1. 修改 `samples/Config.php`， 补充配置信息\n2. 执行 `cd samples/ \u0026\u0026 php RunAll.php`\n\n### 运行单元测试\n\n1. 执行`composer install`下载依赖的库\n2. 设置环境变量\n\n        export OSS_ACCESS_KEY_ID=access-key-id\n        export OSS_ACCESS_KEY_SECRET=access-key-secret\n        export OSS_ENDPOINT=endpoint\n        export OSS_BUCKET=bucket-name\n\n3. 执行 `php vendor/bin/phpunit`\n\n## License\n\n- MIT\n\n## 联系我们\n\n- [阿里云OSS官方网站](http://oss.aliyun.com)\n- [阿里云OSS官方论坛](http://bbs.aliyun.com)\n- [阿里云OSS官方文档中心](http://www.aliyun.com/product/oss#Docs)\n- 阿里云官方技术支持：[提交工单](https://workorder.console.aliyun.com/#/ticket/createIndex)\n\n[releases-page]: https://github.com/aliyun/aliyun-oss-php-sdk/releases\n[phar-composer]: https://github.com/clue/phar-composer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faliyun%2Faliyun-oss-php-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faliyun%2Faliyun-oss-php-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faliyun%2Faliyun-oss-php-sdk/lists"}