HumHub Documentation (unofficial)

Docx extends AbstractOpenXML
in package

Docx document.

Tags
category

Zend

subpackage

Document

Table of Contents

Constants

SCHEMA_COREPROPERTIES  = 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties'
Xml Schema - Core properties
SCHEMA_DUBLINCORE  = 'http://purl.org/dc/elements/1.1/'
Xml Schema - Dublin Core
SCHEMA_DUBLINCORETERMS  = 'http://purl.org/dc/terms/'
Xml Schema - Dublin Core Terms
SCHEMA_OFFICEDOCUMENT  = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'
Xml Schema - Office document
SCHEMA_RELATIONSHIP  = 'http://schemas.openxmlformats.org/package/2006/relationships'
Xml Schema - Relationships
SCHEMA_WORDPROCESSINGML  = 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'
Xml Schema - WordprocessingML

Properties

$boost  : float
Field boost factor It's not stored directly in the index, but affects on normalization factor
$_fields  : array<string|int, mixed>
Associative array \ZendSearch\Lucene\Document\Field objects where the keys to the array are the names of the fields.

Methods

__get()  : string
Proxy method for getFieldValue(), provides more convenient access to the string value of a field.
__isset()  : bool
Magic method for checking the existence of a field
addField()  : Document
Add a field object to this document.
getField()  : Field
Returns {@link \ZendSearch\Lucene\Document\Field} object for a named field in this document.
getFieldNames()  : array<string|int, mixed>
Return an array with the names of the fields in this document.
getFieldUtf8Value()  : string
Returns the string value of a named field in UTF-8 encoding.
getFieldValue()  : string
Returns the string value of a named field in this document.
loadDocxFile()  : Docx
Load Docx document from a file
absoluteZipPath()  : string
Determine absolute zip path
extractMetaData()  : array<string|int, mixed>
Extract metadata from document
__construct()  : mixed
Object constructor

Constants

SCHEMA_COREPROPERTIES

Xml Schema - Core properties

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

SCHEMA_DUBLINCORE

Xml Schema - Dublin Core

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

SCHEMA_DUBLINCORETERMS

Xml Schema - Dublin Core Terms

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

SCHEMA_OFFICEDOCUMENT

Xml Schema - Office document

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

SCHEMA_RELATIONSHIP

Xml Schema - Relationships

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

SCHEMA_WORDPROCESSINGML

Xml Schema - WordprocessingML

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

Properties

$boost

Field boost factor It's not stored directly in the index, but affects on normalization factor

public float $boost = 1.0

$_fields

Associative array \ZendSearch\Lucene\Document\Field objects where the keys to the array are the names of the fields.

protected array<string|int, mixed> $_fields = array()

Methods

__get()

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

public __get(mixed $offset) : string
Parameters
$offset : mixed
Return values
string

__isset()

Magic method for checking the existence of a field

public __isset(string $offset) : bool
Parameters
$offset : string
Return values
bool —

TRUE if the field exists else FALSE

getField()

Returns {@link \ZendSearch\Lucene\Document\Field} object for a named field in this document.

public getField(string $fieldName) : Field
Parameters
$fieldName : string
Tags
throws
InvalidArgumentException
Return values
Field

getFieldNames()

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

public getFieldNames() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFieldUtf8Value()

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

public getFieldUtf8Value(string $fieldName) : string
Parameters
$fieldName : string
Tags
see
__get()
Return values
string

getFieldValue()

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

public getFieldValue(string $fieldName) : string
Parameters
$fieldName : string
Tags
see
__get()
Return values
string

loadDocxFile()

Load Docx document from a file

public static loadDocxFile(string $fileName[, bool $storeContent = false ]) : Docx
Parameters
$fileName : string
$storeContent : bool = false
Tags
throws
InvalidArgumentException
Return values
Docx

absoluteZipPath()

Determine absolute zip path

protected absoluteZipPath(string $path) : string
Parameters
$path : string
Return values
string

extractMetaData()

Extract metadata from document

protected extractMetaData(ZipArchive $package) : array<string|int, mixed>
Parameters
$package : ZipArchive

ZipArchive AbstractOpenXML package

Return values
array<string|int, mixed> —

Key-value pairs containing document meta data


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results