ttbooking / phpword
PHPWord - 一个用于读取和写入文档处理文档的纯PHP库(OOXML, ODF, RTF, HTML, PDF)
Requires
- php: ^5.3.3 || ^7.0 || ^8.0
- ext-xml: *
- laminas/laminas-escaper: ^2.2
Requires (Dev)
- ext-gd: *
- ext-zip: *
- dompdf/dompdf: 0.8.* || 1.0.*
- friendsofphp/php-cs-fixer: ^2.2
- mpdf/mpdf: 5.7.4 || 6.* || 7.* || 8.*
- php-coveralls/php-coveralls: 1.1.0 || ^2.0
- phploc/phploc: 2.* || 3.* || 4.* || 5.* || 6.* || 7.*
- phpmd/phpmd: 2.*
- phpunit/phpunit: ^4.8.36 || ^7.0
- squizlabs/php_codesniffer: ^2.9 || ^3.5
- tecnickcom/tcpdf: 6.*
Suggests
- ext-gd2: Allows adding images
- ext-xmlwriter: Allows writing OOXML and ODF
- ext-xsl: Allows applying XSL style sheet to headers, to main document part, and to footers of an OOXML template
- ext-zip: Allows writing OOXML and ODF
- dompdf/dompdf: Allows writing PDF
This package is auto-updated.
Last update: 2024-08-31 12:07:44 UTC
README
PHPWord是一个用纯PHP编写的库,提供了一组用于写入和读取不同文档文件格式的类。PHPWord的当前版本支持微软Office Open XML(OOXML或OpenXML)、OASIS Open Document Format for Office Applications(OpenDocument或ODF)、Rich Text Format(RTF)、HTML和PDF。
PHPWord 是一个开源项目,遵循 LGPL 版本 3 许可协议。PHPWord 旨在通过集成 持续集成 和 单元测试 来成为一款高质量软件产品。您可以阅读 开发者文档 了解更多关于 PHPWord 的信息。
如果您有任何问题,请在 StackOverFlow 上提问
了解更多关于 PHPWord
功能
使用 PHPWord,您可以使用 PHP 5.3.3+ 脚本动态创建 OOXML、ODF 或 RTF 文档。以下是一些您可以使用 PHPWord 库执行的操作:
- 设置文档属性,例如标题、主题和创建者。
- 创建具有不同设置的文档部分,例如纵向/横向、页面大小和页码。
- 为每个部分创建页眉和页脚。
- 设置默认字体类型、字体大小和段落样式。
- 使用 UTF-8 和东亚字体/字符。
- 定义自定义字体样式(例如加粗、斜体、颜色)和段落样式(例如居中、多列、间距),可以是命名样式或文本内的内联样式。
- 插入段落,可以是简单的文本或包含其他元素的复杂文本(文本运行)。
- 插入标题(页眉)和目录。
- 插入文本分隔符和分页符。
- 插入和格式化图像,可以是本地、远程或作为页面水印。
- 插入二进制 OLE 对象,例如 Excel 或 Visio。
- 插入并格式化具有自定义属性(例如重复作为标题行)的表格和单元格(例如背景颜色、跨行、跨列)。
- 插入项目符号、编号或多级列表项。
- 插入超链接。
- 插入脚注和尾注。
- 插入绘图形状(弧、曲线、直线、多段线、矩形、椭圆)。
- 插入图表(饼图、环形图、柱形图、折线图、面积图、散点图、雷达图)。
- 插入表单字段(文本输入、复选框和下拉列表)。
- 从模板创建文档。
- 使用 XSL 1.0 样式表转换 OOXML 模板中的页眉、主文档部分和页脚。
- ... 以及更多正在开发中的功能
要求
PHPWord 需要以下内容
- PHP 5.3.3+
- XML 解析器扩展
- Laminas Escaper 组件
- Zip 扩展(可选,用于写入 OOXML 和 ODF)
- GD 扩展(可选,用于添加图像)
- XMLWriter 扩展(可选,用于写入 OOXML 和 ODF)
- XSL 扩展(可选,用于将 XSL 样式表应用到模板)
- dompdf 库(可选,用于写入 PDF)
安装
PHPWord 通过 Composer 安装。要将 PHPWord 添加到您的项目中作为依赖项,您可以
运行以下命令以使用最新稳定版本
composer require phpoffice/phpword
或者如果您想要最新的 master 版本
composer require phpoffice/phpword:dev-master
当然,您也可以手动编辑您的 composer.json 文件
{ "require": { "phpoffice/phpword": "v0.18.*" } }
入门指南
以下是一个 PHPWord 库的基本用法示例。
<?php require_once 'bootstrap.php'; // Creating the new document... $phpWord = new \PhpOffice\PhpWord\PhpWord(); /* Note: any element you append to a document must reside inside of a Section. */ // Adding an empty Section to the document... $section = $phpWord->addSection(); // Adding Text element to the Section having font styled by default... $section->addText( '"Learn from yesterday, live for today, hope for tomorrow. ' . 'The important thing is not to stop questioning." ' . '(Albert Einstein)' ); /* * Note: it's possible to customize font style of the Text element you add in three ways: * - inline; * - using named font style (new font style object will be implicitly created); * - using explicitly created font style object. */ // Adding Text element with font customized inline... $section->addText( '"Great achievement is usually born of great sacrifice, ' . 'and is never the result of selfishness." ' . '(Napoleon Hill)', array('name' => 'Tahoma', 'size' => 10) ); // Adding Text element with font customized using named font style... $fontStyleName = 'oneUserDefinedStyle'; $phpWord->addFontStyle( $fontStyleName, array('name' => 'Tahoma', 'size' => 10, 'color' => '1B2232', 'bold' => true) ); $section->addText( '"The greatest accomplishment is not in never falling, ' . 'but in rising again after you fall." ' . '(Vince Lombardi)', $fontStyleName ); // Adding Text element with font customized using explicitly created font style object... $fontStyle = new \PhpOffice\PhpWord\Style\Font(); $fontStyle->setBold(true); $fontStyle->setName('Tahoma'); $fontStyle->setSize(13); $myTextElement = $section->addText('"Believe you can and you\'re halfway there." (Theodor Roosevelt)'); $myTextElement->setFontStyle($fontStyle); // Saving the document as OOXML file... $objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'Word2007'); $objWriter->save('helloWorld.docx'); // Saving the document as ODF file... $objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'ODText'); $objWriter->save('helloWorld.odt'); // Saving the document as HTML file... $objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'HTML'); $objWriter->save('helloWorld.html'); /* Note: we skip RTF, because it's not XML-based and requires a different example. */ /* Note: we skip PDF, because "HTML-to-PDF" approach is used to create PDF documents. */
更多示例请参阅示例文件夹。要轻松访问这些示例,请在示例目录中启动php -S localhost:8000
,然后浏览到https://:8000以查看示例。您还可以阅读开发者文档以获取更多详细信息。
贡献
我们欢迎每个人为PHPWord做出贡献。以下是一些您可以做的事情来做出贡献。
- 阅读我们的贡献指南。
- 分叉我们,并向develop分支请求合并。
- 向GitHub提交错误报告或功能请求。
- 在Twitter上关注@PHPWord和@PHPOffice。