Docs For Class XML_Indexing

XML_Indexing_Builder (Constructor) [line 140]

XML_Indexing_Builder XML_Indexing_Builder(

$xmlSource, string
$xroot, string
$xml)

Constructor

Access: public

Parameters:

string	`$xml`	—	The filename or xml string to build an index against. If it is a string, it has to start with '<?php' ; if that is not the case, it will be recognized as a filename.
string	`$xroot`	—	XPath root
	`$xmlSource`	—

[ Top ]

getIndex [line 420]

array getIndex(
)

Return the built index

Return: All regions with offset and length
Access: public

[ Top ]

getNamespaces [line 435]

array getNamespaces(
)

Return extracted namespaces declarations

Return: Associative array of the form: array ('prefix' => 'uri', ...)
Access: public

[ Top ]

_enterScope [line 382]

void _enterScope(
)

Prototype for entering node scope

This may be overloaded by child classes.

Access: protected

Overridden in child classes as:

XML_Indexing_Builder_Numeric::_enterScope(): Handle entering node scope

[ Top ]

_exitScope [line 394]

void _exitScope(
)

Prototype for exiting node scope

This may be overloaded by child classes.

Access: protected

[ Top ]

_handleRegion [line 370]

void _handleRegion(
int
$offset, int
$length, array
$attribs)

Prototype for region handling

This has to be overloaded by child classes to actually do anything real.

Access: protected

Overridden in child classes as:

XML_Indexing_Builder_Attribute::_handleRegion(): Handle a matched region

XML_Indexing_Builder_Numeric::_handleRegion(): Handle a matched region

Parameters:

int	`$offset`	—	Byte offset of the matched region
int	`$length`	—	Length in bytes of the matched region
array	`$attribs`	—	Attributes of the tag enclosing the region

[ Top ]

Class: XML_Indexing_Builder

Class Overview

Author(s):

Version:

Copyright:

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

XML_Indexing_Builder (Constructor) [line 140]

Parameters:

getIndex [line 420]

getNamespaces [line 435]

_enterScope [line 382]

_exitScope [line 394]

_handleRegion [line 370]

Parameters: