README

安装

通过Composer

$ composer require "njxzwh/superview @dev"

使用方法

SuperView::setConfig($configs);
SuperView::get('soft')->recent();

使用缓存

缓存默认使用全局配置cache_minutes，如果需要为单独的请求设置缓存时间，可以使用cache方法，参数为分钟。

SuperView::get('soft')->cache(10)->recent();

如果需要修改所有的查询都为设置的缓存时间，可以使用第二个参数，缓存时间将一直保留，直到下一次设置cache。

SuperView::get('soft')->cache(10, true)->recent();
SuperView::get('soft')->recent(); //仍然使用上面的缓存时间

SuperView::get('soft')->cache(20)->recent(); //使用新的缓存时间, 并且只在当前调用中

使用分页

所有支持limit参数的方法都可以使用分页

第一个参数用来生成分页的url，应该与路由格式保持一致。第二个参数指定当前分页。

SuperView::get('soft')->page('list-{page}.html', $page)->recent();

使用指定分页和自定义的布局，第二个参数指定分页，第三个参数指定是否使用简洁模式(默认false)，第四个参数参考Configs下的pagination。

SuperView::get('soft')->page('list-{page}.html', 2, false,
    [
        'layout' => '<ul>{total}{previous}{links}{next}</ul>',
        'total' => '<li class="pipe">共{total}页</li>',
        'previous' => '<li href="{url}">上一页</li>',
        'links' => '<li href="{url}">{page}</li>',
        'link_active' => '<li class="on">{page}</li>',
        'next' => '<li href="{url}">下一页</li>',
        'dots' => '<li">...</li>',
    ])->recent();

返回数据格式

[
  "count" => "594",
  "list" => [],
  "page" => ""
]

仅分页数据，不需要返回page和count，第一个参数设置为false。

SuperView::get('soft')->page(false, 2)->recent();
SuperView::get('soft')->page(false)->recent(); // 默认为第一页, 作用相当于不使用page方法

配置

[
    'api_base_url' => 'http://api.base.url',
    'cache_minutes' => 120, // 通用缓存时间, 单位: 分 默认120分钟, 如果设置为0则不使用缓存, 但是所有的分类数据依然使用缓存, 如果需要更新分类缓存可以设置refresh_cache.
    'refresh_cache' => 1, // 刷新所有方法的缓存, 1是, 0否, 默认0
    'class_url' => '/{channel}/{classname}/{classid}{page}.html', //支持参数列表
    'info_url' => '/{channel}/{classname}/{classid}/{id}.html', //支持参数列表
    'pagination' => [
        'layout' => '<div class="pages pt-20">{total}{previous}{links}{next}</div>',
        'total' => '<span class="pipe">共{total}页</span>',
        'previous' => '<a href="{url}">上一页</a>',
        'links' => '<a href="{url}">{page}</a>',
        'link_active' => '<a class="on">{page}</a>',
        'next' => '<a href="{url}">下一页</a>',
        'dots' => '<span class="pipe">...</span>',
    ],
]

API

category 分类模块

1. info($classid)

获取分类信息

参数

2. finalChildren($classid, $limit)

获取子终极分类

参数

3. children($classid, $limit)

获取下一级子分类

参数

4. brothers($classid)

获取同级兄弟分类

参数

5. breadcrumbs($classid)

获取分类的面包屑

参数

6. search($name, $classid)

根据分类名称搜索分类(模糊查询)

参数

content 内容模块

使用具体的channel名称，只有不确定channel才使用content(目前只有superTopic方法支持使用content)

1. info($id)

获取内容信息

参数

2. recent($classid, $limit, $isPic)

获取最新内容列表

参数

3. rank($period, $classid, $limit, $isPic)

获取周期排行列表

参数

4. good($level, $classid, $limit, $isPic, $order)

获取推荐列表

参数

5. top($level, $classid, $limit, $isPic, $order)

获取置顶列表

参数

6. firsttitle($level, $classid, $limit, $isPic, $order)

获取头条列表

参数

7. today($classid, $limit, $isPic, $order)

获取今日列表

参数

8. interval($startTime, $endTime, $classid, $limit, $isPic, $order)

获取时间段列表

参数

9. title($title, $classid, $limit, $isPic, $order)

获取相同名称内容列表

参数

10. related($id, $classid, $limit, $isPic, $order)

获取内容相关内容列表

参数

11. tag($tag, $classid, $limit, $isPic, $order)

获取tag相关内容列表

参数

12. infoTopics($id, $limit)

获取信息所属专题列表(不支持分页)

参数

13. topic($topicId, $limit)

获取专题信息列表

参数

14. superTopic($topicId, $limit)

获取专题信息列表，如果无法指定channel，使用该方法获取该专题下的所有channel的内容，否则直接使用topic方法

参数

15. search($keyword, $classid, $limit, $isPic, $order)

获取tag相关内容列表

参数

16. count($period, $classid)

获取统计数量

参数

17. order($classid, $limit, $order)

排序列表

参数

topic 专题模块

1. index($topicCategoryId, $classid, $limit, $order)

获取专题列表

参数

2. info($id, $path)

获取专题信息

参数

3. categories()

获取所有专题分类列表

4.match($field, $value, $classid = 0, $limit = 0, $order = 'addtime')

专题自定义查询

参数

tag TAG模块

1. index($isGood, $classid, $limit, $order)

获取TAG列表

参数

2. categotyUrl($classid)

获取分类页面URL(正常情况下，你应该不使用此方法，除非你要指定分页)

参数

3.label($ztid, $id, $classid = 0, $limit = 0)

游戏攻略获取标签

参数

4.hotLabel($ztid, $limit = 0)

获取热门标签

参数

5.labelList($ztid, $labelid = 0, $limit = 0, $order = 'newstime')

专题标签下关联软件列表

参数

6.getAllLabel

获取所有标签

无参数

utils 工具模块

1. friendLinks($type, $classid, $limit)

获取专题列表

参数

2. renderPage($route, $total, $limit, $page, $simple, $options)

获取专题列表

参数

变更日志

请参阅变更日志以获取最近更改的更多信息。

安全

如果你发现任何安全相关的问题，请通过电子邮件huangyukun@njxzwh.com而不是使用问题跟踪器。

许可

MIT许可（MIT）。请参阅许可文件以获取更多信息。