class ElementalAreaController extends CMSMain (View source)

Controller for "ElementalArea" - handles loading and saving of in-line edit forms in an elemental area in admin

Traits

Allows an object to have extensions applied to it.

A class that can be instantiated or replaced via DI

Provides extensions to this object to integrate it with standard config API methods.

Allows an object to declare a set of custom methods

Constants

SCHEMA_HEADER

Form schema header identifier

PAGE_ICONS_ID

Unique ID for page icons CSS block

FORM_NAME_TEMPLATE

Config options

extensions array

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

from  Extensible
unextendable_classes array

Classes that cannot be extended

from  Extensible
casting from  CMSMain
default_cast string

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

from  ViewableData
casting_cache array from  ViewableData
url_segment
url_handlers
allowed_actions
add_trailing_slash bool

If true, a trailing slash is added to the end of URLs, e.g. from Controller::join_links()

from  Controller
client_debugging bool

Enable front-end debugging (increases verbosity) in dev mode.

from  LeftAndMain
url_rule from  CMSMain
menu_title from  CMSMain
menu_icon string from  LeftAndMain
menu_priority from  CMSMain
url_priority from  CMSMain
tree_class from  CMSMain
dependencies from  CMSMain
admin_themes array

Themes to use within the CMS

from  LeftAndMain
required_permission_codes from  CMSMain
session_namespace from  CMSMain
extra_requirements_javascript array

Register additional requirements through the Requirements class.

from  LeftAndMain
extra_requirements_i18n array

Register additional i18n requirements through the Requirements class.

from  LeftAndMain
extra_requirements_css array

YAML configuration example:

LeftAndMain:
  extra_requirements_css:
    mysite/css/mystyle.css:
      media: screen
from  LeftAndMain
extra_requirements_themedCss array from  LeftAndMain
session_keepalive_ping bool

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

from  LeftAndMain
frame_options string

Value of X-Frame-Options header

from  LeftAndMain
section_name string|null

The configuration passed to the supporting JS for each CMS section includes a 'name' key that by default matches the FQCN of the current class. This setting allows you to change the key if necessary (for example, if you are overloading CMSMain or another core class and want to keep the core JS - which depends on the core class names - functioning, you would need to set this to the FQCN of the class you are overloading).

from  LeftAndMain
application_name string

The application name

from  LeftAndMain
menu_icon_class from  CMSMain
enable_dynamic_archive_warning_message bool

Should the archive warning message be dynamic based on the specific content? This is slow on larger sites and can be disabled.

from  CMSMain
page_length int

Amount of results showing on a single page.

from  CMSMain
ignore_menuitem

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 public 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 ViewableData $failover

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

from  ViewableData
protected ViewableData $customisedObject from  ViewableData
protected HTTPRequest $request from  RequestHandler
protected $model

The DataModel for this request

from  RequestHandler
protected bool $brokenOnConstruct

This variable records whether RequestHandler::construct() was called or not. Useful for checking if subclasses have called parent::construct()

from  RequestHandler
protected array $urlParams

An array of arguments extracted from the URL.

from  Controller
protected array $requestParams

Contains all GET and POST parameters passed to the current HTTPRequest.

from  Controller
protected string $action

The URL part matched on the current controller as determined by the "$Action" part of the $url_handlers definition. Should correlate to a public method on this controller.

from  Controller
protected static array $controller_stack

Stack of current controllers. Controller::$controller_stack[0] is the current controller.

from  Controller
protected array $templates

Assign templates for this controller.

from  Controller
protected HTTPResponse $response

The response object that the controller returns.

from  Controller
protected bool $baseInitCalled from  Controller
protected FormSchema $schema

Current form schema helper

from  LeftAndMain
protected null $pageID

Current pageID for this request

from  LeftAndMain
protected PjaxResponseNegotiator $responseNegotiator from  LeftAndMain
protected VersionProvider $versionProvider from  LeftAndMain
protected LeftAndMain_SearchFilter $searchFilterCache

Cached search filter instance for current search

from  LeftAndMain
protected CacheInterface $hintsCache from  CMSMain

Methods

public
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

protected
defineMethods()

Adds any methods from Extension instances attached to this object.

protected
registerExtraMethodCallback(string $name, callable $callback)

Register an callback to invoke that defines extra methods

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

protected
bool
hasCustomMethod($method)

Determines if a custom method with this name is defined.

protected
array
getExtraMethodConfig(string $method)

Get meta-data details on a named method

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

protected static 
array
findBuiltInMethods(string|object $class = null)

Get all public built in methods for this class

protected
array
findMethodsFrom(object $object)

Find all methods on the given object.

protected
addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property.

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

Adds any methods from Extension instances attached to this object.

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

Add an extension to a specific class.

public static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

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

Get extra config sources for this class

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

Return TRUE if a class has a specified extension.

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

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

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

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

public
Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

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

public
getExtensionInstances()

Get all extension instances for this specific object instance.

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

public static 
config()

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

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
__construct()

No description

public
bool
__isset(string $property)

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

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

public
__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 ViewableData::setField() method.

public
setFailover(ViewableData $failover)

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

public
getFailover()

Get the current failover object if set

public
bool
hasField(string $field)

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

public
mixed
getField(string $field)

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

public
$this
setField(string $field, mixed $value)

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

public
mixed
getDynamicData(string $field)

No description

public
setDynamicData(string $field, mixed $value)

No description

public
bool
hasDynamicData(string $field)

No description

public
customise(array|ViewableData $data)

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

public
bool
exists()

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

public
string
__toString()

No description

public
getCustomisedObj()

No description

public
setCustomisedObj(ViewableData $object)

No description

public
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. This helper will be a subclass of DBField.

public
string
castingClass(string $field)

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

