tkiehne / silverstripe-tumblrfeed
SilverStripe的Tumblr API模块。
v0.1-beta
2016-06-02 21:18 UTC
Requires
- silverstripe/cms: 3.*
- tumblr/tumblr: *
This package is auto-updated.
Last update: 2024-09-11 14:36:03 UTC
README
使用Tumblr API V2加载SilverStripe模块的Tumblr订阅源。
维护者联系方式
- Tom Kiehne (tkiehne@gmx.us)
需求
- Silverstripe 3.x
安装
$ composer require tkiehne/silverstripe-tumblrfeed
使用
- 将以下内容添加到
mysite/_config/config.yml
以扩展您选择的对象
Page:
extensions:
- TumblrPageExtension
或在mysite/_config.php
中设置以下调用
Page::add_extension('TumblrPageExtension');
- 使用
/dev/build/?flush=1
构建和刷新 - 通过Admin > 设置 > Tumblr选项卡添加Tumblr API密钥和博客名称(注册您的应用程序以获取API密钥)
- 在模板中放置并包含调用(以下为选项),例如
<% include TumblrPosts Posts=$TumblrPostsList %>
调用方法和选项
所有帖子
TumblrPostsList($limit, $offset, $type, $options)
针对特定帖子类型的代理方法
TumblrTextPostsList($limit, $offset, $tag, $text)
TumblrQuotePostsList($limit, $offset, $tag, $text)
TumblrLinkPostsList($limit, $offset, $tag, $text)
TumblrAnswerPostsList($limit, $offset, $tag, $text)
TumblrVideoPostsList($limit, $offset, $tag, $text)
TumblrAudioPostsList($limit, $offset, $tag, $text)
TumblrPhotoPostsList($limit, $offset, $tag, $text)
TumblrChatPostsList($limit, $offset, $tag, $text)
通过ID的单个帖子
TumblrPost($id, $text)
选项
- limit = 要显示的帖子数,从1到20(API最大限制)
- offset = 要跳过的帖子数
- type = 要检索的帖子类型名称(见下文)
- options = API选项数组
- tag = 要通过其过滤的标签名称(仅单个标签)
- text = 布尔标志;返回纯文本(true)或HTML标记(false,默认)
- id = Tumblr帖子ID
模板
默认情况下,TumblrPosts.ss
包含将根据帖子类型调用后续包含。要自定义列表容器,请覆盖或复制TumblrPosts
。要自定义容器内显示帖子的方式,请覆盖相应的Tumblr[TYPE]Post.ss
,或者如果您已经自定义了容器,则创建自己的包含。
包含变量遵循Tumblr API的语法和结构,基于响应的"posts"集合。查看模块的默认包含以获取示例,并注意模板上下文。
缓存
此模块使用SS_Cache来减少API请求的数量。默认缓存生命周期为30分钟。您可以通过在_config.php
中添加此行来更改此值(1800是秒数,表示缓存生命周期)
SS_Cache::set_cache_lifetime('tumblr_api_cache', 1800, 10);
依赖关系
使用官方的Tumblr API v2 PHP客户端