Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/mitarbeiter/sven/public_html/tmp/devcon_php_base/text/xml/scanner.class
dev/con php base - Text functions

XML_SCANNER

XML_SCANNER

XML scanner

 

public class XML_SCANNER

XML scanner

 

Public Method Summary

void

assoc(string $tagname, integer $id_class)

Define an element.
void

tags(string $names)

Register list of handlers that work with all element types.
void

dirtag(string $ns, string $names)

Register directory type dependend functions.
void

set_ref(object any &$objref)

Set object of element handlers.
void

set_context_func(object any &$context_func)

Register context function.
void

push_context()

Push context on stack.
void

pop_context()

Pop context from stack.
string

&exec(array &$branch, [ integer $id, integer $con ])

Exec a document branch.
array

&scan(string &$data)

Create document tree from XML document.

Private Method Summary

string

&_exec_tag(array &$node, [ integer $id, string $con ])

Call handler for an element.
void

_err( $msg)

Warning: documentation is missing.
void

_tags2tree( &$data, integer $ptr)

Warning: documentation is missing.

Private Field Summary

unknown

$classes

unknown

$dirtypes

string

$context

string

$dirtype

string

$parent_context

string

$parent_dirtype

unknown

$context_stack

unknown

$dirtype_stack

array

$_block_stack

unknown

$_tag

unknown

$_dirtag

integer

$_ref

boolean

$_context_func

unknown

$_in

Public Method Details

assoc

public void assoc( string $tagname, integer $id_class )

  Define an element.

Parameter
string $tagname
Element name.
integer $id_class
Element id.
Returns void


tags

public void tags( string $names )

  Register list of handlers that work with all element types.

Parameter
string $names
Space separated list of tag names.
Returns void


dirtag

public void dirtag( string $ns, string $names )

  Register directory type dependend functions.

Parameter
string $ns
Name space.
string $names
Space separated list of tag names.
Returns void


set_ref

public void set_ref( object any &$objref )

  Set object of element handlers.

Parameter
object any &$objref
Returns void


set_context_func

public void set_context_func( object any &$context_func )

  Register context function.

Parameter
object any &$context_func
Returns void


push_context

public void push_context( )

  Push context on stack.

Returns void


pop_context

public void pop_context( )

  Pop context from stack.

Returns void


&exec

public string &exec( array &$branch, [ integer $id, integer $con ] )

  Exec a document branch.
This function iterates over a document tree and calls the tag handlerdefined by assoc(), tag() and/or dirtag().

Parameter
array &$branch
Root node of a branch or tree.
integer $id = >>0<<
integer $con = >>0<<
Initial context.
Returns string

Result from handler.


&scan

public array &scan( string &$data )

  Create document tree from XML document.
A document tree is a nested array containing the following fields:'name': The tag name (non-optional). For a text block the name is#PCDATA, 'ns': the namespace, 'args': an array of arguments keyed byname, '_': an array of child blocks (more arrays of this type).Use exec() to execute a document tree.

Parameter
string &$data
XML document.
Returns array

Document tree.


Private Method Details

&_exec_tag

private string &_exec_tag( array &$node, [ integer $id, string $con ] )

  Call handler for an element.

Parameter
array &$node
Node of element in document tree.
integer $id = >>0<<
string $con = >>''<<
Initial context.
Returns string

Result from handler.


_err

private void _err( $msg )

 

Warning: documentation is missing.

Parameter
$msg
Warning: documentation is missing.
Returns void


_tags2tree

private void _tags2tree( &$data, integer $ptr )

 

Warning: documentation is missing.

Parameter
&$data
Warning: documentation is missing.
integer $ptr
Warning: documentation is missing.
Returns void


Private Field Details

$classes

private unknown $classes

>><<



$dirtypes

private unknown $dirtypes

>><<



$context

private string $context

>>''<<



$dirtype

private string $dirtype

>>''<<



$parent_context

private string $parent_context

>>''<<



$parent_dirtype

private string $parent_dirtype

>>''<<



$context_stack

private unknown $context_stack

>><<



$dirtype_stack

private unknown $dirtype_stack

>><<



$_block_stack

private array $_block_stack

>>array ()<<



$_tag

private unknown $_tag

>><<



$_dirtag

private unknown $_dirtag

>><<



$_ref

private integer $_ref

>><<



$_context_func

private boolean $_context_func

>>false<<



$_in

private unknown $_in

>><<




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta