Docs for page eXcavator.inc

Description

version: 1.0.6
license: GNU General Public License
copyright: 2006 Myron Turner
author: Myron Turner <Myron_Turner@shaw.ca>

Classes

Class	Description
eXcavator	Class definition: eXcavator

Includes

require_once ("XML_PullParser.inc") (line 43)

requires XML_PullParser and eXcavator_QueryParser

require_once ("eXcavator_QueryParser.inc") (line 44)

Constants

ATTR = 0X400 (line 61)

CDATA = 0X1000 (line 62)

CURRENT_TOKEN = 0x2 (line 60)

eXcavator_FILE = '2' (line 55)

eXcavator_STRING = '1' (line 54)

Constants

NEXT_TOKEN = 0x1 (line 57)

SAVE_DATA = 0x100 (line 59)

SAVE_ELEMENT = 0x200 (line 58)

_AND_ = 0x20 (line 67)

_ARROW_ = 0x25 (line 68)

_EQ_ = 0x40 (line 70)

_GTE_ = 0x80 (line 74)

_GT_ = 0x50 (line 71)

_IDENT_ = 0x15 (line 66)

_INCL_ = 0x90 (line 75)

_LTE_ = 0x70 (line 73)

_LT_ = 0x60 (line 72)

_NE_ = 0x5 (line 64)

_NOT_ = 0x10 (line 65)

_OR_ = 0x30 (line 69)

Variables

string $GLOBALS['eXcavator_NS_Definition'] (line 98)

Holds XML_PullParser namespace definition

see: eXcavator_setNamespace()

Functions

eXcavator_setNamespace (line 118)

Set the namespace definition

This function takes a single parameter, a string consisting of one or more namespace URI's. They must be exactly as defined in the XML document. If there is a trailing forward slash in the URI, then this must be included. If more than one namespace is passed in, they must separated by the vertical bar:

    $parser->XML_PullParser_setCurrentNS("http://room535.org/movies/title/|"
      . "http://room535.org/movies/mov/|http://room535.org/movies/star/");

return: previously set namespace definition

mixed eXcavator_setNamespace ( $ns)

$ns

eXcavator_unsetNamespace (line 143)

Unsets the current namespace definition

This is aimed at scripts which create more than one instance of eXcavator, where the the aim is to turn off namespace support and unset the namespace definition, so that the next query is processed without namespace support in effect. Unless this function is called between queries, the namespace definition of the previous query remains in effect and therefore namespace support will also remain in effect.

return: previously set namespace definition

mixed eXcavator_unsetNamespace ()

/eXcavator.inc