shareforce/phpword

PHPWord - 一个用于读取和写入办公文档(OOXML、ODF、RTF、HTML、PDF)的纯PHP库

0.18.3 2022-02-17 15:40 UTC

README

主分支: 最新稳定版本 构建状态 代码质量 覆盖率状态 总下载量 许可证 加入聊天 https://gitter.im/PHPOffice/PHPWord

开发版本: 最新开发版本 构建状态 代码质量 覆盖率状态

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需要以下内容:

安装

PHPWord通过Composer安装。要在项目中添加PHPWord依赖项,可以

运行以下命令以使用最新稳定版本:

    composer require phpoffice/phpword

或者如果您想使用最新主版本:

    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做出贡献。以下是一些您可以做的事情来贡献。