DMSDocumentAddController
class DMSDocumentAddController extends LeftAndMain (View source)
Properties
| public | string | $class | from SS_Object | |
| protected | array | $extension_instances | from SS_Object | |
| protected | $beforeExtendCallbacks | List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. |
from SS_Object | |
| protected | $afterExtendCallbacks | List of callbacks to call after extensions having extend called on them, each grouped by methodName. |
from SS_Object | |
| 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 | SS_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 | from Controller | |
| protected | array | $requestParams | from Controller | |
| protected | string | $action | from Controller | |
| protected | $session | The Session object for this controller |
from Controller | |
| protected static | $controller_stack | Stack of current controllers. |
from Controller | |
| protected | $basicAuthEnabled | from Controller | ||
| protected | SS_HTTPResponse | $response | from Controller | |
| protected | $baseInitCalled | from Controller | ||
| protected | PjaxResponseNegotiator | $responseNegotiator | from LeftAndMain | |
| protected | SilverStripeVersionProvider | $versionProvider | from LeftAndMain |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
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().
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()
This class allows you to overload classes with other classes when they are constructed using the factory method 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.
Add an extension to a specific class.
No description
Attemps 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 methods from the ViewableData::$failover object, as well as wrapping any methods prefixed with an underscore into a ViewableData::cachedCall().
Add all the methods from an object property (which is an Extension) to this object.
Add all the methods from an object property (which is an Extension) to this object.
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)
Add an extra method using raw PHP code passed as a string
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 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 $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.
Get all extension instances for this specific object 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
Loads a cache from the filesystem if a valid on is present and within the specified lifetime
Save a piece of cached data to the file system
Strip a file name of special characters so it is suitable for use as a cache file name
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 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 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 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.
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
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.
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 ViewableData::castingHelper() for information on casting helpers).
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
Generate the cache name for a field
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 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.
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).
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 SS_HTTPResponse object with the result.
Controller's default action handler. It will call the method named in $Action, if that method exists.
Get a array of allowed actions defined on this controller, any parent classes or extensions.
Checks if this request handler has a specific action, even if the current user cannot access it.
Return the class that defines the given action, so that we know where to check allowed_actions.
Check that the given action is allowed to be called from a URL.
Throws a HTTP error response encased in a SS_HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.
Returns the SS_HTTPRequest object that this controller is using.
Typically the request is set through handleAction() or handleRequest(), but in some based we want to set it manually.
You should implement a Link() function in your subclass of LeftAndMain, to point to the URL of that particular controller.
Returns the SS_HTTPResponse object that this controller is building up.
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.
This is the default action handler used if a method doesn't exist.
Removes all the "action" part of the current URL and returns the result.
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 getViewer().
Call this to disable site-wide basic authentication for a specific contoller.
Tests whether we have a currently active controller or not
Returns true if the member is allowed to do the given action.
Overloaded redirection logic to trigger a fake redirect on ajax requests.
Redirect back. Uses either the HTTP_REFERER or a manually set request-variable called "BackURL".
Joins two or more link segments together, putting a slash between them if necessary.
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 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.
Return styling for the menu icon, if a custom icon is set for this class
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 SSViewer::get_templates_by_class()
Gets the current search filter for this request, if available
Get a site tree HTML listing which displays the nodes under the given criteria.
Allows requesting a view update on specific tree nodes.
Returns a placeholder form, used by getEditForm() if no record is selected.
Renders a panel containing tools which apply to all displayed "content" (mostly through 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.
Return fake-ID "root" if no ID is found (needed to upload files into the root-folder). Otherwise the page ID is passed in from the DMSGridFieldAddNewButton.
Forces the current page to be set in session, which can be retrieved later through currentPageID().
URL to a previewable record which is shown through this controller.
Return the version number of the core packages making up this application, using the SilverStripeVersionProvider.
Sets the href for the anchor on the Silverstripe logo in the menu
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 ViewableData->CSSClasses(), but with a changed name to avoid problems when using 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.
Register the given "themeable stylesheet" as required.
Get the current document set, if a document set ID was provided
Returns the link to be used to return the user after uploading a document. Scenarios:
Return a link to edit a page, deep linking into the document set given
Returns HTML representing a list of documents that are associated with the given page ID, across all document sets.
Get an array of allowed file upload extensions, merged with File and extra configuration from this class
Details
static Config_ForClass|null
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
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.
static SS_Object
create()
An implementation of the factory method, allows you to create an instance of a class
This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use 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();
static SS_Object
singleton()
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
static
create_from_string($classSpec, $firstArg = null)
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.
Object::create_from_string("Versioned('Stage','Live')") will return the result of
Versioned::create('Stage', 'Live);
It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.
If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.
Object::create_from_string("Varchar(50)", "MyField") will return the result of
Vachar::create('MyField', '50');
Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.
static
parse_class_spec($classSpec)
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Returns a 2-elemnent array, with classname and arguments
static SS_Object
strong_create()
Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()
static
useCustomClass(string $oldClass, string $newClass, bool $strong = false)
This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()
static string
getCustomClass(string $class)
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
static any
static_lookup($class, $name, null $default = null)
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
static
get_static($class, $name, $uncached = false)
deprecated
deprecated
No description
static
set_static($class, $name, $value)
deprecated
deprecated
No description
static
uninherited_static($class, $name, $uncached = false)
deprecated
deprecated
No description
static
combined_static($class, $name, $ceiling = false)
deprecated
deprecated
No description
static
addStaticVars($class, $properties, $replace = false)
deprecated
deprecated
No description
static
add_static_var($class, $name, $value, $replace = false)
deprecated
deprecated
No description
static
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
static
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the 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()).
static
remove_extension(string $extension)
Remove an extension from a class.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any 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.
static array
get_extensions(string $class, bool $includeArgumentString = false)
No description
static
get_extra_config_sources($class = null)
No description
__construct()
No description
mixed
__call(string $method, array $arguments)
Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()
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
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
defineMethods()
Add methods from the ViewableData::$failover object, as well as wrapping any methods prefixed with an underscore into a ViewableData::cachedCall().
protected array
findMethodsFromExtension(object $extension)
No description
protected
addMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
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
createMethod(string $method, string $code)
Add an extra method using raw PHP code passed as a string
stat($name, $uncached = false)
No description
set_stat($name, $value)
No description
uninherited($name)
No description
bool
exists()
Return true if this object "exists" i.e. has a sensible value
This method should be overriden 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
string
parentClass()
No description
bool
is_a(string $class)
Check if this class is an instance of a specific class, or has that class as one of its parents
string
__toString()
No description
mixed
invokeWithExtensions(string $method, mixed $argument = null)
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
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().
Extension
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in $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(
array
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).
mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
clearCache($method, $ID = false, $arguments = array())
Clears the cache for the given cacheToFile call
protected mixed
loadCache(string $cache, int $lifetime = 3600)
Loads a cache from the filesystem if a valid on is present and within the specified lifetime
protected
saveCache(string $cache, mixed $data)
Save a piece of cached data to the file system
protected string
sanitiseCachename(string $name)
Strip a file name of special characters so it is suitable for use as a cache file name
static string
castingObjectCreator(string $fieldSchema)
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
static array
castingObjectCreatorPair(string $fieldSchema)
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See castingObjectCreator for more information about the constructor.
bool
__isset(string $property)
Check if a field exists on this object or its failover.
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
ViewableData|null
getFailover()
Get the current failover object if set
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
unknown
deprecatedCachedCall($method, $args = null, string $identifier = null)
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
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.
ViewableData
getCustomisedObj()
No description
setCustomisedObj(ViewableData $object)
No description
array
castingHelperPair(string $field)
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see 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)")
string
castingHelper(string $field)
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.
string
castingClass(string $field)
Get the class name a field on this object will be casted to
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
buildCastingCache(reference $cache)
Save the casting cache for this object (including data from any failovers) into a variable
HTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:
- a template name (e.g. Page)
- an array of possible template names - the first valid one will be used
- an SSViewer instance
protected
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
objCacheSet(string $key, mixed $value)
Store a value in the field cache
obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
cachedCall(string $field, array $arguments = null, string $identifier = null)
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
bool
hasValue(string $field, array $arguments = null, bool $cache = true)
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
XML_val($field, $arguments = null, $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
RAW_val($field, $arguments = null, $cache = true)
Return the value of the field without any escaping being applied.
SQL_val($field, $arguments = null, $cache = true)
Return the value of a field in an SQL-safe format.
JS_val($field, $arguments = null, $cache = true)
Return the value of a field in a JavaScript-save format.
ATT_val($field, $arguments = null, $cache = true)
Return the value of a field escaped suitable to be inserted into an XML node attribute.
array
getXMLValues($fields)
Get an array of XML-escaped values by field name
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.
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
string
ThemeDir(string $subtheme = false)
Return the directory if the current active theme (relative to the site root).
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.
string
CSSClasses(string $stopAtClass = 'ViewableData')
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
setDataModel($model)
Set the DataModel for this request.
SS_HTTPResponse|RequestHandler|string|array
handleRequest(SS_HTTPRequest $request, DataModel $model = null)
Executes this controller, and return an SS_HTTPResponse object with the result.
This method first does a few set-up activities:
- Push this controller ont to the controller stack - see Controller::curr() for information about this.
- Call init()
- Defer to 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 - 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->pushCurrent() and end the method with $this->popCurrent(). Failure to do this will create weird session errors.
protected
findAction($request)
No description
protected SS_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.
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.
bool
hasAction(string $action)
Checks if this request handler has a specific action, even if the current user cannot access it.
Includes class ancestry and extensions in the checks.
protected
definingClassForAction($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
checkAccessAction($action)
Check that the given action is allowed to be called from a URL.
It will interrogate self::$allowed_actions to determine this.
httpError(int $errorCode, string $errorMessage = null)
Throws a HTTP error response encased in a SS_HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.
SS_HTTPRequest|NullHTTPRequest
getRequest()
Returns the SS_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 SS_HTTPRequest object.
setRequest($request)
Typically the request is set through handleAction() or handleRequest(), but in some based we want to set it manually.
string
Link($action = null)
You should implement a Link() function in your subclass of LeftAndMain, to point to the URL of that particular controller.
init()
No description
setURLParams($urlParams)
No description
array
getURLParams()
No description
getResponse()
Returns the SS_HTTPResponse object that this controller is building up.
Can be used to set the status code and headers
Controller
setResponse(SS_HTTPResponse $response)
Sets the SS_HTTPResponse object that this controller is building up.
getFormOwner()
Return the object that is going to own a form that's being processed, and handle its execution.
Note that the result needn't be an actual controller object.
defaultAction($action)
This is the default action handler used if a method doesn't exist.
It will process the controller object with the template returned by getViewer()
getAction()
Returns the action that is being executed on this controller.
SSViewer
getViewer($action)
Return an SSViewer object to process the data
static string
removeAction($fullURL, $action = null)
Removes all the "action" part of the current URL and returns the result.
If no action parameter is present, returns the full URL
bool
hasActionTemplate(string $action)
Returns TRUE if this controller has a template that is specifically designed to handle a specific action.
string
render(array $params = null)
Render the current controller with the templates determined by getViewer().
disableBasicAuth()
Call this to disable site-wide basic authentication for a specific contoller.
This must be called before Controller::init(). That is, you must call it in your controller's init method before it calls parent::init().
static Controller
curr()
Returns the current controller
static bool
has_curr()
Tests whether we have a currently active controller or not
bool
can($perm, $member = null)
Returns true if the member is allowed to do the given action.
pushCurrent()
Pushes this controller onto the stack of current controllers.
This means that any redirection, session setting, or other things that rely on Controller::curr() will now write to this controller object.
popCurrent()
Pop this controller off the top of the stack.
SS_HTTPResponse
redirect($url, $code = 302)
Overloaded redirection logic to trigger a fake redirect on ajax requests.
While this violates HTTP principles, its the only way to work around the fact that browsers handle HTTP redirects opaquely, no intervention via JS is possible. In isolation, that's not a problem - but combined with history.pushState() it means we would request the same redirection URL twice if we want to update the URL as well. See LeftAndMain.js for the required jQuery ajaxComplete handlers.
redirectBack()
Redirect back. Uses either the HTTP_REFERER or a manually set request-variable called "BackURL".
This variable is needed in scenarios where not HTTP-Referer is sent ( e.g when calling a page by location.href in IE). If none of the two variables is available, it will redirect to the base URL (see Director::baseURL()).
string
redirectedTo()
Tests whether a redirection has been requested.
Session
getSession()
Get the Session object representing this Controller's session
setSession(Session $session)
Set the Session object.
static string
join_links()
Joins two or more link segments together, putting a slash between them if necessary.
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.
static array
get_template_global_variables()
Called by SSViewer to get a list of global variables to expose to the template, the static method to call on this class to get the value for those variables, and the class to use for casting the returned value for use in a template
If the method to call is not included for a particular template variable, a method named the same as the template variable will be called
If the casting class is not specified for a particular template variable, ViewableData::$default_cast is used
The first letter of the template variable is case-insensitive. However the method name is always case sensitive.
bool
canView(Member $member = null)
Overrides the parent method to allow users with access to DMS admin to access this controller
index($request)
No description
bool
ShowSwitchView()
If this is set to true, the "switchView" context in the template is shown, with links to the staging and publish site.
static
menu_title_for_class($class)
Returns the menu title for the given LeftAndMain subclass.
Implemented static so that we can get this value without instantiating an object. Menu title is not internationalised.
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/';
show($request)
No description
PjaxResponseNegotiator
getResponseNegotiator()
Caution: Volatile API.
SS_List
MainMenu($cached = true)
Returns the main menu of the CMS. This is also used by init() to work out which sections the user has access to.
Menu()
No description
ArrayData
MenuCurrentItem()
No description
array
getTemplatesWithSuffix($suffix)
Return a list of appropriate templates for this class, with the given suffix using SSViewer::get_templates_by_class()
Content()
No description
getRecord($id)
No description
ArrayList
Breadcrumbs($unlinked = false)
No description
string
SiteTreeAsUL()
No description
protected LeftAndMain_SearchFilter
getSearchFilter()
Gets the current search filter for this request, if available
string
getSiteTreeFor(string $className, int $rootID = null, string $childrenMethod = null, $numChildrenMethod = null, $filterFunction = null, $nodeCountThreshold = 30)
Get a site tree HTML listing which displays the nodes under the given criteria.
getsubtree($request)
Get a subtree underneath the request param 'ID'.
If ID = 0, then get the whole tree.
string
updatetreenodes($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.
save($data, $form)
Save handler
delete($data, $form)
No description
SS_HTTPResponse
savetreenode($request)
Update the position and parent of a tree node.
Only saves the node if changes were made.
Required data:
- 'ID': The moved node
- 'ParentID': New parent relation of the moved node (0 for root)
- 'SiblingIDs': Array of all sibling nodes to the moved node (incl. the node itself). In case of a 'ParentID' change, relates to the new siblings under the new parent.
CanOrganiseSitetree()
No description
Form
EditForm($request = null)
No description
Form
getEditForm(int $id = null, FieldList $fields = null)
No description
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.
EditorToolbar()
Return the CMS's HTML-editor toolbar
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: "
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.
batchactions()
Batch Actions Handler
Form
BatchActionsForm()
No description
printable()
No description
ArrayData
getSilverStripeNavigator()
Used for preview controls, mainly links which switch between different states of the page.
int
currentPageID()
Return fake-ID "root" if no ID is found (needed to upload files into the root-folder). Otherwise the page ID is passed in from the DMSGridFieldAddNewButton.
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.
DataObject
currentPage()
Custom currentPage() method to handle opening the 'root' folder
bool
isCurrentPage(DataObject $record)
Compares a given record to the currently selected one (if any).
Used for marking the current tree node.
protected string
sessionNamespace()
No description
string|bool
LinkPreview()
URL to a previewable record which is shown through this controller.
The controller might not have any previewable content, in which case this method returns FALSE.
string
CMSVersion()
Return the version number of the core packages making up this application, using the SilverStripeVersionProvider.
array
SwitchView()
No description
SiteConfig
SiteConfig()
No description
static
set_application_link(string $link)
deprecated
deprecated
Sets the href for the anchor on the Silverstripe logo in the menu
string
ApplicationLink()
No description
static
setApplicationName(string $name)
deprecated
deprecated
No description
string
getApplicationName()
Get the application name.
string
Title()
No description
string
SectionTitle()
Return the title of the current section. Either this is pulled from the current panel's menu_title or from the first active menu
MceRoot()
Return the base directory of the tiny_mce codebase
string
BaseCSSClasses()
Same as ViewableData->CSSClasses(), but with a changed name to avoid problems when using ViewableData->customise() (which always returns "ArrayData" from the $original object).
string
Locale()
No description
providePermissions()
Return a map of permission codes to add to the dropdown shown in the Security section of the CMS.
array( 'VIEW_SITE' => 'View the site', );
static
require_javascript($file)
deprecated
deprecated
Register the given javascript file as required in the CMS.
Filenames should be relative to the base, eg, FRAMEWORK_DIR . '/javascript/loader.js'
static
require_css($file, $media = null)
deprecated
deprecated
Register the given stylesheet file as required.
static
require_themed_css($name, $media = null)
deprecated
deprecated
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.
DMSDocumentSet
getCurrentDocumentSet()
Get the current document set, if a document set ID was provided
string
Backlink()
Returns the link to be used to return the user after uploading a document. Scenarios:
1) Page context: page ID and document set ID provided, redirect back to the page and document set 2) Document set context: no page ID, document set ID provided, redirect back to document set in ModelAdmin 3) Document context: no page ID and no document set ID provided, redirect back to documents in ModelAdmin
protected string
getPageEditLink(int $pageId, int $documentSetId)
Return a link to edit a page, deep linking into the document set given
documentautocomplete()
No description
string
linkdocument()
Link an existing document to the given document set ID
string
documentlist()
Returns HTML representing a list of documents that are associated with the given page ID, across all document sets.
array
getAllowedExtensions()
Get an array of allowed file upload extensions, merged with File and extra configuration from this class