abstract class ModelAdmin extends LeftAndMain (View source)

Generates a three-pane UI for editing model classes, with an automatically generated search panel, tabular results and edit forms.

Relies on data such as {@link DataObject::$db} and {@link DataObject::getCMSFields()} to scaffold interfaces "out of the box", while at the same time providing flexibility to customize the default output.

Properties

static private array $extensions

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

from  SS_Object
string $class from  SS_Object
static private array $casting

An array of objects to cast certain fields to. This is set up as an array in the format:

from  ViewableData
static private string $default_cast

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

from  ViewableData
static private string $url_segment

The current url segment attached to the LeftAndMain instance

from  LeftAndMain
static private $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
static private $allowed_actions

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

from  RequestHandler
static private bool $require_allowed_actions from  RequestHandler
static private string $url_base

The 'base' url for CMS administration areas.

from  LeftAndMain
static private string $url_rule from  LeftAndMain
static private string $menu_title from  LeftAndMain
static private string $menu_icon from  LeftAndMain
static private int $menu_priority from  LeftAndMain
static private int $url_priority from  LeftAndMain
static private string $tree_class

A subclass of {@link DataObject}.

from  LeftAndMain
$help_link

The url used for the link in the Help tab in the backend

from  LeftAndMain
static private array $required_permission_codes from  LeftAndMain
static private string $session_namespace from  LeftAndMain
static private array $extra_requirements_javascript

Register additional requirements through the {@link Requirements} class.

from  LeftAndMain
static private array $extra_requirements_css

YAML configuration example: LeftAndMain: extra_requirements_css: mysite/css/mystyle.css: media: screen

from  LeftAndMain
static private array $extra_requirements_themedCss from  LeftAndMain
static private bool $session_keepalive_ping

If true, call a keepalive ping every 5 minutes from the CMS interface, to ensure that the session never dies.

from  LeftAndMain
static private string $frame_options

Value of X-Frame-Options header

from  LeftAndMain
$application_link

The href for the anchor on the Silverstripe logo.

from  LeftAndMain
static private string $application_name

The application name. Customisable by calling LeftAndMain::setApplicationName() - the first parameter.

from  LeftAndMain
static private array|string $managed_models

List of all managed {@link DataObject}s in this interface.

$showImportForm

Change this variable if you don't want the Import from CSV form to appear.

$showSearchForm

Change this variable if you don't want the search form to appear.

static private array $model_importers

List of all {@link DataObject}s which can be imported through a subclass of {@link BulkLoader} (mostly CSV data).

static private int $page_length

Amount of results showing on a single page.

Methods

static Config_ForClass|null
config()

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

static SS_Object
create()

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

static SS_Object
singleton()

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

static 
create_from_string($classSpec, $firstArg = null)

Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

static 
parse_class_spec($classSpec)

Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

static SS_Object
strong_create()

Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}

static 
useCustomClass(string $oldClass, string $newClass, bool $strong = false)

This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}

static string
getCustomClass(string $class)

If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

static any
static_lookup($class, $name, null $default = null)

Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

static 
get_static($class, $name, $uncached = false) deprecated

No description

static 
set_static($class, $name, $value) deprecated

No description

static 
uninherited_static($class, $name, $uncached = false) deprecated

No description

static 
combined_static($class, $name, $ceiling = false) deprecated

No description

static 
addStaticVars($class, $properties, $replace = false) deprecated

No description

static 
add_static_var($class, $name, $value, $replace = false) deprecated

No description

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

Return TRUE if a class has a specified extension.

static 
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, bool $includeArgumentString = false)

No description

static 
get_extra_config_sources($class = null)

No description

__construct()

No description

mixed
__call(string $method, array $arguments)

Attemps 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

stat($name, $uncached = false)

No description

set_stat($name, $value)

No description

uninherited($name)

No description

bool
exists()

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

string
parentClass()

No description

bool
is_a(string $class)

Check if this class is an instance of a specific class, or has that class as one of its parents

string
__toString()

No description

mixed
invokeWithExtensions(string $method, mixed $argument = null)

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

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.

array
getExtensionInstances()

Get all extension instances for this specific object instance.

mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

static string
castingObjectCreator(string $fieldSchema)

Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".

static array
castingObjectCreatorPair(string $fieldSchema)

Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.

bool
__isset(string $property)

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

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

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

