mmaurice / evo-widgets
来自Modx Evolution 1.x片段和片段的网站小部件
0.1
2023-12-21 12:35 UTC
Requires
- php: >=5.6
- mmaurice/modx-injector: dev-main
This package is auto-updated.
Last update: 2024-09-21 14:30:50 UTC
README
该工具允许以代码形式调用Modx Evolution的任何块或片段,同时可以通过白名单或黑名单来限制输出。
安装
克隆项目
composer create-project mmaurice/evo-widgets ./widgets
转到项目目录
cd ./widgets
更新composer依赖
composer update
创建配置文件
copy ./config.php.example ./config.php
配置
所有设置都存储在config.php文件中。配置文件包含以下节点
-
filter - 应用过滤方法。支持的值:
blacklist
|whitelist
|none
。如果选择blacklist过滤方法,则允许使用不在blacklist中列出的所有块和片段。如果选择whitelist过滤方法,则禁止使用不在whitelist中列出的所有块和片段。 -
blacklist - 禁止使用的块和片段名称数组。
-
whitelist - 允许使用的块和片段名称数组。
注意:对于blacklist和whitelist节点,需要指定以掩码指定的实体名称和类型。
'<type>:<name>'
其中,
- - 实体类型。可以使用:
chunk
|snippet
。 - - 实体名称。
这是为了排除在系统中注册了具有相同名称的块和片段时的歧义。
使用
使用此模块非常简单。需要在浏览器地址栏中调用index.php文件,并通过GET请求传递至少一个主要参数:name,其中需要指定以上述格式指定的调用实体的名称
'<type>:<name>'
因此,地址栏中的链接可以是这样的
http://website/widgets/index.php?name=chunk:demo
此外,一些块和片段支持在调用时传递参数数组。此功能也在此模块中支持。如果请求以下地址
http://website/widgets/index.php?name=snippet:demo&foo=bar
这将等同于调用
{{demo ? &foo=`bar`}}