Form

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

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

Register an callback to invoke that defines extra methods

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

Determines if a custom method with this name is defined.

Get meta-data details on a named method

Return the names of all the methods available on this object

Get all public built in methods for this class

Find all methods on the given object.

Add all the methods from an object property.

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

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)

Add callback as a method.

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

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

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

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

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.

No description

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

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.

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

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

Gets the uninherited value for the given config option

Create a new form, with the given fields an action buttons.

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

No description

No description

No description

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.

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

No description

No description

No description

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

Generate the cache name for a field

Get a cached value from the field cache

Store a value in the field cache

Clear object cache

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

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

Set an HTML attribute

Retrieve the value of an HTML attribute

No description

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.

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.

Returns the field message, used by form validation.

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

Appends a message to the existing message if the types and casts match.

If either is different, the $force argument determines the behaviour.

Note: to prevent duplicates, we check for the $message string in the existing message. If the existing message contains $message as a substring, it won't be added.

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

Get form schema encoded message

No description

No description

Load form state from session state

Flush persistent form state details

Helper to get current request for this form

Get session for this form

Return any form data stored in the session

Store the given form data in the session

Return any ValidationResult instance stored for this object

Sets the ValidationResult in the session to be used with the next view of this form.

Clear form message (and in session)

Populate this form with messages from the given ValidationResult.

Note: This will try not to clear any pre-existing messages, but will clear them if a new message has a different message type or cast than the existing ones.

Set message on a given field name. This message will not persist via redirect.

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

No description

Overrules validation error behaviour in httpSubmission() when validation has failed. Useful for optional handling of a certain accepted content type.

The callback can opt out of handling specific responses by returning NULL, in which case the default form behaviour will kick in.

Convert this form into a readonly form

Set whether the user should be redirected back down to the form on the page upon validation errors in the form or if they just need to redirect back to the page

Get whether the user should be redirected back down to the form on the page upon validation errors

No description

Get the Validator attached to this form.

Set the Validator on this form.

Remove the Validator from this from.

Set actions that are exempt from validation

Get a list of actions that are exempt from validation

Passed a FormAction, returns true if that action is exempt from Form validation

Generate extra special fields - namely the security token field (if required).

Return the form's fields - used by the templates

Return all fields in a form - including fields nested in CompositeFields.

Useful when doing custom field layouts.

Return all fields except for the hidden fields.

Useful when making your own simplified form layouts.

Setter for the form fields.

Return the form's action buttons - used by the templates

Setter for the form actions.

Unset all form actions

No description

Set the target of this form to any value - useful for opening the form contents in a new window or refreshing another frame

Return a FormTemplateHelper for this form. If one has not been set, return the default helper.

Set the target of this form to any value - useful for opening the form contents in a new window or refreshing another frame.

Set the legend value to be inserted into the

element in the Form.ss template.

Set the SS template that this form should use to render with. The default is "Form".

Return the template to render this form with.

Returns the ordered list of preferred templates for rendering this form If the template isn't set, then default to the form class name e.g "Form".

Returns the encoding type for the form.

By default this will be URL encoded, unless there is a file field present in which case multipart is used. You can also set the enc type using setEncType.

Sets the form encoding type. The most common encoding types are defined in ENC_TYPE_URLENCODED} and {@link ENC_TYPE_MULTIPART.

Returns the real HTTP method for the form: GET, POST, PUT, DELETE or HEAD.

As most browsers only support GET and POST in form submissions, all other HTTP methods are added as a hidden field "_method" that gets evaluated in HTTPRequest::detect_method(). See FormMethod() to get a HTTP method for safe insertion into a tag.

Returns the form method to be used in the tag.

See FormHttpMethod() to get the "real" method.

Set the form method: GET, POST, PUT, DELETE.

If set to true (the default), enforces the matching of the form method.

This will mean two things:

• GET vars will be ignored by a POST form, and vice versa
• A submission where the HTTP method used doesn't match the form will return a 400 error.

If set to false then the form method is only used to construct the default form.

No description

Return the form's action attribute.

This is build by adding an executeForm get variable to the parent controller's Link() value

Set the form action attribute to a custom URL.

Note: For "normal" forms, you shouldn't need to use this method. It is recommended only for situations where you have two relatively distinct parts of the system trying to communicate via a form post.

Returns the name of the form.

Set the HTML ID attribute of the form.

No description

Get the controller or parent request handler.

Set the controller or parent request handler.

Get the name of the form.

Set the name of the form.

Returns an object where there is a method with the same name as each data field on the form.

That method will return the field itself.

It means that you can execute $firstName = $form->FieldMap()->FirstName()

Set a message to the session, for display next time this form is shown.

Set an error to the session, for display next time this form is shown.

Set an error message for a field in the session, for display next time this form is shown.

Returns the record that has given this form its data through loadDataFrom().

Get the legend value to be inserted into the

Alias of validate() for backwards compatibility.

Processing that occurs before a form is executed.

This includes form validation, if it fails, we throw a ValidationException

This includes form validation, if it fails, we redirect back to the form with appropriate error messages. Always return true if the current form action is exempt from validation

Triggered through httpSubmission().

Note that CSRF protection takes place in httpSubmission(), if it fails the form data will never reach this method.

Load data from the given record or array.

It will call $object->MyField to get the value of MyField. If you passed an array, it will call $object[MyField]. Doesn't save into dataless FormFields (DatalessField), as determined by FieldList->dataFields().

By default, if a field isn't set (as determined by isset()), its value will not be saved to the field, retaining potential existing values.

Passed data should not be escaped, and is saved to the FormField instances unescaped. Escaping happens automatically on saving the data through saveInto().

Escaping happens automatically on saving the data through saveInto().

Save the contents of this form into the given data object.

It will make use of setCastedField() to do this.

Get the submitted data from this form through FieldList->dataFields(), which filters out any form-specific data like form-actions.

Calls FormField->dataValue() on each field, which returns a value suitable for insertion into a record property.

Return a rendered version of this form.

This is returned when you access a form as $FormObject rather than <% with FormObject %>

Return a rendered version of this form, suitable for ajax post-back.

It triggers slightly different behaviour, such as disabling the rewriting of # links.

Render this form using the given template, and return the result as a string You can pass either an SSViewer or a template name

Return the default button that should be clicked when another one isn't available.

Disable the default button.

Ordinarily, when a form is processed and no action_XXX button is available, then the first button in the actions list will be pressed. However, if this is "delete", for example, this isn't such a good idea.

Disable the requirement of a security token on this form instance. This security protects against CSRF attacks, but you should disable this if you don't want to tie a form to a session - eg a search form.

Check for token state with getSecurityToken() and SecurityToken->isEnabled().

Enable SecurityToken protection for this form instance.

Check for token state with getSecurityToken() and SecurityToken->isEnabled().

Returns the security token for this form (if any exists).

Doesn't check for securityTokenEnabled().

Use SecurityToken::inst() to get a global token.

Compiles all CSS-classes.

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

Add a CSS-class to the form-container. If needed, multiple classes can be added by delimiting a string with spaces.

Remove a CSS-class from the form-container. Multiple class names can be passed through as a space delimited string

No description

Get request handler for this form

Assign a specific request handler for this form

Scaffold new request handler for this form

Can the body of this form be cached?