A pure PHP library for reading and writing word processing documents
Go to file
Gabriel Bull be1e357b83 Changed version number 2013-12-11 19:57:36 -05:00
Examples Moved image example to README.md 2013-12-11 16:17:53 -05:00
samples IMPROVED : Samples\Sample01 2012-05-30 00:06:11 +02:00
src Changed version number 2013-12-11 19:57:36 -05:00
test Added test for image wrapping behind 2013-12-11 16:09:58 -05:00
.gitignore Added Unit Tests and fixed bugs with Autoloader 2013-12-11 15:08:54 -05:00
.travis.yml Added support for composer 2013-12-11 14:39:43 -05:00
README.md Changed version number 2013-12-11 19:57:36 -05:00
changelog.txt Changed version number 2013-12-11 19:57:36 -05:00
composer.json Changed version number 2013-12-11 19:57:36 -05:00
license.md Added readme and license file 2012-07-05 07:25:13 +02:00
phpunit.xml.dist Added Unit Tests and fixed bugs with Autoloader 2013-12-11 15:08:54 -05:00

README.md

PHPWord - OpenXML - Read, Write and Create Word documents in PHP

PHPWord is a library written in PHP that create word documents. No Windows operating system is needed for usage because the result are docx files (Office Open XML) that can be opened by all major office software.

Want to contribute?

Fork us!

Requirements

  • PHP version 5.3.0 or higher

License

PHPWord is licensed under LGPL (GNU LESSER GENERAL PUBLIC LICENSE)

Installation

It is recommended that you install the PHPWord library through composer. To do so, add the following lines to your composer.json.

{
    "require": {
       "phpoffice/phpword": "dev-master"
    }
}

Usage

The following is a basic example of the PHPWord library.

$PHPWord = new PHPWord();

// Every element you want to append to the word document is placed in a section. So you need a section:
$section = $PHPWord->createSection();

// After creating a section, you can append elements:
$section->addText('Hello world!');

// You can directly style your text by giving the addText function an array:
$section->addText('Hello world! I am formatted.', array('name'=>'Tahoma', 'size'=>16, 'bold'=>true));

// If you often need the same style again you can create a user defined style to the word document
// and give the addText function the name of the style:
$PHPWord->addFontStyle('myOwnStyle', array('name'=>'Verdana', 'size'=>14, 'color'=>'1B2232'));
$section->addText('Hello world! I am formatted by a user defined style', 'myOwnStyle');

// You can also putthe appended element to local object an call functions like this:
$myTextElement = $section->addText('Hello World!');
$myTextElement->setBold();
$myTextElement->setName('Verdana');
$myTextElement->setSize(22);

// At least write the document to webspace:
$objWriter = PHPWord_IOFactory::createWriter($PHPWord, 'Word2007');
$objWriter->save('helloWorld.docx');

Image

You can add images easily using the following example.

$section = $PHPWord->createSection();
$section->addImage('mars.jpg');

Images settings include:

  • width width in pixels
  • height height in pixels
  • align image alignment, left, right or center
  • marginTop top margin in inches, can be negative
  • marginLeft left margin in inches, can be negative
  • wrappingStyle can be inline, square, tight, behind, infront

To add an image with settings, consider the following example.

$section->addImage(
   'mars.jpg',
   array(
       'width' => 100,
       'height' => 100,
       'marginTop' => -1,
       'marginLeft' => -1,
       wrappingStyle => 'behind'
   )
);