TreeDropdownField

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

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

Return the names of all the methods available on this object

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

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.

Get extra config sources for this class

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

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

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

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.

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

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.

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

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

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Get inherited config value

Gets the uninherited value for the given config option

Update the config value for a given property

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.

Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.

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.

Get the current failover object if set

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.

Note that any fields you specify will take precedence over the fields on this object.

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

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.

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.

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.

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.

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".

Return debug information about this object that can be rendered into a template

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.

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.

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.

Check that the given action is allowed to be called from a URL.

It will interrogate {@link self::$allowed_actions} to determine this.

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.

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.

Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.

Return a link to this field

Redirect to the given URL.

Safely get the value of the BackURL param, if provided via querystring / posted var

Get referer

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

Returns the field message, used by form validation.

Use {@link setError()} to set this property.

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.

Casting type for this message. Will be 'text' or 'html'

Sets the error message to be displayed on the form field.

Allows HTML content, so remember to use Convert::raw2xml().

Get form schema encoded message

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'

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.

Returns the HTML ID for the form field holder element.

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.

Returns the field name.

Returns the field input name.

Returns the field value.

Method to save this form field into the given {@link DataObject}.

By default, makes use of $this->dataValue()

Returns the field value suitable for insertion into the data object.

Returns the field label - used by templates.

Set the title of this formfield.

Note: This expects escaped HTML.

Gets the contextual label than can be used for additional field description.

Can be shown to the right or under the field in question.

Sets the right title for this formfield

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.

Add one or more CSS-classes to the FormField container.

Multiple class names should be space delimited.

Remove one or more CSS-classes from the FormField container.

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.

Get an HTML attribute defined by the field, or added through {@link setAttribute()}.

Caution: this doesn't work on all fields, see {@link setAttribute()}.

Attributes to be given for this field type

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.

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 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.

Set value assigned from a submitted form postback.

Can be overridden to handle custom behaviour for user-localised data formats.

Set the field name.

Set the field input type.

Set the container form.

This is called automatically when fields are added to forms.

Get the currently used form.

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.

Different from setError() as that appends it to the standard error messaging.

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

Caution: Not consistently implemented in all subclasses, please check the {@link Field()} method on the subclass for support.

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.

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.

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.

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.

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}.

Returns true if this field is a composite field.

To create composite field types, you should subclass {@link CompositeField}.

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.

Sets a read-only flag on this FormField.

Use performReadonlyTransformation() to transform this instance.

Setting this to false has no effect on the field.

Sets a disabled flag on this FormField.

Use performDisabledTransformation() to transform this instance.

Setting this to false has no effect on the field.

Sets a autofocus flag on this FormField.

Changes this field to the readonly field.

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

Returns whether the current field has the given class added

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.

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.

By default, renders as a span class="description" underneath the form field.

This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.

Set the FieldList that contains this field.

Get the FieldList that contains this field.

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.

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']].

Gets the schema data used to render the FormField on the front-end.

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.

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']].

Gets the schema state used to render the FormField on the front-end.

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.

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.

Set the ID of the root node of the tree. This defaults to 0 - i.e.

displays the whole tree.

Set the ID of the root node of the tree. This defaults to 0 - i.e.

displays the whole tree.

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.

Check if search is shown

Get method to invoke on each node to get the child collection

Get method to invoke on nodes to count children

Get the whole tree of a part of the tree via an AJAX request.

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.

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.

Field to use for plain text item titles.

Set field to use for item title

Get class of source object

Set the default selection label, e.g. "select...".

Defaults to an empty string. Automatically sets {@link $hasEmptyDefault} to true.