登录
模块市场 下载
演示
框架功能演示 CMS企业建站 Blog博客系统
讨论 需求墙 任务大厅
开发文档
UI加速器 开发者中心 开发者文档 视频教程 新闻动态 内容资讯

博客系统工具类文档

版本：v3.5.0
博客系统 工具类文档
博客操作 1 统一用单数

获取分类树

MBlog::categoryTree ( )
返回
array

获取最新博客

MBlog::latestBlog ( $limit )
参数 类型 说明
$limit integer 限制条数
返回
array 数组
返回示例 
[
  {
    "id": 19, // 博客ID
    "created_at": "2017-12-20 16:35:24", // 创建时间
    "updated_at": "2022-09-21 14:59:09", // 更新时间
    "title": "博客标题",
    "tag": [
      "标签1",
      "标签2"
    ],
    "summary": "博客摘要",
    "images": [
      "https://example.com/xxx.jpg" // 博客图片多张
    ],
    "content": "内容HTML",
    "isPublished": 1, // 是否发布
    "postTime": "2017-12-20 16:34:44", // 发布时间
    "clickCount": 215048, // 点击量
    "seoKeywords": "SEO关键词",
    "seoDescription": "SEO描述内容",
    "isTop": null, // 是否置顶
    "commentCount": 16, // 评论数
    "categoryId": 1, // 分类ID
    "_category": {
      "id": 1, // 分类ID
      "created_at": "2022-05-27 14:51:09", // 分类创建时间
      "updated_at": "2022-09-21 14:55:33", // 分类更新时间
      "pid": 0, // 父分类ID
      "sort": 1, // 分类排序
      "title": "分类名称",
      "blogCount": 1, // 分类下博客数量
      "cover": "https://xx.com/xx.jpg",
      "keywords": "分类关键词",
      "description": "分类描述"
    },
    "_cover": "https://xx.com/xx.jpg" // 博客封面，如果博客图片为空，会尝试自动从内容中抽取
  },
  // ...
]

获取置顶博客

MBlog::topBlog ( $limit )
参数 类型 说明
$limit integer 限制条数
返回
array 数组
返回示例 
[
  {
    "id": 19, // 博客ID
    "created_at": "2017-12-20 16:35:24", // 创建时间
    "updated_at": "2022-09-21 14:59:09", // 更新时间
    "title": "博客标题",
    "tag": [
      "标签1",
      "标签2"
    ],
    "summary": "博客摘要",
    "images": [
      "https://example.com/xxx.jpg" // 博客图片多张
    ],
    "content": "内容HTML",
    "isPublished": 1, // 是否发布
    "postTime": "2017-12-20 16:34:44", // 发布时间
    "clickCount": 215048, // 点击量
    "seoKeywords": "SEO关键词",
    "seoDescription": "SEO描述内容",
    "isTop": null, // 是否置顶
    "commentCount": 16, // 评论数
    "categoryId": 1, // 分类ID
    "_category": {
      "id": 1, // 分类ID
      "created_at": "2022-05-27 14:51:09", // 分类创建时间
      "updated_at": "2022-09-21 14:55:33", // 分类更新时间
      "pid": 0, // 父分类ID
      "sort": 1, // 分类排序
      "title": "分类名称",
      "blogCount": 1, // 分类下博客数量
      "cover": "https://xx.com/xx.jpg",
      "keywords": "分类关键词",
      "description": "分类描述"
    },
    "_cover": "https://xx.com/xx.jpg" // 博客封面，如果博客图片为空，会尝试自动从内容中抽取
  },
  // ...
]

获取热门博客

MBlog::hotBlog ( $limit )
参数 类型 说明
$limit integer 限制条数
返回
array 数组
返回示例 
[
  {
    "id": 19, // 博客ID
    "created_at": "2017-12-20 16:35:24", // 创建时间
    "updated_at": "2022-09-21 14:59:09", // 更新时间
    "title": "博客标题",
    "tag": [
      "标签1",
      "标签2"
    ],
    "summary": "博客摘要",
    "images": [
      "https://example.com/xxx.jpg" // 博客图片多张
    ],
    "content": "内容HTML",
    "isPublished": 1, // 是否发布
    "postTime": "2017-12-20 16:34:44", // 发布时间
    "clickCount": 215048, // 点击量
    "seoKeywords": "SEO关键词",
    "seoDescription": "SEO描述内容",
    "isTop": null, // 是否置顶
    "commentCount": 16, // 评论数
    "categoryId": 1, // 分类ID
    "_category": {
      "id": 1, // 分类ID
      "created_at": "2022-05-27 14:51:09", // 分类创建时间
      "updated_at": "2022-09-21 14:55:33", // 分类更新时间
      "pid": 0, // 父分类ID
      "sort": 1, // 分类排序
      "title": "分类名称",
      "blogCount": 1, // 分类下博客数量
      "cover": "https://xx.com/xx.jpg",
      "keywords": "分类关键词",
      "description": "分类描述"
    },
    "_cover": "https://xx.com/xx.jpg" // 博客封面，如果博客图片为空，会尝试自动从内容中抽取
  },
  // ...
]

