Security

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

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

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

Register an callback to invoke that defines extra methods

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

Get meta-data details on a named method

Return the names of all the methods available on this object

No description

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 callback as a method.

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.

No description

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

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

Remove an extension from a class.

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

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.

Add support for removing extensions with parameters

No description

Get extra config sources for this class

Return TRUE if a class has a specified extension.

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

Calls a method if available on both this object and all applied 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 __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 $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.

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

Get all extension instances for this specific object instance.

See get_extensions() to get all applied extension classes for this class (not the instance).

This method also provides lazy-population of the extension_instances property.

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

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

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

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

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

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

Get inherited config value

Gets the uninherited value for the given config option

Update the config value for a given property

No description

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

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

Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using 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.

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.

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.

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

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

No description

No description

No description

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

Generate the cache name for a field

Get a cached value from the field cache

Store a value in the field cache

Clear object cache

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.

Get an array of XML-escaped values by field name

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

This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.

Find appropriate templates for SSViewer to use to render this object

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

Return the directory if the current active theme (relative to the site root).

This method is useful for things such as accessing theme images from your template without hardcoding the theme page - e.g. .

This method should only be used when a theme is currently active. However, it will fall over to the current project directory.

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

This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".

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

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

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

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

Important: If you are going to overload handleRequest, make sure that you start the method with $this->beforeHandleRequest() and end the method with $this->afterHandleRequest()

No description

No description

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.

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.

No description

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.

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

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

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

Returns the HTTPRequest object that this controller is using.

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

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

Get a link to a security action

Redirect to the given URL.

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

Get referer

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

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

Initialisation function that is run before any action on the controller is called.

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

A bootstrap for the handleRequest method

setDataModel and setRequest are redundantly called in parent::handleRequest() - sort this out

Cleanup for the handleRequest method

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

No description

Returns the parameters extracted from the URL by the 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 getViewer().

Returns the action that is being executed on this controller.

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

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

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

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

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

Returns the current controller.

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

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

Pushes this controller onto the stack of current controllers. This means that any redirection, session setting, or other things that rely on Controller::curr() will now write to this controller object.

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

Pop this controller off the top of the stack.

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

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

Defines global accessible templates variables.

No description

No description

No description

Get the selected authenticator for this request

Get all registered authenticators

Check if a given authenticator is registered

Register that we've had a permission failure trying to view the given page

This will redirect to a login page. If you don't provide a messageSet, a default will be used.

The intended uses of this function is to temporarily change the current user for things such as canView() checks or unit tests. It is stateless and will not persist between requests. Importantly it also will not call any logic that may be present in the current IdentityStore logIn() or logout() methods

If you are unit testing and calling FunctionalTest::get() or FunctionalTest::post() and you need to change the current user, you should instead use SapphireTest::logInAs() / logOut() which itself will call Injector::inst()->get(IdentityStore::class)->logIn($member) / logout()

No description

Get the login forms for all available authentication methods

This action is available as a keep alive, so user sessions don't timeout. A common use is in the admin.

Perform pre-login checking and prepare a response if available prior to login

Prepare the controller for handling the response to this request

Combine the given forms into a formset with a tabbed interface

Get the HTML Content for the $Content area during login

Set the next message to display for the security login page. Defaults to warning

Clear login message

Show the "login" page

For multiple authenticators, Security_MultiAuthenticatorLogin is used. See getTemplatesFor and getIncludeTemplate for how to override template logic

Log the currently logged in user out

Logging out without ID-parameter in the URL, will log the user out of all applicable Authenticators.

Adding an ID will only log the user out of that Authentication method.

Get authenticators for the given service, optionally filtered by the ID parameter of the current request

Aggregate tabbed forms from each handler to fragments ready to be rendered.

We have three possible scenarios.

We get back Content (e.g. Password Reset) We get back a Form (no token set for logout) We get back a HTTPResponse, telling us to redirect. Return the first one, which is the default response, as that covers all required scenarios

Delegate to a number of handlers and aggregate the results. This is used, for example, to build the log-in page where there are multiple authenticators active.

If a single handler is passed, delegateToHandler() will be called instead

Delegate to another RequestHandler, rendering any fragment arrays into an appropriate.

controller.

Render the given fragments into a security page controller with the given title.

No description

Show the "lost password" page

Show the "change password" page.

This page can either be called directly by logged-in users (in which case they need to provide their old password), or through a link emailed through lostpassword(). In this case no old password is required, authentication is ensured through the Member.AutoLoginHash property.

Create a link to the password reset form.

GET parameters used:

• m: member ID
• t: plaintext token

Determine the list of templates to use for rendering the given action.

Return an existing member with administrator privileges, or create one of necessary.

Will create a default 'Administrators' group if no group is found with an ADMIN permission. Will create a new 'Admin' member with administrative permissions if no existing Member with these permissions is found.

Important: Any newly created administrator accounts will NOT have valid login credentials (Email/Password properties), which means they can't be used for login purposes outside of any default credentials set through Security::setDefaultAdmin().

Flush the default admin credentials

Set a default admin in dev-mode

This will set a static default-admin which is not existing as a database-record. By this workaround we can test pages in dev-mode with a unified login. Submitted login-credentials are first checked against this static information in Security::authenticate().

Checks if the passed credentials are matching the default-admin.

Compares cleartext-password set through Security::setDefaultAdmin().

Check that the default admin account has been set.

Get default admin username

Get default admin password

Encrypt a password according to the current password encryption settings.

If the settings are so that passwords shouldn't be encrypted, the result is simple the clear text password with an empty salt except when a custom algorithm ($algorithm parameter) was passed.

Checks the database is in a state to perform security checks.

See DatabaseAdmin->init() for more information.

Resets the database_is_ready cache

For the database_is_ready call to return a certain value - used for testing

Set to true to ignore access to disallowed actions, rather than returning permission failure Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()

No description

Get the URL of the log-in page.

To update the login url use the "Security.login_url" config setting.

Get the URL of the logout page.

To update the logout url use the "Security.logout_url" config setting.

Get the URL of the logout page.

To update the logout url use the "Security.logout_url" config setting.