ListboxField
class ListboxField extends MultiSelectField
Multi-line listbox field, created from a select tag.
Usage
new ListboxField(
$name = "pickanumber",
$title = "Pick a number",
$source = array(
"1" => "one",
"2" => "two",
"3" => "three"
),
$value = 1
)
Traits
Constants
| SCHEMA_DATA_TYPE_STRING |
|
| SCHEMA_DATA_TYPE_HIDDEN |
|
| SCHEMA_DATA_TYPE_TEXT |
|
| SCHEMA_DATA_TYPE_HTML |
|
| SCHEMA_DATA_TYPE_INTEGER |
|
| SCHEMA_DATA_TYPE_DECIMAL |
|
| SCHEMA_DATA_TYPE_MULTISELECT |
|
| SCHEMA_DATA_TYPE_SINGLESELECT |
|
| SCHEMA_DATA_TYPE_DATE |
|
| SCHEMA_DATA_TYPE_DATETIME |
|
| SCHEMA_DATA_TYPE_TIME |
|
| SCHEMA_DATA_TYPE_BOOLEAN |
|
| SCHEMA_DATA_TYPE_CUSTOM |
|
| SCHEMA_DATA_TYPE_STRUCTURAL |
|
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on this object
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
Gets the uninherited value for the given config option
Creates a new dropdown field.
Check if a field exists on this object or its failover.
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
Set a failover object to attempt to get data from if it is not present on this object.
Check if a field exists on this object. This should be overloaded in child classes.
Get the value of a field on this object. This should be overloaded in child classes.
Set a field on this object. This should be overloaded in child classes.
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
Get the class name a field on this object will be casted to.
Return the string-format type for the given field.
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
Get an array of XML-escaped values by field name
Return a single-item iterator so you can iterate over the fields of a single record.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Get a array of allowed actions defined on this controller, any parent classes or extensions.
Checks if this request handler has a specific action, even if the current user cannot access it.
Check that the given action is allowed to be called from a URL.
Throws a HTTP error response encased in a {@link HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.
Returns the HTTPRequest object that this controller is using.
Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.
Safely get the value of the BackURL param, if provided via querystring / posted var
Redirect back. Uses either the HTTP-Referer or a manually set request-variable called "BackURL".
Sets the error message to be displayed on the form field.
Takes a field name and converts camelcase to spaced words. Also resolves combined field names with dot syntax to spaced words.
Returns the current {@link FormTemplateHelper} on either the parent Form or the global helper set through the {@link Injector} layout.
Save the current value of this MultiSelectField into a DataObject.
Returns the field value suitable for insertion into the data object.
Gets the contextual label than can be used for additional field description.
Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
Add one or more CSS-classes to the FormField container.
Remove one or more CSS-classes from the FormField container.
Set an HTML attribute on the field element, mostly an input tag.
Get an HTML attribute defined by the field, or added through {@link setAttribute()}.
Allows customization through an 'updateAttributes' hook on the base class.
Custom attributes to process. Falls back to {@link getAttributes()}.
Returns a version of a title suitable for insertion into an HTML attribute.
Returns a version of a title suitable for insertion into an HTML attribute.
Set value assigned from a submitted form postback.
Return true if security token protection is enabled on the parent {@link Form}.
Set the custom error message to show instead of the default format.
Get the custom error message for this form field. If a custom message has not been defined then just return blank. The default error is defined on {@link Validator}.
Set name of template (without path or extension).
Set name of template (without path or extension) for the holder, which in turn is responsible for rendering {@link Field()}.
Set name of template (without path or extension) for the small holder, which in turn is responsible for rendering {@link Field()}.
Returns a select tag containing all the appropriate option tags
Returns a "field holder" for this field.
Returns a restricted field holder used within things like FieldGroups.
Returns an array of templates to use for rendering {@link FieldHolder}.
Returns an array of templates to use for rendering {@link FieldHolder}.
Returns an array of templates to use for rendering {@link SmallFieldHolder}.
Transforms the source data for this CheckboxSetField into a comma separated list of values.
Returns whether the current field has the given class added
Describe this field, provide help text for it.
This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.
Returns another instance of this field, but "cast" to a different class.
Determine if the value of this formfield accepts front-end submitted values and is saveable.
Sets the component type the FormField will be rendered as on the front-end.
Gets the type of front-end component the FormField will be rendered as.
Sets the schema data used for rendering the field on the front-end.
Gets the schema data used to render the FormField on the front-end.
Sets the schema data used for rendering the field on the front-end.
Gets the schema state used to render the FormField on the front-end.
Return list of validation rules. Each rule is a key value pair.
Mark certain elements as disabled, regardless of the {@link setDisabled()} settings.
No description
Gets the source array not including any empty default values.
Determine if the current value of this field matches the given option value
Extracts the value of this field, normalised as an array.
Default selections, regardless of the {@link setValue()} settings.
Default selections, regardless of the {@link setValue()} settings.
Encode a list of values into a string, or null if empty (to simplify empty checks)
Gets the list of options to render in this formfield
Get the size of this dropdown in rows.
Sets the size of this dropdown in rows.
Details
in CustomMethods at line 47
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in CustomMethods at line 146
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
in CustomMethods at line 176
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in Extensible at line 172
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).
in Extensible at line 236
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.
in Extensible at line 278
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 312
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
in Extensible at line 373
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
in Extensible at line 415
array
invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in Extensible at line 450
array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
in Extensible at line 497
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in Extensible at line 526
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
in Extensible at line 540
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See {@link get_extensions()} to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
in Injectable at line 26
static Injectable
create(array $args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();
in Injectable at line 43
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
in Configurable at line 20
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in Configurable at line 32
mixed
stat(string $name)
deprecated
deprecated 5.0 Use ->config()->get() instead
Get inherited config value
in Configurable at line 44
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
in Configurable at line 57
$this
set_stat(string $name, mixed $value)
deprecated
deprecated 5.0 Use ->config()->set() instead
Update the config value for a given property
at line 55
__construct(string $name, null|string|ViewableData $title = '', array|ArrayAccess $source = array(), mixed $value = null, int $size = null)
Creates a new dropdown field.
in ViewableData at line 106
bool
__isset(string $property)
Check if a field exists on this object or its failover.
Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.
in ViewableData at line 129
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
in ViewableData at line 152
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
in ViewableData at line 167
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
in ViewableData at line 183
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 194
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
in ViewableData at line 205
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
in ViewableData at line 217
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
in ViewableData at line 232
defineMethods()
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
in ViewableData at line 258
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
in ViewableData at line 281
bool
exists()
Return true if this object "exists" i.e. has a sensible value
This method should be overriden in subclasses to provide more context about the classes state. For example, a {@link DataObject} class could return false when it is deleted from the database
in ViewableData at line 289
string
__toString()
in ViewableData at line 297
ViewableData
getCustomisedObj()
in ViewableData at line 305
setCustomisedObj(ViewableData $object)
in FormField at line 876
string
castingHelper(string $field)
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
in ViewableData at line 352
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
in ViewableData at line 365
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 389
DBHTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
in ViewableData at line 471
Object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
in ViewableData at line 516
Object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
in ViewableData at line 530
bool
hasValue(string $field, array $arguments = [], bool $cache = true)
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
in ViewableData at line 545
string
XML_val(string $field, array $arguments = [], bool $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
in ViewableData at line 558
array
getXMLValues(array $fields)
Get an array of XML-escaped values by field name
in ViewableData at line 579
ArrayIterator
getIterator()
Return a single-item iterator so you can iterate over the fields of a single record.
This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.
in ViewableData at line 592
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
in ViewableData at line 603
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
in ViewableData at line 620
string
ThemeDir()
deprecated
deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead
Return the directory if the current active theme (relative to the site root).
This method is useful for things such as accessing theme images from your template without hardcoding the theme
page - e.g. 
.
This method should only be used when a theme is currently active. However, it will fall over to the current project directory.
in ViewableData at line 647
string
CSSClasses(string $stopAtClass = self::class)
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
in ViewableData at line 676
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in RequestHandler at line 149
HTTPResponse|RequestHandler|string|array
handleRequest(HTTPRequest $request)
Handles URL requests.
- ViewableData::handleRequest() iterates through each rule in {@link self::$url_handlers}.
- If the rule matches, the named method will be called.
- If there is still more URL to be processed, then handleRequest() is called on the object that that method returns.
Once all of the URL has been processed, the final result is returned. However, if the final result is an array, this array is interpreted as being additional template data to customise the 2nd to last result with, rather than an object in its own right. This is most frequently used when a Controller's action will return an array of data with which to customise the controller.
in RequestHandler at line 345
array|null
allowedActions(string $limitToClass = null)
Get a array of allowed actions defined on this controller, any parent classes or extensions.
Caution: Since 3.1, allowed_actions definitions only apply to methods on the controller they're defined on, so it is recommended to use the $class argument when invoking this method.
in RequestHandler at line 382
bool
hasAction(string $action)
Checks if this request handler has a specific action, even if the current user cannot access it.
Includes class ancestry and extensions in the checks.
in RequestHandler at line 456
bool
checkAccessAction(string $action)
Check that the given action is allowed to be called from a URL.
It will interrogate {@link self::$allowed_actions} to determine this.
in RequestHandler at line 516
httpError(int $errorCode, string $errorMessage = null)
Throws a HTTP error response encased in a {@link HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.
in RequestHandler at line 538
HTTPRequest
getRequest()
Returns the HTTPRequest object that this controller is using.
Returns a placeholder {@link NullHTTPRequest} object unless {@link handleAction()} or {@link handleRequest()} have been called, which adds a reference to an actual {@link HTTPRequest} object.
in RequestHandler at line 550
$this
setRequest(HTTPRequest $request)
Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.
in FormField at line 377
string
Link(string $action = null)
Return a link to this field
in RequestHandler at line 589
HTTPResponse
redirect(string $url, int $code = 302)
Redirect to the given URL.
in RequestHandler at line 601
string
getBackURL()
Safely get the value of the BackURL param, if provided via querystring / posted var
in RequestHandler at line 642
string
getReferer()
Get referer
in RequestHandler at line 661
HTTPResponse
redirectBack()
Redirect back. Uses either the HTTP-Referer or a manually set request-variable called "BackURL".
This variable is needed in scenarios where HTTP-Referer is not sent (e.g when calling a page by location.href in IE). If none of the two variables is available, it will redirect to the base URL (see {@link Director::baseURL()}).
in FormMessage at line 42
string
getMessage()
Returns the field message, used by form validation.
Use {@link setError()} to set this property.
in FormMessage at line 56
string
getMessageType()
Returns the field message type.
Arbitrary value which is mostly used for CSS classes in the rendered HTML, e.g "required".
Use {@link setError()} to set this property.
in FormMessage at line 66
string
getMessageCast()
Casting type for this message. Will be 'text' or 'html'
in FormMessage at line 81
$this
setMessage(string $message, string $messageType = ValidationResult::TYPE_ERROR, string $messageCast = ValidationResult::CAST_TEXT)
Sets the error message to be displayed on the form field.
Allows HTML content, so remember to use Convert::raw2xml().
in FormMessage at line 117
array|null
getSchemaMessage()
Get form schema encoded message
in FormField at line 305
static string
name_to_label(string $fieldName)
Takes a field name and converts camelcase to spaced words. Also resolves combined field names with dot syntax to spaced words.
Examples:
- 'TotalAmount' will return 'Total amount'
- 'Organisation.ZipCode' will return 'Organisation zip code'
in FormField at line 398
string
ID()
Returns the HTML ID of the field.
The ID is generated as FormName_FieldName. All Field functions should ensure that this ID is included in the field.
in FormField at line 408
string
HolderID()
Returns the HTML ID for the form field holder element.
in FormField at line 422
FormTemplateHelper
getTemplateHelper()
Returns the current {@link FormTemplateHelper} on either the parent Form or the global helper set through the {@link Injector} layout.
To customize a single {@link FormField}, use {@link setTemplate} and provide a custom template name.
in FormField at line 436
string
getName()
Returns the field name.
in FormField at line 446
string
getInputType()
Returns the field input name.
in FormField at line 457
mixed
Value()
Returns the field value.
in MultiSelectField at line 124
saveInto(DataObjectInterface $record)
Save the current value of this MultiSelectField into a DataObject.
If the field it is saving to is a has_many or many_many relationship, it is saved by setByIDList(), otherwise it creates a comma separated list for a standard DB text/varchar field.
in FormField at line 481
mixed
dataValue()
Returns the field value suitable for insertion into the data object.
in FormField at line 491
string
Title()
Returns the field label - used by templates.
in FormField at line 503
$this
setTitle(string $title)
Set the title of this formfield.
Note: This expects escaped HTML.
in FormField at line 515
string
RightTitle()
Gets the contextual label than can be used for additional field description.
Can be shown to the right or under the field in question.
in FormField at line 526
$this
setRightTitle(string|DBField $rightTitle)
Sets the right title for this formfield
in FormField at line 535
string
LeftTitle()
in FormField at line 545
$this
setLeftTitle(string $leftTitle)
in FormField at line 561
string
extraClass()
Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
Uses {@link Message()} and {@link MessageType()} to add validation error classes which can be used to style the contained tags.
in FormField at line 598
$this
addExtraClass(string $class)
Add one or more CSS-classes to the FormField container.
Multiple class names should be space delimited.
in FormField at line 616
$this
removeExtraClass(string $class)
Remove one or more CSS-classes from the FormField container.
in FormField at line 646
$this
setAttribute(string $name, string $value)
Set an HTML attribute on the field element, mostly an input tag.
Some attributes are best set through more specialized methods, to avoid interfering with built-in behaviour:
- 'class': {@link addExtraClass()}
- 'title': {@link setDescription()}
- 'value': {@link setValue}
- 'name': {@link setName}
Caution: this doesn't work on most fields which are composed of more than one HTML form field.
in FormField at line 661
string
getAttribute(string $name)
Get an HTML attribute defined by the field, or added through {@link setAttribute()}.
Caution: this doesn't work on all fields, see {@link setAttribute()}.
at line 107
array
getAttributes()
Allows customization through an 'updateAttributes' hook on the base class.
Existing attributes are passed in as the first argument and can be manipulated, but any attributes added through a subclass implementation won't be included.
in FormField at line 713
string
getAttributesHTML(array $attributes = null)
Custom attributes to process. Falls back to {@link getAttributes()}.
If at least one argument is passed as a string, all arguments act as excludes, by name.
in FormField at line 761
string
attrTitle()
Returns a version of a title suitable for insertion into an HTML attribute.
in FormField at line 771
string
attrValue()
Returns a version of a title suitable for insertion into an HTML attribute.
in MultiSelectField at line 68
$this
setValue(mixed $value, null|array|DataObject $obj = null)
Load a value into this MultiSelectField
in FormField at line 801
$this
setSubmittedValue(mixed $value, array|DataObject $data = null)
Set value assigned from a submitted form postback.
Can be overridden to handle custom behaviour for user-localised data formats.
in FormField at line 813
$this
setName(string $name)
Set the field name.
in FormField at line 827
$this
setInputType(string $type)
Set the field input type.
in FormField at line 843
$this
setForm(Form $form)
Set the container form.
This is called automatically when fields are added to forms.
in FormField at line 865
bool
securityTokenEnabled()
Return true if security token protection is enabled on the parent {@link Form}.
in FormField at line 894
$this
setCustomValidationMessage(string $customValidationMessage)
Set the custom error message to show instead of the default format.
Different from setError() as that appends it to the standard error messaging.
in FormField at line 907
string
getCustomValidationMessage()
Get the custom error message for this form field. If a custom message has not been defined then just return blank. The default error is defined on {@link Validator}.
in FormField at line 922
$this
setTemplate(string $template)
Set name of template (without path or extension).
Caution: Not consistently implemented in all subclasses, please check the {@link Field()} method on the subclass for support.
in FormField at line 932
string
getTemplate()
in FormField at line 940
string
getFieldHolderTemplate()
in FormField at line 956
$this
setFieldHolderTemplate(string $fieldHolderTemplate)
Set name of template (without path or extension) for the holder, which in turn is responsible for rendering {@link Field()}.
Caution: Not consistently implemented in all subclasses, please check the {@link Field()} method on the subclass for support.
in FormField at line 966
string
getSmallFieldHolderTemplate()
in FormField at line 982
$this
setSmallFieldHolderTemplate(string $smallFieldHolderTemplate)
Set name of template (without path or extension) for the small holder, which in turn is responsible for rendering {@link Field()}.
Caution: Not consistently implemented in all subclasses, please check the {@link Field()} method on the subclass for support.
at line 70
DBHTMLText
Field(array $properties = array())
Returns a select tag containing all the appropriate option tags
in FormField at line 1035
DBHTMLText
FieldHolder(array $properties = array())
Returns a "field holder" for this field.
Forms are constructed by concatenating a number of these field holders.
The default field holder is a label and a form field inside a div.
in FormField at line 1055
string
SmallFieldHolder(array $properties = array())
Returns a restricted field holder used within things like FieldGroups.
in FormField at line 1071
array
getTemplates()
Returns an array of templates to use for rendering {@link FieldHolder}.
in FormField at line 1081
array
getFieldHolderTemplates()
Returns an array of templates to use for rendering {@link FieldHolder}.
in FormField at line 1094
array
getSmallFieldHolderTemplates()
Returns an array of templates to use for rendering {@link SmallFieldHolder}.
in FormField at line 1129
bool
isComposite()
Returns true if this field is a composite field.
To create composite field types, you should subclass {@link CompositeField}.
in FormField at line 1145
bool
hasData()
Returns true if this field has its own data.
Some fields, such as titles and composite fields, don't actually have any data. It doesn't make sense for data-focused methods to look at them. By overloading hasData() to return false, you can prevent any data-focused methods from looking at it.
in FormField at line 1153
bool
isReadonly()
in FormField at line 1169
$this
setReadonly(bool $readonly)
Sets a read-only flag on this FormField.
Use performReadonlyTransformation() to transform this instance.
Setting this to false has no effect on the field.
in FormField at line 1178
bool
isDisabled()
in FormField at line 1194
$this
setDisabled(bool $disabled)
Sets a disabled flag on this FormField.
Use performDisabledTransformation() to transform this instance.
Setting this to false has no effect on the field.
in FormField at line 1204
bool
isAutofocus()
in FormField at line 1215
$this
setAutofocus(bool $autofocus)
Sets a autofocus flag on this FormField.
in MultiSelectField at line 273
FormField
performReadonlyTransformation()
Transforms the source data for this CheckboxSetField into a comma separated list of values.
in SelectField at line 251
FormField
performDisabledTransformation()
Return a disabled version of this field.
Tries to find a class of the class name of this field suffixed with "_Disabled", failing that, finds a method {@link setDisabled()}.
in FormField at line 1269
mixed
transform(FormTransformation $transformation)
in FormField at line 1281
bool
hasClass(string $class)
Returns whether the current field has the given class added
in FormField at line 1298
string
Type()
Returns the field type.
The field type is the class name with the word Field dropped off the end, all lowercase.
It's handy for assigning HTML classes. Doesn't signify the input type attribute.
in MultiSelectField at line 232
bool
validate(Validator $validator)
Validate this field
in FormField at line 1327
$this
setDescription(string $description)
Describe this field, provide help text for it.
By default, renders as a span class="description" underneath the form field.
in FormField at line 1337
string
getDescription()
in FormField at line 1345
string
debug()
in FormField at line 1364
string
forTemplate()
This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.
in FormField at line 1372
bool
Required()
in FormField at line 1387
$this
setContainerFieldList(FieldList $containerFieldList)
Set the FieldList that contains this field.
in FormField at line 1398
FieldList
getContainerFieldList()
Get the FieldList that contains this field.
in SelectField at line 266
FormField
castedCopy(mixed $classOrCopy)
Returns another instance of this field, but "cast" to a different class.
in FormField at line 1467
bool
canSubmitValue()
Determine if the value of this formfield accepts front-end submitted values and is saveable.
in FormField at line 1478
FormField
setSchemaComponent(string $componentType)
Sets the component type the FormField will be rendered as on the front-end.
in FormField at line 1489
string
getSchemaComponent()
Gets the type of front-end component the FormField will be rendered as.
in FormField at line 1505
FormField
setSchemaData(array $schemaData = [])
Sets the schema data used for rendering the field on the front-end.
Merges the passed array with the current $schemaData or {@link getSchemaDataDefaults()}.
Any passed keys that are not defined in {@link getSchemaDataDefaults()} are ignored.
If you want to pass around ad hoc data use the data array e.g. pass ['data' => ['myCustomKey' => 'yolo']].
in FormField at line 1517
array
getSchemaData()
Gets the schema data used to render the FormField on the front-end.
in FormField at line 1528
string
getSchemaDataType()
in FormField at line 1540
array
getSchemaDataDefaults()
Gets the defaults for $schemaData.
The keys defined here are immutable, meaning undefined keys passed to {@link setSchemaData()} are ignored.
Instead the data array should be used to pass around ad hoc data.
in FormField at line 1576
FormField
setSchemaState(array $schemaState = [])
Sets the schema data used for rendering the field on the front-end.
Merges the passed array with the current $schemaState or {@link getSchemaStateDefaults()}.
Any passed keys that are not defined in {@link getSchemaStateDefaults()} are ignored.
If you want to pass around ad hoc data use the data array e.g. pass ['data' => ['myCustomKey' => 'yolo']].
in FormField at line 1588
array
getSchemaState()
Gets the schema state used to render the FormField on the front-end.
in SelectField at line 47
array
getSchemaStateDefaults()
Gets the defaults for $schemaState.
The keys defined here are immutable, meaning undefined keys passed to {@link setSchemaState()} are ignored.
Instead the data array should be used to pass around ad hoc data.
Includes validation data if the field is associated to a {@link Form},
and {@link Form->validate()} has been called.
in FormField at line 1624
array
getSchemaValidation()
Return list of validation rules. Each rule is a key value pair.
The key is the rule name. The value is any information the frontend
validation handler can understand, or just true to enable.
at line 148
$this
setDisabledItems(array|SS_List $items)
Mark certain elements as disabled, regardless of the {@link setDisabled()} settings.
at line 157
array
getDisabledItems()
in SelectField at line 131
array
getValidValues()
Gets all valid values for this field.
Does not include "empty" value if specified
in SelectField at line 143
array|ArrayAccess
getSource()
Gets the source array not including any empty default values.
in SelectField at line 154
$this
setSource(mixed $source)
Set the source for this list
in SelectField at line 216
boolean
isSelectedValue(mixed $dataValue, mixed $userValue)
Determine if the current value of this field matches the given option value
in MultiSelectField at line 32
array
getValueArray()
Extracts the value of this field, normalised as an array.
Scalar values will return a single length array, even if empty
in MultiSelectField at line 45
$this
setDefaultItems(array $items)
Default selections, regardless of the {@link setValue()} settings.
Note: Items marked as disabled through {@link setDisabledItems()} can still be selected by default through this method.
in MultiSelectField at line 56
array
getDefaultItems()
Default selections, regardless of the {@link setValue()} settings.
in MultiSelectField at line 85
loadFrom(DataObjectInterface $record)
Load the value from the dataobject into this field
in MultiSelectField at line 158
string|null
stringEncode(array $value)
Encode a list of values into a string, or null if empty (to simplify empty checks)
at line 84
ArrayList
getOptions()
Gets the list of options to render in this formfield
at line 124
integer
getSize()
Get the size of this dropdown in rows.
at line 135
$this
setSize(int $size)
Sets the size of this dropdown in rows.