NAME

PurpleWiki::View::subtree - Extracts a Subtree Rooted at a Given NID.

SYNOPSIS

    See get() in Transclusion.pm

DESCRIPTION

Subtree extracts a subtree rooted at a node with a given NID. It's useful for doing transclusion or removing slices from a tree.

METHODS

new(nid => $nid)

Returns a new PurpleWiki::View::subtree object.

nid is a PurpleWiki NID for the given node you're searching for. It is an error to not supply nid.

view($tree)

Returns a subtree of $tree with the root node of subtree being a node with the NID passed into new(). $tree is a PurpleWiki::Tree.

getSubTree(void)

Returns the subtree found by the call view(). Returns undef if view() hasn't been called yet.

AUTHORS

Matthew O'Connor, <matthew@canonical.org>

SEE ALSO

PurpleWiki::View::Driver