Search/Lucene/Document/Docx.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Document_Docx

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

\Zend_Search_Lucene_Document_Docx
jump to top

Package: Zend\Search\Lucene\Document

Docx document.

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_WORDPROCESSINGML
                = 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'

Xml Schema - WordprocessingML

: string

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

inherited

Xml Schema - Relationships

Inherited from: \Zend_Search_Lucene_Document_OpenXml::SCHEMA_RELATIONSHIP

Inherited_from: \Zend_Search_Lucene_Document_OpenXml::SCHEMA_RELATIONSHIP
: string

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

inherited

Xml Schema - Office document

Inherited from: \Zend_Search_Lucene_Document_OpenXml::SCHEMA_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

Xml Schema - Core properties

Inherited from: \Zend_Search_Lucene_Document_OpenXml::SCHEMA_COREPROPERTIES

Inherited_from: \Zend_Search_Lucene_Document_OpenXml::SCHEMA_COREPROPERTIES
: string

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

inherited

Xml Schema - Dublin Core

Inherited from: \Zend_Search_Lucene_Document_OpenXml::SCHEMA_DUBLINCORE

Inherited_from: \Zend_Search_Lucene_Document_OpenXml::SCHEMA_DUBLINCORE
: string

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

inherited

Xml Schema - Dublin Core Terms

Inherited from: \Zend_Search_Lucene_Document_OpenXml::SCHEMA_DUBLINCORETERMS

Inherited_from: \Zend_Search_Lucene_Document_OpenXml::SCHEMA_DUBLINCORETERMS
: 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 \Zend_Search_Lucene_Document_OpenXml::$$_fields

Default valuearray()Details

Type: array
Inherited_from: \Zend_Search_Lucene_Document::$$_fields
Inherited_from: \Zend_Search_Lucene_Document_OpenXml::$$_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 \Zend_Search_Lucene_Document_OpenXml::$$boost

Default value1.0Details

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

Parameters

Name	Type	Description
$fileName	string
$storeContent	boolean

Throws

Exception	Description
\Zend_Search_Lucene_Exception

__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()\Zend_Search_Lucene_Document_OpenXml::__get()

Parameters

Name	Type	Description
$offset	string

Returns

Type	Description
string

absoluteZipPath(string $path) : string

inherited

Determine absolute zip path

Inherited from: \Zend_Search_Lucene_Document_OpenXml::absoluteZipPath()

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()\Zend_Search_Lucene_Document_OpenXml::addField()

Parameters

Name	Type	Description
$field	\Zend_Search_Lucene_Field

Returns

Type	Description
\Zend_Search_Lucene_Document

extractMetaData(\ZipArchive $package) : array

inherited

Extract metadata from document

Inherited from: \Zend_Search_Lucene_Document_OpenXml::extractMetaData()

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()\Zend_Search_Lucene_Document_OpenXml::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()\Zend_Search_Lucene_Document_OpenXml::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()\Zend_Search_Lucene_Document_OpenXml::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()\Zend_Search_Lucene_Document_OpenXml::getFieldValue()

Parameters

Name	Type	Description
$fieldName

Returns

Type	Description
string

Details

See: \__get()

loadDocxFile(string $fileName, boolean $storeContent = false) : \Zend_Search_Lucene_Document_Docx

static

Load Docx document from a file

Parameters

Name	Type	Description
$fileName	string
$storeContent	boolean

Returns

Type	Description
\Zend_Search_Lucene_Document_Docx

Throws

Exception	Description
\Zend_Search_Lucene_Document_Exception

Search/Lucene/Document/Docx.php

\Zend_Search_Lucene_Document_Docxjump to top

Constants

Properties

Methods

\Zend_Search_Lucene_Document_Docx
jump to top