Lopwon Json 使用文档

2023年06月01日

demo-lopwon-json.jpg

版本型号：Lopwon Json
适用程序：Typecho
皮肤类型：模板 + 插件
组件作者：Lopwon
作者博客：Lopwon.com
发布页面：Lopwon.com/lopwon-json.html
许可方式：MIT
官方演示：Lopwon Json

组件说明

组件 Lopwon Json 的作用是：把任意数量的指定文章，生成 Json 格式内容，统一输出在同一页面，可以在博客内自己调用，也可以提供给其他博客调用，或者骚一点，变成自己调用友人的博客文章。功能类似于之前制作的 Lopwon Feed 插件，但，组件 Lopwon Json 可以调用任意文章，而不局限于 Feed 的最新 10 篇。

提示：组件 Lopwon Json 未使用缓存机制，过多的订阅会使加载耗时更长。

应用场景

组件 Lopwon Json 由（模板 + 插件）构成：

1. 模板 Lopwon_Json.php 作用，把任意数量的指定文章生成 Json 格式内容，统一输出在同一页面。

2. 插件 Lopwon Json 作用，解析模板 Lopwon_Json.php 生成的 Json 页面内容并输出，可自定义结构和样式。

场景一：调用多位友人博客的任意文章

友人使用模板 Lopwon_Json.php 生成指定的任意文章多篇（如：7 篇），输出在 json.html 页面，自己使用插件 Lopwon Json 解析该页面，并能在插件后台，勾选哪些文章（如：3 篇）可以在自己的博客页面显示。

不局限一位友人，可以同时调用多位友人授权显示的文章。

场景二：把自己博客的文章提供给友人调用

也就是场景一的逆向操作。

场景三：把自己博客的文章提供给自己调用

与场景一相似，自己同时使用（模板 + 插件）完成输出 Json 页面和解析页面的过程。

场景四：如果添加通过识别来源并记录点击数的功能，则可以作为营销页面使用，以点击率获取广告主的推广佣金。

组件更新

2023年08月18日 发布 Lopwon Json v1.1 修正已知问题。

2023年06月04日 发布 Lopwon Json
使用方法

一、模板 Lopwon_Json.php

A 部署文件

1. 将压缩包里的文件 Lopwon_Json.php 上传至目录 usr/themes 中的你的主题文件夹里。

B 配置页面

后台》管理》独立页面》新增，新建独立页面，除以下提到的事项外，其余正常操作即可。

1. 此编辑页面右侧的“自定义模板”里，请选择“Lopwon Json”。

2. 新增自定义字段（必选项），字段名称填入 jsonCid 乱填无效，字段值填入需要生成 Json 格式内容的文章 cid 多个以半角逗号隔开。

3. 新建自定义字段（可选项），字段名称填入 jsonImg 乱填无效，字段值填入图片链接，用于文章中没有图片时，作为默认图片调用。

4. 此编辑页面右侧的“高级选项”，在“公开度”选择“隐藏”后，可将此独立页面的标题不展示在某些主题的分类菜单里。

二、插件 Lopwon Json

A 部署插件

1. 将压缩包里的文件夹 LopwonJson 及其内部的所有文件，上传至目录 usr/plugins 中。

2. 后台》控制台》插件，找到 Lopwon Json 并启用。

B 配置插件

后台》控制台》插件，找到 Lopwon Json 并设置，依喜好设置即可。

C 调用插件

在指定页面调用插件解析的文章。

1. 打开主题文章文件（如：post.php），在合适位置（如：文末）添加以下代码：


    <?php if ($this->cid == '文章cid编码') { Typecho_Plugin::factory('Lopwon_Json')->Lopwon(); } ?>


2. 请把以上代码中（文章cid编码）替换为你要显示插件解析后的文章的页面 cid

D 手欠补救

当你关注这段文档，说明你真的没听劝：

1. 打开数据库后缀为 _options 的表（如：typecho_options）。

2. 找到列名 name 为 plugin:LopwonJson 的行数据，按以下方式修改对应列名为 value 的值。

3. 搜索 jsonNum 将其后第一对双引号内的数值，改为手欠前的数值，提交修改数据即可。

E 避免手欠

除了留意插件里的提示外，还可以自己动手，通过新增验证方法，达到限制输入小于当前（数量）值的目的：

1. 打开插件 Lopwon Json 的文件 Plugin.php 把第 87 行的注释解除，把第 88 行注释掉（也就是把第 87 行前的两个斜杠移到第 88 行前）。

2. 打开文件 var/Typecho/Validate.php 在适当位置（比如：第 58 行）添加以下代码：


    /**
     * 最小数值
     *
     * @access public
     *
     * @param string $str 待处理的数值
     * @param integer $value 最小数值
     *
     * @return boolean
     */
    public static function minValue(string $str, int $value): bool
    {
        return ($str) >= $value;
    }    


3. 如上操作后，在插件 Lopwon Json 的（数量）里，就无法输入小于当前数量的数值，避免了手欠出错。

F 使用技巧

使用HTML标签和属性，在（自己定义）里可以自定义输出文章的结构和样式，如下:

1. 插件样式大部分沿用自你的主题样式（如：字体字号等），如有显示异常，请自行调整文件 lopwon.json.css 进行适配。


    <ul>
        <li>图片：{image}</li>
        <li>标题：{title}</li>
        <li>链接：{permalink}</li>
        <li>日期：{date}</li>
        <li>内容：{content}</li>
        <li>评论：{commentsNum}</li>
        <li>博客：{blog}</li>
        <li>作者：{author}</li>
        <li>主页：{siteUrl}</li>
    </ul>

This is a message

store