Odf_Parser implements Parser_Interface

Parser for OpenDocument files (odt, ods, odp).

Tags
author

Barn2 Plugins [email protected]

license

GPL-3.0

copyright

Barn2 Media Ltd

Interfaces, Classes and Traits

Parser_Interface
Interface for document parsers.

Table of Contents

extract()  : string
Extract plaintext content from the given file.
assert_requirements()  : void
Ensure required PHP extensions are available.
extract_xml_text()  : string
Extract plaintext from XML text nodes.
load_xml()  : bool
Load XML safely while capturing parser warnings.
normalize_text()  : string
Normalize parser output.

Methods

extract()

Extract plaintext content from the given file.

public extract(string $file_path) : string
Parameters
$file_path : string

Absolute file path.

Tags
Return values
string

assert_requirements()

Ensure required PHP extensions are available.

private assert_requirements() : void
Tags
throws
Parse_Exception

When a required extension is unavailable.

Return values
void

extract_xml_text()

Extract plaintext from XML text nodes.

private extract_xml_text(string $xml) : string
Parameters
$xml : string

XML payload.

Tags
Return values
string

load_xml()

Load XML safely while capturing parser warnings.

private load_xml(DOMDocument $dom, string $xml) : bool
Parameters
$dom : DOMDocument

DOM document.

$xml : string

XML payload.

Tags
Return values
bool

normalize_text()

Normalize parser output.

private normalize_text(string $text) : string
Parameters
$text : string

Raw extracted text.

Tags
Return values
string

Search results