setFailover(ViewableData $failover)

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

getFailover()

Get the current failover object if set

bool
hasField(string $field)

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

mixed
getField(string $field)

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

setField(string $field, mixed $value)

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

defineMethods()

Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.

unknown
deprecatedCachedCall($method, $args = null, string $identifier = null)

Method to facilitate deprecation of underscore-prefixed methods automatically being cached.

customise(array|ViewableData $data)

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

setCustomisedObj(ViewableData $object)

No description

array
castingHelperPair(string $field)

Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).

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.

string
castingClass(string $field)

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

string
escapeTypeForField(string $field)

Return the string-format type for the given field.

buildCastingCache(reference $cache)

Save the casting cache for this object (including data from any failovers) into a variable

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

obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, 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.

cachedCall(string $field, array $arguments = null, string $identifier = null)

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

bool
hasValue(string $field, array $arguments = null, 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.

XML_val($field, $arguments = null, $cache = false)

Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.

RAW_val($field, $arguments = null, $cache = true)

Return the value of the field without any escaping being applied.

SQL_val($field, $arguments = null, $cache = true)

Return the value of a field in an SQL-safe format.

JS_val($field, $arguments = null, $cache = true)

Return the value of a field in a JavaScript-save format.

ATT_val($field, $arguments = null, $cache = true)

Return the value of a field escaped suitable to be inserted into an XML node attribute.

array
getXMLValues($fields)

Get an array of XML-escaped values by field name

getIterator()

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

Me()

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

string
ThemeDir(string $subtheme = false)

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

string
CSSClasses(string $stopAtClass = 'ViewableData')

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

Debug()

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

setDataModel($model)

Set the DataModel for this request.

handleRequest(SS_HTTPRequest $request, DataModel $model = null)

Executes this controller, and return an {@link SS_HTTPResponse} object with the result.

array|null
allowedActions(string $limitToClass = null)

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

bool
hasAction(string $action)

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

checkAccessAction($action)

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

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

Throws a HTTP error response encased in a {@link SS_HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.

getRequest()

Returns the SS_HTTPRequest object that this controller is using.

setRequest($request)

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

string
Link($action = null)

You should implement a Link() function in your subclass of LeftAndMain, to point to the URL of that particular controller.

init()

Initialize the model admin interface. Sets up embedded jquery libraries and requisite plugins.

setURLParams($urlParams)

No description

array
getURLParams()

No description

getResponse()

Returns the SS_HTTPResponse object that this controller is building up.

setResponse(SS_HTTPResponse $response)

Sets the SS_HTTPResponse object that this controller is building up.

getFormOwner()

Return the object that is going to own a form that's being processed, and handle its execution.

defaultAction($action)

This is the default action handler used if a method doesn't exist.

getAction()

Returns the action that is being executed on this controller.

getViewer($action)

Return an SSViewer object to process the data

static string
removeAction($fullURL, $action = null)

Removes all the "action" part of the current URL and returns the result.

bool
hasActionTemplate(string $action)

Returns TRUE if this controller has a template that is specifically designed to handle a specific action.

string
render(array $params = null)

Render the current controller with the templates determined by {@link getViewer()}.

disableBasicAuth()

Call this to disable site-wide basic authentication for a specific contoller.

static Controller
curr()

Returns the current controller

static bool
has_curr()

Tests whether we have a currently active controller or not

bool
can($perm, $member = null)

Returns true if the member is allowed to do the given action.

pushCurrent()

Pushes this controller onto the stack of current controllers.

popCurrent()

Pop this controller off the top of the stack.

redirect($url, $code = 302)

Overloaded redirection logic to trigger a fake redirect on ajax requests.

redirectBack()

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

string
redirectedTo()

Tests whether a redirection has been requested.

getSession()

Get the Session object representing this Controller's session

setSession(Session $session)

Set the Session object.

static string
join_links()

Joins two or more link segments together, putting a slash between them if necessary.

static array
get_template_global_variables()

Called by SSViewer to get a list of global variables to expose to the template, the static method to call on this class to get the value for those variables, and the class to use for casting the returned value for use in a template

bool
canView(Member $member = null)

No description

index($request)

No description

bool
ShowSwitchView()

If this is set to true, the "switchView" context in the template is shown, with links to the staging and publish site.

static 
menu_title_for_class($class)

Returns the menu title for the given LeftAndMain subclass.

static string
menu_icon_for_class(string $class)

Return styling for the menu icon, if a custom icon is set for this class

show($request)

No description

MainMenu($cached = true)

Returns the main menu of the CMS. This is also used by init() to work out which sections the user has access to.

Menu()

No description

MenuCurrentItem()

No description

array
getTemplatesWithSuffix($suffix)

Return a list of appropriate templates for this class, with the given suffix using {@link SSViewer::get_templates_by_class()}

Content()

No description

getRecord($id)

No description

Breadcrumbs($unlinked = false)

No description

string
SiteTreeAsUL()

No description

string
getSiteTreeFor(string $className, int $rootID = null, string $childrenMethod = null, $numChildrenMethod = null, $filterFunction = null, $nodeCountThreshold = 30)

Get a site tree HTML listing which displays the nodes under the given criteria.

getsubtree($request)

Get a subtree underneath the request param 'ID'.

string
updatetreenodes($request)

Allows requesting a view update on specific tree nodes.

save($data, $form)

Save handler

delete($data, $form)

No description

savetreenode($request)

Update the position and parent of a tree node.

CanOrganiseSitetree()

No description

EditForm($request = null)

No description

getEditForm(int $id = null, FieldList $fields = null)

Calls {@link SiteTree->getCMSFields()}

EmptyForm()

Returns a placeholder form, used by {@link getEditForm()} if no record is selected.

EditorToolbar()

Return the CMS's HTML-editor toolbar

string
Tools()

Renders a panel containing tools which apply to all displayed "content" (mostly through {@link EditForm()}), for example a tree navigation or a filter panel.

string
EditFormTools()

Renders a panel containing tools which apply to the currently displayed edit form.

batchactions()

Batch Actions Handler

BatchActionsForm()

No description

printable()

No description

getSilverStripeNavigator()

Used for preview controls, mainly links which switch between different states of the page.

int
currentPageID()

Identifier for the currently shown record, in most cases a database ID. Inspects the following sources (in this order):

  • GET/POST parameter named 'ID'
  • URL parameter named 'ID'
  • Session value namespaced by classname, e.g. "CMSMain.currentPage"

setCurrentPageID(int $id)

Forces the current page to be set in session, which can be retrieved later through {@link currentPageID()}.

currentPage()

Uses {@link getRecord()} and {@link currentPageID()} to get the currently selected record.

bool
isCurrentPage(DataObject $record)

Compares a given record to the currently selected one (if any).

string|bool
LinkPreview()

URL to a previewable record which is shown through this controller.

string
CMSVersion()

Return the version number of the core packages making up this application, using the {@link SilverStripeVersionProvider}.

array
SwitchView()

No description

SiteConfig()

No description

static 
set_application_link(string $link) deprecated

Sets the href for the anchor on the Silverstripe logo in the menu

string
ApplicationLink()

No description

static 
setApplicationName(string $name) deprecated

No description

string
getApplicationName()

Get the application name.

string
Title()

No description

string
SectionTitle()

Return the title of the current section. Either this is pulled from the current panel's menu_title or from the first active menu

MceRoot()

Return the base directory of the tiny_mce codebase

string
BaseCSSClasses()

Same as {@link ViewableData->CSSClasses()}, but with a changed name to avoid problems when using {@link ViewableData->customise()} (which always returns "ArrayData" from the $original object).

string
Locale()

No description

providePermissions()

Return a map of permission codes to add to the dropdown shown in the Security section of the CMS.

static 
require_javascript($file) deprecated

Register the given javascript file as required in the CMS.

static 
require_css($file, $media = null) deprecated

Register the given stylesheet file as required.

static 
require_themed_css($name, $media = null) deprecated

Register the given "themeable stylesheet" as required.

array
getExportFields()

Define which fields are used in the {@link getEditForm} GridField export.

getSearchContext()

No description

Form|bool
SearchForm()

No description

getList()

No description

array
getManagedModels()

No description

array
getModelImporters()

Returns all importers defined in {@link self::$model_importers}.

Form|bool
ImportForm()

Generate a CSV import form for a single {@link DataObject} subclass.

bool|null
import(array $data, Form $form, SS_HTTPRequest $request)

Imports the submitted CSV file based on specifications given in {@link self::model_importers}.

static 
set_page_length($length) deprecated

overwrite the static page_length of the admin panel, should be called in the project _config file.

static 
get_page_length() deprecated

Return the static page_length of the admin, default as 30

Details

static Config_ForClass|null config()

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

Return Value

Config_ForClass|null

static SS_Object create()

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

This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use {@link Object::useCustomClass()}

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

Return Value

SS_Object

static SS_Object singleton()

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

Return Value

SS_Object

The singleton instance

static create_from_string($classSpec, $firstArg = null)

Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.

Object::create_from_string("Versioned('Stage','Live')") will return the result of Versioned::create('Stage', 'Live);

It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.

If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.

Object::create_from_string("Varchar(50)", "MyField") will return the result of Vachar::create('MyField', '50');

Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.

Parameters

$classSpec
$firstArg

static parse_class_spec($classSpec)

Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

Returns a 2-elemnent array, with classname and arguments

Parameters

$classSpec

static SS_Object strong_create()

Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}

Return Value

SS_Object

static useCustomClass(string $oldClass, string $newClass, bool $strong = false)

This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}

Parameters

string $oldClass

the class to replace

string $newClass

the class to replace it with

bool $strong

allows you to enforce a certain class replacement under all circumstances. This is used in singletons and DB interaction classes

static string getCustomClass(string $class)

If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

Parameters

string $class

the class to check

Return Value

string

the class that would be created if you called {@link Object::create()} with the class

static any static_lookup($class, $name, null $default = null)

Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

Parameters

$class
  • The class to get the static from
$name
  • The property to get from the class
null $default
  • The value to return if property doesn't exist on class

Return Value

any
  • The value of the static property $name on class $class, or $default if that property is not defined

static get_static($class, $name, $uncached = false) deprecated

deprecated

Parameters

$class
$name
$uncached

static set_static($class, $name, $value) deprecated

deprecated

Parameters

$class
$name
$value

static uninherited_static($class, $name, $uncached = false) deprecated

deprecated

Parameters

$class
$name
$uncached

static combined_static($class, $name, $ceiling = false) deprecated

deprecated

Parameters

$class
$name
$ceiling

static addStaticVars($class, $properties, $replace = false) deprecated

deprecated

Parameters

$class
$properties
$replace

static add_static_var($class, $name, $value, $replace = false) deprecated

deprecated

Parameters

$class
$name
$value
$replace

static 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

if 1 argument supplied, the class name of the extension to check for; if 2 supplied, the class name to test

string $requiredExtension

used only if 2 arguments supplied

bool $strict

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

static 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')"

See also

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

static remove_extension(string $extension)

Remove an extension from a class.

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

Classname of an {@link Extension} subclass, without parameters

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

Parameters

string $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} classnames, or eval'ed classname strings with constructor arguments.

