CMSMain

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns a 2-elemnent array, with classname and arguments

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

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

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

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

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

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.

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.

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

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

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

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

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

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

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

Clears the cache for the given cacheToFile call

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

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

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

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

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

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.

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

The returned array contains two keys:

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

Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.

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

Return the string-format type for the given field.

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

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.

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

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

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

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

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.

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

Set the DataModel for this request.

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

This method first does a few set-up activities:

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

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

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

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

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.

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

Includes class ancestry and extensions in the checks.

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 SS_HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.

Returns the SS_HTTPRequest object that this controller is using.

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

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

Override {@link LeftAndMain} Link to allow blank URL segment for CMSMain.

Returns the SS_HTTPResponse object that this controller is building up.

Can be used to set the status code and headers

Sets the SS_HTTPResponse object that this controller is building up.

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

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

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 an SSViewer object to process the data

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

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

Returns the current controller

Tests whether we have a currently active controller or not

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

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.

Pop this controller off the top of the stack.

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.

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

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

Tests whether a redirection has been requested.

Get the Session object representing this Controller's session

Set the Session object.

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.

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

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

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

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

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

Returns the menu title for the given LeftAndMain subclass.

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

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

Example: static $menu-icon = '/path/to/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 a list of appropriate templates for this class, with the given suffix using {@link SSViewer::get_templates_by_class()}

Get a database record to be managed by the CMS.

Return the entire site tree as a nested set of ULs

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

Get a subtree underneath the request param 'ID'.

If ID = 0, then get the whole tree.

Allows requesting a view update on specific tree nodes.

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

Save and Publish page handler

Delete the current page from draft stage.

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.

Ensuring we set the current page id from the $ID url parameter.

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

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

Return the CMS's HTML-editor toolbar

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.

Get the page id from this request

Set the page id into $pageID rather than into {@link Session}.

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.

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

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

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

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

Return the base directory of the tiny_mce codebase

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

Register the given javascript file as required in the CMS.

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

Register the given stylesheet file as required.

Register the given "themeable stylesheet" as required.

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

Returns a Form for page searching for use in templates.

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

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

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

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

Provides a slower but more precise response over SiteTreeHints

Returns the pages meet a certain criteria as {see 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 {@link SearchForm()}.

Delete the page from live. This means a page in draft mode might still exist.

Actually perform the publication step

Reverts a page by publishing it to live.

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

Delete this page from both live and stage

Rolls a site back to a given version ID

Returns a list of batch actions

Restore a completely deleted page from the SiteTree_versions table.