README

🔎 PHPWord正在寻找新的维护者 👑 📝 (#948)

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

了解更多关于PHPWord的信息

• 特性
• 需求
• 安装
• 入门
• 贡献
• 开发者文档
• API文档

特性

使用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组件
• Zend\Validator组件
• Zip扩展（可选，用于写入OOXML和ODF）
• GD扩展（可选，用于添加图像）
• XMLWriter 扩展（可选，用于写入 OOXML 和 ODF）
• XSL 扩展（可选，用于将 XSL 样式表应用到模板）
• dompdf 库（可选，用于写入 PDF）

安装

PHPWord 通过 Composer 安装。您只需要在您的包中添加对 PHPWord 的 依赖。

示例

{
    "require": {
       "phpoffice/phpword": "v0.13.*"
    }
}

入门

以下是一个 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. */

更多示例可以在 示例文件夹 中找到。您还可以阅读 开发者文档 和 API 文档 以获取更多详细信息。

贡献

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

• 阅读 我们的贡献指南。
• Fork 我们 并向 develop 分支 提交 拉取请求。
• 向 GitHub 提交 错误报告或功能请求。
• 关注 Twitter 上的 @PHPWord 和 @PHPOffice。