s1syphos / kirby3-gesetze
为 Kirby v3 连接德国法律规范,无依赖项且符合 GDPR
1.0.0
2021-12-17 11:07 UTC
Requires
- getkirby/composer-installer: ^1.1
- s1syphos/php-gesetze: ^0.5.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.14
README
此插件自动链接德国法律规范 - 无依赖项且符合 GDPR,由 php-gesetze
提供支持。
入门
使用以下方法之一安装和使用 kirby3-gesetze
Git 子模块
如果您熟悉 Git,可以将其作为 子模块 下载
git submodule add https://codeberg.org/S1SYPHOS/kirby3-gesetze.git site/plugins/kirby3-gesetze
Composer
composer require s1syphos/kirby3-gesetze
克隆或下载
用法
快速演示
此 Markdown text
内容 ..
This is a **simple** HTML text. It contains legal norms, like Art. 12 I GG and § 433 II BGB!
.. 容易地 ..
# .. via `kirbytext()` .. echo $page->text()->kt() # .. or page method .. echo $page->gesetzify($text); # .. or field method .. echo $page->text()->gesetzify();
.. 成为
<p> This is a <strong>simple</strong> HTML text. It contains legal norms, like <a href="https://www.gesetze-im-internet.de/gg/art_12.html" target="_blank">Art. 12 I GG</a> or <a href="https://www.gesetze-im-internet.de/bgb/__433.html" target="_blank">§ 433 II BGB</a>! </p>
配置
您可以从全局的 config.php
中更改某些选项('kirby3-gesetze.optionName'
)
当通过 kirby3-gesetze.enabled
启用插件时,自动链接应用于所有 kirbytext()
/ kt()
调用,有两个例外
- 如果页面的
intendedTemplate()
名称允许(列表),则这会覆盖kirby3-gesetze.enabled
为false
- 如果页面的
intendedTemplate()
名称被列入黑名单,则这会覆盖kirby3-gesetze.enabled
为true
除此之外,还有其他方法可以使用
方法
有多种方式可以实现,您可以使用独立函数、页面方法或字段方法
方法:gesetzify(string $text): string
处理给定的文本中的(有效)法律规范
页面方法:$page->gesetzify(string $text)
与 gesetzify
相同
字段方法:$field->gesetzify(string $text, bool $inline = false)
与 gesetzify
相同,但支持通过 $inline
选项应用 kt()
/ kti()
路线图
- 添加测试
致谢 / 许可证
kirby3-gesetze
基于 php-gesetze
库。它采用 MIT 许可证,但在 生产中使用 Kirby 需要您 购买许可证。
特别感谢
我想感谢所有制作出色软件的人 - 你们太棒了。我也一直感谢反馈和错误报告 :)