class DropdownField extends SingleSelectField (View source)

Dropdown field, created from a select tag.

Setting a $has_one relation

Using here an example of an art gallery, with Exhibition pages, each of which has a Gallery they belong to. The Gallery class is also user-defined.

 static $has_one = array(
     'Gallery' => 'Gallery',
 );

 public function getCMSFields() {
     $fields = parent::getCMSFields();
     $field = DropdownField::create('GalleryID', 'Gallery', Gallery::get()->map('ID', 'Title'))
         ->setEmptyString('(Select one)');
     $fields->addFieldToTab('Root.Content', $field, 'Content');

As you see, you need to put "GalleryID", rather than "Gallery" here.

Populate with Array

Example model definition:

class MyObject extends DataObject {
  static $db = array(
    'Country' => "Varchar(100)"
  );
}

Example instantiation:

DropdownField::create(
  'Country',
  'Country',
  array(
    'NZ' => 'New Zealand',
    'US' => 'United States',
    'GEM'=> 'Germany'
  )
);

Populate with Enum-Values

You can automatically create a map of possible values from an Enum database column.

Example model definition:

class MyObject extends DataObject {
  static $db = array(
    'Country' => "Enum('New Zealand,United States,Germany','New Zealand')"
  );
}

Field construction:

DropdownField::create(
  'Country',
  'Country',
  singleton('MyObject')->dbObject('Country')->enumValues()
);

Disabling individual items

Individual items can be disabled by feeding their array keys to setDisabledItems.

$DrDownField->setDisabledItems( array( 'US', 'GEM' ) );

Traits

This trait can be applied to a ViewableData class to add the logic to render attributes in an SS template.

Form component which contains a castable message

Allows an object to have extensions applied to it.

A class that can be instantiated or replaced via DI

Provides extensions to this object to integrate it with standard config API methods.

Allows an object to declare a set of custom methods

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

Config options

extensions array

An array of extension names and parameters to be applied to this object upon construction.

from  Extensible
unextendable_classes array

Classes that cannot be extended

from  Extensible
casting from  FormField
default_cast string

The default object to cast scalar fields to if casting information is not specified, and casting to an object is required.

from  ViewableData
casting_cache array from  ViewableData
url_segment string|null

Optional url_segment for this request handler

from  RequestHandler
url_handlers

The default URL handling rules. This specifies that the next component of the URL corresponds to a method to be called on this RequestHandlingData object.

from  RequestHandler
allowed_actions

Define a list of action handling methods that are allowed to be called directly by URLs.

from  RequestHandler
default_classes array from  FormField

Properties

protected static array $extra_methods

Custom method sources

from  CustomMethods
protected array $extra_method_registers

Name of methods to invoke by defineMethods for this instance

from  CustomMethods
protected static array $built_in_methods

Non-custom methods

from  CustomMethods
protected Extension[] $extension_instances from  Extensible
protected callable[][] $beforeExtendCallbacks

List of callbacks to call prior to extensions having extend called on them, each grouped by methodName.

from  Extensible
protected callable[][] $afterExtendCallbacks

List of callbacks to call after extensions having extend called on them, each grouped by methodName.

from  Extensible
protected ViewableData $failover

A failover object to attempt to get data from if it is not present on this object.

from  ViewableData
protected ViewableData $customisedObject from  ViewableData
protected HTTPRequest $request from  RequestHandler
protected $model

The DataModel for this request

from  RequestHandler
protected bool $brokenOnConstruct

This variable records whether RequestHandler::construct() was called or not. Useful for checking if subclasses have called parent::construct()

from  RequestHandler
protected array $attributes

List of attributes to render on the frontend

from  AttributesHTML
protected string $message from  FormMessage
protected string $messageType from  FormMessage
protected string $messageCast

Casting for message

from  FormMessage
protected Form $form from  FormField
protected string $inputType

This is INPUT's type attribute value.

from  FormField
protected string $name from  FormField
protected null|string $title from  FormField
protected mixed $value from  FormField
protected string $extraClass from  FormField
protected string $description

Adds a title attribute to the markup.

from  FormField
protected array $extraClasses

Extra CSS classes for the FormField container.

from  FormField
protected string $rightTitle

Right-aligned, contextual label for the field.

from  FormField
protected string $leftTitle

Left-aligned, contextual label for the field.

from  FormField
protected FieldList $containerFieldList

Stores a reference to the FieldList that contains this object.

from  FormField
protected bool $readonly from  FormField
protected bool $disabled from  FormField
protected bool $autofocus from  FormField
protected string $customValidationMessage

Custom validation message for the field.

from  FormField
protected string $template

Name of the template used to render this form field. If not set, then will look up the class ancestry for the first matching template where the template name equals the class name.

from  FormField
protected string $fieldHolderTemplate

Name of the template used to render this form field. If not set, then will look up the class ancestry for the first matching template where the template name equals the class name.

from  FormField
protected string $smallFieldHolderTemplate from  FormField
protected $schemaDataType from  SingleSelectField
protected string $schemaComponent

The type of front-end component to render the FormField as.

from  FormField
protected array $schemaData

Structured schema data representing the FormField.

from  FormField
protected array $schemaState

Structured schema state representing the FormField's current data and validation.

from  FormField
protected array|ArrayAccess $source

Associative or numeric array of all dropdown items, with array key as the submitted field value, and the array value as a natural language description shown in the interface element.

from  SelectField
protected array $disabledItems

The values for items that should be disabled (greyed out) in the dropdown.

from  SelectField
protected bool $hasEmptyDefault

Show the first

from  SingleSelectField
protected string $emptyString

The title shown for an empty default selection, e.g. "Select...".

from  SingleSelectField

Methods

public
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

protected
defineMethods()

Adds any methods from Extension instances attached to this object.

protected
registerExtraMethodCallback(string $name, callable $callback)

Register an callback to invoke that defines extra methods

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

protected
array
getExtraMethodConfig(string $method)

Get meta-data details on a named method

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

protected
array
findMethodsFromExtension(object $extension) deprecated

No description

protected
addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

protected
removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

protected
addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

protected
addCallbackMethod(string $method, callable $callback)

Add callback as a method.

protected
beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

protected
afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

protected
constructExtensions() deprecated

No description

protected
defineExtensionMethods()

Adds any methods from Extension instances attached to this object.

public static 
bool
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

public static 
remove_extension(string $extension)

Remove an extension from a class.

public static 
array
get_extensions(string $class = null, bool $includeArgumentString = false)

No description

public static 
array|null
get_extra_config_sources(string $class = null)

Get extra config sources for this class

public static 
bool
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)

