Docs For Class WFTimeSelect

Description

A Select widget for our framework.

Used to select either a single, or multiple, values.

Located in /framework/widgets/WFTimeSelect.php (line 16)

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFSelect
            |
            --WFTimeSelect

Variable Summary

string $endTime

string $formatString

integer $incrementsPerHour

string $startTime

Method Summary

static void exposedProperties ()

WFTimeSelect __construct ( $id, $page)

void generateOptions ()

void invalidateOptions ()

void setEndTime (string $end)

void setFormatString (string $str)

void setIncrementsPerHour (integer $incs)

void setStartTime (string $start)

Variables

string $endTime (line 29)

var: The End time in HH:MM:SS 24-hour format.
access: protected

string $formatString (line 33)

var: The format string for displaying the times. Should be something that shows hours, minutes, (seconds) (am/pm);
access: protected

integer $incrementsPerHour (line 21)

var: Number of time increments to show per hour. Set to 1 to show each hour; 2 for every half-our, 4 for 15 minutes, up to 60.
access: protected

string $startTime (line 25)

var: The Start time in HH:MM:SS 24-hour format.
access: protected

Inherited Variables

Inherited from WFSelect

WFSelect::$contentLabels
WFSelect::$contentValues
WFSelect::$labelFormatter
WFSelect::$labelFormatterSkipFirst
WFSelect::$multiple
WFSelect::$options
WFSelect::$values
WFSelect::$visibleItems
WFSelect::$width

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

access: public

static void exposedProperties ()

Redefinition of:

WFSelect::exposedProperties()

Constructor __construct (line 38)

Constructor.

WFTimeSelect __construct ( $id, $page)

$id
$page

Redefinition of:

WFSelect::__construct(): Constructor.

generateOptions (line 117)

This function generates the "options" list for the base WFSelect to use.

void generateOptions ()

invalidateOptions (line 67)

Mark the current options as invalid; done because we've changed one of the inputs startTime, endTime, incrementsPerHour, or formatString.

Presently this just instantly re-generates the options.

todo: For efficiency we might want to figure out a way to load it on-demand.

void invalidateOptions ()

setEndTime (line 86)

Set the last time to be shown in the select list.

void setEndTime (string $end)

string $end: 24h format such as 13:30:00.

setFormatString (line 76)

Set the format string used to generate the labels.

void setFormatString (string $str)

string $str: Suitable format string for http://www.php.net/date. Remember this is just used to show times!!!

setIncrementsPerHour (line 107)

Set the number of increments to be shown per hour. For instance, 1 to show each hour, 4 to show every 15 minutes.

throws: Exception if a valid increment not passed.

void setIncrementsPerHour (integer $incs)

integer $incs: One of 1,2,3,4,5,6,30.

setStartTime (line 96)

Set the first time to be shown in the select list.

void setStartTime (string $start)

string $start: 24h format such as 13:30:00.

Inherited Methods

Inherited From WFSelect

WFSelect::__construct()
WFSelect::addValue()
WFSelect::assertMultiple()
WFSelect::canPushValueBinding()
WFSelect::contentLabels()
WFSelect::contentValues()
WFSelect::exposedProperties()
WFSelect::labelFormatter()
WFSelect::multiple()
WFSelect::processBindingOptions()
WFSelect::pushBindings()
WFSelect::render()
WFSelect::restoreState()
WFSelect::setContentLabels()
WFSelect::setContentValues()
WFSelect::setFormatter()
WFSelect::setJSonChange()
WFSelect::setLabelFormatter()
WFSelect::setMultiple()
WFSelect::setOptions()
WFSelect::setupExposedBindings()
WFSelect::setValue()
WFSelect::setValues()
WFSelect::setVisibleItems()
WFSelect::value()
WFSelect::valueIsSelected()
WFSelect::valueLabel()
WFSelect::values()
WFSelect::valuesLabels()
WFSelect::visibleItems()

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