Search/Lucene/Document/OpenXml.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

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: OpenXml.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Search_Lucene_Document_OpenXml

Package: Zend\Search\Lucene\Document
OpenXML document.

Each field has a name and a textual value.

Parent(s)
\Zend_Search_Lucene_Document
Children
\Zend_Search_Lucene_Document_Xlsx
\Zend_Search_Lucene_Document_Docx
\Zend_Search_Lucene_Document_Pptx
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstantstring  SCHEMA_RELATIONSHIP = 'http://schemas.openxmlformats.org/package/2006/relationships'
Xml Schema - Relationships
string

>VConstantstring  SCHEMA_OFFICEDOCUMENT = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'
Xml Schema - Office document
string

>VConstantstring  SCHEMA_COREPROPERTIES = 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties'
Xml Schema - Core properties
string

>VConstantstring  SCHEMA_DUBLINCORE = 'http://purl.org/dc/elements/1.1/'
Xml Schema - Dublin Core
string

>VConstantstring  SCHEMA_DUBLINCORETERMS = 'http://purl.org/dc/terms/'
Xml Schema - Dublin Core Terms
string

Properties

>VPropertyprotectedarray $_fields = array()
inherited
Associative array Zend_Search_Lucene_Field objects where the keys to the array are the names of the fields.
Inherited from: \Zend_Search_Lucene_Document::$$_fields
Default valuearray()Details
Type
array
Inherited_from
\Zend_Search_Lucene_Document::$$_fields  
>VPropertypublicfloat $boost = 1.0
inherited
Field boost factor It's not stored directly in the index, but affects on normalization factor
Inherited from: \Zend_Search_Lucene_Document::$$boost
Default value1.0Details
Type
float
Inherited_from
\Zend_Search_Lucene_Document::$$boost  

Methods

methodpublic__get(string $offset) : string
inherited

Proxy method for getFieldValue(), provides more convenient access to the string value of a field.

Inherited from: \Zend_Search_Lucene_Document::__get()
Parameters
NameTypeDescription
$offsetstring
Returns
TypeDescription
string
methodprotectedabsoluteZipPath(string $path) : string

Determine absolute zip path

Parameters
NameTypeDescription
$pathstring
Returns
TypeDescription
string
methodpublicaddField(\Zend_Search_Lucene_Field $field) : \Zend_Search_Lucene_Document
inherited

Add a field object to this document.

Inherited from: \Zend_Search_Lucene_Document::addField()
Parameters
NameTypeDescription
$field\Zend_Search_Lucene_Field
Returns
TypeDescription
\Zend_Search_Lucene_Document
methodprotectedextractMetaData(\ZipArchive $package) : array

Extract metadata from document

Parameters
NameTypeDescription
$package\ZipArchive

ZipArchive OpenXML package

Returns
TypeDescription
arrayKey-value pairs containing document meta data
methodpublicgetField(string $fieldName) : \Zend_Search_Lucene_Field
inherited

Returns Zend_Search_Lucene_Field object for a named field in this document.

Inherited from: \Zend_Search_Lucene_Document::getField()
Parameters
NameTypeDescription
$fieldNamestring
Returns
TypeDescription
\Zend_Search_Lucene_Field
methodpublicgetFieldNames() : array
inherited

Return an array with the names of the fields in this document.

Inherited from: \Zend_Search_Lucene_Document::getFieldNames()
Returns
TypeDescription
array
methodpublicgetFieldUtf8Value( $fieldName) : string
inherited

Returns the string value of a named field in UTF-8 encoding.

Inherited from: \Zend_Search_Lucene_Document::getFieldUtf8Value()
Parameters
NameTypeDescription
$fieldName
Returns
TypeDescription
string
Details
See
\__get()  
methodpublicgetFieldValue( $fieldName) : string
inherited

Returns the string value of a named field in this document.

Inherited from: \Zend_Search_Lucene_Document::getFieldValue()
Parameters
NameTypeDescription
$fieldName
Returns
TypeDescription
string
Details
See
\__get()  
Documentation was generated by phpDocumentor 2.0.0a12.