XParser_File
extends XParser
in package
A parser based on an opened text file
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- Creates a parser instance on an opened file and given XML string syntax
- apply() : UXMLElement
- Applies syntax on input.
- export() : string
- A megadott node tartalmát XML stringgé alakítja
- filterNodes() : void
- Törli a megadott nevő gyermek node-okat.
- getc() : string
- Must return a char or false on EOF
- getPos() : mixed
- getSymbol() : UXMLElement
- Tries to read a symbol by named rule.
- getTerm() : mixed
- joinAttr() : void
- Converts <_attr name>value</_attr> subnodes to attributes.
- matchList() : bool
- 'list' matches if sequence matches [min, max] times.
- matchNode() : bool
- matches a node, and collects the result tree.
- matchOr() : bool
- 'or' matches if any of elements matches. (Use 'case' for group elements) Matching element terminates early.
- matchRule() : bool
- tries to match a rule once (several rule versions or-ed)
- matchSeq() : bool
- matches a sequence of patterns under the node, and collects the result tree.
- setPos() : mixed
- toRegExp() : string
- Creates a delimited RegEx pattern from a bare pattern.
- ungetc() : mixed
Properties
$debug
public
mixed
$debug
$result
public
UXMLDoc
$result
$cut
private
mixed
$cut
$fh
private
mixed
$fh
$syntax
private
UXMLDoc
$syntax
Methods
__construct()
Creates a parser instance on an opened file and given XML string syntax
public
__construct(resource $fh, string $syntax) : mixed
Parameters
- $fh : resource
-
-- text file to parse
- $syntax : string
-
-- an XML string
apply()
Applies syntax on input.
public
apply() : UXMLElement
Finds default match in syntax file and applies getSymbol(name) of it.
Builds XML representation structure
Tags
Return values
UXMLElement —result node or null
export()
A megadott node tartalmát XML stringgé alakítja
public
export(DOMElement $node[, int $ent = 0 ][, string $c = '' ]) : string
Parameters
- $node : DOMElement
- $ent : int = 0
-
-- 0:default, 1:htmlentities, 2:formatted
- $c : string = ''
-
-- színes span-ben adja vissza
Tags
Return values
string —-- az XML string
filterNodes()
Törli a megadott nevő gyermek node-okat.
public
filterNodes(mixed $node, mixed $nodename) : void
Elsősorban az _attr node-ok eltávolítására szolgál, ahol a text tartalom kell csak.
Parameters
- $node : mixed
- $nodename : mixed
getc()
Must return a char or false on EOF
public
getc() : string
Return values
stringgetPos()
public
getPos() : mixed
getSymbol()
Tries to read a symbol by named rule.
public
getSymbol(string $name) : UXMLElement
Inserts result into result structure. Returns result node or false on failure
Parameters
- $name : string
Tags
Return values
UXMLElement —-- result node
getTerm()
public
getTerm(mixed $term) : mixed
Parameters
- $term : mixed
joinAttr()
Converts <_attr name>value</_attr> subnodes to attributes.
public
joinAttr(DOMElement $node) : void
Duplicate attributes overwrite existing ones. <_attr> subnodes without name attribute are be ignored All other attributes and sub-subnodes are ignored All <_attr> subnodes will be completely removed (including the irregular ones)
Parameters
- $node : DOMElement
matchList()
'list' matches if sequence matches [min, max] times.
public
matchList(DOMElement $node, int $min, int $max, DOMElement $node_parent, bool $f) : bool
Zero match terminates first time.
Parameters
- $node : DOMElement
- $min : int
- $max : int
- $node_parent : DOMElement
- $f : bool
-
-- add chars to result
Tags
Return values
boolmatchNode()
matches a node, and collects the result tree.
public
matchNode(DOMElement $node, DOMElement|DOMDocumentFragment $resultFragment[, int $f = 0 ]) : bool
used in matchSequence and matchOr
Parameters
- $node : DOMElement
-
-- syntax node
- $resultFragment : DOMElement|DOMDocumentFragment
-
-- inserts results here
- $f : int = 0
-
-- add chars to result
Tags
Return values
bool —-- false if failed
matchOr()
'or' matches if any of elements matches. (Use 'case' for group elements) Matching element terminates early.
public
matchOr(DOMElement $node, DOMElement|DOMDocumentFragment $node_parent, bool $f) : bool
Parameters
- $node : DOMElement
- $node_parent : DOMElement|DOMDocumentFragment
- $f : bool
-
-- add chars to result
Tags
Return values
boolmatchRule()
tries to match a rule once (several rule versions or-ed)
public
matchRule(string $name, DOMElement|DOMDocumentFragment $node_parent) : bool
Parameters
- $name : string
-
-- rule name
- $node_parent : DOMElement|DOMDocumentFragment
-
-- inserts result tree here on success
Tags
Return values
bool —-- false on fail (tree result will be untouched)
matchSeq()
matches a sequence of patterns under the node, and collects the result tree.
public
matchSeq(DOMElement $rule, DOMElement|DOMDocumentFragment $node_parent[, int $f = 0 ]) : bool
succeeds only if all of members suceeded consecutively
Parameters
- $rule : DOMElement
-
-- evaluate all children of rule node
- $node_parent : DOMElement|DOMDocumentFragment
-
-- inserts results here
- $f : int = 0
-
-- add chars to result
Tags
Return values
bool —-- false if failed
setPos()
public
setPos(int $p) : mixed
Parameters
- $p : int
Tags
toRegExp()
Creates a delimited RegEx pattern from a bare pattern.
public
static toRegExp( $pattern) : string
Parameters
Return values
string —-- pattern with ~ delimiters and escaped inner ~s
ungetc()
public
ungetc(mixed $c) : mixed
Parameters
- $c : mixed