TreeDropdownField_Readonly
class TreeDropdownField_Readonly extends TreeDropdownField
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
CAVEAT: for search to work properly $labelField must be a database field, or you need to setSearchFunction.
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.
Method to save this form field into the given {@link 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()}.
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 the form field.
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}.
Changes this field to the readonly field.
Returns whether the current field has the given class added
Abstract method each {@link FormField} subclass must implement, determines whether the field is valid or not based on the value.
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.
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.
Set the ID of the root node of the tree. This defaults to 0 - i.e.
Set the ID of the root node of the tree. This defaults to 0 - i.e.
Get a callback used to filter the values of the tree before displaying to the user.
Set a callback used to filter the values of the tree before displaying to the user.
Get the callback used to disable checkboxes for some items in the tree
Set a callback used to disable checkboxes for some items in the tree
Set a callback used to search the hierarchy globally, even before applying the filter.
Set a callback used to search the hierarchy globally, even before applying the filter.
Get method to invoke on each node to get the child collection
Get method to invoke on nodes to count children
Marking public function for the tree, which combines different filters sensibly.
Marking a specific node in the tree as disabled
HTML-encoded label for this node, including css classes and other markup.
HTML-encoded label for this node, including css classes and other markup.
Set the default selection label, e.g. "select.
Details
in CustomMethods at line 50
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 144
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 172
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in Extensible at line 163
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 224
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 264
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 298
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
in Extensible at line 359
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 395
array
invokeWithExtensions(string $method, mixed $arguments)
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 424
array
extend(string $method, mixed $arguments)
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 465
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in Extensible at line 494
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 508
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
in TreeDropdownField at line 223
__construct(string $name, null|string $title = null, string $sourceObject = null, string $keyField = 'ID', string $labelField = 'TreeTitle', bool $showSearch = true)
CAVEAT: for search to work properly $labelField must be a database field, or you need to setSearchFunction.
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 349
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 386
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 460
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 520
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 542
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 554
$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 594
HTTPResponse
redirect(string $url, int $code = 302)
Redirect to the given URL.
in RequestHandler at line 606
string
getBackURL()
Safely get the value of the BackURL param, if provided via querystring / posted var
in RequestHandler at line 647
string
getReferer()
Get referer
in RequestHandler at line 666
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 FormField at line 469
saveInto(DataObjectInterface $record)
Method to save this form field into the given {@link DataObject}.
By default, makes use of $this->dataValue()
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 TreeDropdownField at line 426
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()}.
in TreeDropdownField at line 603
array
getAttributes()
Attributes to be given for this field type
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 FormField at line 786
$this
setValue(mixed $value, array|DataObject $data = null)
Set the field value.
If a FormField requires specific behaviour for loading content from either the database or a submitted form value they should override setSubmittedValue() instead.
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 9
DBHTMLText
Field(array $properties = array())
Returns the form field.
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.
in FormField at line 1036
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 1056
string
SmallFieldHolder(array $properties = array())
Returns a restricted field holder used within things like FieldGroups.
in FormField at line 1072
array
getTemplates()
Returns an array of templates to use for rendering {@link FieldHolder}.
in FormField at line 1082
array
getFieldHolderTemplates()
Returns an array of templates to use for rendering {@link FieldHolder}.
in FormField at line 1095
array
getSmallFieldHolderTemplates()
Returns an array of templates to use for rendering {@link SmallFieldHolder}.
in FormField at line 1130
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 1146
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 1154
bool
isReadonly()
in FormField at line 1170
$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 1179
bool
isDisabled()
in FormField at line 1195
$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 1205
bool
isAutofocus()
in FormField at line 1216
$this
setAutofocus(bool $autofocus)
Sets a autofocus flag on this FormField.
in TreeDropdownField at line 827
FormField
performReadonlyTransformation()
Changes this field to the readonly field.
in FormField at line 1250
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 1270
mixed
transform(FormTransformation $transformation)
in FormField at line 1282
bool
hasClass(string $class)
Returns whether the current field has the given class added
in FormField at line 1299
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 FormField at line 1314
bool
validate(Validator $validator)
Abstract method each {@link FormField} subclass must implement, determines whether the field is valid or not based on the value.
in FormField at line 1328
$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 1338
string
getDescription()
in FormField at line 1346
string
debug()
in FormField at line 1365
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 1373
bool
Required()
in FormField at line 1388
$this
setContainerFieldList(FieldList $containerFieldList)
Set the FieldList that contains this field.
in FormField at line 1399
FieldList
getContainerFieldList()
Get the FieldList that contains this field.
in TreeDropdownField at line 842
FormField
castedCopy(mixed $classOrCopy)
in FormField at line 1468
bool
canSubmitValue()
Determine if the value of this formfield accepts front-end submitted values and is saveable.
in FormField at line 1479
FormField
setSchemaComponent(string $componentType)
Sets the component type the FormField will be rendered as on the front-end.
in FormField at line 1490
string
getSchemaComponent()
Gets the type of front-end component the FormField will be rendered as.
in FormField at line 1506
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 1518
array
getSchemaData()
Gets the schema data used to render the FormField on the front-end.
in FormField at line 1529
string
getSchemaDataType()
in TreeDropdownField at line 898
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 1577
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 1589
array
getSchemaState()
Gets the schema state used to render the FormField on the front-end.
in TreeDropdownField at line 853
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 1625
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.
in TreeDropdownField at line 259
int
getTreeBaseID()
Set the ID of the root node of the tree. This defaults to 0 - i.e.
displays the whole tree.
in TreeDropdownField at line 271
$this
setTreeBaseID(int $ID)
Set the ID of the root node of the tree. This defaults to 0 - i.e.
displays the whole tree.
in TreeDropdownField at line 283
callable
getFilterFunction()
Get a callback used to filter the values of the tree before displaying to the user.
in TreeDropdownField at line 295
$this
setFilterFunction(callable $callback)
Set a callback used to filter the values of the tree before displaying to the user.
in TreeDropdownField at line 310
callable
getDisableFunction()
Get the callback used to disable checkboxes for some items in the tree
in TreeDropdownField at line 321
$this
setDisableFunction(callable $callback)
Set a callback used to disable checkboxes for some items in the tree
in TreeDropdownField at line 337
callable
getSearchFunction()
Set a callback used to search the hierarchy globally, even before applying the filter.
in TreeDropdownField at line 349
$this
setSearchFunction(callable $callback)
Set a callback used to search the hierarchy globally, even before applying the filter.
in TreeDropdownField at line 364
bool
getShowSearch()
Check if search is shown
in TreeDropdownField at line 373
$this
setShowSearch(bool $bool)
in TreeDropdownField at line 384
string
getChildrenMethod()
Get method to invoke on each node to get the child collection
in TreeDropdownField at line 398
$this
setChildrenMethod(string $method)
in TreeDropdownField at line 409
string
getNumChildrenMethod()
Get method to invoke on nodes to count children
in TreeDropdownField at line 420
$this
setNumChildrenMethod(string $method)
in TreeDropdownField at line 438
HTTPResponse
tree(HTTPRequest $request)
Get the whole tree of a part of the tree via an AJAX request.
in TreeDropdownField at line 574
bool
filterMarking(DataObject $node)
Marking public function for the tree, which combines different filters sensibly.
If a filter function has been set, that will be called. And if search text is set, filter on that too. Return true if all applicable conditions are true, false otherwise.
in TreeDropdownField at line 593
boolean
nodeIsDisabled($node)
Marking a specific node in the tree as disabled
in TreeDropdownField at line 626
$this
setLabelField(string $field)
deprecated
deprecated 4.0.0:5.0.0 Use setTitleField()
HTML-encoded label for this node, including css classes and other markup.
in TreeDropdownField at line 638
string
getLabelField()
deprecated
deprecated 4.0.0:5.0.0 Use getTitleField()
HTML-encoded label for this node, including css classes and other markup.
in TreeDropdownField at line 648
string
getTitleField()
Field to use for plain text item titles.
in TreeDropdownField at line 659
$this
setTitleField(string $field)
Set field to use for item title
in TreeDropdownField at line 669
$this
setKeyField(string $field)
in TreeDropdownField at line 678
string
getKeyField()
in TreeDropdownField at line 687
$this
setSourceObject(string $class)
in TreeDropdownField at line 698
string
getSourceObject()
Get class of source object
in TreeDropdownField at line 916
TreeDropdownField
setHasEmptyDefault(boolean $bool)
in TreeDropdownField at line 925
bool
getHasEmptyDefault()
in TreeDropdownField at line 938
$this
setEmptyString(string $string)
Set the default selection label, e.g. "select.
..". Defaults to an empty string. Automatically sets {@link $hasEmptyDefault} to true.