sh4rknado / php-word
PHPWord - 用于读取和写入文档处理文件的纯PHP库(OOXML、ODF、RTF、HTML、PDF)
Requires
- php: ^5.3.3 || ^7.0
- ext-gd: *
- ext-xml: *
- php-unoconv/php-unoconv: ^4.1
- phpoffice/common: ^0.2.9
- zendframework/zend-escaper: ^2.2
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-09-29 05:29:48 UTC
README
PHPWord 是一个用纯PHP编写的库,提供了一系列用于写入和读取不同文档文件格式的类。当前版本的 PHPWord 支持 Microsoft Office Open XML(OOXML 或 OpenXML)、OASIS Open Document Format for Office Applications(OpenDocument 或 ODF)、Rich Text Format(RTF)、HTML 和 PDF。
PHPWord是一个开源项目,根据LGPL版本3许可条款授权。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解析器扩展
- Zend\Escaper组件
- Zend\Stdlib组件
- Zip扩展(可选,用于编写OOXML和ODF)
- GD扩展(可选,用于添加图像)
- XMLWriter扩展(可选,用于编写OOXML和ODF)
- XSL扩展(可选,用于将XSL样式表应用于模板)
- dompdf库(可选,用于编写PDF)
安装
PHPWord通过Composer安装。要将PHPWord作为项目依赖项添加,您可以选择以下操作:
运行以下命令以使用最新稳定版本:
composer require phpoffice/phpword
或者如果您需要最新主版本
composer require phpoffice/phpword:dev-master
当然,您也可以手动编辑您的composer.json文件
{ "require": { "phpoffice/phpword": "v0.16.*" } }
入门指南
以下是一个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做出贡献。以下是一些您可以做的事情来做出贡献。