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 旨在通过结合 持续集成 和 单元测试 来成为一个高质量的软件产品。您可以通过阅读 开发者文档 来了解更多关于 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

或者如果您想要最新的master版本

    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. */

更多示例在samples文件夹中提供。要轻松访问这些示例，请在samples目录中运行php -S localhost:8000，然后在https://:8000中浏览以查看示例。您还可以阅读开发者文档以获取更多详细信息。

贡献

我们欢迎每个人都为PHPWord做出贡献。以下是一些您可以做出的贡献：

• 阅读我们的贡献指南。
• 在GitHub上fork我们，并向develop分支提出pull请求。
• 将错误报告或功能请求提交到GitHub。
• 关注Twitter上的@PHPWord和@PHPOffice。