nstcactus / craft-utils
一组工具类,用于简化在Craft CMS项目中的工作
4.0.0
2024-04-18 06:05 UTC
Requires
- craftcms/cms: ^3.5.0 || ^4.0.0 || ^5.0.0-beta.1
README
这是一个Craft实用工具的集合,用于简化Craft CMS上的自定义开发。
AbstractModule
这个用于自定义模块的基类旨在简化Craft模块的创建。大多数情况下,您只需重写相应的getter即可注册/自定义以下组件
- 翻译分类(提供合理的默认值)
- CP模板根目录(提供合理的默认值)
- 站点模板根目录(提供合理的默认值)
- Twig扩展
- CP导航项
- CP路由
- 站点路由
- 用户权限
- Craft变量添加
- 元素类型
- 视图钩子
⚠️ 由于getters在每个请求上都会执行,因此可能会对性能产生影响。在getters中尽可能少做工作,并在可能的情况下尽早返回。
如果您需要进一步优化代码,可以轻松删除此模块并以传统方式注册组件。
MailerComponentConfiguratorModule
此简单模块允许您使用环境变量配置Craft邮件组件。
使用环境变量NST_MAILER_TRANSPORT_TYPE
设置邮件传输适配器。支持的值:smtp
、mailchimp
(也接受mandrill
,但已弃用)或mailjet
。
根据您选择的适配器,需要不同的环境变量来配置适配器。
所有适配器都通用
NST_MAILER_FROM_NAME
:必需——用于发件人电子邮件的From:
头部的名称NST_MAILER_FROM_EMAIL
:必需——用于发件人电子邮件的From:
头部的电子邮件地址
SMTP
NST_MAILER_SMTP_HOST
:必需——SMTP服务器主机名NST_MAILER_SMTP_PORT
:必需——SMTP服务器端口号NST_MAILER_SMTP_USE_AUTHENTICATION
:布尔值——SMTP服务器是否需要身份验证NST_MAILER_SMTP_USERNAME
:如果NST_MAILER_SMTP_USE_AUTHENTICATION
是必需的——SMTP用户名NST_MAILER_SMTP_PASSWORD
:如果NST_MAILER_SMTP_USE_AUTHENTICATION
是必需的——SMTP密码NST_MAILER_SMTP_ENCRYPTION
:SMTP加密方法。可以是tls
或ssl
Mailchimp
为了使用此适配器,必须安装mailchimp-transactional
插件。
有关映射到这些环境变量的设置详情,请参阅mailchimp-transactional
插件的文档。
NST_MAILER_MAILCHIMP_API_KEY
:必需——mailchimp-transactional
插件apiKey
设置的值NST_MAILER_MAILCHIMP_SUBACCOUNT
:mailchimp-transactional
插件subaccount
设置的值NST_MAILER_MAILCHIMP_TEMPLATE
:mailchimp-transactional
插件template
设置的值
Mailjet
为了使用此适配器,必须安装mailjet
插件。
有关映射到这些环境变量的设置详情,请参阅mailjet
插件的文档。
NST_MAILER_MAILJET_API_KEY
:必需——mailjet
插件apiKey
设置的值NST_MAILER_MAILJET_API_SECRET
:必需——mailjet
插件apiSecret
设置的值