English | 简体中文 | 繁體中文
查询

wkhtmltox\PDF\Converter::convert()函数—用法及示例

「 将HTML内容转换为PDF格式 」


函数名称:wkhtmltox\PDF\Converter::convert()

适用版本:wkhtmltox 0.12.4

函数用法:该函数用于将HTML内容转换为PDF格式。它是wkhtmltopdf库的一部分,可以在PHP中使用。

语法:

public static function convert($html, $options = [], $outputFile = '')

参数:

  • $html(必需):要转换为PDF的HTML内容。
  • $options(可选):转换选项的数组。默认为空数组。可以使用各种选项来自定义转换过程,如页面大小、页边距、页眉页脚等。
  • $outputFile(可选):输出PDF文件的路径。默认为空字符串。如果未指定输出文件路径,则函数将返回PDF内容作为字符串。

返回值:

  • 如果指定了$outputFile参数,则返回true表示转换成功,否则返回PDF内容的字符串。

示例:

use wkhtmltox\PDF\Converter;

$html = '<html><body><h1>Hello, World!</h1></body></html>';
$outputFile = '/path/to/output.pdf';
$options = [
    'page-size' => 'A4',
    'margin-top' => '10mm',
    'margin-right' => '10mm',
    'margin-bottom' => '10mm',
    'margin-left' => '10mm',
];

// 将HTML内容转换为PDF并保存到指定路径
if (Converter::convert($html, $options, $outputFile)) {
    echo 'PDF转换成功!';
} else {
    echo 'PDF转换失败!';
}

// 将HTML内容转换为PDF并获取PDF内容作为字符串
$pdfContent = Converter::convert($html, $options);
echo $pdfContent;

注意事项:

  • 在使用该函数之前,需要先安装wkhtmltopdf库,并确保其可执行文件(wkhtmltopdf)位于系统的可执行路径中。
  • 可以通过$options参数来自定义转换过程,具体的选项可以参考wkhtmltopdf的官方文档。
  • 如果转换失败,可以通过查看返回的错误信息来进行故障排除。
  • 转换过程可能会消耗较多的系统资源,特别是对于复杂的HTML内容,建议在服务器端进行转换时注意性能优化。
补充纠错
下一个函数: wordwrap()函数
热门PHP函数
分享链接