Docs For Class WFBreadCrumbNode

Description

A Breadcrumb system.

Supports WFDecorator(s).

Located in /framework/widgets/WFBreadCrumb.php (line 78)

WFObject
   |
   --WFBreadCrumbNode

Class Constant Summary

LINK_URL_TEMPLATE = '%LINK%'

Variable Summary

mixed $class

array $decorators

mixed $linkTextKeyPath

mixed $linkURLKeyPath

mixed $linkURLTemplate

mixed $parentClass

mixed $parentKeyPath

Method Summary

static object WFBreadCrumbNode BreadCrumbNode ()

void decorateObject ( $o)

void getClass ()

void getLinkURL ( $o)

void getParentClass ()

WFBreadCrumbNode __construct ()

object WFBreadCrumbNode setClass (string $class)

void setDecorator (string $decoratorClassName)

void setDecorators (string $decoratorList)

object WFBreadCrumbNode setLinkURL (string $linkTextKeyPath, string $linkURLTemplate, string $linkURLKeyPath)

object WFBreadCrumbNode setParentClass (string $class, [string $parentKeyPath = NULL])

void undecorateObject ( $o)

Variables

mixed $class (line 82)

access: protected

array $decorators (line 91)

var: An array of WFDecorator objects that will be used to wrap the content object(s).
access: protected

mixed $linkTextKeyPath (line 84)

access: protected

mixed $linkURLKeyPath (line 86)

access: protected

mixed $linkURLTemplate (line 85)

access: protected

mixed $parentClass (line 83)

access: protected

mixed $parentKeyPath (line 87)

access: protected

Methods

static method BreadCrumbNode (line 109)

A static constructor for use with fluent interface.

access: public

static object WFBreadCrumbNode BreadCrumbNode ()

decorateObject (line 156)

Decorate the passed object with the decorator(s) for this controller.

access: public

void decorateObject ( $o)

$o

getClass (line 114)

void getClass ()

Redefinition of:

WFObject::getClass()

getLinkURL (line 122)

void getLinkURL ( $o)

$o

getParentClass (line 118)

void getParentClass ()

Constructor __construct (line 93)

WFBreadCrumbNode __construct ()

Redefinition of:

WFObject::__construct()

setClass (line 179)

Set the class which represents this node.

access: public

object WFBreadCrumbNode setClass (string $class)

string $class: A class name.

setDecorator (line 132)

Set a object WFDecorator object to be used with this controller.

void setDecorator (string $decoratorClassName)

string $decoratorClassName: The name of the decorator class.

setDecorators (line 143)

Set multiple object WFDecorator objects to be used with this controller.

void setDecorators (string $decoratorList)

string $decoratorList: The name(s) of the decorator class(es) to be used to decorate objects managed by this controller. Names should be separated by commas; LAST one wins.

setLinkURL (line 207)

Set the information used to create the link which wrap the node.

access: public

object WFBreadCrumbNode setLinkURL (string $linkTextKeyPath, string $linkURLTemplate, string $linkURLKeyPath)

string $linkTextKeyPath: A keypath on the object to get the link text.
string $linkURLTemplate: A template string to create the link URL.
string $linkURLKeyPath: A keypath on the object to get the value that should be subsitutued for WFBreadCrumbNode::LINK_URL_TEMPLATE

setParentClass (line 192)

Set the class which represents the "parent" of this node in the object graph.

access: public

object WFBreadCrumbNode setParentClass (string $class, [string $parentKeyPath = NULL])

string $class: A class name.
string $parentKeyPath: The keypath to call on the object to get the "parent" object. Defaults to the name of the parent class.

undecorateObject (line 165)

access: public

void undecorateObject ( $o)

$o

Inherited Methods

Inherited From WFObject

WFObject::__construct()
WFObject::exposedProperties()
WFObject::getClass()
WFObject::keyPathToTargetAndKey()
WFObject::setValueForKey()
WFObject::setValueForKeyPath()
WFObject::setValuesForKeys()
WFObject::validatedSetValueForKey()
WFObject::validatedSetValueForKeyPath()
WFObject::validateObject()
WFObject::validateValueForKey()
WFObject::validateValueForKeyPath()
WFObject::valueForKey()
WFObject::valueForKeyPath()
WFObject::valueForStaticKey()
WFObject::valueForStaticKeyPath()
WFObject::valueForTargetAndKeyPath()
WFObject::valueForUndefinedKey()
WFObject::valueForUndefinedStaticKey()
WFObject::valuesForKeyPaths()
WFObject::valuesForKeys()
WFObject::_valueForStaticKey()
WFObject::__toString()

Class Constants

LINK_URL_TEMPLATE = '%LINK%' (line 80)