Search/Lucene/Document/Xlsx.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Document
- Version
- $Id: Xlsx.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_Document_Xlsx
Each field has a name and a textual value.
- Parent(s)
- \Zend_Search_Lucene_Document_OpenXml < \Zend_Search_Lucene_Document
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants

string
SCHEMA_SPREADSHEETML
= 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
- string

string
SCHEMA_DRAWINGML
= 'http://schemas.openxmlformats.org/drawingml/2006/main'
- string

string
SCHEMA_SHAREDSTRINGS
= 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings'
- string

string
SCHEMA_WORKSHEETRELATION
= 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet'
- string

string
SCHEMA_SLIDENOTESRELATION
= 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/notesSlide'
- string

string
SCHEMA_RELATIONSHIP
= 'http://schemas.openxmlformats.org/package/2006/relationships'
- Inherited_from
- \Zend_Search_Lucene_Document_OpenXml::SCHEMA_RELATIONSHIP
- string

string
SCHEMA_OFFICEDOCUMENT
= 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'
- Inherited_from
- \Zend_Search_Lucene_Document_OpenXml::SCHEMA_OFFICEDOCUMENT
- string

string
SCHEMA_COREPROPERTIES
= 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties'
- Inherited_from
- \Zend_Search_Lucene_Document_OpenXml::SCHEMA_COREPROPERTIES
- string

string
SCHEMA_DUBLINCORE
= 'http://purl.org/dc/elements/1.1/'
- Inherited_from
- \Zend_Search_Lucene_Document_OpenXml::SCHEMA_DUBLINCORE
- string

string
SCHEMA_DUBLINCORETERMS
= 'http://purl.org/dc/terms/'
- Inherited_from
- \Zend_Search_Lucene_Document_OpenXml::SCHEMA_DUBLINCORETERMS
- string
Properties


array $_fields = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Search_Lucene_Document::$$_fields
- Inherited_from
- \Zend_Search_Lucene_Document_OpenXml::$$_fields


float $boost = 1.0
1.0
Details- Type
- float
- Inherited_from
- \Zend_Search_Lucene_Document::$$boost
- Inherited_from
- \Zend_Search_Lucene_Document_OpenXml::$$boost
Methods


__construct(string $fileName, boolean $storeContent) : void
Object constructor
Name | Type | Description |
---|---|---|
$fileName | string | |
$storeContent | boolean |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |


__get(string $offset) : string
Proxy method for getFieldValue(), provides more convenient access to the string value of a field.
Inherited from: \Zend_Search_Lucene_Document::__get()\Zend_Search_Lucene_Document_OpenXml::__get()Name | Type | Description |
---|---|---|
$offset | string |
Type | Description |
---|---|
string |


_parseRichText(\SimpleXMLElement $is = null) : string
Parse rich text XML
Name | Type | Description |
---|---|---|
$is | \SimpleXMLElement |
Type | Description |
---|---|
string |


absoluteZipPath(string $path) : string
Determine absolute zip path
Inherited from: \Zend_Search_Lucene_Document_OpenXml::absoluteZipPath()Name | Type | Description |
---|---|---|
$path | string |
Type | Description |
---|---|
string |


addField(\Zend_Search_Lucene_Field $field) : \Zend_Search_Lucene_Document
Add a field object to this document.
Inherited from: \Zend_Search_Lucene_Document::addField()\Zend_Search_Lucene_Document_OpenXml::addField()Name | Type | Description |
---|---|---|
$field | \Zend_Search_Lucene_Field |
Type | Description |
---|---|
\Zend_Search_Lucene_Document |


extractMetaData(\ZipArchive $package) : array
Extract metadata from document
Inherited from: \Zend_Search_Lucene_Document_OpenXml::extractMetaData()Name | Type | Description |
---|---|---|
$package | \ZipArchive | ZipArchive OpenXML package |
Type | Description |
---|---|
array | Key-value pairs containing document meta data |


getField(string $fieldName) : \Zend_Search_Lucene_Field
Returns Zend_Search_Lucene_Field object for a named field in this document.
Inherited from: \Zend_Search_Lucene_Document::getField()\Zend_Search_Lucene_Document_OpenXml::getField()Name | Type | Description |
---|---|---|
$fieldName | string |
Type | Description |
---|---|
\Zend_Search_Lucene_Field |


getFieldNames() : array
Return an array with the names of the fields in this document.
Inherited from: \Zend_Search_Lucene_Document::getFieldNames()\Zend_Search_Lucene_Document_OpenXml::getFieldNames()Type | Description |
---|---|
array |


getFieldUtf8Value( $fieldName) : string
Returns the string value of a named field in UTF-8 encoding.
Inherited from: \Zend_Search_Lucene_Document::getFieldUtf8Value()\Zend_Search_Lucene_Document_OpenXml::getFieldUtf8Value()Name | Type | Description |
---|---|---|
$fieldName |
Type | Description |
---|---|
string |
- See
- \__get()


getFieldValue( $fieldName) : string
Returns the string value of a named field in this document.
Inherited from: \Zend_Search_Lucene_Document::getFieldValue()\Zend_Search_Lucene_Document_OpenXml::getFieldValue()Name | Type | Description |
---|---|---|
$fieldName |
Type | Description |
---|---|
string |
- See
- \__get()


loadXlsxFile(string $fileName, boolean $storeContent = false) : \Zend_Search_Lucene_Document_Xlsx
Load Xlsx document from a file
Name | Type | Description |
---|---|---|
$fileName | string | |
$storeContent | boolean |
Type | Description |
---|---|
\Zend_Search_Lucene_Document_Xlsx |