Return TRUE if a class has a specified extension.

public
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 Extensions, and then attempts to merge all results into an array

public
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

public
Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

public
bool
hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.

public
getExtensionInstances()

Get all extension instances for this specific object instance.

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public static 
config()

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

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public
__construct(string $name, null|string|ViewableData $title = null, array|ArrayAccess $source = [], mixed $value = null)

No description

public
bool
__isset(string $property)

Check if a field exists on this object or its failover.

public
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 ViewableData::getField(), then fall back on a failover object.

public
__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 ViewableData::setField() method.

public
setFailover(ViewableData $failover)

Set a failover object to attempt to get data from if it is not present on this object.

public
getFailover()

Get the current failover object if set

public
bool
hasField(string $field)

Check if a field exists on this object. This should be overloaded in child classes.

public
mixed
getField(string $field)

Get the value of a field on this object. This should be overloaded in child classes.

public
$this
setField(string $field, mixed $value)

Set a field on this object. This should be overloaded in child classes.

public
customise(array|ViewableData $data)

Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.

public
bool
exists()

Return true if this object "exists" i.e. has a sensible value

public
string
__toString()

No description

public
getCustomisedObj()

No description

public
setCustomisedObj(ViewableData $object)

No description

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

public
string
castingClass(string $field)

Get the class name a field on this object will be casted to.

public
string
escapeTypeForField(string $field)

Return the string-format type for the given field.

public
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

protected
string
objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

protected
mixed
objCacheGet(string $key)

Get a cached value from the field cache

protected
$this
objCacheSet(string $key, mixed $value)

Store a value in the field cache

protected
$this
objCacheClear()

Clear object cache

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

public
object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)

A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.

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

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

public
array
getXMLValues(array $fields)

Get an array of XML-escaped values by field name

public
getIterator()

Return a single-item iterator so you can iterate over the fields of a single record.

public
array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

public
Me()

When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

public
string
ThemeDir() deprecated

Return the directory if the current active theme (relative to the site root).

public
string
CSSClasses(string $stopAtClass = self::class)

Get part of the current classes ancestry to be used as a CSS class.

public
Debug()

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

public
handleRequest(HTTPRequest $request)

Handles URL requests.

protected
array
findAction(HTTPRequest $request)

No description

protected
string
addBackURLParam(string $link)

No description

protected
handleAction($request, $action)

Given a request, and an action name, call that action name on this RequestHandler

public
array|null
allowedActions(string $limitToClass = null)

Get a array of allowed actions defined on this controller, any parent classes or extensions.

public
bool
hasAction(string $action)

Checks if this request handler has a specific action, even if the current user cannot access it.

protected
string
definingClassForAction(string $actionOrigCasing)

Return the class that defines the given action, so that we know where to check allowed_actions.

