CMSPageHistoryViewerController
class CMSPageHistoryViewerController extends CMSMain
The history viewer controller replaces the {@link CMSPageHistoryController} and uses the React based {@link HistoryViewerField} to display the history for a {@link DataObject} that has the {@link Versioned} extension.
Traits
Constants
| SCHEMA_HEADER |
Form schema header identifier |
| PAGE_ICONS_ID |
Unique ID for page icons CSS block |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on this object
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied {@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
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.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
Gets the uninherited value for the given config option
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.
Check if a field exists on this object. This should be overloaded in child classes.
Get the value of a field on this object. This should be overloaded in child classes.
Set a field on this object. This should be overloaded in child classes.
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
Get the class name a field on this object will be casted to.
Return the string-format type for the given field.
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
Get an array of XML-escaped values by field name
Return a single-item iterator so you can iterate over the fields of a single record.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Executes this controller, and return an {@link HTTPResponse} object with the result.
Get a array of allowed actions defined on this controller, any parent classes or extensions.
Check that the given action is allowed to be called from a URL.
Throws a HTTP error response encased in a {@link HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.
Returns the HTTPRequest object that this controller is using.
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.
Overloaded redirection logic to trigger a fake redirect on ajax requests.
Safely get the value of the BackURL param, if provided via querystring / posted var
Redirect back. Uses either the HTTP-Referer or a manually set request-variable called "BackURL".
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
Returns the parameters extracted from the URL by the {@link Director}.
Returns the HTTPResponse object that this controller is building up. Can be used to set the status code and headers.
Sets the HTTPResponse object that this controller is building up.
This is the default action handler used if a method doesn't exist. It will process the controller object with the template returned by {@link getViewer()}.
Return the viewer identified being the default handler for this Controller/Action combination.
Removes all the "action" part of the current URL and returns the result. If no action parameter is present, returns the full URL.
Returns TRUE if this controller has a template that is specifically designed to handle a specific action.
Render the current controller with the templates determined by {@link getViewer()}.
Call this to disable site-wide basic authentication for a specific controller. This must be called before Controller::init(). That is, you must call it in your controller's init method before it calls parent::init().
Tests whether we have a currently active controller or not. True if there is at least 1 controller in the stack.
Returns true if the member is allowed to do the given action. Defaults to the currently logged in user.
Pushes this controller onto the stack of current controllers. This means that any redirection, session setting, or other things that rely on Controller::curr() will now write to this controller object.
Tests whether a redirection has been requested. If redirect() has been called, it will return the URL redirected to. Otherwise, it will return null.
Joins two or more link segments together, putting a slash between them if necessary. Use this for building the results of {@link Link()} methods. If either of the links have query strings, then they will be combined and put at the end of the resulting url.
Gets the combined configuration of all LeftAndMain subclasses required by the client app.
Return an error HTTPResponse encoded as json
If this is set to true, the "switchView" context in the template is shown, with links to the staging and publish site.
Get menu title for this section (translated)
Return styling for the menu icon, if a custom icon is set for this class
Return the web font icon class name for this interface icon. Uses the built in SilveStripe webfont. {see menu_icon_for_class()} for providing a background image.
Returns the main menu of the CMS. This is also used by init() to work out which sections the user has access to.
Return appropriate template(s) for this class, with the given suffix using {@link SSViewer::get_templates_by_class()}
Get a database record to be managed by the CMS.
Retrieves an edit form, either for display, or to process submitted data.
Returns a placeholder form, used by {@link getEditForm()} if no record is selected.
Renders a panel containing tools which apply to all displayed "content" (mostly through {@link EditForm()}), for example a tree navigation or a filter panel.
Renders a panel containing tools which apply to the currently displayed edit form.
Used for preview controls, mainly links which switch between different states of the page.
Identifier for the currently shown record, in most cases a database ID. Inspects the following sources (in this order): - GET/POST parameter named 'ID' - URL parameter named 'ID' - Session value namespaced by classname, e.g. "CMSMain.currentPage"
Forces the current page to be set in session, which can be retrieved later through {@link currentPageID()}.
Uses {@link getRecord()} and {@link currentPageID()} to get the currently selected record.
Return the version number of this application, ie. 'CMS: 4.2.1'
Overloads the LeftAndMain::ShowView. Allows to pass a page as a parameter, so we are able to switch view also for archived versions.
Return the title of the current section. Either this is pulled from the current panel's menu_title or from the first active menu
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.
Link to list view for children of a parent page
Return the active tab identifier for the CMS. Used by templates to decide which tab to give the active state.
Get a site tree HTML listing which displays the nodes under the given criteria.
Whether the current member has the permission to reorganise SiteTree objects.
This provides information required to generate the search form and can be modified on extensions through updateSearchContext
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.
This method exclusively handles deferred ajax requests to render the pages tree deferred handler (no pjax-fragment)
Get view state based on the current action
Callback to request the list of page types allowed under a given page instance.
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.
Details
in CustomMethods at line 50
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 {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in CustomMethods at line 144
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
in CustomMethods at line 172
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in Extensible at line 163
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 {@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()}).
in Extensible at line 224
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 {@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.
in Extensible at line 264
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 298
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
in Extensible at line 359
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $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))
in Extensible at line 395
array
invokeWithExtensions(string $method, mixed $arguments)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in Extensible at line 424
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 {@link __construct()} in {@link defineMethods()}.
in Extensible at line 465
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in Extensible at line 494
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
in Extensible at line 508
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See {@link get_extensions()} to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
in Injectable at line 26
static Injectable
create(array $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'); $list = SiteTree::get();
in Injectable at line 43
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).
in Configurable at line 20
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in Configurable at line 32
mixed
stat(string $name)
deprecated
deprecated 5.0 Use ->config()->get() instead
Get inherited config value
in Configurable at line 44
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
in Configurable at line 57
$this
set_stat(string $name, mixed $value)
deprecated
deprecated 5.0 Use ->config()->set() instead
Update the config value for a given property
in RequestHandler at line 121
__construct()
in ViewableData at line 106
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.
in ViewableData at line 129
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
in ViewableData at line 152
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
in ViewableData at line 167
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
in ViewableData at line 183
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 194
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
in ViewableData at line 205
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
in ViewableData at line 217
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
in ViewableData at line 232
defineMethods()
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
in ViewableData at line 258
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
in ViewableData at line 281
bool
exists()
Return true if this object "exists" i.e. has a sensible value
This method should be overriden in subclasses to provide more context about the classes state. For example, a {@link DataObject} class could return false when it is deleted from the database
in ViewableData at line 289
string
__toString()
in ViewableData at line 297
ViewableData
getCustomisedObj()
in ViewableData at line 305
setCustomisedObj(ViewableData $object)
in ViewableData at line 320
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.
in ViewableData at line 352
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
in ViewableData at line 365
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 389
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
in ViewableData at line 471
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.
in ViewableData at line 516
Object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
in ViewableData at line 530
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.
in ViewableData at line 545
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.
in ViewableData at line 558
array
getXMLValues(array $fields)
Get an array of XML-escaped values by field name
in ViewableData at line 579
ArrayIterator
getIterator()
Return a single-item iterator so you can iterate over the fields of a single record.
This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.
in ViewableData at line 592
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
in ViewableData at line 603
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
in ViewableData at line 620
string
ThemeDir()
deprecated
deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead
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.
in ViewableData at line 647
string
CSSClasses(string $stopAtClass = self::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".
in ViewableData at line 676
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in LeftAndMain at line 754
HTTPResponse|RequestHandler|string|array
handleRequest(HTTPRequest $request)
Executes this controller, and return an {@link HTTPResponse} object with the result.
This method defers to {@link RequestHandler->handleRequest()} to determine which action should be executed
Note: You should rarely need to overload handleRequest() - this kind of change is only really appropriate for things like nested controllers - {@link ModelAsController} and {@link RootURLController} are two examples here. If you want to make more orthodox functionality, it's better to overload {@link init()} or {@link index()}.
Important: If you are going to overload handleRequest, make sure that you start the method with $this->beforeHandleRequest() and end the method with $this->afterHandleRequest()
in RequestHandler at line 349
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.
in Controller at line 427
bool
hasAction(string $action)
in RequestHandler at line 460
bool
checkAccessAction(string $action)
Check that the given action is allowed to be called from a URL.
It will interrogate {@link self::$allowed_actions} to determine this.
in RequestHandler at line 520
httpError(int $errorCode, string $errorMessage = null)
Throws a HTTP error response encased in a {@link HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.
in RequestHandler at line 542
HTTPRequest
getRequest()
Returns the HTTPRequest object that this controller is using.
Returns a placeholder {@link NullHTTPRequest} object unless {@link handleAction()} or {@link handleRequest()} have been called, which adds a reference to an actual {@link HTTPRequest} object.
in Controller at line 145
$this
setRequest(HTTPRequest $request)
Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.
in CMSMain at line 291
string
Link(string $action = null)
Override {@link LeftAndMain} Link to allow blank URL segment for CMSMain.
in LeftAndMain at line 798
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.
in RequestHandler at line 606
string
getBackURL()
Safely get the value of the BackURL param, if provided via querystring / posted var
in RequestHandler at line 647
string
getReferer()
Get referer
in RequestHandler at line 666
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 {@link Director::baseURL()}).
in Controller at line 120
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
in Controller at line 314
$this
setURLParams(array $urlParams)
in Controller at line 325
array
getURLParams()
Returns the parameters extracted from the URL by the {@link Director}.
in Controller at line 336
HTTPResponse
getResponse()
Returns the HTTPResponse object that this controller is building up. Can be used to set the status code and headers.
in Controller at line 351
$this
setResponse(HTTPResponse $response)
Sets the HTTPResponse object that this controller is building up.
in Controller at line 369
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 {@link getViewer()}.
in Controller at line 379
string
getAction()
Returns the action that is being executed on this controller.
in Controller at line 391
SSViewer
getViewer(string $action)
Return the viewer identified being the default handler for this Controller/Action combination.
in Controller at line 441
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.
in Controller at line 491
bool
hasActionTemplate(string $action)
Returns TRUE if this controller has a template that is specifically designed to handle a specific action.
in Controller at line 515
string
render(array $params = null)
Render the current controller with the templates determined by {@link getViewer()}.
in Controller at line 537
disableBasicAuth()
deprecated
deprecated 4.1.0:5.0.0 Add this controller's url to SilverStripe\Security\BasicAuthMiddleware.URLPatterns injected property instead of setting false
Call this to disable site-wide basic authentication for a specific controller. This must be called before Controller::init(). That is, you must call it in your controller's init method before it calls parent::init().
in Controller at line 551
static Controller
curr()
Returns the current controller.
in Controller at line 566
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.
in Controller at line 580
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.
in Controller at line 604
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.
in Controller at line 614
popCurrent()
Pop this controller off the top of the stack.
in Controller at line 652
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.
in Controller at line 667
static string
join_links($arg = null)
Joins two or more link segments together, putting a slash between them if necessary. Use this for building the results of {@link Link()} methods. If either of the links have query strings, then they will be combined and put at the end of the resulting url.
Caution: All parameters are expected to be URI-encoded already.
in Controller at line 713
static array
get_template_global_variables()
in LeftAndMain at line 295
string
getCombinedClientConfig()
Gets the combined configuration of all LeftAndMain subclasses required by the client app.
in LeftAndMain at line 329
array
getClientConfig()
Returns configuration required by the client app.
in LeftAndMain at line 363
FormSchema
getFormSchema()
Get form schema helper
in LeftAndMain at line 374
$this
setFormSchema(FormSchema $schema)
Set form schema helper for this controller
in LeftAndMain at line 388
HTTPResponse
schema(HTTPRequest $request)
Gets a JSON schema representing the current edit form.
WARNING: Experimental API.
in LeftAndMain at line 426
HTTPResponse
jsonError(int $errorCode, string $errorMessage = null)
Return an error HTTPResponse encoded as json
in LeftAndMain at line 460
HTTPResponse
methodSchema(HTTPRequest $request)
in LeftAndMain at line 537
bool
canView(Member $member = null)
in LeftAndMain at line 580
static array|string|bool
getRequiredPermissions()
Get list of required permissions
in CMSMain at line 206
HTTPResponse
index(HTTPRequest $request)
in CMSMain at line 255
bool
ShowSwitchView()
If this is set to true, the "switchView" context in the template is shown, with links to the staging and publish site.
in LeftAndMain at line 881
static
menu_title_for_class($class)
deprecated
deprecated 5.0
in LeftAndMain at line 894
static string
menu_title(string $class = null, bool $localise = true)
Get menu title for this section (translated)
in LeftAndMain at line 924
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/';
in LeftAndMain at line 943
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. {see menu_icon_for_class()} for providing a background image.
in LeftAndMain at line 953
HTTPResponse
show(HTTPRequest $request)
in CMSMain at line 217
PjaxResponseNegotiator
getResponseNegotiator()
Caution: Volatile API.
in LeftAndMain at line 1004
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.
in LeftAndMain at line 1099
Menu()
in LeftAndMain at line 1108
ArrayData
MenuCurrentItem()
in LeftAndMain at line 1121
string|array
getTemplatesWithSuffix(string $suffix)
Return appropriate template(s) for this class, with the given suffix using {@link SSViewer::get_templates_by_class()}
in LeftAndMain at line 1127
Content()
in LeftAndMain at line 1137
DBHTMLText
PreviewPanel()
Render $PreviewPanel content
in CMSMain at line 1224
DataObject
getRecord(int|DataObject $id, int $versionID = null)
Get a database record to be managed by the CMS.
in CMSMain at line 1758
HTTPResponse
save(array $data, Form $form)
Save and Publish page handler
in CMSMain at line 1834
DataObject
getNewItem(string|int $id, bool $setID = true)
in CMSMain at line 1959
delete($data, $form)
Delete the current page from draft stage.
in CMSMain at line 1279
Form
EditForm(HTTPRequest $request = null)
Retrieves an edit form, either for display, or to process submitted data.
Also used in the template rendered through {@link Right()} in the $EditForm placeholder.
This is a "pseudo-abstract" methoed, usually connected to a {@link getEditForm()} method in an entwine subclass. This method can accept a record identifier, selected either in custom logic, or through {@link currentPageID()}. The form usually construct itself from {@link DataObject->getCMSFields()} for the specific managed subclass defined in {@link LeftAndMain::$tree_class}.
in CMSMain at line 1417
Form
EmptyForm()
Returns a placeholder form, used by {@link getEditForm()} if no record is selected.
Our javascript logic always requires a form to be present in the CMS interface.
in LeftAndMain at line 1513
ModalController
Modals()
Handler for all global modals
in LeftAndMain at line 1527
string
Tools()
Renders a panel containing tools which apply to all displayed "content" (mostly through {@link EditForm()}), for example a tree navigation or a filter panel.
Auto-detects applicable templates by naming convention: "
in LeftAndMain at line 1549
string
EditFormTools()
Renders a panel containing tools which apply to the currently displayed edit form.
The main difference to {@link Tools()} is that the panel is displayed within the element structure of the form panel (rendered through {@link EditForm}). This means the panel will be loaded alongside new forms, and refreshed upon save, which can mean a performance hit, depending on how complex your panel logic gets. Any form fields contained in the returned markup will also be submitted with the main form, which might be desired depending on the implementation details.
in CMSMain at line 2119
batchactions()
Batch Actions Handler
in LeftAndMain at line 1571
Form
BatchActionsForm()
in LeftAndMain at line 1608
printable()
in LeftAndMain at line 1630
DBHTMLText
getSilverStripeNavigator()
Used for preview controls, mainly links which switch between different states of the page.
in CMSMain at line 1738
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"
in LeftAndMain at line 1681
setCurrentPageID(int $id)
Forces the current page to be set in session, which can be retrieved later through {@link currentPageID()}.
Keep in mind that setting an ID through GET/POST or as a URL parameter will overrule this value.
in LeftAndMain at line 1695
DataObject
currentPage()
Uses {@link getRecord()} and {@link currentPageID()} to get the currently selected record.
in LeftAndMain at line 1707
bool
isCurrentPage(DataObject $record)
Compares a given record to the currently selected one (if any).
Used for marking the current tree node.
in CMSMain at line 486
string|bool
LinkPreview()
in LeftAndMain at line 1738
string
CMSVersion()
Return the version number of this application, ie. 'CMS: 4.2.1'
in LeftAndMain at line 1748
string
CMSVersionNumber()
Return the version number of the CMS, ie. '4.2.1'
in CMSMain at line 267
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.
in LeftAndMain at line 1776
SiteConfig
SiteConfig()
in LeftAndMain at line 1798
ArrayList
getHelpLinks()
Returns help_links in a format readable by a template
in LeftAndMain at line 1832
string
ApplicationLink()
in LeftAndMain at line 1850
string
getApplicationName()
Get the application name.
in LeftAndMain at line 1858
string
Title()
in LeftAndMain at line 1871
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
in LeftAndMain at line 1891
string
LogoutURL()
Generate a logout url with BackURL to the CMS
in LeftAndMain at line 1905
string
BaseCSSClasses()
Same as {@link ViewableData->CSSClasses()}, but with a changed name to avoid problems when using {@link ViewableData->customise()} (which always returns "ArrayData" from the $original object).
in LeftAndMain at line 1913
string
Locale()
in CMSMain at line 2340
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', );
in LeftAndMain at line 1972
$this
setVersionProvider(VersionProvider $provider)
Set the SilverStripe version provider to use
in LeftAndMain at line 1983
VersionProvider
getVersionProvider()
Get the SilverStripe version provider
in CMSMain at line 234
DBHTMLText
PageList()
Get pages listing area
in CMSMain at line 244
DBHTMLText
PageListSidebar()
Page list view for edit-form
in CMSMain at line 303
LinkPages()
in CMSMain at line 308
LinkPagesWithSearch()
in CMSMain at line 318
string
LinkTreeView()
Get link to tree view
in CMSMain at line 329
string
LinkListView()
Get link to list view
in CMSMain at line 342
string
LinkListViewChildren(int|string $parentID)
Link to list view for children of a parent page
in CMSMain at line 354
string
LinkListViewRoot()
in CMSMain at line 364
string
LinkTreeViewDeferred()
Link to lazy-load deferred tree view
in CMSMain at line 374
string
LinkListViewDeferred()
Link to lazy-load deferred list view
in CMSMain at line 379
LinkPageEdit($id = null)
in CMSMain at line 389
LinkPageSettings()
in CMSMain at line 400
LinkPageHistory()
at line 60
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.
in CMSMain at line 429
$this
setHintsCache(CacheInterface $cache)
in CMSMain at line 439
CacheInterface
getHintsCache()
in CMSMain at line 447
clearCache()
Clears all dependent cache backends
in CMSMain at line 452
LinkWithSearch($link)
in CMSMain at line 467
LinkPageAdd($extra = null, $placeholders = null)
in CMSMain at line 504
SiteTreeAsUL()
Return the entire site tree as a nested set of ULs
in CMSMain at line 534
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.
in CMSMain at line 626
string
getTreeNodeClasses(SiteTree $node)
Get extra CSS classes for a page's tree node
in CMSMain at line 659
string
getsubtree(HTTPRequest $request)
Get a subtree underneath the request param 'ID'.
If ID = 0, then get the whole tree.
in CMSMain at line 686
HTTPResponse
updatetreenodes(HTTPRequest $request)
Allows requesting a view update on specific tree nodes.
Similar to {@link getsubtree()}, but doesn't enforce loading all children with the node. Useful to refresh views after state modifications, e.g. saving a form.
in CMSMain at line 758
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.
in CMSMain at line 873
bool
CanOrganiseSitetree()
Whether the current member has the permission to reorganise SiteTree objects.
in CMSMain at line 882
boolean
TreeIsFiltered()
in CMSMain at line 888
ExtraTreeTools()
in CMSMain at line 901
SearchContext
getSearchContext()
This provides information required to generate the search form and can be modified on extensions through updateSearchContext
in CMSMain at line 915
string
getSearchFieldSchema()
Returns the search form schema for the current model
in CMSMain at line 949
Form
getSearchForm()
Returns a Form for page searching for use in templates.
Can be modified from a decorator by a 'updateSearchForm' method
in CMSMain at line 1028
doSearch($data, $form)
in CMSMain at line 1038
string
getBreadcrumbsBackLink()
Get "back" url for breadcrumbs
in CMSMain at line 1112
string
SiteTreeHints()
Create serialized JSON string with site tree hints data to be injected into 'data-hints' attribute of root node of jsTree.
in CMSMain at line 1185
SS_List
PageTypes()
Populates an array of classes in the CMS which allows the user to change the page type.
in CMSMain at line 1517
DBHTMLText
treeview()
This method exclusively handles deferred ajax requests to render the pages tree deferred handler (no pjax-fragment)
in CMSMain at line 1527
DBHTMLText
listview()
Returns deferred listview for the current level
in CMSMain at line 1538
string
ViewState(string $default = 'treeview')
Get view state based on the current action
in CMSMain at line 1557
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
in CMSMain at line 1617
SS_List
getList(array $params = array(), int $parentID)
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()}.
in CMSMain at line 1885
mixed
performPublish(Versioned|DataObject $record)
Actually perform the publication step
in CMSMain at line 1906
HTTPResponse
revert(array $data, Form $form)
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.
in CMSMain at line 1994
HTTPResponse
archive(array $data, Form $form)
Delete this page from both live and stage
in CMSMain at line 2022
publish($data, $form)
in CMSMain at line 2029
unpublish($data, $form)
in CMSMain at line 2059
HTTPResponse
rollback()
in CMSMain at line 2074
HTTPResponse
doRollback(array $data, Form $form)
Rolls a site back to a given version ID
in CMSMain at line 2124
BatchActionParameters()
in CMSMain at line 2149
BatchActionList()
Returns a list of batch actions
in CMSMain at line 2159
HTTPResponse|string|void
publishall($request)
deprecated
deprecated 5.0 Please use custom logic for this
in CMSMain at line 2233
HTTPResponse
restore(array $data, Form $form)
Restore a completely deleted page from the SiteTree_versions table.
in CMSMain at line 2260
duplicate($request)
in CMSMain at line 2303
duplicatewithchildren($request)
in CMSMain at line 2386
static
flush()
Clear the cache on ?flush
in CMSMain at line 2396
flushMemberCache(array $memberIDs = null)
Flush the hints cache for a specific member