Search/Lucene/Document/OpenXml.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Document_OpenXml

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
jump to top

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

string 
                SCHEMA_RELATIONSHIP
                = 'http://schemas.openxmlformats.org/package/2006/relationships'

Xml Schema - Relationships

: string

string 
                SCHEMA_OFFICEDOCUMENT
                = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'

Xml Schema - Office document

: string

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

Xml Schema - Core properties

: string

string 
                SCHEMA_DUBLINCORE
                = 'http://purl.org/dc/elements/1.1/'

Xml Schema - Dublin Core

: string

string 
                SCHEMA_DUBLINCORETERMS
                = 'http://purl.org/dc/terms/'

Xml Schema - Dublin Core Terms

: string

Properties

array $_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

float $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

__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

Name	Type	Description
$offset	string

Returns

Type	Description
string

absoluteZipPath(string $path) : string

Determine absolute zip path

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
string

addField(\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

Name	Type	Description
$field	\Zend_Search_Lucene_Field

Returns

Type	Description
\Zend_Search_Lucene_Document

extractMetaData(\ZipArchive $package) : array

Extract metadata from document

Parameters

Name	Type	Description
$package	\ZipArchive	ZipArchive OpenXML package

Returns

Type	Description
array	Key-value pairs containing document meta data

getField(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

Name	Type	Description
$fieldName	string

Returns

Type	Description
\Zend_Search_Lucene_Field

getFieldNames() : array

inherited

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

Inherited from: \Zend_Search_Lucene_Document::getFieldNames()

Returns

Type	Description
array

getFieldUtf8Value( $fieldName) : string

inherited

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

Inherited from: \Zend_Search_Lucene_Document::getFieldUtf8Value()

Parameters

Name	Type	Description
$fieldName

Returns

Type	Description
string

Details

See: \__get()

getFieldValue( $fieldName) : string

inherited

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

Inherited from: \Zend_Search_Lucene_Document::getFieldValue()

Parameters

Name	Type	Description
$fieldName

Returns

Type	Description
string

Details

See: \__get()

Search/Lucene/Document/OpenXml.php

\Zend_Search_Lucene_Document_OpenXmljump to top

Constants

Properties

Methods

\Zend_Search_Lucene_Document_OpenXml
jump to top