Webylon 3.2 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
  • Download
Version: current
  • 3.2
  • 3.1

Packages

  • 1c
    • exchange
      • catalog
  • auth
  • Booking
  • building
    • company
  • cart
    • shipping
    • steppedcheckout
  • Catalog
    • monument
  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • newsletter
    • publishers
    • reports
    • security
    • tasks
  • Dashboard
  • DataObjectManager
  • event
  • faq
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • googlesitemaps
  • guestbook
  • installer
  • newsletter
  • None
  • photo
    • gallery
  • PHP
  • polls
  • recaptcha
  • sapphire
    • api
    • bulkloading
    • control
    • core
    • cron
    • dev
    • email
    • fields-formattedinput
    • filesystem
    • formatters
    • forms
    • i18n
    • integration
    • misc
    • model
    • parsers
    • search
    • security
    • tasks
    • testing
    • tools
    • validation
    • view
    • widgets
  • seo
    • open
      • graph
  • sfDateTimePlugin
  • spamprotection
  • stealth
    • captha
  • subsites
  • userform
    • pagetypes
  • userforms
  • webylon
  • widgets

Classes

  • DateField
  • DateField_Disabled
  • DatePickerField
  • DatetimeField_Readonly
  • TimeField
  • TimeField_Readonly

Class TimeField

Form field to display editable time values in an <input type="text"> field. Can optionally display a dropdown with predefined time ranges through setConfig('showdropdown', true).

# Configuration

  • 'timeformat' (string): Time format compatible with Zend_Date. Usually set to default format for TimeField::$locale through Zend_Locale_Format::getTimeFormat().
  • 'use_strtotime' (boolean): Accept values in PHP's built-in strtotime() notation, in addition to the format specified in timeformat. Example inputs: 'now', '11pm', '23:59:59'.
  • 'showdropdown': Show a dropdown with suggested date values. CAUTION: The dropdown does not support localization.

# Localization

See DateField

Object
Extended by ViewableData implements IteratorAggregate
Extended by RequestHandler
Extended by FormField
Extended by TextField
Extended by TimeField

Direct known subclasses

TimeField_Readonly

Package: forms\fields-datetime
Located at sapphire/forms/TimeField.php

Methods summary

public
# __construct( FormField::$name $name, FormField::$title $title = null, FormField::$value $value = "" )

Returns an input field, class="text" and type="text" with an optional maxlength

Returns an input field, class="text" and type="text" with an optional maxlength

Parameters

$name
name The internal field name, passed to forms.
$title
title The field label.
$value
value The value of the field.

Overrides

TextField::__construct
protected
# FieldDriver( mixed $html )

Internal volatile API.

Internal volatile API.

See

DateField->FieldDriver()
public
# setValue( String|Array $val )

Sets the internal value to ISO date format.

Sets the internal value to ISO date format.

Parameters

$val
String|Array $val

Overrides

FormField::setValue
public String
# dataValue( )

Returns

String
ISO 8601 date, suitable for insertion into database

Overrides

FormField::dataValue
public Boolean
# validate( mixed $validator )

Returns

Boolean
Boolean

Overrides

FormField::validate
public
# ShowDropdown( )
public string
# getLocale( )

Returns

string
string
public
# setLocale( String $locale )

Parameters

$locale
String $locale
public
# setConfig( string $name, mixed $val )

Parameters

$name
string $name
$val
mixed $val
public mixed
# getConfig( String $name )

Parameters

$name
String $name

Returns

mixed
mixed
public
# performReadonlyTransformation( )

Creates a new readonly field specified below

Creates a new readonly field specified below

Overrides

FormField::performReadonlyTransformation

Methods inherited from TextField

Field(), InternallyLabelledField(), getMaxLength(), setMaxLength()

Methods inherited from FormField

FieldHolder(), LeftTitle(), Link(), Message(), MessageType(), Name(), Required(), RightTitle(), SmallFieldHolder(), Title(), Type(), Value(), addExtraAttribute(), addExtraClass(), allowHTML5(), allow_html5(), attrName(), attrTitle(), attrValue(), createTag(), debug(), describe(), extraClass(), fieldHolderTemplates(), fieldTemplates(), forTemplate(), getCustomValidationMessage(), getExtraClasses(), getForm(), getHTML5Attribute(), getTabIndex(), getTabIndexHTML(), hasClass(), hasData(), id(), isComposite(), isDisabled(), isReadonly(), jsValidation(), name_to_label(), performDisabledTransformation(), removeExtraAttribute(), removeExtraClass(), rootFieldSet(), saveInto(), securityTokenEnabled(), setAutocomplete(), setContainerFieldSet(), setCustomValidationMessage(), setDisabled(), setError(), setFieldHolderTemplate(), setForm(), setHTML5Attribute(), setLeftTitle(), setName(), setReadonly(), setRightTitle(), setSmallFieldHolderTemplate(), setTabIndex(), setTemplate(), setTitle(), smallFieldHolderTemplates(), transform(), useHTML5(), use_html5()

Methods inherited from RequestHandler

allowedActions(), checkAccessAction(), getRequest(), handleRequest(), hasAction(), httpError()

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), ColumnBreak(), ColumnCalc(), ColumnNumber(), ColumnPad(), ColumnPos(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), ThemeName(), Top(), TotalItems(), XML_val(), __get(), __isset(), __set(), buildCastingCache(), cachedCall(), castingClass(), castingHelper(), castingHelperPair(), castingObjectCreator(), castingObjectCreatorPair(), customise(), defineMethods(), escapeTypeForField(), getField(), getIterator(), getSecurityID(), getXMLValues(), hasField(), hasValue(), i18nLocale(), iteratorProperties(), obj(), renderWith(), setCustomisedObj(), setField()

Methods inherited from Object

__call(), __toString(), __wakeup(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), exists(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

protected array $config
#
protected String $locale
#
protected Zend_Date $valueObj
#

Just set if the date is valid. FormField::$value will always be set to aid validation, and might contain invalid values.

Just set if the date is valid. FormField::$value will always be set to aid validation, and might contain invalid values.

Properties inherited from TextField

$maxLength

Properties inherited from FormField

$autocomplete, $containerFieldSet, $customValidationMessage, $description, $disabled, $dontEscape, $extraAttributes, $extraClass, $extraClasses, $fieldHTML5, $fieldHolderTemplate, $form, $html5Attributes, $leftTitle, $message, $messageType, $name, $possible_autocomplete_values, $readonly, $rightTitle, $smallFieldHolderTemplate, $tabIndex, $template, $title, $use_html5, $value

Properties inherited from RequestHandler

$allowed_actions, $brokenOnConstruct, $request, $url_handlers

Properties inherited from ViewableData

$casting, $customisedObject, $default_cast, $failover, $iteratorPos, $iteratorTotalItems

Properties inherited from Object

$class, $extension_instances, $extensions

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -
Webylon 3.2 API Docs API documentation generated by ApiGen 2.8.0