class GridFieldDetailForm implements GridField_URLHandler (View source)

Provides view and edit forms at GridField-specific URLs.

These can be placed into pop-ups by an appropriate front-end.

Usually added to a {@link GridField} alongside of a {@link GridFieldEditButton} which takes care of linking the individual rows to their edit view.

The URLs provided will be off the following form:

  • /field//item/
  • /field//item//edit

Traits

Allows an object to have extensions applied to it.

A class that can be instantiated or replaced via DI

A trait that makes a class able to consume and use a {@link GridFieldStateManagerInterface} implementation

Allows an object to declare a set of custom methods

Properties

static private array $extensions

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

from  Extensible

Methods

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

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

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

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

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

Get extra config sources for this class

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

Return TRUE if a class has a specified extension.

array
invokeWithExtensions(string $method, mixed ...$arguments)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

array
extend(string $method, mixed ...$arguments)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

bool
hasExtension(string $extension)

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

getExtensionInstances()

Get all extension instances for this specific object instance.

static Injectable
create(array ...$args)

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

static Injectable
singleton(string $class = null)

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

getStateManager()

Fallback on the direct Injector access, but allow a custom implementation to be applied

array
getURLHandlers(GridField $gridField)

Return URLs to be handled by this grid field, in an array the same form as $url_handlers.

__construct(string $name = null, bool $showPagination = null, bool $showAdd = null)

Create a popup component. The two arguments will specify how the popup form's HTML and behaviour is created. The given controller will be customised, putting the edit form into the template with the given name.

handleItem(GridField $gridField, HTTPRequest $request)

No description

$this
setTemplate(string $template)

No description

string
getTemplate()

No description

$this
setName(string $name)

No description

string
getName()

No description

bool
getShowPagination()

No description

setShowPagination(bool|null $showPagination)

No description

bool
getShowAdd()

No description

setShowAdd(bool|null $showAdd)

No description

$this
setValidator(Validator $validator)

No description

getValidator()

No description

$this
setFields(FieldList $fields)

No description

getFields()

No description

$this
setItemRequestClass(string $class)

No description

string
getItemRequestClass()

No description

$this
setItemEditFormCallback(Closure $cb)

No description

getItemEditFormCallback()

No description

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

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

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

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

Map of method names with lowercase keys

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

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of {@link Object}

string $extension

Subclass of {@link 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 {@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.

Parameters

string $extension

class name of an {@link Extension} subclass, without parameters

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

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 {@link 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 ...$arguments)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

Parameters

string $method

the method name to call

mixed ...$arguments

List of arguments

Return Value

array

List of results with nulls filtered out

array extend(string $method, mixed ...$arguments)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during {@link __construct()} in {@link defineMethods()}.

Parameters

string $method

the name of the method to call on each extension

mixed ...$arguments

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

Parameters

string $extension

Classname of an {@link Extension} subclass without parameters

Return Value

bool

Extension[] getExtensionInstances()

Get all extension instances for this specific object instance.

See {@link get_extensions()} to get all applied extension classes for this class (not the instance).

This method also provides lazy-population of the extension_instances property.

Return Value

Extension[]

Map of {@link DataExtension} instances, keyed by classname.

static Injectable create(array ...$args)

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

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Parameters

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

GridFieldStateManagerInterface getStateManager()

Fallback on the direct Injector access, but allow a custom implementation to be applied

array getURLHandlers(GridField $gridField)

Return URLs to be handled by this grid field, in an array the same form as $url_handlers.

Handler methods will be called on the component, rather than the {@link GridField}.

Parameters

GridField $gridField

Return Value

array

__construct(string $name = null, bool $showPagination = null, bool $showAdd = null)

Create a popup component. The two arguments will specify how the popup form's HTML and behaviour is created. The given controller will be customised, putting the edit form into the template with the given name.

The arguments are experimental API's to support partial content to be passed back to whatever controller who wants to display the getCMSFields

Parameters

string $name

The name of the edit form to place into the pop-up form

bool $showPagination

Whether the Previous and Next buttons should display or not, leave as null to use default

bool $showAdd

Whether the Add button should display or not, leave as null to use default

HTTPResponse handleItem(GridField $gridField, HTTPRequest $request)

Parameters

GridField $gridField
HTTPRequest $request

Return Value

HTTPResponse

$this setTemplate(string $template)

Parameters

string $template

Return Value

$this

string getTemplate()

Return Value

string

$this setName(string $name)

Parameters

string $name

Return Value

$this

string getName()

Return Value

string

bool getShowPagination()

Return Value

bool

GridFieldDetailForm setShowPagination(bool|null $showPagination)

Parameters

bool|null $showPagination

Return Value

GridFieldDetailForm

bool getShowAdd()

Return Value

bool

GridFieldDetailForm setShowAdd(bool|null $showAdd)

Parameters

bool|null $showAdd

Return Value

GridFieldDetailForm

$this setValidator(Validator $validator)

Parameters

Validator $validator

Return Value

$this

Validator getValidator()

Return Value

Validator

$this setFields(FieldList $fields)

Parameters

FieldList $fields

Return Value

$this

FieldList getFields()

Return Value

FieldList

$this setItemRequestClass(string $class)

Parameters

string $class

Return Value

$this

string getItemRequestClass()

Return Value

string

name of {see \SilverStripe\Forms\GridField\GridFieldDetailForm_ItemRequest} subclass

$this setItemEditFormCallback(Closure $cb)

Parameters

Closure $cb

Make changes on the edit form after constructing it.

Return Value

$this

Closure getItemEditFormCallback()

Return Value

Closure