eZ Components latest

Getting Started

Archive (1.4)
Authentication (1.3.1)
AuthenticationDatabaseTiein (1.1)
Base (1.8)
Cache (1.5)
Configuration (1.3.5)
ConsoleTools (1.6)
Database (1.4.6)
DatabaseSchema (1.4.3)
Debug (1.2.1)
Document (1.3)
EventLog (1.4)
EventLogDatabaseTiein (1.0.2)
Execution (1.1.1)
Feed (1.3)
File (1.2)
Graph (1.5)
GraphDatabaseTiein (1.0.1)
ImageAnalysis (1.1.3)
ImageConversion (1.3.7)
Mail (1.7)
MvcTools (1.1.2)
MvcAuthenticationTiein (1.0)
MvcFeedTiein (1.0)
MvcMailTiein (1.0.1)
MvcTemplateTiein (1.0)
PersistentObject (1.7)
PersistentObjectDatabaseSchemaTiein (1.3)
PhpGenerator (1.0.5)
Search (1.0.8)
SignalSlot (1.1.1)
SystemInformation (1.0.8)
Template (1.4.2)
TemplateTranslationTiein (1.1)
Translation (1.3.2)
TranslationCacheTiein (1.1.2)
Tree (1.1.3)
TreeDatabaseTiein (1.1.1)
TreePersistentObjectTiein (1.0)
Url (1.2.2)
UserInput (1.4)
Webdav (1.1.3)
Workflow (1.4)
WorkflowDatabaseTiein (1.4)
WorkflowEventLogTiein (1.1)
WorkflowSignalSlotTiein (1.0)

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class containing the options for the ezcTreeVisitorXHTMLOptions class. [source]

ezcBaseOptions
   |
   --ezcTreeVisitorXHTMLOptions

bool	read/write	`$addLinks` Whether links should be generated or not.
string	read/write	`$basePath` Which string to prefix the href-targets with.
bool	read/write	`$displayRootNode` Whether the root node should be displayed. The root node will still be disabled from the links that the visitor creates when $selectedNodeLink is set to true.
array(string)	read/write	`$highlightNodeIds` Which IDs should have the 'highlight' CSS class added.
bool	read/write	`$selectedNodeLink` If enabled, only the requested node is shown in links, and not the full path.
array(string)	read/write	`$subtreeHighlightNodeIds` Which subtree IDs should have the 'highlight' CSS class added.
string	read/write	`$xmlId` The ID that should be set on the top level 'ul' XHTML tag.

protected ezcBaseOptions::$properties

public ezcTreeVisitorXHTMLOptions

__construct(
[$options = array()] )

Constructs an object with the specified values.

public ezcBaseOptions	`ezcBaseOptions::__construct()` Construct a new options object.
public void	`ezcBaseOptions::merge()` Merge an array into the actual options object.
public bool	`ezcBaseOptions::offsetExists()` Returns if an option exists.
public mixed	`ezcBaseOptions::offsetGet()` Returns an option value.
public void	`ezcBaseOptions::offsetSet()` Set an option.
public void	`ezcBaseOptions::offsetUnset()` Unset an option.

ezcTreeVisitorXHTMLOptions __construct( [ $options = array()] )

Constructs an object with the specified values.

Name	Type	Description
`$options`	array(string=>mixed)

Class	Description
`ezcBaseValueException`	if $options contains a property with a value not allowed
`ezcBasePropertyNotFoundException`	if $options contains a property not defined

Method	Description
`ezcBaseOptions::__construct()`	Construct a new options object.

Last updated: Mon, 21 Dec 2009