TreenodePageAttrMatcher
in package
implements
TreenodeMatcher
Matches a node which has a specific key matching a specific value
Table of Contents
Interfaces
- TreenodeMatcher
- Interface for matching nodes in the treenode
Properties
- $page_ids : mixed
Methods
- __construct() : mixed
- Constructor
- ascend() : mixed
- Called after children have been processed
- descend() : bool
- Returns true if the children of the specified node should be searched, false otherwise.
- match() : bool
- Does the match
Properties
$page_ids
private
mixed
$page_ids
Methods
__construct()
Constructor
public
__construct(string $attr_name[, mixed $attr_value = null ]) : mixed
Parameters
- $attr_name : string
-
The attr name to search.
- $attr_value : mixed = null
-
The attr value to search for. Can be null to match all pages which contain the attribute, irrespective of the value.
ascend()
Called after children have been processed
public
ascend(Treenode $node) : mixed
Parameters
- $node : Treenode
-
The treenode which has just ascended.
descend()
Returns true if the children of the specified node should be searched, false otherwise.
public
descend(Treenode $node) : bool
Parameters
- $node : Treenode
-
The treenode which is about to be descended into
Return values
bool —True descending should proceed, false otherwise
match()
Does the match
public
match(Treenode $node) : bool
Parameters
- $node : Treenode
-
The treenode to do matching against
Return values
bool —True if the node matches, false otherwise