Class: XPathBase
Source Location: /lib/XPath/XPath.class.php
**********************************************************************************************
|
|
|
Child classes:
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
Class Methods
constructor XPathBase [line 181]
method getLastError [line 537]
Returns the last occured error message.
Tags:
method reset [line 214]
Resets the object so it's able to take a new xml sting/file Constructing objects is slow. If you can, reuse ones that you have used already by using this reset() function.
Overridden in child classes as:
- XPathEngine::reset()
- Resets the object so it's able to take a new xml sting/file
- XPath::reset()
- Resets the object so it's able to take a new xml sting/file
method setVerbose [line 518]
void setVerbose(
[$levelOfVerbosity
$levelOfVerbosity = 1])
|
|
Alter the verbose (error) level reporting. Pass an int. >0 to turn on, 0 to turn off. The higher the number, the higher the level of verbosity. By default, the class has a verbose level of 1.
Parameters:
method _afterstr [line 499]
(string) _afterstr(
$string
$string, $delimiter
$delimiter, [mixed
$offset = 0])
|
|
Retrieves a substring after a delimiter. This method retrieves everything from a string after a given delimiter, not including the delimiter.
Tags:
Parameters:
method _beginDebugFunction [line 609]
(array) _beginDebugFunction(
$functionName
$functionName)
|
|
Called to begin the debug run of a function. This method starts a <DIV>
Tags:
Parameters:
method _bracketExplode [line 317]
(array) _bracketExplode(
$separator
$separator, $term
$term)
|
|
Split a string by a searator-string -- BUT the separator-string must be located *outside* of any brackets. Returns an array of strings, each of which is a substring of string formed by splitting it on boundaries formed by the string separator.
Tags:
Parameters:
method _bracketsCheck [line 228]
(bool) _bracketsCheck(
$term
$term)
|
|
This method checks the right amount and match of brackets
Tags:
Parameters:
method _closeDebugFunction [line 635]
void _closeDebugFunction(
$aStartTime
$aStartTime, [$return_value
$returnValue = ""])
|
|
Called to end the debug run of a function. This method ends a <DIV>
Tags:
Parameters:
method _displayError [line 573]
void _displayError(
$message
$message, [$lineNumber
$lineNumber = '-'], [$terminate
$file = '-'], [mixed
$terminate = TRUE])
|
|
Displays an error message. This method displays an error messages depending on the users verbose settings and sets the last error message. If also possibly stops the execution of the script. ### Terminate should not be allowed --fab. Should it?? N.S.
Parameters:
method _displayMessage [line 590]
void _displayMessage(
$message
$message, [$lineNumber
$lineNumber = '-'], [mixed
$file = '-'])
|
|
Displays a diagnostic message This method displays an error messages
Parameters:
method _getEndGroups [line 395]
(array) _getEndGroups(
$string
$string, [$open
$open = '['], [$close
$close = ']'])
|
|
Split a string at it's groups, ie bracketed expressions Returns an array of strings, when concatenated together would produce the original string. ie a(b)cde(f)(g) would map to: array ('a', '(b)', cde', '(f)', '(g)')
Tags:
Parameters:
method _prestr [line 481]
(string) _prestr(
$string
&$string, $delimiter
$delimiter, [mixed
$offset = 0])
|
|
Retrieves a substring before a delimiter. This method retrieves everything from a string before a given delimiter, not including the delimiter.
Tags:
Parameters:
method _printContext [line 673]
void _printContext(
$context
$context)
|
|
Echo an XPath context for diagnostic purposes
Parameters:
method _profileFunction [line 660]
void _profileFunction(
$aStartTime
$aStartTime, $alertString
$alertString)
|
|
Call to return time since start of function for Profiling
Parameters:
method _searchString [line 285]
(int) _searchString(
$term
$term, $expression
$expression)
|
|
Looks for a string within another string -- BUT the search-string must be located *outside* of any brackets. This method looks for a string within another string. Brackets in the string the method is looking through will be respected, which means that only if the string the method is looking for is located outside of brackets, the search will be successful.
Tags:
Parameters:
method _setLastError [line 556]
void _setLastError(
[$message
$message = ''], [$line
$line = '-'], [mixed
$file = '-'])
|
|
Creates a textual error message and sets it. example: 'XPath error in THIS_FILE_NAME:LINE. Message: YOUR_MESSAGE'; I don't think the message should include any markup because not everyone wants to debug into the browser window. You should call _displayError() rather than _setLastError() if you would like the message, dependant on their verbose settings, echoed to the screen.
Tags:
Parameters:
method _treeDump [line 685]
void _treeDump(
$node
$node, [$indent
$indent = ''])
|
|
This is a debug helper function. It dumps the node-tree as HTML *QUICK AND DIRTY*. Needs some polishing.
Parameters:
|
|