Workbook.php - This PHP class generates XML output for Micr…

/branches/v1.6.4/Classes/PHPExcel/Writer/Excel2007/Workbook.php

# · PHP · 440 lines · 203 code · 65 blank · 172 comment · 24 complexity · 9e7cf222d830e342a0e6a507216b15b3 MD5 · raw file

<?php

/**

 * PHPExcel

 *

 * Copyright (c) 2006 - 2008 PHPExcel

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

 * License as published by the Free Software Foundation; either

 * version 2.1 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

 *

 * @category   PHPExcel

 * @package    PHPExcel_Writer_Excel2007

 * @copyright  Copyright (c) 2006 - 2008 PHPExcel (http://www.codeplex.com/PHPExcel)

 * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt	LGPL

 * @version    ##VERSION##, ##DATE##

 */





/** PHPExcel */

require_once 'PHPExcel.php';



/** PHPExcel_Writer_Excel2007 */

require_once 'PHPExcel/Writer/Excel2007.php';



/** PHPExcel_Writer_Excel2007_WriterPart */

require_once 'PHPExcel/Writer/Excel2007/WriterPart.php';



/** PHPExcel_Cell */

require_once 'PHPExcel/Cell.php';



/** PHPExcel_Shared_XMLWriter */

require_once 'PHPExcel/Shared/XMLWriter.php';





/**

 * PHPExcel_Writer_Excel2007_Workbook

 *

 * @category   PHPExcel

 * @package    PHPExcel_Writer_Excel2007

 * @copyright  Copyright (c) 2006 - 2008 PHPExcel (http://www.codeplex.com/PHPExcel)

 */

class PHPExcel_Writer_Excel2007_Workbook extends PHPExcel_Writer_Excel2007_WriterPart

{

	/**

	 * Write workbook to XML format

	 *

	 * @param 	PHPExcel	$pPHPExcel

	 * @return 	string 		XML Output

	 * @throws 	Exception

	 */

	public function writeWorkbook(PHPExcel $pPHPExcel = null)