public
bool
checkAccessAction(string $action)

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

public
httpError(int $errorCode, string $errorMessage = null)

Throws a HTTP error response encased in a HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.

public
getRequest()

Returns the HTTPRequest object that this controller is using.

public
$this
setRequest(HTTPRequest $request)

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

public
string
Link(string $action = null)

Return a link to this field

public
redirect(string $url, int $code = 302)

Redirect to the given URL.

public
string
getBackURL()

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

public
string
getReferer()

Get referer

public
redirectBack()

Redirect back. Uses either the HTTP-Referer or a manually set request-variable called "BackURL".

public
$this
setAttribute($name, $value)

Set an HTML attribute

public
mixed|null
getAttribute(string $name)

Retrieve the value of an HTML attribute

protected
array
getDefaultAttributes()

Get the default attributes when rendering this object.

public
array
getAttributes()

Allows customization through an 'updateAttributes' hook on the base class.

public
string
getAttributesHTML(array $attributes = null)

Custom attributes to process. Falls back to getAttributes().

public
string
getMessage()

Returns the field message, used by form validation.

public
string
getMessageType()

Returns the field message type.

public
string
getMessageCast()

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

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

protected
string
getMessageCastingHelper()

Get casting helper for message cast, or null if not known

public
array|null
getSchemaMessage()

Get form schema encoded message

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

protected
setupDefaultClasses()

Set up the default classes for the form. This is done on construct so that the default classes can be removed after instantiation

public
string
ID()

Returns the HTML ID of the field.

public
string
HolderID()

Returns the HTML ID for the form field holder element.

public
getTemplateHelper()

Returns the current FormTemplateHelper on either the parent Form or the global helper set through the Injector layout.

public
string
getName()

Returns the field name.

public
string
getInputType()

Returns the field input name.

public
mixed
Value()

Returns the field value.

public
saveInto(DataObjectInterface $record)

Method to save this form field into the given DataObject.

public
mixed
dataValue()

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

public
string
Title()

Returns the field label - used by templates.

public
$this
setTitle(string $title)

Set the title of this formfield.

public
string
RightTitle()

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

public
$this
setRightTitle(string|DBField $rightTitle)

Sets the right title for this formfield

public
string
LeftTitle()

No description

public
$this
setLeftTitle(string $leftTitle)

No description

public
string
extraClass()

Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.

public
bool
hasExtraClass(string $class)

Check if a CSS-class has been added to the form container.

public
$this
addExtraClass(string $class)

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

public
$this
removeExtraClass(string $class)

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

public
string
attrTitle()

Returns a version of a title suitable for insertion into an HTML attribute.

public
string
attrValue()

Returns a version of a title suitable for insertion into an HTML attribute.

public
$this
setValue(mixed $value, array|DataObject $data = null)

Set the field value.

public
$this
setSubmittedValue(mixed $value, array|DataObject $data = null)

Set value assigned from a submitted form postback.

public
$this
setName(string $name)

Set the field name.

public
$this
setInputType(string $type)

Set the field input type.

public
$this
setForm(Form $form)

Set the container form.

public
getForm()

Get the currently used form.

public
bool
securityTokenEnabled()

Return true if security token protection is enabled on the parent Form.

public
$this
setCustomValidationMessage(string $customValidationMessage)

Set the custom error message to show instead of the default format.

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

public
$this
setTemplate(string $template)

Set name of template (without path or extension).

public
string
getTemplate()

No description

public
string
getFieldHolderTemplate()

No description

public
$this
setFieldHolderTemplate(string $fieldHolderTemplate)

Set name of template (without path or extension) for the holder, which in turn is responsible for rendering Field().

public
string
getSmallFieldHolderTemplate()

No description

public
$this
setSmallFieldHolderTemplate(string $smallFieldHolderTemplate)

Set name of template (without path or extension) for the small holder, which in turn is responsible for rendering Field().

public
Field(array $properties = [])

No description

public
FieldHolder(array $properties = [])

Returns a "field holder" for this field.

public
string
SmallFieldHolder(array $properties = [])

Returns a restricted field holder used within things like FieldGroups.

public
array
getTemplates()

Returns an array of templates to use for rendering FieldHolder.

public
array
getFieldHolderTemplates()

Returns an array of templates to use for rendering FieldHolder.

public
array
getSmallFieldHolderTemplates()

Returns an array of templates to use for rendering SmallFieldHolder.

protected
array
_templates(string $customTemplate = null, string $customTemplateSuffix = null)

Generate an array of class name strings to use for rendering this form field into HTML.

public
bool
isComposite()

Returns true if this field is a composite field.

public
bool
hasData()

Returns true if this field has its own data.

public
bool
isReadonly()

No description

public
$this
setReadonly(bool $readonly)

