zellien/zellien-mjml

用于渲染 MJML 模板的 PHP 库

v1.0.0 2023-06-22 16:50 UTC

This package is auto-updated.

Last update: 2024-09-22 20:00:19 UTC


README

用于渲染 MJML 模板的 PHP 库

Static Badge Static Badge

安装

首选的安装方法是使用 Composer。运行以下命令来安装包并将其添加到项目的需求中:

composer require zellien/zellien-mjml

使用方法

通过将配置数组传递给构造函数来创建 MjmlRenderer 类的实例。配置数组应包含非空字符串的应用程序 ID 和密钥。

在 $renderer 对象上调用 render 方法,传递非空字符串的 MJML 模板。它将以非空字符串的形式返回渲染的 HTML。

$mjmlTemplate = '<mjml>Your MJML template goes here</mjml>';
$renderedHtml = $renderer->render($mjmlTemplate);

处理 render 方法可能抛出的潜在异常

  • BadRequestException 如果请求无效。
  • UnauthorizedException 如果身份验证失败。
  • ForbiddenException 如果请求未经授权。
  • UnexpectedErrorException 如果发生意外错误。
try {
    $renderedHtml = $renderer->render($mjmlTemplate);
} catch (BadRequestException $e) {
    // Handle bad request error
} catch (UnauthorizedException $e) {
    // Handle unauthorized error
} catch (ForbiddenException $e) {
    // Handle forbidden error
} catch (UnexpectedErrorException $e) {
    // Handle unexpected error
}

附加说明

确保已安装必要的依赖项,例如 cURL 扩展。

确保 API URL(https://api.mjml.io/v1/render)可以从您的环境中访问。

就这样!您现在可以在项目中使用 MjmlRenderer 库来通过 API 渲染 MJML 模板。