	{

		// Create XML writer

		$objWriter = null;

		if ($this->getParentWriter()->getUseDiskCaching()) {

			$objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_DISK);

		} else {

			$objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_MEMORY);

		}



		// XML header

		$objWriter->startDocument('1.0','UTF-8','yes');



		// workbook

		$objWriter->startElement('workbook');

		$objWriter->writeAttribute('xml:space', 'preserve');

		$objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/spreadsheetml/2006/main');

		$objWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships');



			// fileVersion

			$this->_writeFileVersion($objWriter);



			// workbookPr

			$this->_writeWorkbookPr($objWriter);



			// workbookProtection

			$this->_writeWorkbookProtection($objWriter, $pPHPExcel);



			// bookViews

			if ($this->getParentWriter()->getOffice2003Compatibility() === false) {

				$this->_writeBookViews($objWriter, $pPHPExcel);

			}



			// sheets

			$this->_writeSheets($objWriter, $pPHPExcel);



			// definedNames

			$this->_writeDefinedNames($objWriter, $pPHPExcel);



			// calcPr

			$this->_writeCalcPr($objWriter);



		$objWriter->endElement();



		// Return

		return $objWriter->getData();

	}



	/**

	 * Write file version

	 *

	 * @param 	PHPExcel_Shared_XMLWriter $objWriter 		XML Writer

	 * @throws 	Exception

	 */

	private function _writeFileVersion(PHPExcel_Shared_XMLWriter $objWriter = null)

	{

		$objWriter->startElement('fileVersion');

		$objWriter->writeAttribute('appName', 'xl');

		$objWriter->writeAttribute('lastEdited', '4');

		$objWriter->writeAttribute('lowestEdited', '4');

		$objWriter->writeAttribute('rupBuild', '4505');

		$objWriter->endElement();

	}



	/**

	 * Write WorkbookPr

	 *

	 * @param 	PHPExcel_Shared_XMLWriter $objWriter 		XML Writer

	 * @throws 	Exception

	 */

	private function _writeWorkbookPr(PHPExcel_Shared_XMLWriter $objWriter = null)

	{

		$objWriter->startElement('workbookPr');

		$objWriter->writeAttribute('codeName', 'ThisWorkbook');

		$objWriter->endElement();

	}



	/**

	 * Write BookViews

	 *

	 * @param 	PHPExcel_Shared_XMLWriter 	$objWriter 		XML Writer

	 * @param 	PHPExcel					$pPHPExcel

	 * @throws 	Exception

	 */

	private function _writeBookViews(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel $pPHPExcel = null)

	{

		// bookViews

		$objWriter->startElement('bookViews');



			// workbookView

			$objWriter->startElement('workbookView');



			$objWriter->writeAttribute('activeTab', $pPHPExcel->getActiveSheetIndex());

			$objWriter->writeAttribute('autoFilterDateGrouping', '1');

			$objWriter->writeAttribute('firstSheet', '0');

			$objWriter->writeAttribute('minimized', '0');

			$objWriter->writeAttribute('showHorizontalScroll', '1');

			$objWriter->writeAttribute('showSheetTabs', '1');

			$objWriter->writeAttribute('showVerticalScroll', '1');

			$objWriter->writeAttribute('tabRatio', '600');

			$objWriter->writeAttribute('visibility', 'visible');



			$objWriter->endElement();



		$objWriter->endElement();

	}



	/**

	 * Write WorkbookProtection

	 *

	 * @param 	PHPExcel_Shared_XMLWriter 	$objWriter 		XML Writer

	 * @param 	PHPExcel					$pPHPExcel

	 * @throws 	Exception

	 */

	private function _writeWorkbookProtection(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel $pPHPExcel = null)

	{

		if ($pPHPExcel->getSecurity()->isSecurityEnabled()) {

			$objWriter->startElement('workbookProtection');

			$objWriter->writeAttribute('lockRevision',		($pPHPExcel->getSecurity()->getLockRevision() ? 'true' : 'false'));

			$objWriter->writeAttribute('lockStructure', 	($pPHPExcel->getSecurity()->getLockStructure() ? 'true' : 'false'));

			$objWriter->writeAttribute('lockWindows', 		($pPHPExcel->getSecurity()->getLockWindows() ? 'true' : 'false'));



			if ($pPHPExcel->getSecurity()->getRevisionsPassword() != '') {

				$objWriter->writeAttribute('revisionsPassword',	$pPHPExcel->getSecurity()->getRevisionsPassword());

			}



			if ($pPHPExcel->getSecurity()->getWorkbookPassword() != '') {

				$objWriter->writeAttribute('workbookPassword',	$pPHPExcel->getSecurity()->getWorkbookPassword());

			}



			$objWriter->endElement();

		}

	}



	/**

	 * Write calcPr

	 *

	 * @param 	PHPExcel_Shared_XMLWriter $objWriter 		XML Writer

	 * @throws 	Exception

	 */

	private function _writeCalcPr(PHPExcel_Shared_XMLWriter $objWriter = null)

	{

		$objWriter->startElement('calcPr');



		$objWriter->writeAttribute('calcId', 			'124519');

		$objWriter->writeAttribute('calcMode', 			'auto');

		$objWriter->writeAttribute('fullCalcOnLoad', 	'1');



		$objWriter->endElement();

	}



	/**

	 * Write sheets

	 *

	 * @param 	PHPExcel_Shared_XMLWriter 	$objWriter 		XML Writer

	 * @param 	PHPExcel					$pPHPExcel

	 * @throws 	Exception

	 */

	private function _writeSheets(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel $pPHPExcel = null)

	{

		// Write sheets

		$objWriter->startElement('sheets');

		$sheetCount = $pPHPExcel->getSheetCount();

		for ($i = 0; $i < $sheetCount; ++$i) {

			// sheet

			$this->_writeSheet(

				$objWriter,

				$pPHPExcel->getSheet($i)->getTitle(),

				($i + 1),

				($i + 1 + 3)

			);

		}



		$objWriter->endElement();

	}



	/**

	 * Write sheet

	 *

	 * @param 	PHPExcel_Shared_XMLWriter 	$objWriter 		XML Writer

	 * @param 	string 						$pSheetname 		Sheet name

	 * @param 	int							$pSheetId	 		Sheet id

	 * @param 	int							$pRelId				Relationship ID

	 * @throws 	Exception

	 */

	private function _writeSheet(PHPExcel_Shared_XMLWriter $objWriter = null, $pSheetname = '', $pSheetId = 1, $pRelId = 1)

	{

		if ($pSheetname != '') {

			// Write sheet

			$objWriter->startElement('sheet');

			$objWriter->writeAttribute('name', 		$pSheetname);

			$objWriter->writeAttribute('sheetId', 	$pSheetId);

			$objWriter->writeAttribute('r:id', 		'rId' . $pRelId);

			$objWriter->endElement();

		} else {

			throw new Exception("Invalid parameters passed.");

		}

	}



	/**

	 * Write Defined Names

	 *

	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer

	 * @param 	PHPExcel					$pPHPExcel

	 * @throws 	Exception

	 */

	private function _writeDefinedNames(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel $pPHPExcel = null)

	{

		// Write defined names

		$objWriter->startElement('definedNames');



		// Named ranges

		if (count($pPHPExcel->getNamedRanges()) > 0) {

			// Named ranges

			$this->_writeNamedRanges($objWriter, $pPHPExcel);

		}



		// Other defined names

		$sheetCount = $pPHPExcel->getSheetCount();

		for ($i = 0; $i < $sheetCount; ++$i) {

			// definedName for autoFilter

			$this->_writeDefinedNameForAutofilter($objWriter, $pPHPExcel->getSheet($i), $i);



			// definedName for Print_Titles

			$this->_writeDefinedNameForPrintTitles($objWriter, $pPHPExcel->getSheet($i), $i);



			// definedName for Print_Area

			$this->_writeDefinedNameForPrintArea($objWriter, $pPHPExcel->getSheet($i), $i);

		}



		$objWriter->endElement();

	}



	/**

	 * Write named ranges

	 *

	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer

	 * @param 	PHPExcel					$pPHPExcel

	 * @throws 	Exception

	 */

	private function _writeNamedRanges(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel $pPHPExcel)

	{

		// Loop named ranges

		$namedRanges = $pPHPExcel->getNamedRanges();

		foreach ($namedRanges as $namedRange) {

			$this->_writeDefinedNameForNamedRange($objWriter, $namedRange);

		}

	}



	/**

	 * Write Defined Name for autoFilter

	 *

	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer

	 * @param 	PHPExcel_NamedRange			$pNamedRange

	 * @throws 	Exception

	 */

	private function _writeDefinedNameForNamedRange(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel_NamedRange $pNamedRange)

	{

		// definedName for named range

		$objWriter->startElement('definedName');

		$objWriter->writeAttribute('name',			$pNamedRange->getName());

		if ($pNamedRange->getLocalOnly()) {

			$objWriter->writeAttribute('localSheetId',	$pNamedRange->getWorksheet()->getParent()->getIndex($pNamedRange->getWorksheet()));

		}



		// Create absolute coordinate and write as raw text

		$range = PHPExcel_Cell::splitRange($pNamedRange->getRange());

		$range[0] = PHPExcel_Cell::absoluteCoordinate($range[0]);

		if (isset($range[1])) {

			$range[1] = PHPExcel_Cell::absoluteCoordinate($range[1]);

		}

		$range = implode(':', $range);



		$objWriter->writeRaw('\'' . $pNamedRange->getWorksheet()->getTitle() . '\'!' . $range);



		$objWriter->endElement();

	}



	/**

	 * Write Defined Name for autoFilter

	 *

	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer

	 * @param 	PHPExcel_Worksheet			$pSheet

	 * @param 	int							$pSheetId

	 * @throws 	Exception

	 */

	private function _writeDefinedNameForAutofilter(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel_Worksheet $pSheet = null, $pSheetId = 0)

	{

		// definedName for autoFilter

		if ($pSheet->getAutoFilter() != '') {

			$objWriter->startElement('definedName');

			$objWriter->writeAttribute('name',			'_xlnm._FilterDatabase');

			$objWriter->writeAttribute('localSheetId',	$pSheetId);

			$objWriter->writeAttribute('hidden',		'1');



			// Create absolute coordinate and write as raw text

			$range = PHPExcel_Cell::splitRange($pSheet->getAutoFilter());

			$range[0] = PHPExcel_Cell::absoluteCoordinate($range[0]);

			$range[1] = PHPExcel_Cell::absoluteCoordinate($range[1]);

			$range = implode(':', $range);



			$objWriter->writeRaw('\'' . $pSheet->getTitle() . '\'!' . $range);



			$objWriter->endElement();

		}

	}



	/**

	 * Write Defined Name for PrintTitles

	 *

	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer

	 * @param 	PHPExcel_Worksheet			$pSheet

	 * @param 	int							$pSheetId

	 * @throws 	Exception

	 */

	private function _writeDefinedNameForPrintTitles(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel_Worksheet $pSheet = null, $pSheetId = 0)

	{

		// definedName for PrintTitles

		if ($pSheet->getPageSetup()->isColumnsToRepeatAtLeftSet() || $pSheet->getPageSetup()->isRowsToRepeatAtTopSet()) {

			$objWriter->startElement('definedName');

			$objWriter->writeAttribute('name',			'_xlnm.Print_Titles');

			$objWriter->writeAttribute('localSheetId',	$pSheetId);



			// Setting string

			$settingString = '';



			// Columns to repeat

			if ($pSheet->getPageSetup()->isColumnsToRepeatAtLeftSet()) {

				$repeat = $pSheet->getPageSetup()->getColumnsToRepeatAtLeft();



				$settingString = '\'' . $pSheet->getTitle() . '\'!$' . $repeat[0] . ':$' . $repeat[1];

			}



			// Rows to repeat

			if ($pSheet->getPageSetup()->isRowsToRepeatAtTopSet()) {

				if ($pSheet->getPageSetup()->isColumnsToRepeatAtLeftSet()) {

					$settingString .= ',';

				}



				$repeat = $pSheet->getPageSetup()->getRowsToRepeatAtTop();



				$settingString = '\'' . $pSheet->getTitle() . '\'!$' . $repeat[0] . ':$' . $repeat[1];

			}



			$objWriter->writeRaw($settingString);



			$objWriter->endElement();

		}

	}



	/**

	 * Write Defined Name for PrintTitles

	 *

	 * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer

	 * @param 	PHPExcel_Worksheet			$pSheet

	 * @param 	int							$pSheetId

	 * @throws 	Exception

	 */

	private function _writeDefinedNameForPrintArea(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel_Worksheet $pSheet = null, $pSheetId = 0)

	{

		// definedName for PrintArea

		if ($pSheet->getPageSetup()->isPrintAreaSet()) {

			$objWriter->startElement('definedName');

			$objWriter->writeAttribute('name',			'_xlnm.Print_Area');

			$objWriter->writeAttribute('localSheetId',	$pSheetId);



			// Setting string

			$settingString = '';



			// Print area

			$printArea = PHPExcel_Cell::splitRange($pSheet->getPageSetup()->getPrintArea());

			$printArea[0] = PHPExcel_Cell::absoluteCoordinate($printArea[0]);

			$printArea[1] = PHPExcel_Cell::absoluteCoordinate($printArea[1]);



			$objWriter->writeRaw('\'' . $pSheet->getTitle() . '\'!' . implode(':', $printArea));



			$objWriter->endElement();

		}

	}

}