SilverStripe 2.4 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
Version: master
  • master
  • 3.1
  • 3.0
  • 2.4
  • tagfield

Packages

  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • publishers
    • reports
    • security
    • tasks
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • installer
  • None
  • PHP
  • 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

Classes

  • DateField
  • DateField_Disabled
  • 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
FormField::$name
The internal field name, passed to forms.
$title
FormField::$title
The field label.
$value
FormField::$value
The value of the field.

Overrides

TextField::__construct
public
# Field( )

Returns the form field - used by templates. Although FieldHolder is generally what is inserted into templates, all of the field holder templates make use of $Field. It's expected that FieldHolder will give you the "complete" representation of the field on the form, whereas Field will give you the core editing widget, such as an input tag.

Returns the form field - used by templates. Although FieldHolder is generally what is inserted into templates, all of the field holder templates make use of $Field. It's expected that FieldHolder will give you the "complete" representation of the field on the form, whereas Field will give you the core editing widget, such as an input tag.

Our base FormField class just returns a span containing the value. This should be overridden!

Overrides

TextField::Field
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

Overrides

FormField::validate
public string
# getLocale( )

Returns

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
public
# performReadonlyTransformation( )

Creates a new readonly field specified below

Creates a new readonly field specified below

Overrides

FormField::performReadonlyTransformation

Methods inherited from TextField

InternallyLabelledField(), getMaxLength(), setMaxLength()

Methods inherited from FormField

FieldHolder(), LeftTitle(), Link(), Message(), MessageType(), Name(), Required(), RightTitle(), SmallFieldHolder(), Title(), Type(), Value(), addExtraClass(), attrName(), attrTitle(), attrValue(), createTag(), debug(), describe(), extraClass(), forTemplate(), getCustomValidationMessage(), getForm(), getTabIndex(), getTabIndexHTML(), hasClass(), hasData(), id(), isComposite(), isDisabled(), isReadonly(), jsValidation(), name_to_label(), performDisabledTransformation(), removeExtraClass(), rootFieldSet(), saveInto(), securityTokenEnabled(), setContainerFieldSet(), setCustomValidationMessage(), setDisabled(), setError(), setForm(), setLeftTitle(), setName(), setReadonly(), setRightTitle(), setTabIndex(), setTitle(), transform()

Methods inherited from RequestHandler

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

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), 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(), 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

$containerFieldSet, $customValidationMessage, $description, $disabled, $dontEscape, $extraClass, $extraClasses, $form, $leftTitle, $message, $messageType, $name, $readonly, $rightTitle, $tabIndex, $title, $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

Comments

Comment policy: Please use comments for tips and corrections about the described functionality. Comments are moderated, we reserve the right to remove comments that are inappropriate or are no longer relevant.
Use the Silverstripe Forum to ask questions.
blog comments powered by Disqus
SilverStripe 2.4 API Docs API documentation generated by ApiGen 2.8.0