Office Converter 技术文档

Office Converter 技术文档

office-converter PHP Wrapper for LibreOffice 项目地址: https://gitcode.com/gh_mirrors/of/office-converter

1. 安装指南

1.1 安装依赖

在使用 Office Converter 之前，您需要安装 LibreOffice。LibreOffice 是一个开源的办公套件，支持多种文件格式的转换。

1.2 使用 Composer 安装 Office Converter

我们推荐使用 Composer 来安装 Office Converter。Composer 是一个 PHP 的依赖管理工具，可以帮助您轻松管理项目中的依赖关系。

在您的项目目录中运行以下命令：

composer require ncjoes/office-converter

2. 项目使用说明

2.1 基本用法

Office Converter 提供了一个简单的 API，用于将 Office 文件转换为 PDF 和 HTML 格式。以下是一些基本的使用示例：

<?php
// 如果您使用 Composer，只需使用以下代码
use NcJoes\OfficeConverter\OfficeConverter;

// 创建一个转换器实例，传入要转换的文件路径
$converter = new OfficeConverter('test-file.docx');

// 将文件转换为 PDF 格式
$converter->convertTo('output-file.pdf'); // 生成的 PDF 文件将保存在与 test-file.docx 相同的目录中

// 将文件转换为 HTML 格式
$converter->convertTo('output-file.html'); // 生成的 HTML 文件将保存在与 test-file.docx 相同的目录中

// 如果您想指定输出目录，可以在构造函数中指定第二个参数
$converter = new OfficeConverter('test-file.docx', 'path-to-outdir');
?>

2.2 支持的转换格式

Office Converter 支持以下文件格式的转换：

• pptx => pdf
• ppt => pdf
• pdf => pdf
• docx => pdf, odt, html
• doc => pdf, odt, html
• xlsx => pdf
• xls => pdf
• png => pdf
• jpg => pdf
• jpeg => pdf

3. 项目 API 使用文档

3.1 OfficeConverter 类

构造函数

public function __construct(string $inputFilePath, string $outputDir = '')

• inputFilePath: 要转换的文件路径。
• outputDir: 可选参数，指定输出文件的目录。如果不指定，输出文件将保存在与输入文件相同的目录中。

convertTo 方法

public function convertTo(string $outputFileName)

• outputFileName: 输出文件的名称（不包括扩展名）。该方法会根据输出文件的扩展名自动选择转换格式。

4. 项目安装方式

Office Converter 通过 Composer 进行安装。Composer 是一个 PHP 的依赖管理工具，可以帮助您轻松管理项目中的依赖关系。

在您的项目目录中运行以下命令：

composer require ncjoes/office-converter

5. 反馈与贡献

如果您在使用过程中遇到任何问题、发现 bug 或希望提出改进建议，请随时与我们联系。感谢您的支持！

---

注意：本文档使用 Markdown 格式编写，适用于在 GitHub 或其他支持 Markdown 的平台上阅读。

office-converter PHP Wrapper for LibreOffice 项目地址: https://gitcode.com/gh_mirrors/of/office-converter