[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/spout/src/Spout/Reader/XLSX/Helper/ -> SheetHelper.php (summary)

(no description)

File Size: 180 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SheetHelper:: (6 methods):
  __construct()
  getSheets()
  getSheetFromXML()
  getWorkbookXMLRelsAsXMLElement()
  getWorkbookXMLAsXMLElement()
  getFileAsXMLElementWithNamespace()


Class: SheetHelper  - X-Ref

Class SheetHelper
This class provides helper functions related to XLSX sheets

__construct($filePath, $sharedStringsHelper, $globalFunctionsHelper)   X-Ref

param: string $filePath Path of the XLSX file being read
param: \Box\Spout\Reader\XLSX\Helper\SharedStringsHelper Helper to work with shared strings
param: \Box\Spout\Common\Helper\GlobalFunctionsHelper $globalFunctionsHelper

getSheets()   X-Ref
Returns the sheets metadata of the file located at the previously given file path.
The paths to the sheets' data are read from the [Content_Types].xml file.

return: Sheet[] Sheets within the XLSX file

getSheetFromXML($sheetDataXMLFilePath)   X-Ref
Returns an instance of a sheet, given the path of its data XML file.
We first look at "xl/_rels/workbook.xml.rels" to find the relationship ID of the sheet.
Then we look at "xl/worbook.xml" to find the sheet entry associated to the found ID.
The entry contains the ID and name of the sheet.

param: string $sheetDataXMLFilePath Path of the sheet data XML file as in [Content_Types].xml
return: \Box\Spout\Reader\XLSX\Sheet Sheet instance

getWorkbookXMLRelsAsXMLElement()   X-Ref
Returns a representation of the workbook.xml.rels file, ready to be parsed.
The returned value is cached.

return: \Box\Spout\Reader\Wrapper\SimpleXMLElement XML element representating the workbook.xml.rels file

getWorkbookXMLAsXMLElement()   X-Ref
Returns a representation of the workbook.xml file, ready to be parsed.
The returned value is cached.

return: \Box\Spout\Reader\Wrapper\SimpleXMLElement XML element representating the workbook.xml.rels file

getFileAsXMLElementWithNamespace($xmlFilePath, $mainNamespace)   X-Ref
Loads the contents of the given file in an XML parser and register the given XPath namespace.

param: string $xmlFilePath The path of the XML file inside the XLSX file
param: string $mainNamespace The main XPath namespace to register
return: \Box\Spout\Reader\Wrapper\SimpleXMLElement The XML element representing the file



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1