silverware / flickr
SilverWare Flickr 模块。
Requires
- php: >=5.6.0
- guzzlehttp/guzzle: ^6.2
- silverware/lightbox: ^1.0
- silverware/silverware: ^1.5
This package is not auto-updated.
Last update: 2024-09-15 05:22:49 UTC
README
为 SilverWare 应用程序提供一个组件,用于显示来自 Flickr 账户的一系列标记照片。
内容
需求
安装
通过 Composer 进行安装
$ composer require silverware/flickr
配置
与所有 SilverStripe 模块一样,配置通过 YAML 进行。您可以通过 YAML 修改默认的 API 端点和超时
SilverWare\Flickr\API\FlickrAPI: default_endpoint: https://api.flickr.com/services/rest default_timeout: 10
在使用此模块之前,您需要创建一个 Flickr API 密钥。一旦您创建了 API 密钥,您可以通过两种方式之一定义您的应用程序中的 API 密钥
- 通过网站配置(设置选项卡)
- 通过 YAML 配置文件
此模块将在您的网站设置中的 SilverWare 下的“服务”选项卡中添加一个 Flickr 选项卡。您可以将 API 密钥粘贴到“Flickr API 密钥”字段中。
或者,您可以将 API 密钥添加到应用程序的 YAML 配置中
SilverWare\Flickr\API\FlickrAPI: api_key: <paste the key here>
站点配置中定义的密钥将优先于 YAML 密钥。
使用
此模块提供了一个 FlickrPhotosComponent
组件,用于在您的 SilverWare 模板和布局中使用。
创建组件后,您可以使用 CMS 输入组件的 Flickr 用户 ID(也称为 NSID)。Flickr 用户 ID 通常具有以下格式 12345678@N01
。此外,您还可以定义一系列逗号分隔的标记,以显示具有这些标记的照片。
在组件的“选项”选项卡中,您可以更改任何默认选项,包括
- 照片数量
- 缩略图大小(以像素为单位)
- 标记模式:所有或任何(确定是否显示具有所有标记的照片或任何标记的照片)
- 标题模式:无、标题或页脚(用于灯箱弹出窗口)
- 标志宽度(以像素为单位)
- 链接标题
- 缓存持续时间(以秒为单位)
结果照片在请求之间进行缓存,以避免不必要的 API 调用。每次更改用户 ID、照片标记或标记模式时,组件都会自动清除缓存。刷新网站也会清除照片缓存。
问题
请使用 问题跟踪器 报告错误和功能请求。
贡献
我们非常欢迎您的贡献,以帮助改进此项目。有关更多信息,请参阅 贡献。
维护者
许可证
BSD-3-Clause © Praxis Interactive