获取推荐博客

MBlog::recommendBlog ( $limit )
参数 类型 说明
$limit integer 限制条数
返回
array 数组
返回示例 
[
  {
    "id": 19, // 博客ID
    "created_at": "2017-12-20 16:35:24", // 创建时间
    "updated_at": "2022-09-21 14:59:09", // 更新时间
    "title": "博客标题",
    "tag": [
      "标签1",
      "标签2"
    ],
    "summary": "博客摘要",
    "images": [
      "https://example.com/xxx.jpg" // 博客图片多张
    ],
    "content": "内容HTML",
    "isPublished": 1, // 是否发布
    "postTime": "2017-12-20 16:34:44", // 发布时间
    "clickCount": 215048, // 点击量
    "seoKeywords": "SEO关键词",
    "seoDescription": "SEO描述内容",
    "isTop": null, // 是否置顶
    "commentCount": 16, // 评论数
    "categoryId": 1, // 分类ID
    "_category": {
      "id": 1, // 分类ID
      "created_at": "2022-05-27 14:51:09", // 分类创建时间
      "updated_at": "2022-09-21 14:55:33", // 分类更新时间
      "pid": 0, // 父分类ID
      "sort": 1, // 分类排序
      "title": "分类名称",
      "blogCount": 1, // 分类下博客数量
      "cover": "https://xx.com/xx.jpg",
      "keywords": "分类关键词",
      "description": "分类描述"
    },
    "_cover": "https://xx.com/xx.jpg" // 博客封面，如果博客图片为空，会尝试自动从内容中抽取
  },
  // ...
]

最新博客评论

MBlog::latestComment ( $limit )
参数 类型 说明
$limit integer 限制条数
返回
array
返回示例 
[
  {
    "id": 1, // 评论ID
    "created_at": "2022-09-21 14:59:09", // 创建时间
    "blog": {
      "id": 19,          // 博客ID
      "title": "博客标题",
      "_url": "/blog/15"  // 博客URL
    }
  },
  // ...
]

最新留言内容

MBlog::latestMessage ( $limit )
参数 类型 说明
$limit integer 限制条数
返回
array
返回示例 
[
  {
    "id": 5650,
    "created_at": "2022-05-28 11:06:23",
    "updated_at": "2022-05-28 11:06:28",
    "reply": null,
    "username": "我心飞扬",
    "email": "",
    "url": "",
    "content": "<p>或许对于世界，你是一个人；但对于我，你就是全世界。你在时，你是一切，你不在时，一切是你。</p>",
    "upCount": null,
    "downCount": null,
    "memberUserId": 0,
    "status": 2
  },
  // ...
}

获取最热博客

MBlog::hottestBlog ( $limit )
参数 类型 说明
$limit integer 限制条数
返回
array 数组
返回示例 
[
  {
    "id": 19, // 博客ID
    "created_at": "2017-12-20 16:35:24", // 创建时间
    "updated_at": "2022-09-21 14:59:09", // 更新时间
    "title": "博客标题",
    "tag": [
      "标签1",
      "标签2"
    ],
    "summary": "博客摘要",
    "images": [
      "https://example.com/xxx.jpg" // 博客图片多张
    ],
    "content": "内容HTML",
    "isPublished": 1, // 是否发布
    "postTime": "2017-12-20 16:34:44", // 发布时间
    "clickCount": 215048, // 点击量
    "seoKeywords": "SEO关键词",
    "seoDescription": "SEO描述内容",
    "isTop": null, // 是否置顶
    "commentCount": 16, // 评论数
    "categoryId": 1, // 分类ID
    "_category": {
      "id": 1, // 分类ID
      "created_at": "2022-05-27 14:51:09", // 分类创建时间
      "updated_at": "2022-09-21 14:55:33", // 分类更新时间
      "pid": 0, // 父分类ID
      "sort": 1, // 分类排序
      "title": "分类名称",
      "blogCount": 1, // 分类下博客数量
      "cover": "https://xx.com/xx.jpg",
      "keywords": "分类关键词",
      "description": "分类描述"
    },
    "_cover": "https://xx.com/xx.jpg" // 博客封面，如果博客图片为空，会尝试自动从内容中抽取
  },
  // ...
]

随机获取博客