public
string
escapeTypeForField(string $field)

Return the string-format type for the given field.

public
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

protected
string
objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

protected
mixed
objCacheGet(string $key)

Get a cached value from the field cache

protected
$this
objCacheSet(string $key, mixed $value)

Store a value in the field cache

protected
$this
objCacheClear()

Clear object cache

public
object|DBField
obj(string $fieldName, array $arguments = [], 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.

public
object|DBField
cachedCall(string $fieldName, array $arguments = [], string $identifier = null)

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

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

public
string
XML_val(string $field, array $arguments = [], bool $cache = false)

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

public
array
getXMLValues(array $fields)

Get an array of XML-escaped values by field name

public
getIterator() deprecated

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

public
array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

public
Me()

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

public
string
CSSClasses(string $stopAtClass = ViewableData::class)

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

public
Debug()

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

public
handleRequest(HTTPRequest $request)

Executes this controller, and return an HTTPResponse object with the result.

protected
array
findAction(HTTPRequest $request)

No description

protected
string
addBackURLParam(string $link)

No description

protected
handleAction($request, $action)

Controller's default action handler. It will call the method named in "$Action", if that method exists. If "$Action" isn't given, it will use "index" as a default.

public
array|null
allowedActions(string $limitToClass = null)

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

public
bool
hasAction(string $action)

No description

protected
string
definingClassForAction(string $action)

Return the class that defines the given action, so that we know where to check allowed_actions.

public
bool
checkAccessAction(string $action)

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

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

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

public
getRequest()

Returns the HTTPRequest object that this controller is using.

public
setRequest(HTTPRequest $request)

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

public
?string
Link(string $action = null)

Override LeftAndMain Link to allow blank URL segment for CMSMain.

from  CMSMain
public
?string
AbsoluteLink(string $action = '')

Get the absolute URL for this controller, including protocol and host.

public
redirect(string $url, int $code = 302)

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

public
string
getBackURL()

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

public
string
getReferer()

Get referer

public
redirectBack()

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

protected
string
prepareDataForPjax(array $data)

Convert an array of data to JSON and wrap it in an HTML tag as pjax is used and jQuery will parse this as an element on the client side in LeftAndMain.js handleAjaxResponse() The attribute type="application/json" denotes this is a data block and won't be processed by a browser https://html.spec.whatwg.org/#the-script-element

protected
init()

No description

from  CMSMain
public
doInit()

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

protected
beforeHandleRequest(HTTPRequest $request)

A bootstrap for the handleRequest method

public
afterHandleRequest()

Cleanup for the handleRequest method

protected
prepareResponse(HTTPResponse|object $response)

Prepare the response (we can receive an assortment of response types (strings/objects/HTTPResponses) and changes the controller response object appropriately

public
$this
setURLParams(array $urlParams)

No description

public
array
getURLParams()

Returns the parameters extracted from the URL by the Director.

public
getResponse()

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

public
$this
setResponse(HTTPResponse $response)

Sets the HTTPResponse object that this controller is building up.

public
defaultAction(string $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 getViewer().

public
string
getAction()

Returns the action that is being executed on this controller.

public
getViewer(string $action)

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

public
string
removeAction(string $fullURL, null|string $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.

public
bool
hasActionTemplate(string $action)

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

public
string
render(array $params = null)

Render the current controller with the templates determined by getViewer().

public static 
curr()

Returns the current controller.

public static 
bool
has_curr()

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

public
bool
can(string $perm, null|member $member = null)

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

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

public
popCurrent()

Pop this controller off the top of the stack.

public
null|string
redirectedTo()

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

public static 
string
join_links(string|array $arg = null)

Joins two or more link segments together, putting a slash between them if necessary. Use this for building the results of Link() methods. If either of the links have query strings, then they will be combined and put at the end of the resulting url.

public static 
string
normaliseTrailingSlash(string $url)

Normalises a URL according to the configuration for add_trailing_slash

public static 
array
public
string
getCombinedClientConfig()

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

public
array
getClientConfig()

Returns configuration required by the client app.

public
getFormSchema()

Get form schema helper

public
$this
setFormSchema(FormSchema $schema)

Set form schema helper for this controller

public
schema(HTTPRequest $request)

Gets a JSON schema representing the current edit form.

protected
jsonSuccess(int $statusCode, array $data = [])

Creates a successful json response

public
jsonError(int $errorCode, string $errorMessage = null)

Return an error HTTPResponse encoded as json

public
methodSchema(HTTPRequest $request)

No description

protected
bool
getSchemaRequested()

Check if the current request has a X-Formschema-Request header set.

protected
getSchemaResponse(string $schemaID, Form $form = null, ValidationResult $errors = null, array $extraData = [])

Generate schema for the given form based on the X-Formschema-Request header value

public
bool
canView(Member $member = null)

No description

public static 
array|string|bool
getRequiredPermissions()

Get list of required permissions

public
index(HTTPRequest $request)

No description

from  CMSMain
public
bool
ShowSwitchView()

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

from  CMSMain
public static 
string
menu_title(string $class = null, bool $localise = true)

Get menu title for this section (translated)

public static 
string
menu_icon_for_class(string $class)

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

public static 
string
menu_icon_class_for_class(string $class)

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

public
show(HTTPRequest $request)

No description

public
getResponseNegotiator()

No description

from  CMSMain
public
MainMenu(bool $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.

public
Menu()

No description

public
MenuCurrentItem()

No description

public
string|array
getTemplatesWithSuffix(string $suffix)

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

public
Content()

No description

public
PreviewPanel()

Render $PreviewPanel content

public
getRecord(int|DataObject $id, int $versionID = null)

Get a database record to be managed by the CMS.

from  CMSMain
public
ArrayData>
Breadcrumbs(bool $unlinked = false)

No description

from  CMSMain
protected
getSearchFilter()

Gets the current search filter for this request, if available

public
save(array $data, Form $form)

Arrive here from FormRequestHandler::httpSubmission() during a POST request to /admin/linkfield/linkForm/ The 'save' method is called because it is the FormAction set on the Form

public
getNewItem(string|int $id, bool $setID = true)

No description

from  CMSMain
public
delete(array $data, Form $form)

Delete the current page from draft stage.

from  CMSMain
public
EditForm(HTTPRequest $request = null)

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

from  CMSMain
public
getEditForm(int $id = null, FieldList $fields = null)

No description

from  CMSMain
public
EmptyForm()

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

from  CMSMain
public
Modals()

Handler for all global modals

public
string
Tools()

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

public
string
EditFormTools()

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

public
batchactions()

Batch Actions Handler

from  CMSMain
public
BatchActionsForm()

No description

public
printable()

No description

public
getSilverStripeNavigator(DataObject|null $record = null)

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

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

from  CMSMain
public
setCurrentPageID(int $id)

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

public
currentPage()

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

public
bool
isCurrentPage(DataObject $record)

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

protected
string
sessionNamespace()

No description

public
string|bool
LinkPreview()

No description

from  CMSMain
public
string
CMSVersion()

Return the version number of this application, ie. 'CMS: 4.2.1'

public
string
CMSVersionNumber()

Return the version number of the CMS in the 'major.minor' format, e.g. '4.2' Will handle 4.10.x-dev by removing .x-dev

public
array
SwitchView(SiteTree $page = null)

Overloads the LeftAndMain::ShowView. Allows to pass a page as a parameter, so we are able to switch view also for archived versions.

from  CMSMain
public
SiteConfig()

No description

public
getHelpLinks()

Returns help_links in a format readable by a template

public
string
ApplicationLink()

No description

public
string
getApplicationName()

Get the application name.

public
string
Title()

No description

public
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

public
string
LogoutURL()

Generate a logout url with BackURL to the CMS

public
string
BaseCSSClasses()

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

public
string
Locale()

No description

public
providePermissions()

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

from  CMSMain
public
$this
setVersionProvider(VersionProvider $provider)

Set the SilverStripe version provider to use

public
getVersionProvider()

Get the SilverStripe version provider

public
string
getHttpErrorMessage()

Get the HTTP error message if one has occurred during HandleRequest.

public
PageList()

Get pages listing area

from  CMSMain
public
PageListSidebar()

Page list view for edit-form

from  CMSMain
public
LinkPages()

No description

from  CMSMain
public
LinkPagesWithSearch()

No description

from  CMSMain
public
string
LinkTreeView()

Get link to tree view

from  CMSMain
public
string
LinkListView()

Get link to list view

from  CMSMain
public
string
LinkListViewChildren(int|string $parentID)

Link to list view for children of a parent page

from  CMSMain
public
string
LinkListViewRoot()

No description

from  CMSMain
public
string
LinkTreeViewDeferred()

Link to lazy-load deferred tree view

from  CMSMain
public
string
LinkListViewDeferred()

Link to lazy-load deferred list view

from  CMSMain
public
string
getCMSEditLinkForManagedDataObject(SiteTree $obj)

Get the link for editing a page.

from  CMSMain
public
LinkPageEdit($id = null)

No description

from  CMSMain
public
LinkPageSettings()

No description

from  CMSMain
public
LinkPageHistory()

No description

from  CMSMain
public
string
getTabIdentifier()

Return the active tab identifier for the CMS. Used by templates to decide which tab to give the active state.

from  CMSMain
public
$this
setHintsCache(CacheInterface $cache)

No description

from  CMSMain
public
CacheInterface
getHintsCache()

No description

from  CMSMain
public
clearCache()

Clears all dependent cache backends

from  CMSMain
public
LinkWithSearch($link)

No description

from  CMSMain
public
LinkPageAdd($extra = null, $placeholders = null)

No description

from  CMSMain
public
SiteTreeAsUL()

Return the entire site tree as a nested set of ULs

from  CMSMain
public
string
getSiteTreeFor(string $className, string $rootID = null, string $childrenMethod = null, string $numChildrenMethod = null, callable $filterFunction = null, int $nodeCountThreshold = null)

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

from  CMSMain
protected
callable
getTreeNodeCustomisations()

Get callback to determine template customisations for nodes

from  CMSMain
public
string
getTreeNodeClasses(SiteTree $node)

Get extra CSS classes for a page's tree node

from  CMSMain
public
getsubtree(HTTPRequest $request)

Get a subtree underneath the request param 'ID'.

from  CMSMain
public
updatetreenodes(HTTPRequest $request)

Allows requesting a view update on specific tree nodes.

from  CMSMain
public
savetreenode(HTTPRequest $request)

Update the position and parent of a tree node.

from  CMSMain
public
bool
CanOrganiseSitetree()

Whether the current member has the permission to reorganise SiteTree objects.

from  CMSMain
public
bool
TreeIsFiltered()

No description

from  CMSMain
public
ExtraTreeTools()

No description

from  CMSMain
public
getSearchContext()

This provides information required to generate the search form and can be modified on extensions through updateSearchContext

from  CMSMain
public
string
getSearchFieldSchema()

Returns the search form schema for the current model

from  CMSMain
public
getSearchForm()

Returns a Form for page searching for use in templates.

from  CMSMain
protected
array
getPageTypes()

Returns a sorted array suitable for a dropdown with pagetypes and their translated name

from  CMSMain
public
doSearch(array $data, Form $form)

No description

from  CMSMain
public
string
getBreadcrumbsBackLink()

Get "back" url for breadcrumbs

from  CMSMain
public
string
SiteTreeHints()

Create serialized JSON string with site tree hints data to be injected into 'data-hints' attribute of root node of jsTree.

from  CMSMain
public
PageTypes()

Populates an array of classes in the CMS which allows the user to change the page type.

from  CMSMain
protected
string
getArchiveWarningMessage(SiteTree $record)

Build an archive warning message based on the page's children

from  CMSMain
protected
bool
collateDescendants(int[] $recordIDs, array $collator)

Find IDs of all descendant pages for the provided ID lists.

from  CMSMain
public
treeview()

This method exclusively handles deferred ajax requests to render the pages tree deferred handler (no pjax-fragment)

from  CMSMain
public
listview()

Returns deferred listview for the current level

from  CMSMain
public
string
ViewState(string $default = 'treeview')

Get view state based on the current action

from  CMSMain
public
childfilter(HTTPRequest $request)

Callback to request the list of page types allowed under a given page instance.

from  CMSMain
protected
getQueryFilter(array $params)

Safely reconstruct a selected filter from a given set of query parameters

from  CMSMain
public
getList(array $params = [], int $parentID = 0)

Returns the pages meet a certain criteria as {CMSSiteTreeFilter} or the subpages of a parent page defaulting to no filter and show all pages in first level.

from  CMSMain
public
ListViewForm()

No description

from  CMSMain
public
mixed
performPublish(Versioned|DataObject $record)

Actually perform the publication step

from  CMSMain
public
revert(array $data, Form $form)

Reverts a page by publishing it to live.

from  CMSMain
public
archive(array $data, Form $form)

Delete this page from both live and stage

from  CMSMain
public
publish(array $data, Form $form)

No description

from  CMSMain
public
unpublish(array $data, Form $form)

No description

from  CMSMain
public
rollback()

No description

from  CMSMain
public
doRollback(array $data, Form $form)

Rolls a site back to a given version ID

from  CMSMain
public
BatchActionParameters()

Returns a LiteralField containing parameter field HTML for batch actions

from  CMSMain
public
BatchActionList()

Returns a list of batch actions

from  CMSMain
public
restore(array $data, Form $form)

Restore a completely deleted page from the SiteTree_versions table.

from  CMSMain
public
duplicate(HTTPRequest $request)

No description

from  CMSMain
public
duplicatewithchildren(HTTPRequest $request)

No description

from  CMSMain
protected
string
getCMSTreeTitle()

Get title for root CMS node

from  CMSMain
protected
string
generateHintsCacheKey($memberID)

Cache key for SiteTreeHints() method

from  CMSMain
public static 
flush()

Clear the cache on ?flush

from  CMSMain
public
flushMemberCache(array $memberIDs = null)

Flush the hints cache for a specific member

from  CMSMain
public
elementForm(HTTPRequest $request = null)

Used for both:

  • GET requests to get the FormSchema via getElementForm() called from LeftAndMain::schema()
  • POST Requests to save the Form. Will be handled by to FormRequestHandler::httpSubmission() /admin/linkfield/elementForm/

public
Form|null
getElementForm(int $elementID)

This method is called from LeftAndMain::schema() /admin/linkfield/schema/elementForm/

public static 
array
removeNamespacesFromFields(array $data, int $elementID)

Remove the pseudo namespaces that were added to form fields by the form factory

public
apiSaveForm(HTTPRequest $request) deprecated

This method should not be used and will be removed

public
formAction(HTTPRequest $request) deprecated

Provides action control for form fields that are request handlers when they're used in an in-line edit form.

Details

mixed __call(string $method, array $arguments)

Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located

You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

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

Parameters

string $name
callable $callback

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

protected bool hasCustomMethod($method)

Determines if a custom method with this name is defined.

Parameters

$method

Return Value

bool

protected array getExtraMethodConfig(string $method)

Get meta-data details on a named method

Parameters

string $method

Return Value

array

List of custom method details, if defined for this method

array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom

include methods added dynamically at runtime

Return Value

array

Map of method names with lowercase keys

static protected array findBuiltInMethods(string|object $class = null)

Get all public built in methods for this class

Parameters

string|object $class

Class or instance to query methods from (defaults to static::class)

Return Value

array

Map of methods with lowercase key name

protected array findMethodsFrom(object $object)

Find all methods on the given object.

Parameters

object $object

Return Value

array

protected addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

Exceptions

InvalidArgumentException

protected removeMethodsFrom(string $property, string|int $index = null)

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

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

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)

Parameters

string $method

the method name to wrap

string $wrap

the method name to wrap to

protected addCallbackMethod(string $method, callable $callback)

Add callback as a method.

Parameters

string $method

Name of method

callable $callback

Callback to invoke. Note: $this is passed as first parameter to this callback and then $args as array

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.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

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.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

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

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of Object

string $extension

Subclass of Extension with optional parameters as a string, e.g. "Versioned"

Return Value

bool

Flag if the extension was added

See also

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

static remove_extension(string $extension)

Remove an extension from a class.

Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any 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.

Parameters

string $extension

class name of an Extension subclass, without parameters

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

No description

Parameters

string $class

If omitted, will get extensions for the current class

bool $includeArgumentString

Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array

Numeric array of either DataExtension class names, or eval'ed class name strings with constructor arguments.

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

Get extra config sources for this class

Parameters

string $class

Name of class. If left null will return for the current class

Return Value

array|null

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

Return TRUE if a class has a specified extension.

This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

Parameters

string $classOrExtension

Class to check extension for, or the extension name to check if the second argument is null.

string $requiredExtension

If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.

bool $strict

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

Return Value

bool

Flag if the extension exists

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

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

Parameters

string $method

the method name to call

mixed ...$arguments

List of arguments

Return Value

array

List of results with nulls filtered out

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

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

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

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

Parameters

string $method

the name of the method to call on each extension

mixed ...$arguments

Return Value

array

Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

bool hasExtension(string $extension)

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

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension

Classname of an Extension subclass without parameters

Return Value

bool

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.

Return Value

Extension[]

Map of DataExtension instances, keyed by classname.

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

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

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

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

static Config_ForClass config()

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

Return Value

Config_ForClass

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

__construct()

No description

bool __isset(string $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.

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

$this setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

Return Value

$this

mixed getDynamicData(string $field)

No description

Parameters

string $field

Return Value

mixed

ViewableData setDynamicData(string $field, mixed $value)

No description

Parameters

string $field
mixed $value

Return Value

ViewableData

bool hasDynamicData(string $field)

No description

Parameters

string $field

Return Value

bool

ViewableData_Customised customise(array|ViewableData $data)

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

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

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

bool exists()

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

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

Return Value

bool

string __toString()

No description

Return Value

string

the class name

ViewableData getCustomisedObj()

No description

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

No description

Parameters

ViewableData $object

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. This helper will be a subclass of DBField.

Parameters

string $field

Return Value

string

Casting helper As a constructor pattern, and may include arguments.

Exceptions

Exception

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'

DBHTMLText 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

DBHTMLText

protected string objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName

Name of field

array $arguments

List of optional arguments given

Return Value

string

protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key

Cache key

Return Value

mixed

protected $this objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key

Cache key

mixed $value

Return Value

$this

protected $this objCacheClear()

Clear object cache

Return Value

$this

object|DBField obj(string $fieldName, array $arguments = [], 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 $cache

Cache this object

string $cacheName

a custom cache name

Return Value

object|DBField

object|DBField cachedCall(string $fieldName, array $arguments = [], string $identifier = null)

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

Parameters

string $fieldName
array $arguments
string $identifier

an optional custom cache identifier

Return Value

object|DBField

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

string XML_val(string $field, array $arguments = [], bool $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

string $field
array $arguments
bool $cache

Return Value

string

array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields

an array of field names

Return Value

array

Traversable getIterator() deprecated

deprecated 5.2.0 Will be removed without equivalent functionality

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

Traversable

array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

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 CSSClasses(string $stopAtClass = ViewableData::class)

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

HTTPResponse|RequestHandler|string|array handleRequest(HTTPRequest $request)

Executes this controller, and return an HTTPResponse object with the result.

This method defers to 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 - ModelAsController} and {@link RootURLController are two examples here. If you want to make more orthodox functionality, it's better to overload 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()

Parameters

HTTPRequest $request

The object that is responsible for distributing URL parsing

Return Value

HTTPResponse|RequestHandler|string|array

protected array findAction(HTTPRequest $request)

No description

Parameters

HTTPRequest $request

Return Value

array

protected string addBackURLParam(string $link)

No description

Parameters

string $link

Return Value

string

protected HTTPResponse handleAction($request, $action)

Controller's default action handler. It will call the method named in "$Action", if that method exists. If "$Action" isn't given, it will use "index" as a default.

Parameters

$request
$action

Return Value

HTTPResponse

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)

No description

Parameters

string $action

Return Value

bool

protected string definingClassForAction(string $action)

Return the class that defines the given action, so that we know where to check allowed_actions.

Overrides RequestHandler to also look at defined templates.

Parameters

string $action

Return Value

string

bool checkAccessAction(string $action)

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

It will interrogate RequestHandler::$allowed_actions to determine this.

Parameters

string $action

Return Value

bool

Exceptions

Exception

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

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

Parameters

int $errorCode
string $errorMessage

Plaintext error message

Exceptions

HTTPResponse_Exception

HTTPRequest getRequest()

Returns the HTTPRequest object that this controller is using.

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

Return Value

HTTPRequest

RequestHandler setRequest(HTTPRequest $request)

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

Parameters

HTTPRequest $request

Return Value

RequestHandler

Override LeftAndMain Link to allow blank URL segment for CMSMain.

Parameters

string $action

Optional action

Return Value

?string

Get the absolute URL for this controller, including protocol and host.

Returns null if no link could be generated.

Parameters

string $action

See Link()

Return Value

?string

HTTPResponse redirect(string $url, int $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

string $url
int $code

Return Value

HTTPResponse

string getBackURL()

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

Return Value

string

string getReferer()

Get referer

Return Value

string

HTTPResponse redirectBack()

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 Director::baseURL()).

Return Value

HTTPResponse

protected string prepareDataForPjax(array $data)

Convert an array of data to JSON and wrap it in an HTML tag as pjax is used and jQuery will parse this as an element on the client side in LeftAndMain.js handleAjaxResponse() The attribute type="application/json" denotes this is a data block and won't be processed by a browser https://html.spec.whatwg.org/#the-script-element

Parameters

array $data

Return Value

string

protected init()

No description

doInit()

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

protected beforeHandleRequest(HTTPRequest $request)

A bootstrap for the handleRequest method

Parameters

HTTPRequest $request

afterHandleRequest()

Cleanup for the handleRequest method

protected prepareResponse(HTTPResponse|object $response)

Prepare the response (we can receive an assortment of response types (strings/objects/HTTPResponses) and changes the controller response object appropriately

Parameters

HTTPResponse|object $response

$this setURLParams(array $urlParams)

No description

Parameters

array $urlParams

Return Value

$this

array getURLParams()

Returns the parameters extracted from the URL by the Director.

Return Value

array

HTTPResponse getResponse()

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

Return Value

HTTPResponse

$this setResponse(HTTPResponse $response)

Sets the HTTPResponse object that this controller is building up.

Parameters

HTTPResponse $response

Return Value

$this

DBHTMLText defaultAction(string $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 getViewer().

Parameters

string $action

Return Value

DBHTMLText

string getAction()

Returns the action that is being executed on this controller.

Return Value

string

SSViewer getViewer(string $action)

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

Parameters

string $action

Return Value

SSViewer

string removeAction(string $fullURL, null|string $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

string $fullURL
null|string $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 getViewer().

Parameters

array $params

Return Value

string

static Controller curr()

Returns the current controller.

Return Value

Controller

static bool has_curr()

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

Return Value

bool

bool can(string $perm, null|member $member = null)

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

Parameters

string $perm
null|member $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.

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

popCurrent()

Pop this controller off the top of the stack.

null|string redirectedTo()

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

Return Value

null|string

Joins two or more link segments together, putting a slash between them if necessary. Use this for building the results of 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.

Parameters

string|array $arg

One or more link segments, or list of link segments as an array

Return Value

string

static string normaliseTrailingSlash(string $url)

Normalises a URL according to the configuration for add_trailing_slash

Parameters

string $url

Return Value

string

static array get_template_global_variables()

No description

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 => [], where the array can contain these key => value pairs
    • "method" => method name
    • "casting" => casting class to use (i.e., Varchar, HTMLFragment, etc)

string getCombinedClientConfig()

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

Return Value

string

WARNING: Experimental API

array getClientConfig()

Returns configuration required by the client app.

Return Value

array

WARNING: Experimental API

FormSchema getFormSchema()

Get form schema helper

Return Value

FormSchema

$this setFormSchema(FormSchema $schema)

Set form schema helper for this controller

Parameters

FormSchema $schema

Return Value

$this

HTTPResponse schema(HTTPRequest $request)

Gets a JSON schema representing the current edit form.

Parameters

HTTPRequest $request

Return Value

HTTPResponse

protected HTTPResponse jsonSuccess(int $statusCode, array $data = [])

Creates a successful json response

Parameters

int $statusCode
array $data

Return Value

HTTPResponse

HTTPResponse jsonError(int $errorCode, string $errorMessage = null)

Return an error HTTPResponse encoded as json

Parameters

int $errorCode
string $errorMessage

Return Value

HTTPResponse

Exceptions

HTTPResponse_Exception

HTTPResponse methodSchema(HTTPRequest $request)

No description

Parameters

HTTPRequest $request

Return Value

HTTPResponse

protected bool getSchemaRequested()

Check if the current request has a X-Formschema-Request header set.

Used by conditional logic that responds to validation results

Return Value

bool

protected HTTPResponse getSchemaResponse(string $schemaID, Form $form = null, ValidationResult $errors = null, array $extraData = [])

Generate schema for the given form based on the X-Formschema-Request header value

Parameters

string $schemaID

ID for this schema. Required.

Form $form

Required for 'state' or 'schema' response

ValidationResult $errors

Required for 'error' response

array $extraData

Any extra data to be merged with the schema response

Return Value

HTTPResponse

bool canView(Member $member = null)

No description

Parameters

Member $member

Return Value

bool

static array|string|bool getRequiredPermissions()

Get list of required permissions

Return Value

array|string|bool

Code, array of codes, or false if no permission required

HTTPResponse index(HTTPRequest $request)

No description

Parameters

HTTPRequest $request

Return Value

HTTPResponse

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 string menu_title(string $class = null, bool $localise = true)

Get menu title for this section (translated)

Parameters

string $class

Optional class name if called on LeftAndMain directly

bool $localise

Determine if menu title should be localised via i18n.

Return Value

string

Menu title for the given 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

static string menu_icon_class_for_class(string $class)

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

Parameters

string $class .

Return Value

string

HTTPResponse show(HTTPRequest $request)

No description

Parameters

HTTPRequest $request

Return Value

HTTPResponse

Exceptions

HTTPResponse_Exception

PjaxResponseNegotiator getResponseNegotiator()

No description

Return Value

PjaxResponseNegotiator

SS_List MainMenu(bool $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

bool $cached

Return Value

SS_List

Menu()

No description

ArrayData MenuCurrentItem()

No description

Return Value

ArrayData

A single menu entry (see MainMenu)

string|array getTemplatesWithSuffix(string $suffix)

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

Parameters

string $suffix

Return Value

string|array

Content()

No description

DBHTMLText PreviewPanel()

Render $PreviewPanel content

Return Value

DBHTMLText

DataObject getRecord(int|DataObject $id, int $versionID = null)

Get a database record to be managed by the CMS.

Parameters

int|DataObject $id

ID or object

int $versionID

optional Version id of the given record

Return Value

DataObject

ArrayData> Breadcrumbs(bool $unlinked = false)

No description

Parameters

bool $unlinked

Return Value

ArrayData>

protected LeftAndMain_SearchFilter getSearchFilter()

Gets the current search filter for this request, if available

HTTPResponse save(array $data, Form $form)

Arrive here from FormRequestHandler::httpSubmission() during a POST request to /admin/linkfield/linkForm/ The 'save' method is called because it is the FormAction set on the Form

Parameters

array $data
Form $form

Return Value

HTTPResponse

DataObject getNewItem(string|int $id, bool $setID = true)

No description

Parameters

string|int $id
bool $setID

Return Value

DataObject

Exceptions

HTTPResponse_Exception

HTTPResponse delete(array $data, Form $form)

Delete the current page from draft stage.

Parameters

array $data
Form $form

Return Value

HTTPResponse

Exceptions

HTTPResponse_Exception

See also

deletefromlive()

Form EditForm(HTTPRequest $request = null)

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

Also used in the template rendered through Right() in the $EditForm placeholder.

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

Parameters

HTTPRequest $request

Passed if executing a HTTPRequest directly on the form. If empty, this is invoked as $EditForm in the template

Return Value

Form

Should return a form regardless wether a record has been found. Form might be readonly if the current user doesn't have the permission to edit the record.

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

No description

Parameters

int $id
FieldList $fields

Return Value

Form

Form EmptyForm()

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

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

Return Value

Form

ModalController Modals()

Handler for all global modals

Return Value

ModalController

string Tools()

Renders a panel containing tools which apply to all displayed "content" (mostly through 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 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 Tools() is that the panel is displayed within the element structure of the form panel (rendered through 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()

No description

Return Value

Form

printable()

No description

DBHTMLText getSilverStripeNavigator(DataObject|null $record = null)

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

Parameters

DataObject|null $record

Return Value

DBHTMLText

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

protected string sessionNamespace()

No description

Return Value

string

string|bool LinkPreview()

No description

Return Value

string|bool

string CMSVersion()

Return the version number of this application, ie. 'CMS: 4.2.1'

Return Value

string

string CMSVersionNumber()

Return the version number of the CMS in the 'major.minor' format, e.g. '4.2' Will handle 4.10.x-dev by removing .x-dev

Return Value

string

array SwitchView(SiteTree $page = null)

Overloads the LeftAndMain::ShowView. Allows to pass a page as a parameter, so we are able to switch view also for archived versions.

Parameters

SiteTree $page

Return Value

array

SiteConfig SiteConfig()

No description

Return Value

SiteConfig

Returns help_links in a format readable by a template

Return Value

ArrayList

No description

Return Value

string

string getApplicationName()

Get the application name.

Return Value

string

string Title()

No description

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

string LogoutURL()

Generate a logout url with BackURL to the CMS

Return Value

string

string BaseCSSClasses()

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

Return Value

string

string Locale()

No description

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', );

$this setVersionProvider(VersionProvider $provider)

Set the SilverStripe version provider to use

Parameters

VersionProvider $provider

Return Value

$this

VersionProvider getVersionProvider()

Get the SilverStripe version provider

Return Value

VersionProvider

string getHttpErrorMessage()

Get the HTTP error message if one has occurred during HandleRequest.

Return Value

string

DBHTMLText PageList()

Get pages listing area

Return Value

DBHTMLText

DBHTMLText PageListSidebar()

Page list view for edit-form

Return Value

DBHTMLText

LinkPages()

No description

LinkPagesWithSearch()

No description

string LinkTreeView()

Get link to tree view

Return Value

string

string LinkListView()

Get link to list view

Return Value

string

string LinkListViewChildren(int|string $parentID)

Link to list view for children of a parent page

Parameters

int|string $parentID

Literal parentID, or placeholder (e.g. '%d') for client side substitution

Return Value

string

string LinkListViewRoot()

No description

Return Value

string

string LinkTreeViewDeferred()

Link to lazy-load deferred tree view

Return Value

string

string LinkListViewDeferred()

Link to lazy-load deferred list view

Return Value

string

string getCMSEditLinkForManagedDataObject(SiteTree $obj)

Get the link for editing a page.

Parameters

SiteTree $obj

Return Value

string

See also

\SilverStripe\CMS\Controllers\CMSEditLinkExtension::getCMSEditLinkForManagedDataObject()

LinkPageEdit($id = null)

No description

Parameters

$id

LinkPageSettings()

No description

LinkPageHistory()

No description

string getTabIdentifier()

Return the active tab identifier for the CMS. Used by templates to decide which tab to give the active state.

The default value is "edit", as the primary content tab. Child controllers will override this.

Return Value

string

$this setHintsCache(CacheInterface $cache)

No description

Parameters

CacheInterface $cache

Return Value

$this

CacheInterface getHintsCache()

No description

Return Value

CacheInterface $cache

clearCache()

Clears all dependent cache backends

LinkWithSearch($link)

No description

Parameters

$link

LinkPageAdd($extra = null, $placeholders = null)

No description

Parameters

$extra
$placeholders

SiteTreeAsUL()

Return the entire site tree as a nested set of ULs

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

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

Parameters

string $className

The class of the root object

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

string $numChildrenMethod
callable $filterFunction
int $nodeCountThreshold

Return Value

string

Nested unordered list with links to each page

protected callable getTreeNodeCustomisations()

Get callback to determine template customisations for nodes

Return Value

callable

string getTreeNodeClasses(SiteTree $node)

Get extra CSS classes for a page's tree node

Parameters

SiteTree $node

Return Value

string

HTTPResponse getsubtree(HTTPRequest $request)

Get a subtree underneath the request param 'ID'.

If ID = 0, then get the whole tree.

Parameters

HTTPRequest $request

Return Value

HTTPResponse

HTTPResponse updatetreenodes(HTTPRequest $request)

Allows requesting a view update on specific tree nodes.

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

Parameters

HTTPRequest $request

Return Value

HTTPResponse

HTTPResponse savetreenode(HTTPRequest $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

HTTPRequest $request

Return Value

HTTPResponse

Exceptions

HTTPResponse_Exception

bool CanOrganiseSitetree()

Whether the current member has the permission to reorganise SiteTree objects.

Return Value

bool

bool TreeIsFiltered()

No description

Return Value

bool

ExtraTreeTools()

No description

SearchContext getSearchContext()

This provides information required to generate the search form and can be modified on extensions through updateSearchContext

Return Value

SearchContext

string getSearchFieldSchema()

Returns the search form schema for the current model

Return Value

string

Form getSearchForm()

Returns a Form for page searching for use in templates.

Can be modified from a decorator by a 'updateSearchForm' method

Return Value

Form

protected array getPageTypes()

Returns a sorted array suitable for a dropdown with pagetypes and their translated name

Return Value

array

HTTPResponse doSearch(array $data, Form $form)

No description

Parameters

array $data
Form $form

Return Value

HTTPResponse

Get "back" url for breadcrumbs

Return Value

string

string SiteTreeHints()

Create serialized JSON string with site tree hints data to be injected into 'data-hints' attribute of root node of jsTree.

Return Value

string

Serialized JSON

SS_List PageTypes()

Populates an array of classes in the CMS which allows the user to change the page type.

Return Value

SS_List

protected string getArchiveWarningMessage(SiteTree $record)

Build an archive warning message based on the page's children

Parameters

SiteTree $record

Return Value

string

protected bool collateDescendants(int[] $recordIDs, array $collator)

Find IDs of all descendant pages for the provided ID lists.

Parameters

int[] $recordIDs
array $collator

Return Value

bool

DBHTMLText treeview()

This method exclusively handles deferred ajax requests to render the pages tree deferred handler (no pjax-fragment)

Return Value

DBHTMLText

HTML response with the rendered treeview

DBHTMLText listview()

Returns deferred listview for the current level

Return Value

DBHTMLText

HTML response with the rendered listview

string ViewState(string $default = 'treeview')

Get view state based on the current action

Parameters

string $default

Return Value

string

HTTPResponse childfilter(HTTPRequest $request)

Callback to request the list of page types allowed under a given page instance.

Provides a slower but more precise response over SiteTreeHints

Parameters

HTTPRequest $request

Return Value

HTTPResponse

protected CMSSiteTreeFilter getQueryFilter(array $params)

Safely reconstruct a selected filter from a given set of query parameters

Parameters

array $params

Query parameters to use, or null if none present

Return Value

CMSSiteTreeFilter

The filter class

Exceptions

InvalidArgumentException

SS_List getList(array $params = [], int $parentID = 0)

Returns the pages meet a certain criteria as {CMSSiteTreeFilter} or the subpages of a parent page defaulting to no filter and show all pages in first level.

Doubles as search results, if any search parameters are set through SearchForm().

Parameters

array $params

Search filter criteria

int $parentID

Optional parent node to filter on (can't be combined with other search criteria)

Return Value

SS_List

Exceptions

InvalidArgumentException

Form ListViewForm()

No description

Return Value

Form

mixed performPublish(Versioned|DataObject $record)

Actually perform the publication step

Parameters

Versioned|DataObject $record

Return Value

mixed

HTTPResponse revert(array $data, Form $form)

Reverts a page by publishing it to live.

Use restorepage() if you want to restore a page which was deleted from draft without publishing.

Parameters

array $data
Form $form

Return Value

HTTPResponse

Exceptions

HTTPResponse_Exception

HTTPResponse archive(array $data, Form $form)

Delete this page from both live and stage

Parameters

array $data
Form $form

Return Value

HTTPResponse

Exceptions

HTTPResponse_Exception

HTTPResponse publish(array $data, Form $form)

No description

Parameters

array $data
Form $form

Return Value

HTTPResponse

HTTPResponse unpublish(array $data, Form $form)

No description

Parameters

array $data
Form $form

Return Value

HTTPResponse

HTTPResponse rollback()

No description

Return Value

HTTPResponse

HTTPResponse doRollback(array $data, Form $form)

Rolls a site back to a given version ID

Parameters

array $data
Form $form

Return Value

HTTPResponse

LiteralField BatchActionParameters()

Returns a LiteralField containing parameter field HTML for batch actions

Used by LeftAndMain to render batch actions in the BatchActionsForm

Return Value

LiteralField

BatchActionList()

Returns a list of batch actions

HTTPResponse restore(array $data, Form $form)

Restore a completely deleted page from the SiteTree_versions table.

Parameters

array $data
Form $form

Return Value

HTTPResponse

HTTPResponse duplicate(HTTPRequest $request)

No description

Parameters

HTTPRequest $request

Return Value

HTTPResponse

HTTPResponse duplicatewithchildren(HTTPRequest $request)

No description

Parameters

HTTPRequest $request

Return Value

HTTPResponse

protected string getCMSTreeTitle()

Get title for root CMS node

Return Value

string

protected string generateHintsCacheKey($memberID)

Cache key for SiteTreeHints() method

Parameters

$memberID

Return Value

string

static flush()

Clear the cache on ?flush

flushMemberCache(array $memberIDs = null)

Flush the hints cache for a specific member

Parameters

array $memberIDs

Form elementForm(HTTPRequest $request = null)

Used for both:

  • GET requests to get the FormSchema via getElementForm() called from LeftAndMain::schema()
  • POST Requests to save the Form. Will be handled by to FormRequestHandler::httpSubmission() /admin/linkfield/elementForm/

Parameters

HTTPRequest $request

Return Value

Form

Form|null getElementForm(int $elementID)

This method is called from LeftAndMain::schema() /admin/linkfield/schema/elementForm/

Parameters

int $elementID

Return Value

Form|null

Returns null if no element exists for the given ID

static array removeNamespacesFromFields(array $data, int $elementID)

Remove the pseudo namespaces that were added to form fields by the form factory

Parameters

array $data
int $elementID

Return Value

array

HTTPResponse|null apiSaveForm(HTTPRequest $request) deprecated

deprecated 5.3.0 Send a POST request to elementForm/$ItemID instead

This method should not be used and will be removed

Save an inline edit form for a block

Parameters

HTTPRequest $request

Return Value

HTTPResponse|null

JSON encoded string or null if an exception is thrown

Exceptions

HTTPResponse_Exception

array|HTTPResponse|RequestHandler|string formAction(HTTPRequest $request) deprecated

deprecated 5.3.0 Will be removed without equivalent functionality to replace it

Provides action control for form fields that are request handlers when they're used in an in-line edit form.

Eg. UploadField

Parameters

HTTPRequest $request

Return Value

array|HTTPResponse|RequestHandler|string