static get_extra_config_sources($class = null)

Parameters

$class

__construct()

mixed __call(string $method, array $arguments)

Attemps 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

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

stat($name, $uncached = false)

Parameters

$name
$uncached

See also

SS_Object::get_static

set_stat($name, $value)

Parameters

$name
$value

See also

SS_Object::set_static

uninherited($name)

Parameters

$name

See also

SS_Object::uninherited_static

bool exists()

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

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

Return Value

bool

string parentClass()

Return Value

string

this classes parent class

bool is_a(string $class)

Check if this class is an instance of a specific class, or has that class as one of its parents

Parameters

string $class

Return Value

bool

string __toString()

Return Value

string

the class name

mixed invokeWithExtensions(string $method, mixed $argument = null)

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

a single argument to pass

Return Value

mixed

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 {@link __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 getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

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

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

Return Value

array

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

mixed cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

Parameters

string $method

the method name to cache

int $lifetime

the cache lifetime in seconds

string $ID

custom cache ID to use

array $arguments

an optional array of arguments

Return Value

mixed

the cached data

clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

static string castingObjectCreator(string $fieldSchema)

Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".

Parameters

string $fieldSchema

The field spec

Return Value

string

static array castingObjectCreatorPair(string $fieldSchema)

Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.

Parameters

string $fieldSchema

Return Value

array

bool __isset(string $property)

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

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

setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

defineMethods()

Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.

unknown deprecatedCachedCall($method, $args = null, string $identifier = null)

Method to facilitate deprecation of underscore-prefixed methods automatically being cached.

Parameters

$method
$args
string $identifier

an optional custom cache identifier

Return Value

unknown

ViewableData_Customised customise(array|ViewableData $data)

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

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

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

ViewableData getCustomisedObj()

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

array castingHelperPair(string $field)

Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).