Sets a read-only flag on this FormField.

public
bool
isDisabled()

No description

public
$this
setDisabled(bool $disabled)

Sets a disabled flag on this FormField.

public
bool
isAutofocus()

No description

public
$this
setAutofocus(bool $autofocus)

Sets a autofocus flag on this FormField.

public
performDisabledTransformation()

Return a disabled version of this field.

public
mixed
transform(FormTransformation $transformation)

No description

public
bool
hasClass(string $class)

Returns whether the current field has the given class added

public
string
Type()

Returns the field type.

public
bool
validate(Validator $validator)

Validate this field

public
$this
setDescription(string $description)

Describe this field, provide help text for it.

public
string
getDescription()

No description

public
string
debug()

No description

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

public
bool
Required()

No description

public
$this
setContainerFieldList(FieldList $containerFieldList)

Set the FieldList that contains this field.

public
getContainerFieldList()

Get the FieldList that contains this field.

public
null|FieldList
rootFieldList()

No description

public
castedCopy(mixed $classOrCopy)

Returns another instance of this field, but "cast" to a different class.

public
bool
canSubmitValue()

Determine if the value of this formfield accepts front-end submitted values and is saveable.

public
setSchemaComponent(string $componentType)

Sets the component type the FormField will be rendered as on the front-end.

public
string
getSchemaComponent()

Gets the type of front-end component the FormField will be rendered as.

public
setSchemaData(array $schemaData = [])

Sets the schema data used for rendering the field on the front-end.

public
array
getSchemaData()

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

public
string
getSchemaDataType()

No description

public
array
getSchemaDataDefaults()

Gets the defaults for $schemaData.

public
setSchemaState(array $schemaState = [])

Sets the schema data used for rendering the field on the front-end.

public
array
getSchemaState()

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

public
array
getSchemaStateDefaults()

Gets the defaults for $schemaState.

public
array
getSchemaValidation()

Return list of validation rules. Each rule is a key value pair.

public
Tip|null
getTitleTip()

No description

public
setTitleTip(Tip|null $tip)

No description

public
$this
setDisabledItems(array|SS_List $items)

Mark certain elements as disabled, regardless of the setDisabled() settings.

public
array
getDisabledItems()

Non-associative list of disabled item values

protected
bool
isDisabledValue(string $value)

Check if the given value is disabled

protected
array
getSourceValues()

Retrieve all values in the source array

public
array
getValidValues()

Gets all valid values for this field.

public
array|ArrayAccess
getSource()

Gets the source array not including any empty default values.

public
$this
setSource(mixed $source)

Set the source for this list

protected
array
getListMap(mixed $source)

Given a list of values, extract the associative map of id => title

protected
array
getListValues(mixed $values)

Given a non-array collection, extract the non-associative list of ids If passing as array, treat the array values (not the keys) as the ids

public
bool
isSelectedValue(mixed $dataValue, mixed $userValue)

Determine if the current value of this field matches the given option value

public
getDefaultValue()

No description

public
setHasEmptyDefault(bool $bool)

No description

public
bool
getHasEmptyDefault()

A required DropdownField must have a user selected attribute, so require an empty default for a required field

public
$this
setEmptyString(string $string)

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

public
string
getEmptyString()

No description

public
array|ArrayAccess
getSourceEmpty()

Gets the source array, including the empty string, if present

protected
getFieldOption(mixed $value, string $title)

Build a field option for template rendering

Details

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 Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

protected defineMethods()

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

protected registerExtraMethodCallback(string $name, callable $callback)

Register an callback to invoke that defines extra methods

Parameters

string $name
callable $callback

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

Parameters

string $method

Return Value

bool

protected array getExtraMethodConfig(string $method)

Get meta-data details on a named method

Parameters

string $method

Return Value

array

List of custom method details, if defined for this method

array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom

include methods added dynamically at runtime

Return Value

array

protected array findMethodsFromExtension(object $extension) deprecated

deprecated 4.13.0 Will be replaced by findMethodsFrom() in CMS 5

No description

Parameters

object $extension

Return Value

array

protected addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

Exceptions

InvalidArgumentException

protected removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

protected addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

Parameters

string $method

the method name to wrap

string $wrap

the method name to wrap to

protected addCallbackMethod(string $method, callable $callback)

Add callback as a method.

Parameters

string $method

Name of method

callable $callback

Callback to invoke. Note: $this is passed as first parameter to this callback and then $args as array

protected beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected constructExtensions() deprecated

deprecated 4.0.0:5.0.0 Extensions and methods are now lazy-loaded

No description

protected defineExtensionMethods()

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

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 Object::$extensions array. See 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 singleton()).

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of Object

string $extension

