Zeta Components - high quality PHP components

Zeta Components Manual :: Docs For Class ezcDocumentParser

Document::ezcDocumentParser

Class ezcDocumentParser

A base class for document parsers

Source for this file: /Document/src/interfaces/parser.php

Implements interfaces:

Version:   //autogen//

Descendants

Child Class Description
ezcDocumentWikiParser Parser for wiki documents.
ezcDocumentBBCodeParser Parser for bbcode documents.
ezcDocumentRstParser Parser for RST documents

Member Variables

protected ezcDocumentParserOptions $options
XML document base options.
protected array $properties = array(
'errors' => array(),)

Additional parser properties.

Method Summary

public ezcDocumentParser __construct( [ $options = null] )
Construct new document
public array getErrors( )
Return list of errors occured during visiting the document.
public void triggerError( $level , $message , [ $file = null] , [ $line = null] , [ $position = null] )
Trigger parser error

Methods

__construct

ezcDocumentParser __construct( [ezcDocumentParserOptions $options = null] )

Construct new document

Parameters:
Name Type Description
$options ezcDocumentParserOptions
Redefined in descendants as:
Method Description
ezcDocumentRstParser::__construct() Construct new document 

getErrors

array getErrors( )

Return list of errors occured during visiting the document.

May be an empty array, if on errors occured, or a list of ezcDocumentVisitException objects.

Implementation of:
Method Description
ezcDocumentErrorReporting::getErrors() Return list of errors occured during visiting the document.

triggerError

void triggerError( int $level , string $message , [string $file = null] , [int $line = null] , [int $position = null] )

Trigger parser error

Emit a parser error and handle it dependiing on the current error reporting settings.

Parameters:
Name Type Description
$level int
$message string
$file string
$line int
$position int
Implementation of:
Method Description
ezcDocumentErrorReporting::triggerError() Trigger parser error.
Documentation generated by phpDocumentor 1.4.3