集成配置 表单说明
Note
此页面的内容需要进行重大更新。旧页面包含过时且可能不准确的信息。您仍然可以在 Mautic Developer Documentation archived repository 中访问它。
如果您有兴趣帮助开发此页面和其他新内容的，请考虑加入文档编写工作。
请阅读 Contributing Guidelines 和 Contributing to Mautic’s documentation 以开始贡献。
集成框架允许开发者为插件的配置表单定义自定义消息。
ConfigSupport 类应实现 \Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface 接口。
- interface \Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface
- public function getAuthorizationNote(): ?Note
- Returns:
Auth 选项卡的提示信息和类型。
- Return type:
Note
- public function getFeaturesNote(): ?Note
- Returns:
Features 选项卡的提示信息和类型。
- Return type:
Note
- public function getFieldMappingNote(): ?Note
- Returns:
Field Mapping 选项卡的提示信息和类型。
- Return type:
Note
Note 对象
- class \Mautic\IntegrationsBundle\DTO\Note
- public note;
- public type;
- public function getNote(): string
- Returns:
要显示的字符串。
- Return type:
string
- public function getType(): string
- Returns:
提示信息类型，这有助于注释提示信息。
- Return type:
string
以下代码片段展示了 \Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface 的用法。
<?php declare(strict_types=1); namespace MauticPlugin\HelloWorldBundle\Integration\Support;
```markdown use MauticIntegrationsBundleDTONote;
use MauticIntegrationsBundleIntegrationConfigFormNotesTrait; use MauticIntegrationsBundleIntegrationDefaultConfigFormTrait; use MauticIntegrationsBundleIntegrationInterfacesConfigFormAuthInterface; use MauticIntegrationsBundleIntegrationInterfacesConfigFormFeatureSettingsInterface; use MauticIntegrationsBundleIntegrationInterfacesConfigFormFeaturesInterface; use MauticIntegrationsBundleIntegrationInterfacesConfigFormInterface; use MauticIntegrationsBundleIntegrationInterfacesConfigFormNotesInterface; use MauticIntegrationsBundleIntegrationInterfacesConfigFormSyncInterface; use MauticPluginHelloWorldBundleFormTypeConfigAuthType; use MauticPluginHelloWorldBundleFormTypeConfigFeaturesType; use MauticPluginHelloWorldBundleIntegrationHelloWorldIntegration;
class ConfigSupport extends HelloWorldIntegration implements ConfigFormInterface, ConfigFormAuthInterface, ConfigFormFeatureSettingsInterface, ConfigFormSyncInterface, ConfigFormFeaturesInterface, ConfigFormNotesInterface {
use DefaultConfigFormTrait; use ConfigFormNotesTrait;
public function getAuthConfigFormName(): string {
return ConfigAuthType::class;
}
public function getFeatureSettingsConfigFormName(): string {
return ConfigFeaturesType::class;
}
// …
- /**
为“启用/身份验证”选项卡添加消息。
*/
public function getAuthorizationNote(): ?Note {
return new Note(‘Additional information for Authorization tab.’, Note::TYPE_INFO);
}
- /**
为“功能”选项卡添加消息。
*/
public function getFeaturesNote(): ?Note {
return new Note(‘Warning message for Features tab.’, Note::TYPE_WARNING);
}
- /**
为“字段映射”选项卡添加消息。
*/
public function getFieldMappingNote(): ?Note {
return new Note(‘Additional information for Field mapping tab.’, Note::TYPE_INFO);
}
}
补充信息
MauticIntegrationsBundleIntegrationConfigFormNotesTrait 特性有助于定义默认值 null。
除了纯字符串，还可以传递包含消息的翻译键，例如 new Note(‘helloworld.config.auth_tab’, Note::TYPE_INFO);