GridFieldDetailForm
class GridFieldDetailForm extends AbstractGridFieldComponent 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 GridField alongside of a 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 trait that makes a class able to consume and use a GridFieldStateManagerInterface implementation
Allows an object to declare a set of custom methods
A class that can be instantiated or replaced via DI
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 | GridFieldStateManagerInterface | $stateManager | from GridFieldStateAware | |
| protected | string | $template | ||
| protected | string | $name | ||
| protected | bool | $showPagination | ||
| protected | bool | $showAdd | ||
| protected | Validator | $validator | ||
| protected | FieldList | $fields | ||
| protected | string | $itemRequestClass | ||
| protected | bool | $redirectMissingRecords | If true, will redirect to missing records if they are found elsewhere |
|
| protected | callable | $itemEditFormCallback |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Adds any methods from Extension instances attached to this object.
Register an callback to invoke that defines extra methods
Return TRUE if a method exists on this object
Get meta-data details on a named method
Return the names of all the methods available on this object
Add all the methods from an object property (which is an Extension) to this object.
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.
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in $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.
Get all extension instances for this specific object instance.
Fallback on the direct Injector access, but allow a custom implementation to be applied
Return URLs to be handled by this grid field, in an array the same form as $url_handlers.
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.
Try and find another URL at which the given record can be edited.
Build a request handler for the given record
Enable redirection to missing records.
Details
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();
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).
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()
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
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
protected array
getExtraMethodConfig(string $method)
Get meta-data details on a named method
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
protected array
findMethodsFromExtension(object $extension)
deprecated
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
deprecated
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()).
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.
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.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
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
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().
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 $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(
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.
GridFieldStateAware
setStateManager(GridFieldStateManagerInterface $manager)
No description
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 GridField.
__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
HTTPResponse
handleItem(GridField $gridField, HTTPRequest $request)
No description
protected DataObject|null
getRecordFromRequest(GridField $gridField, HTTPRequest $request)
No description
string|null
getLostRecordRedirection(GridField $gridField, HTTPRequest $request, int|null $id = null)
Try and find another URL at which the given record can be edited.
If redirectMissingRecords is true and the record has a CMSEditLink method, that value will be returned. This only works when the list passed to the GridField is a DataList.
protected GridFieldDetailForm_ItemRequest
getItemRequestHandler(GridField $gridField, DataObject $record, RequestHandler $requestHandler)
Build a request handler for the given record
$this
setTemplate(string $template)
No description
string
getTemplate()
No description
$this
setName(string $name)
No description
string
getName()
No description
GridFieldDetailForm
setRedirectMissingRecords(bool $redirectMissingRecords)
Enable redirection to missing records.
If a GridField shows a filtered list, and the DataObject is not in the list but exists in the database, and the DataObject has a CMSEditLink method, then the system will redirect to the URL returned by that method.
bool
getRedirectMissingRecords()
Return the status of redirection to missing records.
protected bool
getDefaultShowPagination()
No description
bool
getShowPagination()
No description
GridFieldDetailForm
setShowPagination(bool|null $showPagination)
No description
protected bool
getDefaultShowAdd()
No description
bool
getShowAdd()
No description
GridFieldDetailForm
setShowAdd(bool|null $showAdd)
No description
$this
setValidator(Validator $validator)
No description
Validator
getValidator()
No description
$this
setFields(FieldList $fields)
No description
FieldList
getFields()
No description
$this
setItemRequestClass(string $class)
No description
string
getItemRequestClass()
No description
$this
setItemEditFormCallback(Closure $cb)
No description
Closure
getItemEditFormCallback()
No description