ModelAdmin

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

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

Return the names of all the methods available on this object

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

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.

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

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.

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

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

Get inherited config value

Gets the uninherited value for the given config option

Update the config value for a given property

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

Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.

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

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.

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

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.

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

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

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.

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

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

This method defers to {@link RequestHandler->handleRequest()} to determine which action should be executed

Note: You should rarely need to overload handleRequest() - 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->beforeHandleRequest() and end the method with $this->afterHandleRequest()

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.

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

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

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

Returns the 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 HTTPRequest} object.

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

Overrides {@link \SilverStripe\Admin\LeftAndMain} to ensure the active model class (the DataObject we are currently viewing) is included in the URL.

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.

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

Get referer

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

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

A stand in function to protect the init function from failing to be called as well as providing before and after hooks for the init function itself

This should be called on all controllers before handling requests

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

Returns the HTTPResponse object that this controller is building up. Can be used to set the status code and headers.

Sets the HTTPResponse object that this controller is building up.

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

Returns the action that is being executed on this controller.

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

Removes all the "action" part of the current URL and returns the result. If no action parameter is present, returns the full URL.

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

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

Call this to disable site-wide basic authentication for a specific controller. This must be called before Controller::init(). That is, you must call it in your controller's init method before it calls parent::init().

Returns the current controller.

Tests whether we have a currently active controller or not. True if there is at least 1 controller in the stack.

Returns true if the member is allowed to do the given action. Defaults to the currently logged in user.

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.

Note: Ensure this controller is assigned a request with a valid session before pushing it to the stack.

Pop this controller off the top of the stack.

Tests whether a redirection has been requested. If redirect() has been called, it will return the URL redirected to. Otherwise, it will return null.

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.

Gets the combined configuration of all LeftAndMain subclasses required by the client app.

Returns configuration required by the client app.

Get form schema helper

Set form schema helper for this controller

Gets a JSON schema representing the current edit form.

WARNING: Experimental API.

Return an error HTTPResponse encoded as json

Get list of required permissions

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

Get menu title for this section (translated)

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

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

Return the web font icon class name for this interface icon. Uses the built in SilveStripe webfont. {see menu_icon_for_class()} for providing a background image.

Caution: Volatile API.

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

Return appropriate template(s) for this class, with the given suffix using {@link SSViewer::get_templates_by_class()}

Render $PreviewPanel content

Get dataobject from the current ID

Save handler

Create new item.

Retrieves an edit form, either for display, or to process submitted data.

Also used in the template rendered through {@link Right()} in the $EditForm placeholder.

This is a "pseudo-abstract" methoed, usually connected to a {@link getEditForm()} method in an entwine subclass. This method can accept a record identifier, selected either in custom logic, or through {@link currentPageID()}. The form usually construct itself from {@link DataObject->getCMSFields()} for the specific managed subclass defined in {@link LeftAndMain::$tree_class}.

Produces an edit form that includes a default {@link \SilverStripe\Forms\GridField\GridField} for the currently active {@link \SilverStripe\ORM\DataObject}. The GridField will show data from the currently active modelClass only (see {@link self::init()}).

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.

Handler for all global modals

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.

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.

Batch Actions Handler

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

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"

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.

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

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

Used for marking the current tree node.

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 the version number of this application, ie. 'CMS: 4.2.1'

Return the version number of the CMS, ie. '4.2.1'

Returns help_links in a format readable by a template

Get the application name.

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

Generate a logout url with BackURL to the CMS

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 a map of permission codes to add to the dropdown shown in the Security section of the CMS.

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

Set the SilverStripe version provider to use

Get the SilverStripe version provider

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

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

Gets a list of fields that have been searched

Returns the search form

You can override how ModelAdmin returns DataObjects by either overloading this method, or defining an extension to ModelAdmin that implements the updateList method (and takes a {@link \SilverStripe\ORM\DataList} as the first argument).

For example, you might want to do this if this particular ModelAdmin should only ever show objects where an Archived flag is set to false. That would be best done as an extension, for example:

public function updateList(\SilverStripe\ORM\DataList $list) { return $list->filter('Archived', false); }

The model managed by this instance.

See $managed_models for potential values.

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.

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

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

Redirects back with a success/failure message.