diza / unsplash
Requires
- php: >=5.6.0
- ext-json: *
- guzzlehttp/guzzle: ~6.2
Requires (Dev)
- phpunit/phpunit: 4.3.*
This package is not auto-updated.
Last update: 2020-06-27 09:38:55 UTC
README
非官方的 PHP 包装器,用于访问 Unsplash API,专注于 API 调用效率和易用性。
注意: 此包装器仅支持 公共操作。
安装
Unsplash-PHP 使用 Composer。要使用它,请要求库
composer require cetteup/unsplash
用法
配置
在您开始调用 API 之前,您需要使用您的应用程序 ID 配置客户端。
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID');
API 方法
有关响应结构的更详细信息,请参阅 官方文档。
Cetteup\Unsplash\HttpClient->user_find($username)
获取给定用户的公共详细信息。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 |
|---|---|---|
$username |
字符串 | 必需 |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $user = $unsplash->user_find('cetteup');
Cetteup\Unsplash\HttpClient->user_portfolio_link($username)
获取单个用户的投资组合链接。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 |
|---|---|---|
$username |
字符串 | 必需 |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $link = $unsplash->user_portfolio_link('cetteup');
Cetteup\Unsplash\HttpClient->user_photos($username, $page, $per_page, $order_by, $stats, $resolution, $quantity, $orientation)
获取用户上传的图片列表。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 | 注意 |
|---|---|---|---|
$username |
字符串 | 必需 | |
$page |
整数 | 可选 (默认: 1) | |
$per_page |
整数 | 可选 (默认: 10 / 最大: 30) | |
$order_by |
字符串 | 可选 (默认: latest) | 接受值: latest, oldest, popular |
$stats |
布尔值 | 可选 (默认: false) | |
$resolution |
字符串 | 可选 (默认: days) | 接受值: days |
$quantity |
整数 | 可选 (默认: 30) | |
$orientation |
字符串 | 可选 | 接受值: landscape, portrait, squarish |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $photos = $unsplash->user_photos('cetteup', 2, 30, 'oldest');
Cetteup\Unsplash\HttpClient->user_likes($username, $page, $per_page, $order_by, $orientation)
获取用户喜欢的图片列表。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 | 注意 |
|---|---|---|---|
$username |
字符串 | 必需 | |
$page |
整数 | 可选 (默认: 1) | |
$per_page |
整数 | 可选 (默认: 10 / 最大: 30) | |
$order_by |
字符串 | 可选 (默认: latest) | 接受值: latest, oldest, popular |
$orientation |
字符串 | 可选 | 接受值: landscape, portrait, squarish |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $photos = $unsplash->user_likes('cetteup', 2, 20, 'popular');
Cetteup\Unsplash\HttpClient->user_collections($username, $page, $per_page)
获取用户创建的收藏夹列表。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 |
|---|---|---|
$username |
字符串 | 必需 |
$page |
整数 | 可选 (默认: 1) |
$per_page |
整数 | 可选 (默认: 10 / 最大: 30) |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $collections = $unsplash->user_collections('jlantunez', 3, 5);
Cetteup\Unsplash\HttpClient->user_statistics($username, $resolution, $quantity)
获取用户所有照片的下载量、浏览量和点赞量总计,以及特定时间段的统计数据的历史分解和平均值。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 | 注意 |
|---|---|---|---|
$username |
字符串 | 必需 | |
$resolution |
字符串 | 可选 (默认: days) | 接受值: days |
$quantity |
整数 | 选项 (默认:30 / 最小:1 / 最大:30) |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $collections = $unsplash->user_statistics('cetteup', 'days', 10);
Cetteup\Unsplash\HttpClient->photo_all($page, $per_page, $order_by)
获取所有照片列表中的单页。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 | 注意 |
|---|---|---|---|
$page |
整数 | 可选 (默认: 1) | |
$per_page |
整数 | 可选 (默认: 10 / 最大: 30) | |
$order_by |
字符串 | 可选 (默认: latest) | 接受值: latest, oldest, popular |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $photos = $unsplash->photo_all(2, 30, 'oldest');
Cetteup\Unsplash\HttpClient->photo_find($id)
检索单个照片。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 |
|---|---|---|
$id |
字符串 | 必需 |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $photo = $unsplash->photo_find('54t5rivyAiI');
Cetteup\Unsplash\HttpClient->photo_random($params)
给定可选过滤器,检索单个随机照片。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 |
|---|---|---|
$params |
数组 | 可选 |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $photo = $unsplash->photo_random(['orientation' => 'portrait']);
Cetteup\Unsplash\HttpClient->photo_statistics($id, $resolution, $quantity)
检索单个照片的下载量、浏览量和点赞量总计,以及特定时间段的统计数据的历史分解。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 | 注意 |
|---|---|---|---|
$id |
字符串 | 必需 | |
$resolution |
字符串 | 可选 (默认: days) | 接受值: days |
$quantity |
整数 | 选项 (默认:30 / 最小:1 / 最大:30) |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $stats = $unsplash->photo_statistics('54t5rivyAiI', 'days', 14);
Cetteup\Unsplash\HttpClient->photo_download($id)
跟踪照片下载。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 |
|---|---|---|
$id |
字符串 | 必需 |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $unsplash->photo_download('54t5rivyAiI');
Cetteup\Unsplash\HttpClient->search_photos($search, $page, $per_page, $order_by, $content_filter, $collections, $color, $orientation)
获取查询结果的图片单页。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 | 注意 |
|---|---|---|---|
$search |
字符串 | 必需 | 多个搜索词需要用空格、逗号或加号分隔 |
$page |
整数 | 可选 (默认: 1) | |
$per_page |
整数 | 可选 (默认: 10 / 最大: 30) | |
$order_by |
字符串 | 选项 (默认:相关) | 接受值:最新,相关 |
$content_filter |
字符串 | 选项 (默认:低) | 接受值:低,高 |
$collections |
字符串 | 可选 | 多个ID需要以逗号分隔 |
$color |
字符串 | 可选 | 接受值:黑白,黑色,白色,黄色,橙色,红色,紫色,洋红色,绿色,蓝绿色,蓝色 |
$orientation |
字符串 | 可选 | 接受值: landscape, portrait, squarish |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $results = $unsplash->search_photos('cats', 5, 30);
Cetteup\Unsplash\HttpClient->search_collections($search, $page, $per_page)
获取查询结果的单页收藏集。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 | 注意 |
|---|---|---|---|
$search |
字符串 | 必需 | 多个搜索词需要用空格、逗号或加号分隔 |
$page |
整数 | 可选 (默认: 1) | |
$per_page |
整数 | 可选 (默认: 10 / 最大: 30) |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $results = $unsplash->search_collections('dogs', 10, 25);
Cetteup\Unsplash\HttpClient->search_users($search, $page, $per_page)
获取查询结果的单页用户。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 | 注意 |
|---|---|---|---|
$search |
字符串 | 必需 | 多个搜索词需要用空格、逗号或加号分隔 |
$page |
整数 | 可选 (默认: 1) | |
$per_page |
整数 | 可选 (默认: 10 / 最大: 30) |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $results = $unsplash->search_users('photography', 1, 15);
Cetteup\Unsplash\HttpClient->collection_all($page, $per_page)
获取所有收藏列表的单页。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 |
|---|---|---|
$page |
整数 | 可选 (默认: 1) |
$per_page |
整数 | 可选 (默认: 10 / 最大: 30) |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $collections = $unsplash->collection_all(10, 30);
Cetteup\Unsplash\HttpClient->collection_featured($page, $per_page)
获取特色收藏列表的单页。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 |
|---|---|---|
$page |
整数 | 可选 (默认: 1) |
$per_page |
整数 | 可选 (默认: 10 / 最大: 30) |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $collections = $unsplash->collection_featured(2, 10);
Cetteup\Unsplash\HttpClient->collection_find($id)
获取单个集合。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 | 注意 |
|---|---|---|---|
$id |
整数 | 必需 |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $collection = $unsplash->collection_find(1121542);
Cetteup\Unsplash\HttpClient->collection_photos($id, $page, $per_page, $orientation)
获取集合的图片。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 | 注意 |
|---|---|---|---|
$id |
整数 | 必需 | |
$page |
整数 | 可选 (默认: 1) | |
$per_page |
整数 | 可选 (默认: 10 / 最大: 30) | |
$orientation |
字符串 | 可选 | 接受值: landscape, portrait, squarish |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $photos = $unsplash->collection_photos(1121542, 1, 10, 'squarish');
Cetteup\Unsplash\HttpClient->collection_related($id)
获取相关集合的列表。
注意: 您需要首先实例化一个 httpclient 对象
参数
| 参数 | 类型 | 可选/必需 |
|---|---|---|
$id |
整数 | 必需 |
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $collections = $unsplash->collection_related(1121542);
Cetteup\Unsplash\HttpClient->stats_total()
获取Unsplash所有数据的统计列表。
注意: 您需要首先实例化一个 httpclient 对象
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $stats = $unsplash->stats_total();
Cetteup\Unsplash\HttpClient->stats_month()
获取过去30天的Unsplash总体统计数据。
注意: 您需要首先实例化一个 httpclient 对象
示例
$unsplash = new Cetteup\Unsplash\HttpClient('YOUR APPLICATION ID'); $stats = $unsplash->stats_month();