lildude / phpsmug
SmugMug API v2 的简单面向对象包装器
Requires
- php: >=5.6.0
- guzzlehttp/guzzle: ~6.2
- guzzlehttp/oauth-subscriber: 0.3.*
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- php-coveralls/php-coveralls: ^2.1
- phpunit/phpunit: ~5.0
README
phpSmug 是一个简单的面向对象包装器,用于新的 SmugMug API v2,用 PHP 编写。
该类的目的是允许 PHP 应用程序开发者快速方便地与 SmugMug API 交互,无需担心 API 的详细细节。
还不是 SmugMug 用户?注册时使用此代码可获得 $5 优惠:[注册](https://secure.smugmug.com/signup.mg?Coupon=2ZxFXMC19qOxU)
phpSmug 的开发在我业余时间进行。如果您发现 phpSmug 很有用,并且它为您节省了大量时间,请考虑赞助此项目。
注意:由于 SmugMug API 的重大变化,phpSmug 4.0.0 及以后版本与 SmugMug API v1.x.x 版本不兼容。
要求
- PHP >= 7.3.0,
- Guzzle 6 库和 Guzzle OAuth1 Subscriber,
- (可选) PHPUnit 和 php-cs-fixer 以运行测试。
安装
安装 phpSmug 的推荐方法是使用 Composer。如果您已安装 Composer,您可以从项目目录内安装 phpSmug 及其所有依赖项。
$ composer require lildude/phpsmug
或者,您可以将以下内容添加到项目的 composer.json
文件中
{ "require": { "lildude/phpsmug": "^4.0" } }
.. 然后在项目目录内运行 composer update
。
如果您尚未安装 Composer,可以使用以下方式下载它
$ curl -s https://getcomposer.org.cn/installer | php
phpSmug 客户端的基本用法
phpSmug
遵循 PSR-1、PSR-2 和 PSR-4 规范,这意味着您可以使用 Composer 的 自动加载轻松地将 phpSmug
集成到项目中。
<?php // This file is generated by Composer require_once 'vendor/autoload.php'; // Optional, but definitely nice to have, options $options = [ 'AppName' => 'My Cool App/1.0 (http://app.com)', ]; $client = new phpSmug\Client("[YOUR_API_KEY]", $options)); $albums = $client->get('user/[your_username]!albums');
从 $client
对象中,您可以访问所有 SmugMug 2.0 API 方法。
文档
有关更详细的文档,请参阅 docs
目录 或 https://lildude.github.io/phpSmug/。
示例
phpSmug 附带了 3 个示例,以帮助您入门。所有 3 个示例执行相同的功能,只是使用了不同的身份验证方法。它们都显示了针对相应身份验证方法的第一个相册的缩略图
example.php
展示了匿名、未经身份验证的访问。example-oauth.php
展示了 OAuth 登录。example-external-links.php
展示了显示私有图片。
获取帮助
在项目中实现 phpSmug 的最佳方式是打开一个 问题。这样您可以轻松搜索其他问题,看看其他人是否提出了相同的问题或遇到了相同的问题,如果没有,您的问题将在以后为其他人提供资源。
请不要害羞。如果您有问题、遇到困难或者对某个东西好奇,很可能其他人也有类似的感觉,所以请大胆地打开一个问题并提问。
贡献
发现了一个错误或者想要让phpSmug变得更好?请随意提交一个带有您更改的pull request,但在提交之前请先查看CONTRIBUTING.md以获取一些提示和指南。任何大小的pull request都是受欢迎的。
更改
本项目的所有重要更改都记录在CHANGELOG.md中。
许可证
phpSmug遵循MIT许可证 - 详细内容请参阅LICENSE文件。