The returned array contains two keys:

  • className: the class the field would be casted to (e.g. "Varchar")
  • castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")

Parameters

string $field

Return Value

array

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.

Parameters

string $field

Return Value

string

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'

buildCastingCache(reference $cache)

Save the casting cache for this object (including data from any failovers) into a variable

Parameters

reference $cache

HTMLText 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

HTMLText

obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, 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 $forceReturnedObject

if TRUE, the value will ALWAYS be casted to an object before being returned, even if there is no explicit casting information

bool $cache

Cache this object

string $cacheName

a custom cache name

cachedCall(string $field, array $arguments = null, string $identifier = null)

A simple wrapper around {@link 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

bool hasValue(string $field, array $arguments = null, 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

XML_val($field, $arguments = null, $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

$field
$arguments
$cache

RAW_val($field, $arguments = null, $cache = true)

Return the value of the field without any escaping being applied.

Parameters

$field
$arguments
$cache

SQL_val($field, $arguments = null, $cache = true)

Return the value of a field in an SQL-safe format.

Parameters

$field
$arguments
$cache

JS_val($field, $arguments = null, $cache = true)

Return the value of a field in a JavaScript-save format.

Parameters

$field
$arguments
$cache

ATT_val($field, $arguments = null, $cache = true)

Return the value of a field escaped suitable to be inserted into an XML node attribute.

Parameters

$field
$arguments
$cache

array getXMLValues($fields)

Get an array of XML-escaped values by field name

Parameters

$fields

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

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(string $subtheme = false)

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.

Parameters

string $subtheme

the subtheme path to get

Return Value

string

string CSSClasses(string $stopAtClass = 'ViewableData')

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

setDataModel($model)

Set the DataModel for this request.

Parameters

$model

SS_HTTPResponse|RequestHandler|string|array handleRequest(SS_HTTPRequest $request, DataModel $model = null)

Executes this controller, and return an {@link SS_HTTPResponse} object with the result.

This method first does a few set-up activities:

  • Push this controller ont to the controller stack - see {@link Controller::curr()} for information about this.
  • Call {@link init()}
  • Defer to {@link RequestHandler->handleRequest()} to determine which action should be executed

Note: $requestParams['executeForm'] support was removed, make the following change in your URLs: "/?executeForm=FooBar" -> "/FooBar" Also make sure "FooBar" is in the $allowed_actions of your controller class.

Note: You should rarely need to overload run() - this kind of change is only really appropriate for things like nested controllers - {@link ModelAsController} and {@link RootURLController} are two examples here. If you want to make more orthodox functionality, it's better to overload {@link init()} or {@link index()}.

Important: If you are going to overload handleRequest, make sure that you start the method with $this->pushCurrent() and end the method with $this->popCurrent(). Failure to do this will create weird session errors.

Parameters

SS_HTTPRequest $request

The {@link SS_HTTPRequest} object that is reponsible for distributing URL parsing

DataModel $model

Return Value

SS_HTTPResponse|RequestHandler|string|array

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

checkAccessAction($action)

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

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

Parameters

$action

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

Throws a HTTP error response encased in a {@link SS_HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.

Parameters

int $errorCode
string $errorMessage

Plaintext error message

SS_HTTPRequest|NullHTTPRequest getRequest()

Returns the SS_HTTPRequest object that this controller is using.

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

setRequest($request)

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

Parameters

$request

You should implement a Link() function in your subclass of LeftAndMain, to point to the URL of that particular controller.

Parameters

$action

Return Value

string

init()

Initialize the model admin interface. Sets up embedded jquery libraries and requisite plugins.

setURLParams($urlParams)

Parameters

$urlParams

array getURLParams()

Return Value

array

The parameters extracted from the URL by the {@link Director}.

getResponse()

Returns the SS_HTTPResponse object that this controller is building up.

Can be used to set the status code and headers

Controller setResponse(SS_HTTPResponse $response)

Sets the SS_HTTPResponse object that this controller is building up.

Parameters

SS_HTTPResponse $response

Return Value

Controller

getFormOwner()

Return the object that is going to own a form that's being processed, and handle its execution.

Note that the result needn't be an actual controller object.

defaultAction($action)

This is the default action handler used if a method doesn't exist.

It will process the controller object with the template returned by {@link getViewer()}

Parameters

$action

getAction()

Returns the action that is being executed on this controller.

SSViewer getViewer($action)

Return an SSViewer object to process the data

Parameters

$action

Return Value

SSViewer

The viewer identified being the default handler for this Controller/Action combination

static string removeAction($fullURL, $action = null)

Removes all the "action" part of the current URL and returns the result.

If no action parameter is present, returns the full URL

Parameters

$fullURL
$action

Return Value

string

bool hasActionTemplate(string $action)

Returns TRUE if this controller has a template that is specifically designed to handle a specific action.

Parameters

string $action

Return Value

bool

string render(array $params = null)

Render the current controller with the templates determined by {@link getViewer()}.

Parameters

array $params

Key-value array for custom template variables (Optional)

Return Value

string

Parsed template content

disableBasicAuth()

Call this to disable site-wide basic authentication for a specific contoller.

This must be called before Controller::init(). That is, you must call it in your controller's init method before it calls parent::init().

static Controller curr()

Returns the current controller

Return Value

Controller

static bool has_curr()

Tests whether we have a currently active controller or not

Return Value

bool

True if there is at least 1 controller in the stack.

bool can($perm, $member = null)

Returns true if the member is allowed to do the given action.

Parameters

$perm
$member

Return Value

bool

pushCurrent()

Pushes this controller onto the stack of current controllers.

This means that any redirection, session setting, or other things that rely on Controller::curr() will now write to this controller object.

popCurrent()

Pop this controller off the top of the stack.

SS_HTTPResponse redirect($url, $code = 302)

Overloaded redirection logic to trigger a fake redirect on ajax requests.

While this violates HTTP principles, its the only way to work around the fact that browsers handle HTTP redirects opaquely, no intervention via JS is possible. In isolation, that's not a problem - but combined with history.pushState() it means we would request the same redirection URL twice if we want to update the URL as well. See LeftAndMain.js for the required jQuery ajaxComplete handlers.

Parameters

$url
$code

Return Value

SS_HTTPResponse

redirectBack()

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

This variable is needed in scenarios where not HTTP-Referer is sent ( e.g when calling a page by location.href in IE). If none of the two variables is available, it will redirect to the base URL (see {@link Director::baseURL()}).

string redirectedTo()

Tests whether a redirection has been requested.

Return Value

string

If redirect() has been called, it will return the URL redirected to. Otherwise, it will return null;

Session getSession()

Get the Session object representing this Controller's session

Return Value

Session

setSession(Session $session)

Set the Session object.

Parameters

Session $session

Joins two or more link segments together, putting a slash between them if necessary.

Use this for building the results of {@link Link()} methods. If either of the links have query strings, then they will be combined and put at the end of the resulting url.

Caution: All parameters are expected to be URI-encoded already.

Return Value

string

static array get_template_global_variables()

Called by SSViewer to get a list of global variables to expose to the template, the static method to call on this class to get the value for those variables, and the class to use for casting the returned value for use in a template

If the method to call is not included for a particular template variable, a method named the same as the template variable will be called

If the casting class is not specified for a particular template variable, ViewableData::$default_cast is used

The first letter of the template variable is case-insensitive. However the method name is always case sensitive.

Return Value

array

Returns an array of items. Each key => value pair is one of three forms:

  • template name (no key)
  • template name => method name
  • template name => array(), where the array can contain these key => value pairs
    • "method" => method name
    • "casting" => casting class to use (i.e., Varchar, HTMLText, etc)

bool canView(Member $member = null)

Parameters

Member $member

Return Value

bool

index($request)

Parameters

$request

bool ShowSwitchView()

If this is set to true, the "switchView" context in the template is shown, with links to the staging and publish site.

Return Value

bool

static menu_title_for_class($class)

Returns the menu title for the given LeftAndMain subclass.

Implemented static so that we can get this value without instantiating an object. Menu title is not internationalised.

Parameters

$class

static string menu_icon_for_class(string $class)

Return styling for the menu icon, if a custom icon is set for this class

Example: static $menu-icon = '/path/to/image/';

Parameters

string $class

Return Value

string

show($request)

Parameters

$request

PjaxResponseNegotiator getResponseNegotiator()

Caution: Volatile API.

Return Value

PjaxResponseNegotiator

SS_List MainMenu($cached = true)

Returns the main menu of the CMS. This is also used by init() to work out which sections the user has access to.

Parameters

$cached

Return Value

SS_List

ArrayData MenuCurrentItem()

Return Value

ArrayData

A single menu entry (see {@link MainMenu})

array getTemplatesWithSuffix($suffix)

Return a list of appropriate templates for this class, with the given suffix using {@link SSViewer::get_templates_by_class()}

Parameters

$suffix

Return Value

array

getRecord($id)

Parameters

$id

ArrayList Breadcrumbs($unlinked = false)

Parameters

$unlinked

Return Value

ArrayList

string SiteTreeAsUL()

Return Value

string

HTML

string getSiteTreeFor(string $className, int $rootID = null, string $childrenMethod = null, $numChildrenMethod = null, $filterFunction = null, $nodeCountThreshold = 30)

Get a site tree HTML listing which displays the nodes under the given criteria.

Parameters

string $className

The class of the root object

int $rootID

The ID of the root object. If this is null then a complete tree will be shown

string $childrenMethod

The method to call to get the children of the tree. For example, Children, AllChildrenIncludingDeleted, or AllHistoricalChildren

$numChildrenMethod
$filterFunction
$nodeCountThreshold

Return Value

string

Nested unordered list with links to each page

getsubtree($request)

Get a subtree underneath the request param 'ID'.

If ID = 0, then get the whole tree.

Parameters

$request

string updatetreenodes($request)

Allows requesting a view update on specific tree nodes.

Similar to {@link getsubtree()}, but doesn't enforce loading all children with the node. Useful to refresh views after state modifications, e.g. saving a form.

Parameters

$request

Return Value

string

JSON

save($data, $form)

Save handler

Parameters

$data
$form

delete($data, $form)

Parameters

$data
$form

SS_HTTPResponse savetreenode($request)

Update the position and parent of a tree node.

Only saves the node if changes were made.

Required data:

  • 'ID': The moved node
  • 'ParentID': New parent relation of the moved node (0 for root)
  • 'SiblingIDs': Array of all sibling nodes to the moved node (incl. the node itself). In case of a 'ParentID' change, relates to the new siblings under the new parent.

Parameters

$request

Return Value

SS_HTTPResponse

JSON string with a

CanOrganiseSitetree()

Form EditForm($request = null)

Parameters

$request

Return Value

Form

Form getEditForm(int $id = null, FieldList $fields = null)

Calls {@link SiteTree->getCMSFields()}

Parameters

int $id
FieldList $fields

Return Value

Form

Form EmptyForm()

Returns a placeholder form, used by {@link getEditForm()} if no record is selected.

Our javascript logic always requires a form to be present in the CMS interface.

Return Value

Form

EditorToolbar()

Return the CMS's HTML-editor toolbar

string Tools()

Renders a panel containing tools which apply to all displayed "content" (mostly through {@link EditForm()}), for example a tree navigation or a filter panel.

Auto-detects applicable templates by naming convention: "_Tools.ss", and takes the most specific template (see {@link getTemplatesWithSuffix()}). To explicitly disable the panel in the subclass, simply create a more specific, empty template.

Return Value

string

HTML

string EditFormTools()

Renders a panel containing tools which apply to the currently displayed edit form.

The main difference to {@link Tools()} is that the panel is displayed within the element structure of the form panel (rendered through {@link EditForm}). This means the panel will be loaded alongside new forms, and refreshed upon save, which can mean a performance hit, depending on how complex your panel logic gets. Any form fields contained in the returned markup will also be submitted with the main form, which might be desired depending on the implementation details.

Return Value

string

HTML

batchactions()

Batch Actions Handler

Form BatchActionsForm()

Return Value

Form

printable()

ArrayData getSilverStripeNavigator()

Used for preview controls, mainly links which switch between different states of the page.

Return Value

ArrayData

int currentPageID()

Identifier for the currently shown record, in most cases a database ID. Inspects the following sources (in this order):

  • GET/POST parameter named 'ID'
  • URL parameter named 'ID'
  • Session value namespaced by classname, e.g. "CMSMain.currentPage"

Return Value

int

setCurrentPageID(int $id)

Forces the current page to be set in session, which can be retrieved later through {@link currentPageID()}.

Keep in mind that setting an ID through GET/POST or as a URL parameter will overrule this value.

Parameters

int $id

DataObject currentPage()

Uses {@link getRecord()} and {@link currentPageID()} to get the currently selected record.

Return Value

DataObject

bool isCurrentPage(DataObject $record)

Compares a given record to the currently selected one (if any).

Used for marking the current tree node.

Parameters

DataObject $record

Return Value

bool

string|bool LinkPreview()

URL to a previewable record which is shown through this controller.

The controller might not have any previewable content, in which case this method returns FALSE.

Return Value

string|bool

string CMSVersion()

Return the version number of the core packages making up this application, using the {@link SilverStripeVersionProvider}.

Return Value

string

array SwitchView()

Return Value

array

SiteConfig SiteConfig()

Return Value

SiteConfig

deprecated since version 4.0

Sets the href for the anchor on the Silverstripe logo in the menu

Parameters

string $link

Return Value

string

static setApplicationName(string $name) deprecated

deprecated since version 4.0

Parameters

string $name

string getApplicationName()

Get the application name.

Return Value

string

string Title()

Return Value

string

string SectionTitle()

Return the title of the current section. Either this is pulled from the current panel's menu_title or from the first active menu

Return Value

string

MceRoot()

Return the base directory of the tiny_mce codebase

string BaseCSSClasses()

Same as {@link ViewableData->CSSClasses()}, but with a changed name to avoid problems when using {@link ViewableData->customise()} (which always returns "ArrayData" from the $original object).

Return Value

string

string Locale()

Return Value

string

providePermissions()

Return a map of permission codes to add to the dropdown shown in the Security section of the CMS.

array( 'VIEW_SITE' => 'View the site', );

static require_javascript($file) deprecated

deprecated since version 4.0

Register the given javascript file as required in the CMS.

Filenames should be relative to the base, eg, FRAMEWORK_DIR . '/javascript/loader.js'

Parameters

$file

static require_css($file, $media = null) deprecated

deprecated since version 4.0

Register the given stylesheet file as required.

Parameters

$file

String Filenames should be relative to the base, eg, THIRDPARTY_DIR . '/tree/tree.css'

$media

String Comma-separated list of media-types (e.g. "screen,projector")

See also

http://www.w3.org/TR/REC-CSS2/media.html

static require_themed_css($name, $media = null) deprecated

deprecated since version 4.0

Register the given "themeable stylesheet" as required.

Themeable stylesheets have globally unique names, just like templates and PHP files. Because of this, they can be replaced by similarly named CSS files in the theme directory.

Parameters

$name

String The identifier of the file. For example, css/MyFile.css would have the identifier "MyFile"

$media

String Comma-separated list of media-types (e.g. "screen,projector")

array getExportFields()

Define which fields are used in the {@link getEditForm} GridField export.

By default, it uses the summary fields from the model definition.

Return Value

array

SearchContext getSearchContext()

Return Value

SearchContext

Form|bool SearchForm()

Return Value

Form|bool

getList()

array getManagedModels()

Return Value

array

Map of class name to an array of 'title' (see {@link $managed_models})

array getModelImporters()

Returns all importers defined in {@link self::$model_importers}.

If none are defined, we fall back to {@link self::managed_models} with a default {@link CsvBulkLoader} class. In this case the column names of the first row in the CSV file are assumed to have direct mappings to properties on the object.

Return Value

array

Map of model class names to importer instances

Form|bool ImportForm()

Generate a CSV import form for a single {@link DataObject} subclass.

Return Value

Form|bool

bool|null import(array $data, Form $form, SS_HTTPRequest $request)

Imports the submitted CSV file based on specifications given in {@link self::model_importers}.

Redirects back with a success/failure message.

Parameters

array $data
Form $form
SS_HTTPRequest $request

Return Value

bool|null

static set_page_length($length) deprecated

deprecated 4.0 Use "ModelAdmin.page_length" config setting

overwrite the static page_length of the admin panel, should be called in the project _config file.

Parameters

$length

static get_page_length() deprecated

deprecated 4.0 Use "ModelAdmin.page_length" config setting

Return the static page_length of the admin, default as 30