Docs For Class WFModuleView

Description

The WFModuleView allows for the easy inclusion of module/page based components in your template.

This is a very powerful capability. Developers can develop re-usable components for their web application using the standard Module/Page mechanism. Then, any page in the entire application can easily include the component with a {WFModuleView id="subModuleID"} tag in the template. The instance can be configured with any WFModuleView::invocationPath, and can be used multiple times. Even the targeting of forms on the component can be configured with the WFModuleView::targetRootModule property.

PHOCOA Builder Setup:

Required:

invocationPath

todo: Once bindings are moved to WFView, this should probably be made into a WFView subclass since it does not use "value" or represent an interactive control.

Located in /framework/widgets/WFModuleView.php (line 27)

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFModuleView

Variable Summary

string $invocationPath

boolean $targetRootModule

Method Summary

static void exposedProperties ()

WFModuleView __construct ( $id, $page)

void canPushValueBinding ()

void invocationPath ()

void render ([ $blockContent = NULL])

void setInvocationPath (string $path)

void setupExposedBindings ()

Variables

string $invocationPath (line 32)

var: The invocationPath for the module to include. Ex: /path/to/my/module/PageName/param1/param2
access: protected

boolean $targetRootModule (line 36)

var: TRUE to target the module to the root module, false to target to the current module.
access: protected

Inherited Variables

Inherited from WFWidget

WFWidget::$bindings
WFWidget::$class
WFWidget::$errors
WFWidget::$formatter
WFWidget::$hasRestoredState
WFWidget::$hidden
WFWidget::$name
WFWidget::$value
WFWidget::$widgetLabel

Inherited from WFView

WFView::$children
WFView::$cssImports
WFView::$enabled
WFView::$id
WFView::$importInHead
WFView::$jsActions
WFView::$jsEvents
WFView::$jsImports
WFView::$page
WFView::$parent

Methods

static method exposedProperties (line 48)

access: public

static void exposedProperties ()

Redefinition of:

WFWidget::exposedProperties()

Constructor __construct (line 41)

Constructor.

WFModuleView __construct ( $id, $page)

$id
$page

Redefinition of:

WFWidget::__construct(): Constructor.

canPushValueBinding (line 95)

void canPushValueBinding ()

Redefinition of:

WFWidget::canPushValueBinding(): Does this widget use the "value" binding to WRITE data back to the bindings?

invocationPath (line 77)

void invocationPath ()

render (line 82)

void render ([ $blockContent = NULL])

$blockContent

Redefinition of:

WFView::render(): Render the view into HTML.

setInvocationPath (line 72)

Set the invocationPath that will be used for the module view.

void setInvocationPath (string $path)

string $path: The full invocationPath

setupExposedBindings (line 56)

void setupExposedBindings ()

Redefinition of:

WFWidget::setupExposedBindings(): Set up all exposed bindings for this widget.

Inherited Methods

Inherited From WFWidget

WFWidget::__construct()
WFWidget::addError()
WFWidget::bind()
WFWidget::bindingByName()
WFWidget::bindings()
WFWidget::canPushValueBinding()
WFWidget::errors()
WFWidget::exposedBindings()
WFWidget::exposedProperties()
WFWidget::formattedValue()
WFWidget::formatter()
WFWidget::hasRestoredState()
WFWidget::hidden()
WFWidget::name()
WFWidget::processBindingOptions()
WFWidget::propagateValueToBinding()
WFWidget::pullBindings()
WFWidget::pushBindings()
WFWidget::restoreState()
WFWidget::setFormatter()
WFWidget::setHidden()
WFWidget::setName()
WFWidget::setupExposedBindings()
WFWidget::setValue()
WFWidget::setWidgetLabel()
WFWidget::unbind()
WFWidget::value()
WFWidget::valueForBinding()
WFWidget::widgetLabel()

Inherited From WFView

WFView::__construct()
WFView::addChild()
WFView::allConfigFinishedLoading()
WFView::children()
WFView::cloneWithID()
WFView::enabled()
WFView::exposedProperties()
WFView::getForm()
WFView::getJSActions()
WFView::getListenerJS()
WFView::getListenerJSInScriptTag()
WFView::getWidgetDir()
WFView::getWidgetWWWDir()
WFView::id()
WFView::importCSS()
WFView::importJS()
WFView::jsEndHTML()
WFView::jsStartHTML()
WFView::page()
WFView::parent()
WFView::removeChild()
WFView::render()
WFView::setEnabled()
WFView::setId()
WFView::setJSonBlur()
WFView::setJSonClick()
WFView::setListener()
WFView::setOnEvent()
WFView::setParent()
WFView::yuiPath()

Inherited From WFObject

WFObject::__construct()
WFObject::exposedProperties()
WFObject::getClass()
WFObject::keyPathToTargetAndKey()
WFObject::setValueForKey()
WFObject::setValueForKeyPath()
WFObject::validateValueForKey()
WFObject::validateValueForKeyPath()
WFObject::valueForKey()
WFObject::valueForKeyPath()
WFObject::valueForUndefinedKey()
WFObject::__toString()