Docs For Class WFDieselKeyword

Description

Implements interfaces:

WFDieselSearchHelperStateTracking

A Dieselpoint Keyword search widget for our framework.

NOTE: by default, whenever a keyword is entered that is different from the previous keyword, the default sort will be set to sort by relevance instead of whatever the existing default is. Of course this can be overridden with the Paginator Sort controls.

Located in /framework/widgets/WFDieselKeyword.php (line 18)

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFDieselKeyword

Variable Summary

object WFDieselSearch $dieselSearchHelper

mixed $maxLength

mixed $size

Method Summary

static void exposedProperties ()

WFDieselKeyword __construct ( $id, $page)

void allConfigFinishedLoading ()

void canPushValueBinding ()

void dieselSearchRestoreState ()

void editFacetLink ()

void facetSelectionHTML ()

void isKeywordQuery ()

void label ()

void removeFacetLink ([ $linkText = "Remove"])

void render ([ $blockContent = NULL])

void setDieselSearchHelper ( $ds)

void setupExposedBindings ()

Variables

object WFDieselSearch $dieselSearchHelper (line 25)

var: The WFDieselSearch object that this facet is linked to.
access: protected

mixed $maxLength (line 20)

access: protected

mixed $size (line 21)

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 38)

access: public

static void exposedProperties ()

Redefinition of:

WFWidget::exposedProperties()

Constructor __construct (line 30)

Constructor.

WFDieselKeyword __construct ( $id, $page)

$id
$page

Redefinition of:

WFWidget::__construct(): Constructor.

allConfigFinishedLoading (line 67)

void allConfigFinishedLoading ()

Redefinition of:

WFView::allConfigFinishedLoading(): After WFPage has completed the loading of all config for all widgets, it will call this function on each widget.

canPushValueBinding (line 134)

void canPushValueBinding ()

Redefinition of:

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

dieselSearchRestoreState (line 52)

void dieselSearchRestoreState ()

Implementation of:

WFDieselSearchHelperStateTracking::dieselSearchRestoreState(): IFF the UI widget knows that its state was set in the interface, it should use addAttributeQuery/setSimpleQuery to effect this.

editFacetLink (line 96)

void editFacetLink ()

facetSelectionHTML (line 86)

void facetSelectionHTML ()

isKeywordQuery (line 72)

void isKeywordQuery ()

label (line 81)

void label ()

removeFacetLink (line 100)

void removeFacetLink ([ $linkText = "Remove"])

$linkText

render (line 110)

void render ([ $blockContent = NULL])

$blockContent

Redefinition of:

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

setDieselSearchHelper (line 47)

void setDieselSearchHelper ( $ds)

$ds

setupExposedBindings (line 126)

******************* BINDINGS SETUP ***********************

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()