文章摘要
scbkw
Typecho Theme Development Framework
一个 Typecho 主题开发框架 v2 版，
还算不上框架只能说让开发变得更简单些
特别感谢@Sualiu
GitHub
类与方法
调用方法时值为 true 直接 echo 输出，如果为 false 则返回值。
Get::SiteUrl(true) 为 echo 输出
Get::SiteUrl(false) 为 return 返回值
TTDF 类
| 方法 | 描述 | 示例 |
|---|---|---|
| Ver | 获取框架版本号 | TTDF::Ver(); |
| TypechoVer | 获取 Typecho 版本号 | TTDF::TypechoVer(); |
| HeadMeta | 调用 meta 标签 | TTDF::HeadMeta(); |
Get 类
获取站点信息及其他通用功能。
| 方法 | 描述 | 示例 |
|---|---|---|
| SiteUrl | 获取站点的 URL | Get::SiteUrl(); |
| Options($param) | 获取配置项 | Get::Options(‘name’); |
| Fields($param) | 获取字段 | Get::Fields(‘name’); |
| Is($type) | 判断当前页面类型 | Get::Is(‘type’); |
| Next() | 循环输出文章 | Get::Next(); |
| PageNav($prev, $next) | 获取分页导航 | Get::PageNav(); |
| PageLink($link, $type = ”) | 获取分页链接 | Get::PageLink(); |
| Total() | 获取文章总数 | Get::Total(); |
| PageSize() | 获取每页文章数 | Get::PageSize(); |
| CurrentPage() | 获取当前页码 | Get::CurrentPage(); |
| Permalink() | 获取文章链接 | Get::Permalink(); |
| Field($field) | 获取自定义字段 | Get::Field(); |
GetTheme 类
获取主题的相关信息。
| 方法 | 描述 | 示例 |
|---|---|---|
| Url() | 获取主题的 URL | GetTheme::Url(); |
| Name() | 获取主题名称 | GetTheme::Name(); |
| Author() | 获取主题作者 | GetTheme::Author(); |
| Ver() | 获取主题版本号 | GetTheme::Ver(); |
GetPost 类
获取文章的相关信息。
| 方法 | 描述 | 示例 |
|---|---|---|
| Title() | 获取文章标题 | GetPost::Title(); |
| Date() | 获取文章日期 | GetPost::Date(); |
| Category() | 获取文章分类 | GetPost::Category(); |
| Tags() | 获取文章标签 | GetPost::Tags(); |
| Excerpt() | 获取文章摘要 | GetPost::Excerpt(); |
| Permalink() | 获取文章链接 | GetPost::Permalink(); |
| Content() | 获取文章内容 | GetPost::Content(); |
| PostsNum() | 获取文章数 | GetPost::PostsNum(); |
| PagesNum() | 获取页面数 | GetPost::PagesNum(); |
| CurrentPage() | 获取当前页码 | GetPost::CurrentPage(); |
| ArchiveTitle() | 获取当前页面标题 | GetPost::ArchiveTitle(); |
| Author() | 获取文章作者 | GetPost::Author();> |
| AuthorPermalink() | 获取作者链接 | GetPost::AuthorPermalink(); |
GetComments 类
获取评论的相关信息。
| 方法 | 描述 | 示例 |
|---|---|---|
| Comments() | 获取评论 | GetComments::Comments(); |
| CommentsPage() | 获取评论页面 | GetComments::CommentsPage(); |
| CommentsList() | 获取评论列表 | GetComments::CommentsList(); |
| CommentsNum() | 获取评论数 | GetComments::CommentsNum(); |
| CommentsForm() | 获取评论表单 | GetComments::CommentsForm(); |
| RespondId() | 获取评论 id | GetComments::RespondId();> |
| CancelReply() | 获取取消回复 | GetComments::CancelReply(); |
| Remember() | 获取 Remember | GetComments::Remember(); |
| PageNav() | 获取评论分页 | GetComments::PageNav(); |
GetFunctions 类
提供一些常用的功能函数。
| 方法 | 描述 | 示例 |
|---|---|---|
| TimerStop() | 获取加载时间 | GetFunctions::TimerStop(); |
| ArtCount() | 获取文章字数 | GetFunctions::ArtCount(); |
GetJsonData 类
提供 Json 数据输出。
注意，需要启用 Json 输出，请在 header 文件顶部增加 GetJsonData::Tomori(); 方法
| 方法 | 描述 | 示例 |
|---|---|---|
| Tomori() | 启用 Json 输出 | GetJsonData::Tomori(); |
| JsonTitle() | 获取 Json 数据标题 | GetJsonData::JsonTitle(); |
| JsonContent() | 获取 Json 数据内容 | GetJsonData::JsonContent(); |
REST API 使用说明：
获取文章列表：
?JsonData=page
?JsonData=page&page=2
获取文章详情：
?JsonData=common&cid=文章ID
获取分类：
?JsonData=category // 获取所有分类
?JsonData=category&cid=分类ID // 获取特定分类下的文章
?JsonData=category&cid=分类ID&page=2 // 分页获取分类文章
获取标签：
?JsonData=tag // 获取所有标签
?JsonData=tag&tid=标签ID // 获取特定标签下的文章
?JsonData=tag&tid=标签ID&page=2 // 分页获取标签文章
主要特点： 统一的响应格式 完整的错误处理
支持分页 丰富的文章元数据 主题信息输出 缓存控制 支持文章缩略图和摘要 这个版本提供了一个完整的 RESTful API 实现，可以用于构建前端应用或小程序等。
© 版权声明
THE END
酷盾安全提供安全防护和加速服务
暂无评论内容