icybee / module-views
允许模块动态数据在内容区域显示。
v3.0.0
2016-05-24 21:44 UTC
Requires
- php: ^5.5|^7.0
- icanboogie/facets: ^0.6
- icanboogie/module-installer: ^1.2
This package is auto-updated.
Last update: 2024-09-20 06:29:41 UTC
README
视图模块(views
)允许模块动态数据在内容区域显示。
事件
视图已收集
在Collection\CollectEvent类的Icybee\Modules\Views\Collection::collect
事件在已启用的模块定义的视图收集后触发。事件钩子可以使用此事件来更改收集内容。
提供的记录被修改
在视图的alter_records
方法修改由提供者获取的记录之前,将触发View\BeforeAlterRecords类的Icybee\Modules\Views\View::alter_records:before
事件。在调用alter_records
方法后,将触发View\AlterRecords类的Icybee\Modules\Views\View::alter_records
事件。事件钩子可以使用这些事件来修改记录。
事件回调
Icybee\Modules\Pages\SaveOperation::process
更新视图的目标页面。
原型方法
Icybee\Modules\Nodes\Node::url
返回指定视图类型的记录的相对URL。
Icybee\Modules\Nodes\Node::absolute_url
返回指定视图类型的记录的URL。
Icybee\Modules\Nodes\Node::get_url
返回记录的相对URL。
Icybee\Modules\Node::get_absolute_url
返回记录的URL。
Icybee\Modules\Sites\Site::resolve_view_target
返回与视图相关联的目标页面。
Icybee\Modules\Sites\Site::resolve_view_url
返回视图的URL。
ICanBoogie\Core::get_views
返回视图集合。
标记
call-view
显示视图。
需求
<h2>Last articles</h2> <p:call-view name="articles/home" />
该包需要PHP 5.5或更高版本。
安装
安装此包的推荐方法是使用Composer。创建一个composer.json
文件,并运行php composer.phar install
命令来安装它
注意:此模块是Icybee所需的模块之一。
$ composer require icybee/module-views
克隆仓库
该包可在GitHub上找到,其仓库可以通过以下命令行克隆:
$ git clone https://github.com/Icybee/module-views views
测试
测试套件通过make test
命令运行。Composer以及运行套件所需的所有依赖项将自动安装。可以使用make clean
命令清理包目录。
该包由Travis CI持续测试。
文档
该软件包作为 Icybee CMS 的文档的一部分进行说明。软件包及其依赖项的文档可以使用 make doc
命令生成。文档使用 ApiGen 在 docs
目录中生成。之后可以使用 make clean
命令清理软件包目录。
许可协议
该模块遵循新BSD许可协议 - 详细信息请参阅 LICENSE 文件。