Zeta Components - high quality PHP components

Tutorial
API

Zeta Components Manual :: Docs For Class ezcTreeVisitorYUI

Tree::ezcTreeVisitorYUI

Class ezcTreeVisitorYUI

An implementation of the ezcTreeVisitor interface that generates an XHTML representatation of a tree structure, as YUI wants.

See http://developer.yahoo.com/yui/menu.

<?php
$visitor = new ezcTreeVisitorYUI( 'menu' );
$tree->accept( $visitor );
echo (string) $visitor; // print the plot
?>

Source for this file: /Tree/src/visitors/yui.php

Implements interfaces:

ezcTreeVisitor

Version:

//autogentag//

Member Variables

protected string	`$class` Holds the XHTML class.
protected array(string=>array(string))	`$edges = array()` Holds all the edges of the graph.
public ezcTreeVisitorYUIOptions	`$options` Holds the options for this class
protected string	`$root = null` Holds the root ID.
protected string	`$xmlId` Holds the XML ID.

Method Summary

public ezcTreeVisitorYUI	`__construct( $xmlId , [ $options = null] )` Constructs a new ezcTreeVisitorYUI visualizer.
protected string	`doChildren( $id , [ $level = 0] , [ $levelLast = array()] )` Loops over the children of the node with ID $id.
protected string	`formatData( $data , $highlight )` Formats a node's data.
public bool	`visit( $visitable )` Visits the node and sets the the member variables according to the node type and contents.

Methods

__construct

ezcTreeVisitorYUI __construct( string $xmlId , [ezcTreeVisitorYUIOptions $options = null] )

Constructs a new ezcTreeVisitorYUI visualizer.

Parameters:

Name	Type	Description
`$xmlId`	string
`$options`	ezcTreeVisitorYUIOptions

doChildren

string doChildren( string $id , [int $level = 0] , [array(int=>bool) $levelLast = array()] )

Loops over the children of the node with ID $id.

This methods loops over all the node's children and adds the correct layout for each node depending on the state that is collected in the $level and $levelLast variables.

Parameters:

Name	Type	Description
`$id`	string
`$level`	int
`$levelLast`	array(int=>bool)

formatData

string formatData( mixed $data , bool $highlight )

Formats a node's data.

It is just a simple method, that provide an easy way to change the way on how data is formatted when this class is extended. The data is passed in the $data argument, and whether the node should be highlighted is passed in the $highlight argument.

Parameters:

Name	Type	Description
`$data`	mixed
`$highlight`	bool

visit

bool visit( ezcTreeVisitable $visitable )

Visits the node and sets the the member variables according to the node type and contents.

Parameters:

Name	Type	Description
`$visitable`	ezcTreeVisitable

Implementation of:

Method	Description
`ezcTreeVisitor::visit()`	Visit the $visitable.

Documentation generated by phpDocumentor 1.4.3