diff --git a/CHANGELOG.md b/CHANGELOG.md index f97c4c07..c785dbf4 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ This is the changelog between releases of PHPWord. Releases are listed in revers - Font: Add `bgColor` to font style to define background using HEX color - @jcarignan GH-168 - Table: Add `exactHeight` to row style to define whether row height should be exact or atLeast - @jcarignan GH-168 - Element: New `CheckBox` element for sections and table cells - @ozilion GH-156 +- Settings: Ability to use PCLZip as alternative to ZipArchive - @bskrtich @ivanlanin GH-106 GH-140 GH-185 ### Bugfixes diff --git a/docs/general.rst b/docs/general.rst index 9b25551a..1c810722 100644 --- a/docs/general.rst +++ b/docs/general.rst @@ -7,7 +7,8 @@ Basic example ------------- The following is a basic example of the PHPWord library. More examples -are provided in the `samples folder `__. +are provided in the `samples +folder `__. .. code-block:: php @@ -52,6 +53,42 @@ are provided in the `samples folder save('helloWorld.rtf'); +Settings +-------- + +The ``PhpOffice\PhpWord\Settings`` class provides some options that will +affect the behavior of PHPWord. Below are the options. + +XML Writer compatibility +~~~~~~~~~~~~~~~~~~~~~~~~ + +This option sets +```XMLWriter::setIndent`` `__ +and +```XMLWriter::setIndentString`` `__. +The default value of this option is ``true`` (compatible), which is +`required for OpenOffice `__ to +render OOXML document correctly. You can set this option to ``false`` +during development to make the resulting XML file easier to read. + +.. code-block:: php + + PhpOffice\PhpWord\Settings::setCompatibility(false); + +Zip class +~~~~~~~~~ + +By default, PHPWord uses PHP +`ZipArchive `__ to read or write +ZIP compressed archive and the files inside them. If you can't have +ZipArchive installed on your server, you can use pure PHP library +alternative, `PCLZip `__, which +included with PHPWord. + +.. code-block:: php + + PhpOffice\PhpWord\Settings::setZipClass(PhpOffice\PhpWord\Settings::PCLZIP); + Default font ------------ @@ -105,3 +142,4 @@ points to twips. $sectionStyle->setMarginLeft(\PhpOffice\PhpWord\Shared\Font::inchSizeToTwips(.5)); // 2 cm right margin $sectionStyle->setMarginRight(\PhpOffice\PhpWord\Shared\Font::centimeterSizeToTwips(2)); + diff --git a/src/PhpWord/Template.php b/src/PhpWord/Template.php index 83ff0206..f54d729e 100644 --- a/src/PhpWord/Template.php +++ b/src/PhpWord/Template.php @@ -21,7 +21,7 @@ class Template /** * ZipArchive object * - * @var \ZipArchive + * @var mixed */ private $_objZip;