Subclass of Extension with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool

Flag if the extension was added

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

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 Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.

Add support for removing extensions with parameters

Parameters

string $extension

class name of an Extension subclass, without parameters

static array get_extensions(string $class = null, bool $includeArgumentString = false)

No description

Parameters

string $class

If omitted, will get extensions for the current class

bool $includeArgumentString

Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array

Numeric array of either DataExtension class names, or eval'ed class name strings with constructor arguments.

static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

string $class

Name of class. If left null will return for the current class

Return Value

array|null

static bool has_extension(string $classOrExtension, string $requiredExtension = null, bool $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))

Parameters

string $classOrExtension

Class to check extension for, or the extension name to check if the second argument is null.

string $requiredExtension

If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.

bool $strict

if the extension has to match the required extension and not be a subclass

Return Value

bool

Flag if the extension exists

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 Extensions, and then attempts to merge all results into an array

Parameters

string $method

the method name to call

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

List of results with nulls filtered out

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 __construct()} in {@link defineMethods().

Parameters

string $method

the name of the method to call on each extension

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

bool hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method 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.

Parameters

string $extension

Classname of an Extension subclass without parameters

Return Value

bool

Extension[] getExtensionInstances()

Get all extension instances for this specific object instance.

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

Return Value

Extension[]

Map of DataExtension instances, keyed by classname.

static Injectable create(mixed ...$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::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

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

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

static Config_ForClass config()

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

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct(string $name, null|string|ViewableData $title = null, array|ArrayAccess $source = [], mixed $value = null)

No description

Parameters

string $name

The internal field name, passed to forms.

null|string|ViewableData $title

The human-readable field label.

array|ArrayAccess $source

A map of the dropdown items

mixed $value

The value of the field.

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.

Parameters

string $property

Return Value

bool

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 ViewableData::getField(), then fall back on a failover object.

Parameters

string $property

Return Value

mixed

__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 ViewableData::setField() method.

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

Set a failover object to attempt to get data from if it is not present on this object.

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

Check if a field exists on this object. This should be overloaded in child classes.

Parameters

string $field

Return Value

bool

mixed getField(string $field)

Get the value of a field on this object. This should be overloaded in child classes.

Parameters

string $field

Return Value

mixed

$this setField(string $field, mixed $value)

Set a field on this object. This should be overloaded in child classes.

Parameters

string $field
mixed $value

Return Value

$this

ViewableData_Customised customise(array|ViewableData $data)

Merge some arbitrary data in with this object. This method returns a 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.

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

bool exists()

Return true if this object "exists" i.e. has a sensible value

This method should be overridden in subclasses to provide more context about the classes state. For example, a DataObject class could return false when it is deleted from the database

Return Value

bool

string __toString()

No description

Return Value

string

the class name

ViewableData getCustomisedObj()

No description

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

No description

Parameters

ViewableData $object

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.

Parameters

string $field

Return Value

string

Casting helper As a constructor pattern, and may include arguments.

Exceptions

Exception

string castingClass(string $field)

Get the class name a field on this object will be casted to.

Parameters

string $field

Return Value

string

string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string 'xml'|'raw'

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

Parameters

string|array|SSViewer $template

the template to render into

array $customFields

fields to customise() the object with before rendering

Return Value

DBHTMLText

protected string objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName

Name of field

array $arguments

List of optional arguments given

Return Value

string

protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key

Cache key

Return Value

mixed

protected $this objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key

Cache key

mixed $value

Return Value

$this

protected $this objCacheClear()

Clear object cache

Return Value

$this

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.

Parameters

string $fieldName
array $arguments
bool $cache

Cache this object

string $cacheName

a custom cache name

Return Value

object|DBField

object|DBField cachedCall(string $field, array $arguments = [], string $identifier = null)

A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.

Parameters

string $field
array $arguments
string $identifier

an optional custom cache identifier

Return Value

object|DBField

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

string

array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields

an array of field names

Return Value

array

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.

Return Value

ArrayIterator

array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

ViewableData Me()

When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

Return Value

ViewableData

string ThemeDir() deprecated

deprecated 4.0.1 Use ModuleResourceLoader::resourcePath() or ModuleResourceLoader::resourceURL() 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.

Return Value

string

URL to the current theme

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

Parameters

string $stopAtClass

the class to stop at (default: ViewableData)

Return Value

string

ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

HTTPResponse|RequestHandler|string|array handleRequest(HTTPRequest $request)

Handles URL requests.

  • ViewableData::handleRequest() iterates through each rule in 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.

Parameters

HTTPRequest $request

The object that is responsible for distributing URL parsing

Return Value

HTTPResponse|RequestHandler|string|array

protected array findAction(HTTPRequest $request)

No description

Parameters

HTTPRequest $request

Return Value

array

protected string addBackURLParam(string $link)

No description

Parameters

string $link

Return Value

string

protected HTTPResponse handleAction($request, $action)

Given a request, and an action name, call that action name on this RequestHandler

Must not raise HTTPResponse_Exceptions - instead it should return

Parameters

$request
$action

Return Value

HTTPResponse

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.

Parameters

string $limitToClass

Return Value

array|null

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.

Parameters

string $action

Return Value

bool

protected string definingClassForAction(string $actionOrigCasing)

Return the class that defines the given action, so that we know where to check allowed_actions.

Parameters

string $actionOrigCasing

Return Value

string

bool checkAccessAction(string $action)

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

It will interrogate self::$allowed_actions to determine this.

Parameters

string $action

Return Value

bool

Exceptions

Exception

httpError(int $errorCode, string $errorMessage = null)

Throws a HTTP error response encased in a HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.

Parameters

int $errorCode
string $errorMessage

Plaintext error message

Exceptions

HTTPResponse_Exception

HTTPRequest getRequest()

Returns the HTTPRequest object that this controller is using.

Returns a placeholder NullHTTPRequest object unless handleAction()} or {@link handleRequest() have been called, which adds a reference to an actual HTTPRequest object.

Return Value

HTTPRequest

$this setRequest(HTTPRequest $request)

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

Parameters

HTTPRequest $request

Return Value

$this

Return a link to this field

Parameters

string $action

Optional action

Return Value

string

Exceptions

LogicException

HTTPResponse redirect(string $url, int $code = 302)

Redirect to the given URL.

Parameters

string $url
int $code

Return Value

HTTPResponse

string getBackURL()

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

Return Value

string

string getReferer()

Get referer

Return Value

string

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 Director::baseURL()).

Return Value

HTTPResponse

$this setAttribute($name, $value)

Set an HTML attribute

Parameters

$name
$value

Return Value

$this

mixed|null getAttribute(string $name)

Retrieve the value of an HTML attribute

Parameters

string $name

Return Value

mixed|null

abstract protected array getDefaultAttributes()

Get the default attributes when rendering this object.

Called by getAttributes()

Return Value

array

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.

Return Value

array

string getAttributesHTML(array $attributes = null)

Custom attributes to process. Falls back to getAttributes().

If at least one argument is passed as a string, all arguments act as excludes, by name.

Parameters

array $attributes

Return Value

string

string getMessage()

Returns the field message, used by form validation.

Use setError() to set this property.

Return Value

string

string getMessageType()

Returns the field message type.

Arbitrary value which is mostly used for CSS classes in the rendered HTML, e.g "required".

Use setError() to set this property.

Return Value

string

string getMessageCast()

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

Return Value

string

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

Parameters

string $message

Message string

string $messageType

Message type

string $messageCast

Return Value

$this

protected string getMessageCastingHelper()

Get casting helper for message cast, or null if not known

Return Value

string

array|null getSchemaMessage()

Get form schema encoded message

Return Value

array|null

Message in array format, or null if no message

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'

Parameters

string $fieldName

Return Value

string

protected setupDefaultClasses()

Set up the default classes for the form. This is done on construct so that the default classes can be removed after instantiation

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.

Return Value

string

string HolderID()

Returns the HTML ID for the form field holder element.

Return Value

string

FormTemplateHelper getTemplateHelper()

Returns the current FormTemplateHelper on either the parent Form or the global helper set through the Injector layout.

To customize a single FormField}, use {@link setTemplate and provide a custom template name.

Return Value

FormTemplateHelper

string getName()

Returns the field name.

Return Value

string

string getInputType()

Returns the field input name.

Return Value

string

mixed Value()

Returns the field value.

Return Value

mixed

See also

FormField::setSubmittedValue

saveInto(DataObjectInterface $record)

Method to save this form field into the given DataObject.

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

Parameters

DataObjectInterface $record

DataObject to save data into

mixed dataValue()

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

Return Value

mixed

See also

\SilverStripe\Forms\Formfield::setValue()

string Title()

Returns the field label - used by templates.

Return Value

string

$this setTitle(string $title)

Set the title of this formfield.

Note: This expects escaped HTML.

Parameters

string $title

Escaped HTML for title

Return Value

$this

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.

Return Value

string

Contextual label text

$this setRightTitle(string|DBField $rightTitle)

Sets the right title for this formfield

Parameters

string|DBField $rightTitle

Plain text string, or a DBField with appropriately escaped HTML

Return Value

$this

string LeftTitle()

No description

Return Value

string

$this setLeftTitle(string $leftTitle)

No description

Parameters

string $leftTitle

Return Value

$this

string extraClass()

Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.

Uses Message()} and {@link MessageType() to add validation error classes which can be used to style the contained tags.

Return Value

string

bool hasExtraClass(string $class)

Check if a CSS-class has been added to the form container.

Parameters

string $class

A string containing a classname or several class names delimited by a single space.

Return Value

bool

True if all of the classnames passed in have been added.

$this addExtraClass(string $class)

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

Multiple class names should be space delimited.

Parameters

string $class

Return Value

$this

$this removeExtraClass(string $class)

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

Parameters

string $class

Return Value

$this

string attrTitle()

Returns a version of a title suitable for insertion into an HTML attribute.

Return Value

string

string attrValue()

Returns a version of a title suitable for insertion into an HTML attribute.

Return Value

string

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

Parameters

mixed $value

Either the parent object, or array of source data being loaded

array|DataObject $data

{\SilverStripe\Forms\Form::loadDataFrom}

Return Value

$this

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

Parameters

mixed $value
array|DataObject $data

Return Value

$this

$this setName(string $name)

Set the field name.

Parameters

string $name

Return Value

$this

$this setInputType(string $type)

Set the field input type.

Parameters

string $type

Return Value

$this

$this setForm(Form $form)

Set the container form.

This is called automatically when fields are added to forms.

Parameters

Form $form

Return Value

$this

Form getForm()

Get the currently used form.

Return Value

Form

bool securityTokenEnabled()

Return true if security token protection is enabled on the parent Form.

Return Value

bool

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

Parameters

string $customValidationMessage

Return Value

$this

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

Return Value

string

$this setTemplate(string $template)

Set name of template (without path or extension).

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

Parameters

string $template

Return Value

$this

string getTemplate()

No description

Return Value

string

string getFieldHolderTemplate()

No description

Return Value

string

$this setFieldHolderTemplate(string $fieldHolderTemplate)

Set name of template (without path or extension) for the holder, which in turn is responsible for rendering Field().

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

Parameters

string $fieldHolderTemplate

Return Value

$this

string getSmallFieldHolderTemplate()

No description

Return Value

string

$this setSmallFieldHolderTemplate(string $smallFieldHolderTemplate)

Set name of template (without path or extension) for the small holder, which in turn is responsible for rendering Field().

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

Parameters

string $smallFieldHolderTemplate

Return Value

$this

DBHTMLText Field(array $properties = [])

No description

Parameters

array $properties

Return Value

DBHTMLText

DBHTMLText FieldHolder(array $properties = [])

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.

Parameters

array $properties

Return Value

DBHTMLText

See also

FieldHolder.ss

string SmallFieldHolder(array $properties = [])

Returns a restricted field holder used within things like FieldGroups.

Parameters

array $properties

Return Value

string

array getTemplates()

Returns an array of templates to use for rendering FieldHolder.

Return Value

array

array getFieldHolderTemplates()

Returns an array of templates to use for rendering FieldHolder.

Return Value

array

array getSmallFieldHolderTemplates()

Returns an array of templates to use for rendering SmallFieldHolder.

Return Value

array

protected array _templates(string $customTemplate = null, string $customTemplateSuffix = null)

Generate an array of class name strings to use for rendering this form field into HTML.

Parameters

string $customTemplate
string $customTemplateSuffix

Return Value

array

bool isComposite()

Returns true if this field is a composite field.

To create composite field types, you should subclass CompositeField.

Return Value

bool

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.

Return Value

bool

See also

FieldList::collateDataFields

bool isReadonly()

No description

Return Value

bool

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

Parameters

bool $readonly

Return Value

$this

bool isDisabled()

No description

Return Value

bool

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

Parameters

bool $disabled

Return Value

$this

bool isAutofocus()

No description

Return Value

bool

$this setAutofocus(bool $autofocus)

Sets a autofocus flag on this FormField.

Parameters

bool $autofocus

Return Value

$this

FormField performReadonlyTransformation()

No description

Return Value

FormField

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

Return Value

FormField

mixed transform(FormTransformation $transformation)

No description

Parameters

FormTransformation $transformation

Return Value

mixed

bool hasClass(string $class)

Returns whether the current field has the given class added

Parameters

string $class

Return Value

bool

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.

Return Value

string

See also

{@link getAttributes()}.

bool validate(Validator $validator)

Validate this field

Parameters

Validator $validator

Return Value

bool

$this setDescription(string $description)

Describe this field, provide help text for it.

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

Parameters

string $description

Return Value

$this

string getDescription()

No description

Return Value

string

string debug()

No description

Return Value

string

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.

Return Value

string

bool Required()

No description

Return Value

bool

$this setContainerFieldList(FieldList $containerFieldList)

Set the FieldList that contains this field.

Parameters

FieldList $containerFieldList

Return Value

$this

FieldList getContainerFieldList()

Get the FieldList that contains this field.

Return Value

FieldList

null|FieldList rootFieldList()

No description

Return Value

null|FieldList

FormField castedCopy(mixed $classOrCopy)

Returns another instance of this field, but "cast" to a different class.

Parameters

mixed $classOrCopy

Class name for copy, or existing copy instance to update

Return Value

FormField

bool canSubmitValue()

Determine if the value of this formfield accepts front-end submitted values and is saveable.

Return Value

bool

FormField setSchemaComponent(string $componentType)

Sets the component type the FormField will be rendered as on the front-end.

Parameters

string $componentType

Return Value

FormField

string getSchemaComponent()

Gets the type of front-end component the FormField will be rendered as.

Return Value

string

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 getSchemaDataDefaults(). Any passed keys that are not defined in getSchemaDataDefaults() are ignored. If you want to pass around ad hoc data use the data array e.g. pass ['data' => ['myCustomKey' => 'yolo']].

Add deep merging of arrays like `data` and `attributes`.

Parameters

array $schemaData
  • The data to be merged with $this->schemaData.

Return Value

FormField

array getSchemaData()

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

Return Value

array

string getSchemaDataType()

No description

Throw exception if value is missing, once a form field schema is mandatory across the CMS

Return Value

string

array getSchemaDataDefaults()

Gets the defaults for $schemaData.

The keys defined here are immutable, meaning undefined keys passed to setSchemaData() are ignored. Instead the data array should be used to pass around ad hoc data.

Return Value

array

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 getSchemaStateDefaults(). Any passed keys that are not defined in getSchemaStateDefaults() are ignored. If you want to pass around ad hoc data use the data array e.g. pass ['data' => ['myCustomKey' => 'yolo']].

Add deep merging of arrays like `data` and `attributes`.

Parameters

array $schemaState

The data to be merged with $this->schemaData.

Return Value

FormField

array getSchemaState()

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

Return Value

array

array getSchemaStateDefaults()

Gets the defaults for $schemaState.

The keys defined here are immutable, meaning undefined keys passed to 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 Form, and Form->validate() has been called.

Return Value

array

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.

Return Value

array

Tip|null getTitleTip()

No description

Return Value

Tip|null

FormField setTitleTip(Tip|null $tip)

No description

Parameters

Tip|null $tip

Return Value

FormField

$this setDisabledItems(array|SS_List $items)

Mark certain elements as disabled, regardless of the setDisabled() settings.

These should be items that appear in the source list, not in addition to them.

Parameters

array|SS_List $items

Collection of values or items

Return Value

$this

array getDisabledItems()

Non-associative list of disabled item values

Return Value

array

protected bool isDisabledValue(string $value)

Check if the given value is disabled

Parameters

string $value

Return Value

bool

protected array getSourceValues()

Retrieve all values in the source array

Return Value

array

array getValidValues()

Gets all valid values for this field.

Does not include "empty" value if specified

Return Value

array

array|ArrayAccess getSource()

Gets the source array not including any empty default values.

Return Value

array|ArrayAccess

$this setSource(mixed $source)

Set the source for this list

Parameters

mixed $source

Return Value

$this

protected array getListMap(mixed $source)

Given a list of values, extract the associative map of id => title

Parameters

mixed $source

Return Value

array

Associative array of ids and titles

protected array getListValues(mixed $values)

Given a non-array collection, extract the non-associative list of ids If passing as array, treat the array values (not the keys) as the ids

Parameters

mixed $values

Return Value

array

Non-associative list of values

bool isSelectedValue(mixed $dataValue, mixed $userValue)

Determine if the current value of this field matches the given option value

Parameters

mixed $dataValue

The value as extracted from the source of this field (or empty value if available)

mixed $userValue

The value as submitted by the user

Return Value

bool

True if the selected value matches the given option value

getDefaultValue()

No description

SingleSelectField setHasEmptyDefault(bool $bool)

No description

Parameters

bool $bool

Return Value

SingleSelectField

Self reference

bool getHasEmptyDefault()

A required DropdownField must have a user selected attribute, so require an empty default for a required field

Return Value

bool

$this setEmptyString(string $string)

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

Defaults to an empty string. Automatically sets $hasEmptyDefault to true.

Parameters

string $string

Return Value

$this

string getEmptyString()

No description

Return Value

string

array|ArrayAccess getSourceEmpty()

Gets the source array, including the empty string, if present

Return Value

array|ArrayAccess

protected ArrayData getFieldOption(mixed $value, string $title)

Build a field option for template rendering

Parameters

mixed $value

Value of the option

string $title

Title of the option

Return Value

ArrayData

Field option