You are here

Home » API reference » Loft Data Grids 6.2 » Workbook.php

class PHPExcel_Writer_Excel2007_Workbook in Loft Data Grids 6.2

Same name and namespace in other branches
  1. 7.2 vendor/phpoffice/phpexcel/Classes/PHPExcel/Writer/Excel2007/Workbook.php \PHPExcel_Writer_Excel2007_Workbook

PHPExcel_Writer_Excel2007_Workbook

@category PHPExcel @package PHPExcel_Writer_Excel2007 @copyright Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)

Hierarchy

Expanded class hierarchy of PHPExcel_Writer_Excel2007_Workbook

1 string reference to 'PHPExcel_Writer_Excel2007_Workbook'
PHPExcel_Writer_Excel2007::__construct in vendor/phpoffice/phpexcel/Classes/PHPExcel/Writer/Excel2007.php
Create a new PHPExcel_Writer_Excel2007

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Writer/Excel2007/Workbook.php, line 36

View source 
class PHPExcel_Writer_Excel2007_Workbook extends PHPExcel_Writer_Excel2007_WriterPart {

  /**
   * Write workbook to XML format
   *
   * @param 	PHPExcel	$pPHPExcel
   * @param	boolean		$recalcRequired	Indicate whether formulas should be recalculated before writing
   * @return 	string 		XML Output
   * @throws 	PHPExcel_Writer_Exception
   */
  public function writeWorkbook(PHPExcel $pPHPExcel = null, $recalcRequired = FALSE) {

    // Create XML writer
    $objWriter = null;
    if ($this
      ->getParentWriter()
      ->getUseDiskCaching()) {
      $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_DISK, $this
        ->getParentWriter()
        ->getDiskCachingDirectory());
    }
    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, $recalcRequired);
    $objWriter
      ->endElement();

    // Return
    return $objWriter
      ->getData();
  }

  /**
   * Write file version
   *
   * @param 	PHPExcel_Shared_XMLWriter $objWriter 		XML Writer
   * @throws 	PHPExcel_Writer_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 	PHPExcel_Writer_Exception
   */
  private function _writeWorkbookPr(PHPExcel_Shared_XMLWriter $objWriter = null) {
    $objWriter
      ->startElement('workbookPr');
    if (PHPExcel_Shared_Date::getExcelCalendar() == PHPExcel_Shared_Date::CALENDAR_MAC_1904) {
      $objWriter
        ->writeAttribute('date1904', '1');
    }
    $objWriter
      ->writeAttribute('codeName', 'ThisWorkbook');
    $objWriter
      ->endElement();
  }

  /**
   * Write BookViews
   *
   * @param 	PHPExcel_Shared_XMLWriter 	$objWriter 		XML Writer
   * @param 	PHPExcel					$pPHPExcel
   * @throws 	PHPExcel_Writer_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 	PHPExcel_Writer_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
   * @param	boolean						$recalcRequired	Indicate whether formulas should be recalculated before writing
   * @throws 	PHPExcel_Writer_Exception
   */
  private function _writeCalcPr(PHPExcel_Shared_XMLWriter $objWriter = null, $recalcRequired = TRUE) {
    $objWriter
      ->startElement('calcPr');

    //	Set the calcid to a higher value than Excel itself will use, otherwise Excel will always recalc
    //  If MS Excel does do a recalc, then users opening a file in MS Excel will be prompted to save on exit
    //     because the file has changed
    $objWriter
      ->writeAttribute('calcId', '999999');
    $objWriter
      ->writeAttribute('calcMode', 'auto');

    //	fullCalcOnLoad isn't needed if we've recalculating for the save
    $objWriter
      ->writeAttribute('calcCompleted', $recalcRequired ? 1 : 0);
    $objWriter
      ->writeAttribute('fullCalcOnLoad', $recalcRequired ? 0 : 1);
    $objWriter
      ->endElement();
  }

  /**
   * Write sheets
   *
   * @param 	PHPExcel_Shared_XMLWriter 	$objWriter 		XML Writer
   * @param 	PHPExcel					$pPHPExcel
   * @throws 	PHPExcel_Writer_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, $pPHPExcel
        ->getSheet($i)
        ->getSheetState());
    }
    $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
   * @param   string                      $sheetState         Sheet state (visible, hidden, veryHidden)
   * @throws 	PHPExcel_Writer_Exception
   */
  private function _writeSheet(PHPExcel_Shared_XMLWriter $objWriter = null, $pSheetname = '', $pSheetId = 1, $pRelId = 1, $sheetState = 'visible') {
    if ($pSheetname != '') {

      // Write sheet
      $objWriter
        ->startElement('sheet');
      $objWriter
        ->writeAttribute('name', $pSheetname);
      $objWriter
        ->writeAttribute('sheetId', $pSheetId);
      if ($sheetState != 'visible' && $sheetState != '') {
        $objWriter
          ->writeAttribute('state', $sheetState);
      }
      $objWriter
        ->writeAttribute('r:id', 'rId' . $pRelId);
      $objWriter
        ->endElement();
    }
    else {
      throw new PHPExcel_Writer_Exception("Invalid parameters passed.");
    }
  }

  /**
   * Write Defined Names
   *
   * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer
   * @param 	PHPExcel					$pPHPExcel
   * @throws 	PHPExcel_Writer_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 	PHPExcel_Writer_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 named range
   *
   * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer
   * @param 	PHPExcel_NamedRange			$pNamedRange
   * @throws 	PHPExcel_Writer_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
        ->getScope()
        ->getParent()
        ->getIndex($pNamedRange
        ->getScope()));
    }

    // Create absolute coordinate and write as raw text
    $range = PHPExcel_Cell::splitRange($pNamedRange
      ->getRange());
    for ($i = 0; $i < count($range); $i++) {
      $range[$i][0] = '\'' . str_replace("'", "''", $pNamedRange
        ->getWorksheet()
        ->getTitle()) . '\'!' . PHPExcel_Cell::absoluteReference($range[$i][0]);
      if (isset($range[$i][1])) {
        $range[$i][1] = PHPExcel_Cell::absoluteReference($range[$i][1]);
      }
    }
    $range = PHPExcel_Cell::buildRange($range);
    $objWriter
      ->writeRawData($range);
    $objWriter
      ->endElement();
  }

  /**
   * Write Defined Name for autoFilter
   *
   * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer
   * @param 	PHPExcel_Worksheet			$pSheet
   * @param 	int							$pSheetId
   * @throws 	PHPExcel_Writer_Exception
   */
  private function _writeDefinedNameForAutofilter(PHPExcel_Shared_XMLWriter $objWriter = null, PHPExcel_Worksheet $pSheet = null, $pSheetId = 0) {

    // definedName for autoFilter
    $autoFilterRange = $pSheet
      ->getAutoFilter()
      ->getRange();
    if (!empty($autoFilterRange)) {
      $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($autoFilterRange);
      $range = $range[0];

      //	Strip any worksheet ref so we can make the cell ref absolute
      if (strpos($range[0], '!') !== false) {
        list($ws, $range[0]) = explode('!', $range[0]);
      }
      $range[0] = PHPExcel_Cell::absoluteCoordinate($range[0]);
      $range[1] = PHPExcel_Cell::absoluteCoordinate($range[1]);
      $range = implode(':', $range);
      $objWriter
        ->writeRawData('\'' . str_replace("'", "''", $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 	PHPExcel_Writer_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 .= '\'' . str_replace("'", "''", $pSheet
          ->getTitle()) . '\'!$' . $repeat[0] . ':$' . $repeat[1];
      }

      // Rows to repeat
      if ($pSheet
        ->getPageSetup()
        ->isRowsToRepeatAtTopSet()) {
        if ($pSheet
          ->getPageSetup()
          ->isColumnsToRepeatAtLeftSet()) {
          $settingString .= ',';
        }
        $repeat = $pSheet
          ->getPageSetup()
          ->getRowsToRepeatAtTop();
        $settingString .= '\'' . str_replace("'", "''", $pSheet
          ->getTitle()) . '\'!$' . $repeat[0] . ':$' . $repeat[1];
      }
      $objWriter
        ->writeRawData($settingString);
      $objWriter
        ->endElement();
    }
  }

  /**
   * Write Defined Name for PrintTitles
   *
   * @param 	PHPExcel_Shared_XMLWriter	$objWriter 		XML Writer
   * @param 	PHPExcel_Worksheet			$pSheet
   * @param 	int							$pSheetId
   * @throws 	PHPExcel_Writer_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());
      $chunks = array();
      foreach ($printArea as $printAreaRect) {
        $printAreaRect[0] = PHPExcel_Cell::absoluteReference($printAreaRect[0]);
        $printAreaRect[1] = PHPExcel_Cell::absoluteReference($printAreaRect[1]);
        $chunks[] = '\'' . str_replace("'", "''", $pSheet
          ->getTitle()) . '\'!' . implode(':', $printAreaRect);
      }
      $objWriter
        ->writeRawData(implode(',', $chunks));
      $objWriter
        ->endElement();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPExcel_Writer_Excel2007_Workbook::writeWorkbook public function * Write workbook to XML format * *
PHPExcel_Writer_Excel2007_Workbook::_writeBookViews private function * Write BookViews * *
PHPExcel_Writer_Excel2007_Workbook::_writeCalcPr private function * Write calcPr * *
PHPExcel_Writer_Excel2007_Workbook::_writeDefinedNameForAutofilter private function * Write Defined Name for autoFilter * *
PHPExcel_Writer_Excel2007_Workbook::_writeDefinedNameForNamedRange private function * Write Defined Name for named range * *
PHPExcel_Writer_Excel2007_Workbook::_writeDefinedNameForPrintArea private function * Write Defined Name for PrintTitles * *
PHPExcel_Writer_Excel2007_Workbook::_writeDefinedNameForPrintTitles private function * Write Defined Name for PrintTitles * *
PHPExcel_Writer_Excel2007_Workbook::_writeDefinedNames private function * Write Defined Names * *
PHPExcel_Writer_Excel2007_Workbook::_writeFileVersion private function * Write file version * *
PHPExcel_Writer_Excel2007_Workbook::_writeNamedRanges private function * Write named ranges * *
PHPExcel_Writer_Excel2007_Workbook::_writeSheet private function * Write sheet * *
PHPExcel_Writer_Excel2007_Workbook::_writeSheets private function * Write sheets * *
PHPExcel_Writer_Excel2007_Workbook::_writeWorkbookPr private function * Write WorkbookPr * *
PHPExcel_Writer_Excel2007_Workbook::_writeWorkbookProtection private function * Write WorkbookProtection * *
PHPExcel_Writer_Excel2007_WriterPart::$_parentWriter private property * Parent IWriter object * *
PHPExcel_Writer_Excel2007_WriterPart::getParentWriter public function * Get parent IWriter object * *
PHPExcel_Writer_Excel2007_WriterPart::setParentWriter public function * Set parent IWriter object * *
PHPExcel_Writer_Excel2007_WriterPart::__construct public function * Set parent IWriter object * *