123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334 |
- <?php
- /**
- * This file is part of PHPWord - A pure PHP library for reading and writing
- * word processing documents.
- *
- * PHPWord is free software distributed under the terms of the GNU Lesser
- * General Public License version 3 as published by the Free Software Foundation.
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code. For the full list of
- * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
- *
- * @see https://github.com/PHPOffice/PHPWord
- * @copyright 2010-2018 PHPWord contributors
- * @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
- */
- namespace PhpOffice\PhpWord\Writer;
- use PhpOffice\PhpWord\Element\Section;
- use PhpOffice\PhpWord\Media;
- use PhpOffice\PhpWord\PhpWord;
- use PhpOffice\PhpWord\Shared\ZipArchive;
- /**
- * Word2007 writer
- */
- class Word2007 extends AbstractWriter implements WriterInterface
- {
- /**
- * Content types values
- *
- * @var array
- */
- private $contentTypes = array('default' => array(), 'override' => array());
- /**
- * Document relationship
- *
- * @var array
- */
- private $relationships = array();
- /**
- * Create new Word2007 writer
- *
- * @param \PhpOffice\PhpWord\PhpWord
- */
- public function __construct(PhpWord $phpWord = null)
- {
- // Assign PhpWord
- $this->setPhpWord($phpWord);
- // Create parts
- $this->parts = array(
- 'ContentTypes' => '[Content_Types].xml',
- 'Rels' => '_rels/.rels',
- 'DocPropsApp' => 'docProps/app.xml',
- 'DocPropsCore' => 'docProps/core.xml',
- 'DocPropsCustom' => 'docProps/custom.xml',
- 'RelsDocument' => 'word/_rels/document.xml.rels',
- 'Document' => 'word/document.xml',
- 'Comments' => 'word/comments.xml',
- 'Styles' => 'word/styles.xml',
- 'Numbering' => 'word/numbering.xml',
- 'Settings' => 'word/settings.xml',
- 'WebSettings' => 'word/webSettings.xml',
- 'FontTable' => 'word/fontTable.xml',
- 'Theme' => 'word/theme/theme1.xml',
- 'RelsPart' => '',
- 'Header' => '',
- 'Footer' => '',
- 'Footnotes' => '',
- 'Endnotes' => '',
- 'Chart' => '',
- );
- foreach (array_keys($this->parts) as $partName) {
- $partClass = get_class($this) . '\\Part\\' . $partName;
- if (class_exists($partClass)) {
- /** @var \PhpOffice\PhpWord\Writer\Word2007\Part\AbstractPart $part Type hint */
- $part = new $partClass();
- $part->setParentWriter($this);
- $this->writerParts[strtolower($partName)] = $part;
- }
- }
- // Set package paths
- $this->mediaPaths = array('image' => 'word/media/', 'object' => 'word/embeddings/');
- }
- /**
- * Save document by name.
- *
- * @param string $filename
- */
- public function save($filename = null)
- {
- $filename = $this->getTempFile($filename);
- $zip = $this->getZipArchive($filename);
- $phpWord = $this->getPhpWord();
- // Content types
- $this->contentTypes['default'] = array(
- 'rels' => 'application/vnd.openxmlformats-package.relationships+xml',
- 'xml' => 'application/xml',
- );
- // Add section media files
- $sectionMedia = Media::getElements('section');
- if (!empty($sectionMedia)) {
- $this->addFilesToPackage($zip, $sectionMedia);
- $this->registerContentTypes($sectionMedia);
- foreach ($sectionMedia as $element) {
- $this->relationships[] = $element;
- }
- }
- // Add header/footer media files & relations
- $this->addHeaderFooterMedia($zip, 'header');
- $this->addHeaderFooterMedia($zip, 'footer');
- // Add header/footer contents
- $rId = Media::countElements('section') + 6; // @see Rels::writeDocRels for 6 first elements
- $sections = $phpWord->getSections();
- foreach ($sections as $section) {
- $this->addHeaderFooterContent($section, $zip, 'header', $rId);
- $this->addHeaderFooterContent($section, $zip, 'footer', $rId);
- }
- $this->addNotes($zip, $rId, 'footnote');
- $this->addNotes($zip, $rId, 'endnote');
- $this->addComments($zip, $rId);
- $this->addChart($zip, $rId);
- // Write parts
- foreach ($this->parts as $partName => $fileName) {
- if ($fileName != '') {
- $zip->addFromString($fileName, $this->getWriterPart($partName)->write());
- }
- }
- // Close zip archive and cleanup temp file
- $zip->close();
- $this->cleanupTempFile();
- }
- /**
- * Get content types
- *
- * @return array
- */
- public function getContentTypes()
- {
- return $this->contentTypes;
- }
- /**
- * Get content types
- *
- * @return array
- */
- public function getRelationships()
- {
- return $this->relationships;
- }
- /**
- * Add header/footer media files, e.g. footer1.xml.rels.
- *
- * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip
- * @param string $docPart
- */
- private function addHeaderFooterMedia(ZipArchive $zip, $docPart)
- {
- $elements = Media::getElements($docPart);
- if (!empty($elements)) {
- foreach ($elements as $file => $media) {
- if (count($media) > 0) {
- if (!empty($media)) {
- $this->addFilesToPackage($zip, $media);
- $this->registerContentTypes($media);
- }
- /** @var \PhpOffice\PhpWord\Writer\Word2007\Part\AbstractPart $writerPart Type hint */
- $writerPart = $this->getWriterPart('relspart')->setMedia($media);
- $zip->addFromString("word/_rels/{$file}.xml.rels", $writerPart->write());
- }
- }
- }
- }
- /**
- * Add header/footer content.
- *
- * @param \PhpOffice\PhpWord\Element\Section &$section
- * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip
- * @param string $elmType header|footer
- * @param int &$rId
- */
- private function addHeaderFooterContent(Section &$section, ZipArchive $zip, $elmType, &$rId)
- {
- $getFunction = $elmType == 'header' ? 'getHeaders' : 'getFooters';
- $elmCount = ($section->getSectionId() - 1) * 3;
- $elements = $section->$getFunction();
- /** @var \PhpOffice\PhpWord\Element\AbstractElement $element Type hint */
- foreach ($elements as &$element) {
- $elmCount++;
- $element->setRelationId(++$rId);
- $elmFile = "{$elmType}{$elmCount}.xml"; // e.g. footer1.xml
- $this->contentTypes['override']["/word/$elmFile"] = $elmType;
- $this->relationships[] = array('target' => $elmFile, 'type' => $elmType, 'rID' => $rId);
- /** @var \PhpOffice\PhpWord\Writer\Word2007\Part\AbstractPart $writerPart Type hint */
- $writerPart = $this->getWriterPart($elmType)->setElement($element);
- $zip->addFromString("word/$elmFile", $writerPart->write());
- }
- }
- /**
- * Add footnotes/endnotes
- *
- * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip
- * @param int &$rId
- * @param string $noteType
- */
- private function addNotes(ZipArchive $zip, &$rId, $noteType = 'footnote')
- {
- $phpWord = $this->getPhpWord();
- $noteType = ($noteType == 'endnote') ? 'endnote' : 'footnote';
- $partName = "{$noteType}s";
- $method = 'get' . $partName;
- $collection = $phpWord->$method();
- // Add footnotes media files, relations, and contents
- /** @var \PhpOffice\PhpWord\Collection\AbstractCollection $collection Type hint */
- if ($collection->countItems() > 0) {
- $media = Media::getElements($noteType);
- $this->addFilesToPackage($zip, $media);
- $this->registerContentTypes($media);
- $this->contentTypes['override']["/word/{$partName}.xml"] = $partName;
- $this->relationships[] = array('target' => "{$partName}.xml", 'type' => $partName, 'rID' => ++$rId);
- // Write relationships file, e.g. word/_rels/footnotes.xml
- if (!empty($media)) {
- /** @var \PhpOffice\PhpWord\Writer\Word2007\Part\AbstractPart $writerPart Type hint */
- $writerPart = $this->getWriterPart('relspart')->setMedia($media);
- $zip->addFromString("word/_rels/{$partName}.xml.rels", $writerPart->write());
- }
- // Write content file, e.g. word/footnotes.xml
- $writerPart = $this->getWriterPart($partName)->setElements($collection->getItems());
- $zip->addFromString("word/{$partName}.xml", $writerPart->write());
- }
- }
- /**
- * Add comments
- *
- * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip
- * @param int &$rId
- */
- private function addComments(ZipArchive $zip, &$rId)
- {
- $phpWord = $this->getPhpWord();
- $collection = $phpWord->getComments();
- $partName = 'comments';
- // Add comment relations and contents
- /** @var \PhpOffice\PhpWord\Collection\AbstractCollection $collection Type hint */
- if ($collection->countItems() > 0) {
- $this->relationships[] = array('target' => "{$partName}.xml", 'type' => $partName, 'rID' => ++$rId);
- // Write content file, e.g. word/comments.xml
- $writerPart = $this->getWriterPart($partName)->setElements($collection->getItems());
- $zip->addFromString("word/{$partName}.xml", $writerPart->write());
- }
- }
- /**
- * Add chart.
- *
- * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip
- * @param int &$rId
- */
- private function addChart(ZipArchive $zip, &$rId)
- {
- $phpWord = $this->getPhpWord();
- $collection = $phpWord->getCharts();
- $index = 0;
- if ($collection->countItems() > 0) {
- /** @var \PhpOffice\PhpWord\Element\Chart $chart */
- foreach ($collection->getItems() as $chart) {
- $index++;
- $rId++;
- $filename = "charts/chart{$index}.xml";
- // ContentTypes.xml
- $this->contentTypes['override']["/word/{$filename}"] = 'chart';
- // word/_rels/document.xml.rel
- $this->relationships[] = array('target' => $filename, 'type' => 'chart', 'rID' => $rId);
- // word/charts/chartN.xml
- $chart->setRelationId($rId);
- $writerPart = $this->getWriterPart('Chart');
- $writerPart->setElement($chart);
- $zip->addFromString("word/{$filename}", $writerPart->write());
- }
- }
- }
- /**
- * Register content types for each media.
- *
- * @param array $media
- */
- private function registerContentTypes($media)
- {
- foreach ($media as $medium) {
- $mediumType = $medium['type'];
- if ($mediumType == 'image') {
- $extension = $medium['imageExtension'];
- if (!isset($this->contentTypes['default'][$extension])) {
- $this->contentTypes['default'][$extension] = $medium['imageType'];
- }
- } elseif ($mediumType == 'object') {
- if (!isset($this->contentTypes['default']['bin'])) {
- $this->contentTypes['default']['bin'] = 'application/vnd.openxmlformats-officedocument.oleObject';
- }
- }
- }
- }
- }
|