API Documentation

Search/Lucene/Document/Docx.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Search_Lucene  
subpackage
Document  
version
$Id: Docx.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Search_Lucene_Document_Docx

Docx document.

Extends from
\Zend_Search_Lucene_Document_OpenXml
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Search_Lucene  
subpackage
Document  

Constants

Constantstring  SCHEMA_WORDPROCESSINGML = 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'

Xml Schema - WordprocessingML

string

Methods

methodprivate__construct( string $fileName, boolean $storeContent ) : void

Object constructor

Parameters
Name Type Description
$fileName string
$storeContent boolean
Throws
Exception Description
\Zend_Search_Lucene_Exception
methodpublic__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()
Parameters
Name Type Description
$offset string
Returns
Type Description
string
methodprotectedabsoluteZipPath( string $path ) : string

Determine absolute zip path

Inherited from: \Zend_Search_Lucene_Document_OpenXml::absoluteZipPath()
Parameters
Name Type Description
$path string
Returns
Type Description
string
methodpublicaddField( \Zend_Search_Lucene_Field $field ) : \Zend_Search_Lucene_Document

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
methodprotectedextractMetaData( \ZipArchive $package ) : array

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
methodpublicgetField( 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()
Parameters
Name Type Description
$fieldName string
Returns
Type Description
\Zend_Search_Lucene_Field
methodpublicgetFieldNames( ) : array

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

Inherited from: \Zend_Search_Lucene_Document::getFieldNames()
Returns
Type Description
array
methodpublicgetFieldUtf8Value(  $fieldName ) : string

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()  
methodpublicgetFieldValue(  $fieldName ) : string

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()  
methodpublicloadDocxFile( 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
Documentation was generated by DocBlox 0.13.3.