MBlog::randomBlog ( $limit )
参数 类型 说明
$limit integer 限制条数
返回
array 数组
返回示例 
[
  {
    "id": 19, // 博客ID
    "created_at": "2017-12-20 16:35:24", // 创建时间
    "updated_at": "2022-09-21 14:59:09", // 更新时间
    "title": "博客标题",
    "tag": [
      "标签1",
      "标签2"
    ],
    "summary": "博客摘要",
    "images": [
      "https://example.com/xxx.jpg" // 博客图片多张
    ],
    "content": "内容HTML",
    "isPublished": 1, // 是否发布
    "postTime": "2017-12-20 16:34:44", // 发布时间
    "clickCount": 215048, // 点击量
    "seoKeywords": "SEO关键词",
    "seoDescription": "SEO描述内容",
    "isTop": null, // 是否置顶
    "commentCount": 16, // 评论数
    "categoryId": 1, // 分类ID
    "_category": {
      "id": 1, // 分类ID
      "created_at": "2022-05-27 14:51:09", // 分类创建时间
      "updated_at": "2022-09-21 14:55:33", // 分类更新时间
      "pid": 0, // 父分类ID
      "sort": 1, // 分类排序
      "title": "分类名称",
      "blogCount": 1, // 分类下博客数量
      "cover": "https://xx.com/xx.jpg",
      "keywords": "分类关键词",
      "description": "分类描述"
    },
    "_cover": "https://xx.com/xx.jpg" // 博客封面，如果博客图片为空，会尝试自动从内容中抽取
  },
  // ...
]

获取博客分页

MBlog::paginateBlog ( $categoryId, $page, $pageSize, $option )
参数 类型 说明
$categoryId integer 分类ID
$page integer 分页，默认为1
$pageSize integer 分页大小，默认为10
$option array 分页高级参数
返回
array 数组
返回示例 
{
  "records": [
    {
      "id": 19,
      "created_at": "2017-12-20 16:35:24",
      "updated_at": "2022-09-21 14:59:09",
      "title": "博客标题",
      "tag": [
        "标签1",
        "标签2"
      ],
      "summary": "博客摘要",
      "images": [
        "https://example.com/xxx.jpg"
      ],
      "content": "内容HTML",
      "isPublished": 1,
      "postTime": "2017-12-20 16:34:44",
      "clickCount": 215048,
      "seoKeywords": "博客SEO关键词",
      "seoDescription": "博客SEO描述",
      "isTop": null,
      "commentCount": 16,
      "categoryId": 1,
      "_category": {
        "id": 1,
        "created_at": "2022-05-27 14:51:09",
        "updated_at": "2022-09-21 14:55:33",
        "pid": 0,
        "sort": 1,
        "title": "分类名称",
        "blogCount": 1,
        "cover": "https://xx.com/xx.jpg",
        "keywords": "分类关键词",
        "description": "分类描述"
      },
      "_cover": "https://xx.com/xx.jpg"
    },
    // ...
  ],
  "total": 1
}

根据年份列出所有博客

MBlog::listBlogByYear ( array )
参数 类型 说明
array $option
返回
array {

获取分类信息

MBlog::getCategory ( $categoryId )
参数 类型 说明
$categoryId integer 分类ID
返回
array 数组
返回示例 
{
  "id": 1, // 分类ID
  "created_at": "2022-05-27 14:51:09",
  "updated_at": "2022-09-21 14:55:33",
  "pid": 0,
  "sort": 1,
  "title": "分类名称",
  "blogCount": 1,
  "cover": "https://example.com/xxx.jpg",
  "keywords": "分类关键词",
  "description": "分类描述"
}

获取子分类信息

MBlog::listChildCategories ( $parentCategoryId )
参数 类型 说明
$parentCategoryId integer 分类ID
返回
array 数组
返回示例 
[
  {
    "id": 1, // 分类ID
    "created_at": "2022-05-27 14:51:09",
    "updated_at": "2022-09-21 14:55:33",
    "pid": 0,
    "sort": 1,
    "title": "分类名称",
    "blogCount": 1,
    "cover": "https://example.com/xxx.jpg",
    "keywords": "分类关键词",
    "description": "分类描述"
  },
  // ...
]

获取所有博客标签信息

MBlog::tags ( $limit )
参数 类型 说明
$limit integer 限制数量，0为不限制
返回
array 数组，标签→数量映射
返回示例 
{
  "标签1": 1,
  "标签2": 2
}

获取所有博客标签信息

MBlog::tagRecords ( )
返回
array 数组
返回示例 
[
 {
  "name": "标签1",
  "count": 1
 }
]

按月获取归档数量

MBlog::archiveMonthCounts ( $year )
参数 类型 说明
$year number|string 年
返回
array 数组
返回示例 
[
{
"month": "06",
"total": 1
},
{
"month": "12",
"total": 6
}
]

按年获取归档数量

MBlog::archiveYearCounts ( )
返回
array 数组
返回示例 
[
{
"year": "06",
"total": 1
},
{
"year": "12",
"total": 6
}
]
ＱＱ

QQ扫一扫联系

点击联系

2374926113

微信

微信扫一扫联系
客服