Index | SilverStripe API

Registers the given object to receive an updated TopPage reference after the duplication operation completes, ensuring the new Page is written to the database beforehand.

AdminErrorExtension — Class in namespace SilverStripe\Admin

AdminRootController — Class in namespace SilverStripe\Admin

AdminRootController::admin_url() — Method in class AdminRootController

Returns the root admin URL for the site with trailing slash

CMSBatchAction::applicablePagesHelper() — Method in class CMSBatchAction

Helper method for applicablePages() methods. Acts as a skeleton implementation.

CMSBatchAction::applicablePages() — Method in class CMSBatchAction

Given a list of object IDs, filter out which items can have this batch action applied to them.

CMSMenu::add_controller() — Method in class CMSMenu

Add a LeftAndMain controller to the CMS menu.

CMSMenu::add_link() — Method in class CMSMenu

Add an arbitrary URL to the CMS menu.

CMSMenu::add_menu_item() — Method in class CMSMenu

Add a navigation item to the main administration menu showing in the top bar.

$ UsedOnTable#allowed_actions — Property in class UsedOnTable

$ LeftAndMain#admin_themes — Property in class LeftAndMain

Themes to use within the CMS

$ LeftAndMain#application_link — Property in class LeftAndMain

The href for the anchor on the Silverstripe logo

$ LeftAndMain#application_name — Property in class LeftAndMain

The application name

LeftAndMain::afterHandleRequest() — Method in class LeftAndMain

LeftAndMain::ApplicationLink() — Method in class LeftAndMain

LeftAndMainExtension::accessedCMS() — Method in class LeftAndMainExtension

LeftAndMainExtension::augmentNewSiteTreeItem() — Method in class LeftAndMainExtension

SudoModeController::activate() — Method in class SudoModeController

After validating the request data including password against the current member, activate sudo mode for the current member.

AssetAdmin — Class in namespace SilverStripe\AssetAdmin\Controller

AssetAdmin is the 'file store' section of the CMS.

AssetAdmin::apiCreateFile() — Method in class AssetAdmin

Creates a single file based on a form-urlencoded upload.

AssetAdmin::apiUploadFile() — Method in class AssetAdmin

Upload a new asset for a pre-existing record. Returns the asset tuple.

AssetAdmin::apiHistory() — Method in class AssetAdmin

Returns a JSON array for history of a given file ID. Returns a list of all the history.

AssetAdmin::addtocampaign() — Method in class AssetAdmin

Action handler for adding pages to a campaign

AssetAdmin::addToCampaignForm() — Method in class AssetAdmin

Url handler for add to campaign form

AssetAdminFieldsExtension — Class in namespace SilverStripe\AssetAdmin\Controller

AssetAdminFile — Class in namespace SilverStripe\AssetAdmin\Controller

Update File dataobjects to be editable in this asset admin

AssetFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms

$ UploadField#allowed_actions — Property in class UploadField

AssetAdminResolver — Class in namespace SilverStripe\AssetAdmin\GraphQL\Resolvers

AssetControlExtension — Class in namespace SilverStripe\Assets

This class provides the necessary business logic to ensure that any assets attached to a record are safely deleted, published, or protected during certain operations.

AssetManipulationList — Class in namespace SilverStripe\Assets

Provides a mechanism for determining the effective visibility of a set of assets (identified by filename and hash), given their membership to objects of varying visibility.

AssetManipulationList::addAsset() — Method in class AssetManipulationList

Add asset with the given state

AssetManipulationList::addPublicAsset() — Method in class AssetManipulationList

Mark a file as public

AssetManipulationList::addProtectedAsset() — Method in class AssetManipulationList

Record an asset as protected

AssetManipulationList::addDeletedAsset() — Method in class AssetManipulationList

Record an asset as deleted

TestAssetStore::activate() — Method in class TestAssetStore

Set this store as the new asset backend

$ File#allowed_extensions — Property in class File

$ File#app_categories — Property in class File

$ File#apply_restrictions_to_admin — Property in class File

File::AbsoluteLink() — Method in class File

Just an alias function to keep a consistent API with SiteTree

File::appCategory() — Method in class File

Returns a category based on the file extension.

AssetAdapter — Class in namespace SilverStripe\Assets\Flysystem

Adapter for local filesystem based on assets directory

$ ImageManipulation#asset_preview_width — Property in class ImageManipulation

The width of an image preview in the Asset section

$ ImageManipulation#asset_preview_height — Property in class ImageManipulation

The height of an image preview in the Asset section

FileLinkTracking::augmentSyncLinkTracking() — Method in class FileLinkTracking

Find HTMLText fields on {@link owner} to scrape for links that need tracking

$ FileShortcodeProvider#allow_session_grant — Property in class FileShortcodeProvider

Set to true if shortcodes should apply a session grant on their calls to getAsURL.

$ ImageShortcodeProvider#attribute_whitelist — Property in class ImageShortcodeProvider

A whitelist of attributes which are allowed in the resultant markup.

AssetContainer — Class in namespace SilverStripe\Assets\Storage

Represents a container for a specific asset.

AssetNameGenerator — Class in namespace SilverStripe\Assets\Storage

Provides a mechanism for suggesting filename alterations to a file

AssetStore — Class in namespace SilverStripe\Assets\Storage

Represents an abstract asset persistence layer. Acts as a backend to files.

AssetStoreRouter — Class in namespace SilverStripe\Assets\Storage

Represents a store usable with ProtectedFileController to serve up non-direct file requests

DBFile::AbsoluteLink() — Method in class DBFile

Return absolute URL for this image. Alias for getAbsoluteURL()

$ Upload_Validator#allowedMaxFileSize — Property in class Upload_Validator

Restrict filesize for either all filetypes or a specific extension, with extension-name as array-key and the size-restriction in bytes as array-value.

$ Upload_Validator#allowedExtensions — Property in class Upload_Validator

AuditFactory — Class in namespace SilverStripe\Auditor

Logs are written using a side-channel, because audit trail should not be mixed up with regular PHP errors.

AuditHook — Class in namespace SilverStripe\Auditor

Provides logging hooks that are inserted into Framework objects.

AuditHook::afterMemberLoggedIn() — Method in class AuditHook

Log successful login attempts.

AuditHook::authenticationFailed() — Method in class AuditHook

Log failed login attempts.

AuditHook::afterMemberLoggedOut() — Method in class AuditHook

Log successful logout.

AuditHookMFA — Class in namespace SilverStripe\Auditor

Provides logging actions on extension hooks from certain silverstripe/mfa actions.

AuditHookManyManyList — Class in namespace SilverStripe\Auditor

AuditHookMemberGroupSet — Class in namespace SilverStripe\Auditor

AuditHookSessionManager — Class in namespace SilverStripe\Auditor

Provides logging actions on extension hooks from certain silverstripe/session-manager actions.

GridFieldMergeAction::augmentColumns() — Method in class GridFieldMergeAction

Modify the list of columns displayed in the table.

BlogController::archive() — Method in class BlogController

Renders an archive for a specified date. This can be by year or year/month.

$ BlogPost#AuthorNames — Property in class BlogPost

BlogPost::Authors() — Method in class BlogPost

BlogPostFilter::augmentSQL() — Method in class BlogPostFilter

Augment queries so that we don't fetch unpublished articles.

BlogPostFilter::augmentLoadLazyFields() — Method in class BlogPostFilter

{@inheritDoc}

$ BlogArchiveWidget#ArchiveType — Property in class BlogArchiveWidget

CMSBatchAction_Archive::applicablePages() — Method in class CMSBatchAction_Archive

Given a list of object IDs, filter out which items can have this batch action applied to them.

CMSBatchAction_Publish::applicablePages() — Method in class CMSBatchAction_Publish

Given a list of object IDs, filter out which items can have this batch action applied to them.

CMSBatchAction_Restore::applicablePages() — Method in class CMSBatchAction_Restore

{see SiteTree::canEdit()}

CMSBatchAction_Unpublish::applicablePages() — Method in class CMSBatchAction_Unpublish

Given a list of object IDs, filter out which items can have this batch action applied to them.

CMSMain::archive() — Method in class CMSMain

Delete this page from both live and stage

CMSPageAddController::AddForm() — Method in class CMSPageAddController

CMSPageEditController::addtocampaign() — Method in class CMSPageEditController

Action handler for adding pages to a campaign

CMSPageEditController::AddToCampaignForm() — Method in class CMSPageEditController

Url handler for add to campaign form

AnchorLinkFormFactory — Class in namespace SilverStripe\CMS\Forms

AnchorSelectorField — Class in namespace SilverStripe\CMS\Forms

Assists with selecting anchors on a given page

AnchorSelectorField::anchors() — Method in class AnchorSelectorField

Find all anchors available on the given page.

LinkablePlugin::apply() — Method in class LinkablePlugin

LinkablePlugin::applyLinkFilter() — Method in class LinkablePlugin

$ SiteTree#allowed_children — Property in class SiteTree

Indicates what kind of children this page type can have.

SiteTree::AbsoluteLink() — Method in class SiteTree

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

SiteTree::allowedChildren() — Method in class SiteTree

Returns an array of the class names of classes that are allowed to be children of this class.

SiteTreeLinkTracking::augmentSyncLinkTracking() — Method in class SiteTreeLinkTracking

Find HTMLText fields on {@link owner} to scrape for links that need tracking

VirtualPage::allowedChildren() — Method in class VirtualPage

VirtualPage::allMethodNames() — Method in class VirtualPage

{@inheritdoc}

AddToCampaignHandler — Class in namespace SilverStripe\CampaignAdmin

Class AddToCampaignHandler - handle the AddToCampaign action.

AddToCampaignHandler::addToCampaign() — Method in class AddToCampaignHandler

Performs the actual action of adding the object to the ChangeSet, once the ChangeSet ID is known

AddToCampaignHandler_FormAction — Class in namespace SilverStripe\CampaignAdmin

A form action to return from geCMSActions or otherwise include in a CMS Edit Form that has the right action name and CSS classes to trigger the AddToCampaignHandler.

AddToCampaignValidator — Class in namespace SilverStripe\CampaignAdmin

ConfigCollectionInterface::addMiddleware() — Method in class ConfigCollectionInterface

MiddlewareAware::addMiddleware() — Method in class MiddlewareAware

YamlTransformer::addRule() — Method in class YamlTransformer

This allows external rules to be added to only/except checks. Config is only supposed to be setup once, so adding rules is a one-way system. You cannot remove rules after being set. This also prevent built-in rules from being removed.

SiteTreeContentReview::addReviewNote() — Method in class SiteTreeContentReview

Creates a ContentReviewLog and connects it to this Page.

SiteTreeContentReview::advanceReviewDate() — Method in class SiteTreeContentReview

Advance review date to the next date based on review period or set it to null if there is no schedule. Returns true if date was required and false is content review is 'off'.

$ Director#alternate_base_folder — Property in class Director

Director::absoluteURL() — Method in class Director

Converts the given path or url into an absolute url. This method follows the below rules:

Absolute urls (e.g. http://localhost) are not modified
Relative urls (e.g. //localhost) have current protocol added (http://localhost)
Absolute paths (e.g. /base/about-us) are resolved by adding the current protocol and host (http://localhost/base/about-us)
Relative paths (e.g. about-us/staff) must be resolved using one of three methods, disambiguated via the $relativeParent argument:
- BASE - Append this path to the base url (i.e. behaves as though <base> tag is provided in a html document). This is the default.

Director::absoluteBaseURL() — Method in class Director

Returns the Absolute URL of the site root.

Director::absoluteBaseURLWithAuth() — Method in class Director

Returns the Absolute URL of the site root, embedding the current basic-auth credentials into the URL.

Email::addAttachment() — Method in class Email

Email::addAttachmentFromData() — Method in class Email

Email::addData() — Method in class Email

Add data to be used in the template

HTTP::absoluteURLs() — Method in class HTTP

Turn all relative URLs in the content to absolute URLs.

HTTPRequest::addHeader() — Method in class HTTPRequest

Add a HTTP header to the response, replacing any header of the same name.

HTTPRequest::allParams() — Method in class HTTPRequest

HTTPRequest::allParsed() — Method in class HTTPRequest

Returns true if the URL has been completely parsed.

HTTPResponse::addHeader() — Method in class HTTPResponse

Add a HTTP header to the response, replacing any header of the same name.

AllowedHostsMiddleware — Class in namespace SilverStripe\Control\Middleware

Secures requests by only allowing a whitelist of Host values

AjaxBypass — Class in namespace SilverStripe\Control\Middleware\ConfirmationMiddleware

Bypass for AJAX requests

HttpMethodBypass::addMethods() — Method in class HttpMethodBypass

Add new HTTP methods to the list

Url::addHttpMethods() — Method in class Url

Add HTTP methods to check against

$ HTTPCacheControlMiddleware#allowed_directives — Property in class HTTPCacheControlMiddleware

A list of allowed cache directives for HTTPResponses

HTTPCacheControlMiddleware::addVary() — Method in class HTTPCacheControlMiddleware

Add a vary

HTTPCacheControlMiddleware::applyToResponse() — Method in class HTTPCacheControlMiddleware

Generate all headers to add to this object

HTTPMiddlewareAware::addMiddleware() — Method in class HTTPMiddlewareAware

RSSFeed_Entry::Author() — Method in class RSSFeed_Entry

Get the author of this entry

RSSFeed_Entry::AbsoluteLink() — Method in class RSSFeed_Entry

Get a link to this entry

$ RequestHandler#allowed_actions — Property in class RequestHandler

Define a list of action handling methods that are allowed to be called directly by URLs.

RequestHandler::allowedActions() — Method in class RequestHandler

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

RequestHandler::AbsoluteLink() — Method in class RequestHandler

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

Session::addToArray() — Method in class Session

Merge value with array

Application — Class in namespace SilverStripe\Core

Identifies a class as a root silverstripe application

BaseKernel::activate() — Method in class BaseKernel

Ensures this kernel is the active kernel after or during nesting

ApcuCacheFactory — Class in namespace SilverStripe\Core\Cache

ClassInfo::allClasses() — Method in class ClassInfo

Wrapper for classes getter.

ClassInfo::ancestry() — Method in class ClassInfo

Returns the passed class name along with all its parent class names in an array, sorted with the root class first.

ConfigLoader::activate() — Method in class ConfigLoader

Mark this instance as the current instance

CustomMethods::allMethodNames() — Method in class CustomMethods

Return the names of all the methods available on this object

Extensible::add_extension() — Method in class Extensible

Add an extension to a specific class.

Extension::add_to_class() — Method in class Extension

Called when this extension is added to a particular class

AfterCallAspect — Class in namespace SilverStripe\Core\Injector

An AfterCallAspect is run after a method is executed

AfterCallAspect::afterCall() — Method in class AfterCallAspect

Call this aspect after a method is executed

AopProxyService — Class in namespace SilverStripe\Core\Injector

A class that proxies another, allowing various functionality to be injected.

$ AopProxyService#afterCall — Property in class AopProxyService

Injector::addAutoProperty() — Method in class Injector

Add an object that should be automatically set on managed objects

InjectorLoader::activate() — Method in class InjectorLoader

Mark this instance as the current instance

Kernel::activate() — Method in class Kernel

Ensures this kernel is the active kernel after or during nesting

ManifestFileFinder::acceptDir() — Method in class ManifestFileFinder

Module::activate() — Method in class Module

Activate _config.php for this module, if one exists

ModuleManifest::addModule() — Method in class ModuleManifest

Adds a path as a module

ModuleManifest::activateConfig() — Method in class ModuleManifest

Includes all of the php _config.php files found by this manifest.

BulkLoader_Result::addCreated() — Method in class BulkLoader_Result

BulkLoader_Result::addUpdated() — Method in class BulkLoader_Result

BulkLoader_Result::addDeleted() — Method in class BulkLoader_Result

DevConfigController::audit() — Method in class DevConfigController

Output the extraneous config properties which are defined in .yaml but not in a corresponding class

$ DevelopmentAdmin#allow_all_cli — Property in class DevelopmentAdmin

Assume that CLI equals admin permissions If set to false, normal permission model will apply even in CLI mode Applies to all development admin tasks (E.g. TaskRunner, DatabaseAdmin)

FixtureBlueprint::addCallback() — Method in class FixtureBlueprint

See class documentation.

FunctionalTest::assertPartialMatchBySelector() — Method in class FunctionalTest

Assert that the most recently queried page contains a number of content tags specified by a CSS selector.

FunctionalTest::assertExactMatchBySelector() — Method in class FunctionalTest

Assert that the most recently queried page contains a number of content tags specified by a CSS selector.

FunctionalTest::assertPartialHTMLMatchBySelector() — Method in class FunctionalTest

Assert that the most recently queried page contains a number of content tags specified by a CSS selector.

FunctionalTest::assertExactHTMLMatchBySelector() — Method in class FunctionalTest

Assert that the most recently queried page contains a number of content tags specified by a CSS selector.

DatabaseAdapterRegistry::autodiscover() — Method in class DatabaseAdapterRegistry

Detects all _register_database.php files and invokes them.

DatabaseAdapterRegistry::autoconfigure() — Method in class DatabaseAdapterRegistry

Detects all _configure_database.php files and invokes them Called by ConfigureFromEnv.php.

SapphireTest::assertEmailSent() — Method in class SapphireTest

Assert that the matching email was sent since the last call to clearEmails() All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.

SapphireTest::assertListContains() — Method in class SapphireTest

Assert that the given {@link SS_List} includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.

SapphireTest::assertListNotContains() — Method in class SapphireTest

Asserts that no items in a given list appear in the given dataobject list

SapphireTest::assertListEquals() — Method in class SapphireTest

Assert that the given {@link SS_List} includes only DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.

SapphireTest::assertListAllMatch() — Method in class SapphireTest

Assert that the every record in the given {@link SS_List} matches the given key-value pairs.

SapphireTest::assertSQLEquals() — Method in class SapphireTest

Asserts that two SQL queries are equivalent

SapphireTest::assertSQLContains() — Method in class SapphireTest

Asserts that a SQL query contains a SQL fragment

SapphireTest::assertSQLNotContains() — Method in class SapphireTest

Asserts that a SQL query contains a SQL fragment

SapphireTest::actWithPermission() — Method in class SapphireTest

A wrapper for automatically performing callbacks as a user with a specific permission

EnvironmentCheckSuiteResult::addResult() — Method in class EnvironmentCheckSuiteResult

CompositeValidator::addValidator() — Method in class CompositeValidator

FieldList::addFieldToTab() — Method in class FieldList

Add an extra field to a tab within this FieldList.

FieldList::addFieldsToTab() — Method in class FieldList

Add a number of extra fields to a tab within this FieldList.

Form::actionIsValidationExempt() — Method in class Form

Passed a FormAction, returns true if that action is exempt from Form validation

Form::Actions() — Method in class Form

Return the form's action buttons - used by the templates

Form::addExtraClass() — Method in class Form

Add a CSS-class to the form-container. If needed, multiple classes can be added by delimiting a string with spaces.

FormAction::actionName() — Method in class FormAction

Get the action name

FormField::addExtraClass() — Method in class FormField

Add one or more CSS-classes to the FormField container.

FormField::attrTitle() — Method in class FormField

Returns a version of a title suitable for insertion into an HTML attribute.

FormField::attrValue() — Method in class FormField

Returns a version of a title suitable for insertion into an HTML attribute.

$ FormRequestHandler#allowed_actions — Property in class FormRequestHandler

$ FormScaffolder#ajaxSafe — Property in class FormScaffolder

FormScaffolder::addManyManyRelationshipFields() — Method in class FormScaffolder

Adds the default many-many relation fields for the relationship provided.

AbstractGridFieldComponent — Class in namespace SilverStripe\Forms\GridField

AbstractRequestAwareStore — Class in namespace SilverStripe\Forms\GridField\FormAction

AttributeStore — Class in namespace SilverStripe\Forms\GridField\FormAction

Stores GridField action state on an attribute on the action and then analyses request parameters to load it back

GridField::addAllStateToUrl() — Method in class GridField

Add GET and POST parameters pertaining to other gridfield's state to the URL.

GridField::addDataFields() — Method in class GridField

Add additional calculated data fields to be used on this GridField

GridFieldConfig::addComponent() — Method in class GridFieldConfig

GridFieldConfig::addComponents() — Method in class GridFieldConfig

GridFieldDataColumns::augmentColumns() — Method in class GridFieldDataColumns

Modify the list of columns displayed in the table.

GridFieldDeleteAction::augmentColumns() — Method in class GridFieldDeleteAction

Add a column 'Delete'

GridFieldEditButton::augmentColumns() — Method in class GridFieldEditButton

Add a column 'Delete'

GridFieldEditButton::addExtraClass() — Method in class GridFieldEditButton

Add an extra HTML class

GridFieldStateManager::addStateToURL() — Method in class GridFieldStateManager

GridFieldStateManagerInterface::addStateToURL() — Method in class GridFieldStateManagerInterface

GridFieldViewButton::augmentColumns() — Method in class GridFieldViewButton

Modify the list of columns displayed in the table.

GridField_ActionMenu::augmentColumns() — Method in class GridField_ActionMenu

Modify the list of columns displayed in the table.

GridField_ColumnProvider::augmentColumns() — Method in class GridField_ColumnProvider

Modify the list of columns displayed in the table.

GridState::array_to_object() — Method in class GridState

GridState::attrValue() — Method in class GridState

TinyMCEConfig::addButtonsToLine() — Method in class TinyMCEConfig

Add buttons to the end of a line

RequiredFields::addRequiredField() — Method in class RequiredFields

Adds a single required field to required fields stack.

RequiredFields::appendRequiredFields() — Method in class RequiredFields

Add {@link RequiredField} objects together

AbstractSegmentFieldModifier — Class in namespace SilverStripe\Forms\SegmentFieldModifier

AuthenticatorInterface — Class in namespace SilverStripe\GraphQL\Auth

An AuthenticatorInterface is responsible for authenticating against a SilverStripe CMS Member from the given request data.

AuthenticatorInterface::authenticate() — Method in class AuthenticatorInterface

Given the current request, authenticate the request for non-session authorization (outside the CMS).

BasicAuthAuthenticator::authenticate() — Method in class BasicAuthAuthenticator

Given the current request, authenticate the request for non-session authorization (outside the CMS).

Configuration::apply() — Method in class Configuration

Controller::autobuildEnabled() — Method in class Controller

Controller::addCorsHeaders() — Method in class Controller

Process the CORS config options and add the appropriate headers to the response.

QueryRecorderExtension::augmentDataQueryCreation() — Method in class QueryRecorderExtension

Record query against a given class.

QueryHandler::addContextProvider() — Method in class QueryHandler

QueryHandler::addMiddleware() — Method in class QueryHandler

QueryHandlerInterface::addContextProvider() — Method in class QueryHandlerInterface

VersionFilters::applyToReadingState() — Method in class VersionFilters

Use this as a fallback where resolver results aren't queried as a DataList, but rather use DataObject::get_one(). Example: SiteTree::get_by_link().

VersionFilters::applyToList() — Method in class VersionFilters

AbstractBulkLoader — Class in namespace SilverStripe\GraphQL\Schema\BulkLoader

Provides base functionality to all bulk loaders. Should override the collect() method with computations that parse the include/exclude directives and return a collection of classes.

AbstractBulkLoader::applyConfig() — Method in class AbstractBulkLoader

BulkLoaderSet::applyConfig() — Method in class BulkLoaderSet

BulkLoaderSet::addLoader() — Method in class BulkLoaderSet

AbstractTypeResolver — Class in namespace SilverStripe\GraphQL\Schema\DataObject

Used for unions and interfaces to map a class instance to a type

$ FieldAccessor#allowed_aggregates — Property in class FieldAccessor

FieldAccessor::accessField() — Method in class FieldAccessor

Resolves complex dot syntax references.

InheritanceUnionBuilder::applyUnionsToQueries() — Method in class InheritanceUnionBuilder

Changes all queries to use inheritance unions where applicable

InterfaceBuilder::applyBaseInterface() — Method in class InterfaceBuilder

InterfaceBuilder::applyInterfacesToQueries() — Method in class InterfaceBuilder

ModelCreator::appliesTo() — Method in class ModelCreator

AbstractCanViewPermission — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin

Defines a permission checking plugin for queries. Subclasses just need to provide a resolver function

AbstractCanViewPermission::apply() — Method in class AbstractCanViewPermission

DBDateArgs::applyToField() — Method in class DBDateArgs

DBDecimalArgs::applyToField() — Method in class DBDecimalArgs

DBFieldArgs::applyToField() — Method in class DBFieldArgs

DBFieldArgsPlugin::apply() — Method in class DBFieldArgsPlugin

DBFloatArgs::applyToField() — Method in class DBFloatArgs

DBHTMLTextArgs::applyToField() — Method in class DBHTMLTextArgs

DBTextArgs::applyToField() — Method in class DBTextArgs

DBTimeArgs::applyToField() — Method in class DBTimeArgs

DBFieldTypes::apply() — Method in class DBFieldTypes

FirstResult::apply() — Method in class FirstResult

Inheritance::apply() — Method in class Inheritance

InheritedPlugins::apply() — Method in class InheritedPlugins

FieldFilterInterface::apply() — Method in class FieldFilterInterface

FieldFilterRegistry::addFilter() — Method in class FieldFilterRegistry

FilterRegistryInterface::addFilter() — Method in class FilterRegistryInterface

ContainsFilter::apply() — Method in class ContainsFilter

EndsWithFilter::apply() — Method in class EndsWithFilter

EqualToFilter::apply() — Method in class EqualToFilter

GreaterThanFilter::apply() — Method in class GreaterThanFilter

GreaterThanOrEqualFilter::apply() — Method in class GreaterThanOrEqualFilter

InFilter::apply() — Method in class InFilter

LessThanFilter::apply() — Method in class LessThanFilter

LessThanOrEqualFilter::apply() — Method in class LessThanOrEqualFilter

NotEqualFilter::apply() — Method in class NotEqualFilter

StartsWithFilter::apply() — Method in class StartsWithFilter

QueryFilter::apply() — Method in class QueryFilter

QuerySort::apply() — Method in class QuerySort

ScalarDBField::apply() — Method in class ScalarDBField

Argument — Class in namespace SilverStripe\GraphQL\Schema\Field

An abstraction of a field argument

Argument::applyConfig() — Method in class Argument

Field::applyConfig() — Method in class Field

Field::addArg() — Method in class Field

Field::addResolverContext() — Method in class Field

Field::addResolverMiddleware() — Method in class Field

Field::addResolverAfterware() — Method in class Field

ModelField::applyConfig() — Method in class ModelField

ConfigurationApplier::applyConfig() — Method in class ConfigurationApplier

FieldPlugin::apply() — Method in class FieldPlugin

ModelFieldPlugin::apply() — Method in class ModelFieldPlugin

ModelMutationPlugin::apply() — Method in class ModelMutationPlugin

ModelQueryPlugin::apply() — Method in class ModelQueryPlugin

ModelTypePlugin::apply() — Method in class ModelTypePlugin

MutationPlugin::apply() — Method in class MutationPlugin

QueryPlugin::apply() — Method in class QueryPlugin

SchemaModelCreatorInterface::appliesTo() — Method in class SchemaModelCreatorInterface

TypePlugin::apply() — Method in class TypePlugin

Logger::alert() — Method in class Logger

AbstractQueryFilterPlugin — Class in namespace SilverStripe\GraphQL\Schema\Plugin

Generic plugin that can be used for filter inputs

AbstractQueryFilterPlugin::apply() — Method in class AbstractQueryFilterPlugin

AbstractQuerySortPlugin — Class in namespace SilverStripe\GraphQL\Schema\Plugin

Generic plugin that can be used to add sort paramaters to a query

AbstractQuerySortPlugin::apply() — Method in class AbstractQuerySortPlugin

PaginationPlugin::apply() — Method in class PaginationPlugin

PluginConsumer::addPlugin() — Method in class PluginConsumer

SortPlugin::apply() — Method in class SortPlugin

EncodedResolver::addContext() — Method in class EncodedResolver

EncodedResolver::addMiddleware() — Method in class EncodedResolver

EncodedResolver::addAfterware() — Method in class EncodedResolver

Schema::applyConfig() — Method in class Schema

Converts a configuration array to instance state.

Schema::addQuery() — Method in class Schema

Schema::addMutation() — Method in class Schema

Schema::addType() — Method in class Schema

Schema::addEnum() — Method in class Schema

Schema::addScalar() — Method in class Schema

Schema::addModel() — Method in class Schema

Schema::addModelbyClassName() — Method in class Schema

Schema::addInterface() — Method in class Schema

Schema::addUnion() — Method in class Schema

Schema::applyBulkLoader() — Method in class Schema

Schema::applyBulkLoaders() — Method in class Schema

Schema::assertValidConfig() — Method in class Schema

Schema::assertValidName() — Method in class Schema

AbstractTypeRegistry — Class in namespace SilverStripe\GraphQL\Schema\Storage

Enum::addValue() — Method in class Enum

InterfaceType::applyConfig() — Method in class InterfaceType

ModelType::applyConfig() — Method in class ModelType

ModelType::addField() — Method in class ModelType

ModelType::addFields() — Method in class ModelType

ModelType::addAllFields() — Method in class ModelType

ModelType::addAllOperations() — Method in class ModelType

ModelType::applyOperationsConfig() — Method in class ModelType

ModelType::addOperation() — Method in class ModelType

Scalar::applyConfig() — Method in class Scalar

Type::applyConfig() — Method in class Type

Type::addField() — Method in class Type

Type::addInterface() — Method in class Type

UnionType::applyConfig() — Method in class UnionType

LDAPAuthenticator::authenticate() — Method in class LDAPAuthenticator

Performs the login, but will also create and sync the Member record on-the-fly, if not found.

$ LDAPLoginHandler#allowed_actions — Property in class LDAPLoginHandler

$ LDAPLostPasswordHandler#allowed_actions — Property in class LDAPLostPasswordHandler

Since the logout and dologin actions may be conditionally removed, it's necessary to ensure these remain valid actions regardless of the member login state.

$ LDAPMemberExtension#allow_update_failure_during_login — Property in class LDAPMemberExtension

If enabled, this allows the afterMemberLoggedIn() call to fail to update the user without causing a login failure and server error. This can be useful when not all of your web servers have access to the LDAP server (for example when your front-line web servers are not the servers that perform the LDAP sync into the database.

LDAPMemberExtension::afterMemberLoggedIn() — Method in class LDAPMemberExtension

Triggered by {@link IdentityStore::logIn()}. When successfully logged in, this will update the Member record from LDAP data.

LDAPGateway::authenticate() — Method in class LDAPGateway

Authenticate the given username and password with LDAP.

LDAPGateway::add() — Method in class LDAPGateway

Add an LDAP object.

LDAPService::authenticate() — Method in class LDAPService

Authenticate the given username and password with LDAP.

LDAPService::addLDAPUserToGroup() — Method in class LDAPService

Add LDAP user by DN to LDAP group.

LDAPService::add() — Method in class LDAPService

A simple proxy to LDAP add operation.

EnablerExtension::afterCallActionHandler() — Method in class EnablerExtension

GridFieldSiteTreeState::augmentColumns() — Method in class GridFieldSiteTreeState

Modify the list of columns displayed in the table.

Method::applyRequirements() — Method in class Method

Leverage the Requirements API to ensure client requirements are included. This is called just after the base module requirements are specified

AdminRegistrationController — Class in namespace SilverStripe\MFA\Controller

This controller handles actions that a user may perform on MFA methods registered on their own account while logged in. This includes deleting methods, registering new methods and replacing (re-registering) existing methods.

AuthenticationFailedException — Class in namespace SilverStripe\MFA\Exception

$ MemberExtension#AccountResetHash — Property in class MemberExtension

$ MemberExtension#AccountResetExpired — Property in class MemberExtension

MemberExtension::afterMemberLoggedIn() — Method in class MemberExtension

Clear any temporary multi-factor authentication related session keys when a member is successfully logged in.

MethodInterface::applyRequirements() — Method in class MethodInterface

Leverage the Requirements API to ensure client requirements are included. This is called just after the base module requirements are specified

AvailableMethodDetails — Class in namespace SilverStripe\MFA\State

AvailableMethodDetailsInterface — Class in namespace SilverStripe\MFA\State

Used to provide details about an available {@link \SilverStripe\MFA\Method\MethodInterface} instance, for example when being used in the multi-factor application schema.

SessionStore::addState() — Method in class SessionStore

Add to the state in the store

SessionStore::addVerifiedMethod() — Method in class SessionStore

Add and keep track of methods that have been verified

StoreInterface::addState() — Method in class StoreInterface

Add to the state in the store

StoreInterface::addVerifiedMethod() — Method in class StoreInterface

Add and keep track of methods that have been verified

ArrayLib — Class in namespace SilverStripe\ORM

Library of static methods for manipulating arrays.

ArrayLib::array_values_recursive() — Method in class ArrayLib

Flattens a multi-dimensional array to a one level array without preserving the keys

ArrayLib::array_map_recursive() — Method in class ArrayLib

Similar to array_map, but recurses when arrays are encountered.

ArrayLib::array_merge_recursive() — Method in class ArrayLib

Recursively merges two or more arrays.

ArrayList — Class in namespace SilverStripe\ORM

A list object that wraps around an array of objects or arrays.

ArrayList::add() — Method in class ArrayList

Add this $item into this list

DBConnector::affectedRows() — Method in class DBConnector

Determines the number of affected rows from the last SQL query

DBSchemaManager::alterationMessage() — Method in class DBSchemaManager

Show a message about database alteration

DBSchemaManager::alterIndex() — Method in class DBSchemaManager

Alter an index on a table.

DBSchemaManager::alterTable() — Method in class DBSchemaManager

Alter a table's schema.

Database::affectedRows() — Method in class Database

Return the number of rows affected by the previous operation.

MySQLSchemaManager::alterTable() — Method in class MySQLSchemaManager

Alter a table's schema.

MySQLSchemaManager::alterField() — Method in class MySQLSchemaManager

Change the database type of the given field.

MySQLSchemaManager::alterIndex() — Method in class MySQLSchemaManager

Alter an index on a table.

MySQLiConnector::affectedRows() — Method in class MySQLiConnector

Determines the number of affected rows from the last SQL query

$ DB#alternative_database_enabled — Property in class DB

Allow alternative DB to be disabled.

DB::affected_rows() — Method in class DB

Return the number of rows affected by the previous operation.

DB::alteration_message() — Method in class DB

Show a message about database alteration

DataExtension::augmentSQL() — Method in class DataExtension

Edit the given query object to support queries for this extension

DataExtension::augmentDatabase() — Method in class DataExtension

Update the database schema as required by this extension.

DataExtension::augmentWrite() — Method in class DataExtension

Augment a write-record request.

DataList::alterDataQuery() — Method in class DataList

Return a new DataList instance with the underlying {@link DataQuery} object altered

DataList::addFilter() — Method in class DataList

Return a new instance of the list with an added filter

DataList::applyRelation() — Method in class DataList

Given a field or relation name, apply it safely to this datalist.

DataList::avg() — Method in class DataList

Return the average value of the given field in this DataList

DataList::addMany() — Method in class DataList

Add a number of items to the component set.

DataList::add() — Method in class DataList

This method are overloaded by HasManyList and ManyMany list to perform more sophisticated list manipulation

$ DataObject#api_access — Property in class DataObject

Allow API access to this object?

DataQuery::avg() — Method in class DataQuery

Return the average value of the given field in this DataList

DataQuery::aggregate() — Method in class DataQuery

Runs a raw aggregate expression. Please handle escaping yourself

DataQuery::applyRelationPrefix() — Method in class DataQuery

Prefix of all joined table aliases. E.g. ->filter('Banner.Image.Title)' Will join the Banner, and then Image relations $relationPrefx will be banner_image_ Each table in the Image chain will be suffixed to this prefix. E.g.

DataQuery::applyRelation() — Method in class DataQuery

Traverse the relationship fields, and add the table mappings to the query object state. This has to be called in any overloaded {@link SearchFilter->apply()} methods manually.

DataQuery::addSelectFromTable() — Method in class DataQuery

Add the given fields from the given table to the select statement.

DataQueryManipulator::afterGetFinalisedQuery() — Method in class DataQueryManipulator

Invoked after getFinalisedQuery()

DBComposite::addToQuery() — Method in class DBComposite

Add all columns which are defined through {@link requireField()} and {@link $composite_db}, or any additional SQL that is required to get to these columns. Will mostly just write to the {@link SQLSelect->select} array.

DBDate::Ago() — Method in class DBDate

Returns the number of seconds/minutes/hours/days or months since the timestamp.

DBField::addToQuery() — Method in class DBField

Add custom query parameters for this field, mostly SELECT statements for multi-value fields.

DBField::ATT() — Method in class DBField

Gets the value appropriate for a HTML attribute string

DBHTMLText::AbsoluteLinks() — Method in class DBHTMLText

Return the value of the field with relative links converted to absolute urls (with placeholders parsed).

PartialMatchFilter::apply() — Method in class PartialMatchFilter

Apply filter criteria to a SQL query.

SearchFilter::applyAggregate() — Method in class SearchFilter

Given an escaped HAVING clause, add it along with the appropriate GROUP BY clause

SearchFilter::apply() — Method in class SearchFilter

Apply filter criteria to a SQL query.

HasManyList::add() — Method in class HasManyList

Adds the item to this relation.

Hierarchy::AllChildren() — Method in class Hierarchy

Return all children, including those 'not in menus'.

Hierarchy::AllChildrenIncludingDeleted() — Method in class Hierarchy

Return all children, including those that have been deleted but are still in live.

Hierarchy::AllHistoricalChildren() — Method in class Hierarchy

Return all the children that this page had, including pages that were deleted from both stage & live.

ManyManyList::add() — Method in class ManyManyList

Add an item to this many_many relationship Does so by adding an entry to the joinTable.

ManyManyThroughList::add() — Method in class ManyManyThroughList

ManyManyThroughQueryManipulator::afterGetFinalisedQuery() — Method in class ManyManyThroughQueryManipulator

Invoked after getFinalisedQuery()

PolymorphicHasManyList::add() — Method in class PolymorphicHasManyList

Adds the item to this relation.

SQLAssignmentRow::addAssignments() — Method in class SQLAssignmentRow

Adds assignments for a list of several fields

SQLAssignmentRow::assign() — Method in class SQLAssignmentRow

Set the value for a single field

SQLAssignmentRow::assignSQL() — Method in class SQLAssignmentRow

Assigns a value to a field using the literal SQL expression, rather than a value to be escaped

SQLConditionalExpression::addFrom() — Method in class SQLConditionalExpression

Add a table to include in the query or update

SQLConditionalExpression::addLeftJoin() — Method in class SQLConditionalExpression

Add a LEFT JOIN criteria to the tables list.

SQLConditionalExpression::addInnerJoin() — Method in class SQLConditionalExpression

Add an INNER JOIN criteria

SQLConditionalExpression::addFilterToJoin() — Method in class SQLConditionalExpression

Add an additional filter (part of the ON clause) on a join.

SQLConditionalExpression::addWhere() — Method in class SQLConditionalExpression

Adds a WHERE clause.

SQLConditionalExpression::addWhereAny() — Method in class SQLConditionalExpression

SQLDelete::addDelete() — Method in class SQLDelete

Sets the list of tables to limit the delete to, if multiple tables are specified in the condition clause

SQLInsert::addRow() — Method in class SQLInsert

Appends a new row to insert

SQLInsert::addRows() — Method in class SQLInsert

Adds the list of rows to the array

SQLInsert::addAssignments() — Method in class SQLInsert

Adds assignments for a list of several fields.

SQLInsert::assign() — Method in class SQLInsert

Set the value for a single field

SQLInsert::assignSQL() — Method in class SQLInsert

Assigns a value to a field using the literal SQL expression, rather than a value to be escaped

SQLSelect::addSelect() — Method in class SQLSelect

Add to the list of columns to be selected by the query.

SQLSelect::addOrderBy() — Method in class SQLSelect

Add ORDER BY clause either as SQL snippet or in array format.

SQLSelect::addGroupBy() — Method in class SQLSelect

Add a GROUP BY clause.

SQLSelect::addHaving() — Method in class SQLSelect

Add a HAVING clause

SQLSelect::aggregate() — Method in class SQLSelect

Return a new SQLSelect that calls the given aggregate functions on this data.

SQLUpdate::addAssignments() — Method in class SQLUpdate

Adds assignments for a list of several fields.

SQLUpdate::assign() — Method in class SQLUpdate

Set the value for a single field

SQLUpdate::assignSQL() — Method in class SQLUpdate

Assigns a value to a field using the literal SQL expression, rather than a value to be escaped

SQLWriteExpression::addAssignments() — Method in class SQLWriteExpression

Adds assignments for a list of several fields.

SQLWriteExpression::assign() — Method in class SQLWriteExpression

Set the value for a single field

SQLWriteExpression::assignSQL() — Method in class SQLWriteExpression

Assigns a value to a field using the literal SQL expression, rather than a value to be escaped

RelationList::addCallbacks() — Method in class RelationList

Manage callbacks which are called after the add() action is completed.

SS_List::add() — Method in class SS_List

Adds an item to the list, making no guarantees about where it will appear.

SearchContext::addFilter() — Method in class SearchContext

Adds a instance of {@link SearchFilter}.

SearchContext::addField() — Method in class SearchContext

Adds a new {@link FormField} instance.

UnsavedRelationList::add() — Method in class UnsavedRelationList

Add an item to this relationship

UnsavedRelationList::addMany() — Method in class UnsavedRelationList

Add a number of items to the relation.

ValidationResult::addError() — Method in class ValidationResult

Record an error against this validation result,

ValidationResult::addFieldError() — Method in class ValidationResult

Record an error against this validation result,

ValidationResult::addMessage() — Method in class ValidationResult

Add a message to this ValidationResult without necessarily marking it as an error

ValidationResult::addFieldMessage() — Method in class ValidationResult

Add a message to this ValidationResult without necessarily marking it as an error

Authenticator — Class in namespace SilverStripe\RealMe

Class RealMeAuthenticator

Authenticator::authenticate() — Method in class Authenticator

Method to authenticate an user.

$ LoginHandler#allowed_actions — Property in class LoginHandler

LoginHandler::acs() — Method in class LoginHandler

$ RealMeService#authn_contexts — Property in class RealMeService

$ RealMeService#allowed_authn_context_list — Property in class RealMeService

RegistryPageController::AllQueryVars() — Method in class RegistryPageController

Get all search query vars, compiled into a query string for a URL.

ReportWrapper::afterQuery() — Method in class ReportWrapper

Override this method to perform some actions after querying.

BasicRestfulAuthenticator::authenticate() — Method in class BasicRestfulAuthenticator

The authenticate function

$ JSONDataFormatter#api_base — Property in class JSONDataFormatter

$ XMLDataFormatter#api_base — Property in class XMLDataFormatter

$ RestfulServer#api_base — Property in class RestfulServer

$ RestfulServer#authenticator — Property in class RestfulServer

AuthenticationHandler — Class in namespace SilverStripe\Security

An AuthenticationHandler is responsible for providing an identity (in the form of a Member object) for a given HTTPRequest.

AuthenticationHandler::authenticateRequest() — Method in class AuthenticationHandler

Given the current request, authenticate the request for non-session authorization (outside the CMS).

AuthenticationMiddleware — Class in namespace SilverStripe\Security

Authenticator — Class in namespace SilverStripe\Security

Abstract base class for an authentication method

Authenticator::authenticate() — Method in class Authenticator

Method to authenticate an user.

Group::AllChildrenIncludingDeleted() — Method in class Group

Returns all of the children for the CMS Tree.

$ Member#auto_login_token_lifetime — Property in class Member

Default lifetime of auto login token.

$ Member#AutoLoginHash — Property in class Member

$ Member#AutoLoginExpired — Property in class Member

Member::afterMemberLoggedIn() — Method in class Member

Called after a member is logged in via session/cookie/etc

Member::afterMemberLoggedOut() — Method in class Member

Audit logging hook, called after a member is logged out

Member::actAs() — Method in class Member

Temporarily act as the specified user, limited to a $callback, but without logging in as that user.

Member::addToGroupByCode() — Method in class Member

Adds the member to a group. This will create the group if the given group code does not return a valid group object.

CookieAuthenticationHandler::authenticateRequest() — Method in class CookieAuthenticationHandler

$ LoginHandler#allowed_actions — Property in class LoginHandler

$ LostPasswordHandler#allowed_actions — Property in class LostPasswordHandler

Since the logout and dologin actions may be conditionally removed, it's necessary to ensure these remain valid actions regardless of the member login state.

MemberAuthenticator::authenticate() — Method in class MemberAuthenticator

Method to authenticate an user.

SessionAuthenticationHandler::authenticateRequest() — Method in class SessionAuthenticationHandler

Member_GroupSet::add() — Method in class Member_GroupSet

Add an item to this many_many relationship Does so by adding an entry to the joinTable.

NullSecurityToken::addToUrl() — Method in class NullSecurityToken

PasswordExpirationMiddleware::allowCurrentRequest() — Method in class PasswordExpirationMiddleware

Allow the current request to be finished without password expiration check

$ Permission#admin_implies_all — Property in class Permission

Set to false to prevent the 'ADMIN' permission from implying all permissions in the system

RequestAuthenticationHandler::authenticateRequest() — Method in class RequestAuthenticationHandler

Given the current request, authenticate the request for non-session authorization (outside the CMS).

$ Security#autologin_enabled — Property in class Security

Showing "Remember me"-checkbox on loginform, and saving encrypted credentials to a cookie.

SecurityToken::addToUrl() — Method in class SecurityToken

SudoModeService::activate() — Method in class SudoModeService

SudoModeServiceInterface::activate() — Method in class SudoModeServiceInterface

LogInAuthenticationHandler::authenticateRequest() — Method in class LogInAuthenticationHandler

LogOutAuthenticationHandler::authenticateRequest() — Method in class LogOutAuthenticationHandler

CommentSpamProtection::alterCommentForm() — Method in class CommentSpamProtection

$ Publisher#add_timestamp — Property in class Publisher

UrlBundleInterface::addUrls() — Method in class UrlBundleInterface

Add URLs to this bundle

UrlBundleService::addUrls() — Method in class UrlBundleService

FileSubsites::alternateTreeTitle() — Method in class FileSubsites

Amends the CMS tree title for folders in the Files & Images section.

FileSubsites::augmentSQL() — Method in class FileSubsites

Update any requests to limit the results to the current site

GroupSubsites::augmentSQL() — Method in class GroupSubsites

Update any requests to limit the results to the current site

GroupSubsites::alternateCanEdit() — Method in class GroupSubsites

LeftAndMainSubsites::alternateMenuDisplayCheck() — Method in class LeftAndMainSubsites

LeftAndMainSubsites::alternateAccessCheck() — Method in class LeftAndMainSubsites

Prevent accessing disallowed resources. This happens after onBeforeInit has executed, so all redirections should've already taken place.

LeftAndMainSubsites::augmentNewSiteTreeItem() — Method in class LeftAndMainSubsites

SiteConfigSubsites::augmentSQL() — Method in class SiteConfigSubsites

Update any requests to limit the results to the current site

SiteTreeSubsites::augmentSQL() — Method in class SiteTreeSubsites

Update any requests to limit the results to the current site

SiteTreeSubsites::alternateSiteConfig() — Method in class SiteTreeSubsites

SiteTreeSubsites::alternateAbsoluteLink() — Method in class SiteTreeSubsites

SiteTreeSubsites::augmentSyncLinkTracking() — Method in class SiteTreeSubsites

SiteTreeSubsites::augmentValidURLSegment() — Method in class SiteTreeSubsites

Ensure that valid url segments are checked within the correct subsite of the owner object, even if the current subsiteID is set to some other subsite.

$ InitStateMiddleware#admin_url_paths — Property in class InitStateMiddleware

URL paths that should be considered as admin only, i.e. not frontend

Subsite::all_sites() — Method in class Subsite

Return all subsites, regardless of permissions (augmented with main site).

Subsite::all_accessible_sites() — Method in class Subsite

Subsite::accessible_sites() — Method in class Subsite

Return the subsites that the current user can access by given permission.

Subsite::allowedThemes() — Method in class Subsite

Return the themes that can be used with this subsite, as an array of themecode => description

Subsite::absoluteBaseURL() — Method in class Subsite

Get the absolute URL for this subsite

Subsite::adminDuplicate() — Method in class Subsite

Javascript admin action to duplicate this subsite

Subsite::activate() — Method in class Subsite

Make this subsite the current one

SubsiteDomain::absoluteBaseURL() — Method in class SubsiteDomain

Get absolute baseURL for this domain

Method::applyRequirements() — Method in class Method

Leverage the Requirements API to ensure client requirements are included. This is called just after the base module requirements are specified

$ EditableFormField#abstract — Property in class EditableFormField

Define this field as abstract (not inherited)

$ EditableFormField#allowed_css — Property in class EditableFormField

A list of CSS classes that can be added

$ EditableFileField#allowed_extensions_blacklist — Property in class EditableFileField

Further limit uploadable file extensions in addition to the restrictions imposed by the File.allowed_extensions global configuration.

$ EditableMultipleOptionField#abstract — Property in class EditableMultipleOptionField

Define this field as abstract (not inherited)

EditableOption::allow_empty_values() — Method in class EditableOption

Returns whether to allow empty values or not.

$ EditableTextField#Autocomplete — Property in class EditableTextField

$ EmailRecipient#allow_unbound_recipient_fields — Property in class EmailRecipient

Setting this to true will allow you to select "risky" fields as email recipient, such as free-text entry fields.

$ VersionFeed#allchanges_enabled — Property in class VersionFeed

Enable the allchanges feed

$ VersionFeed#allchanges_limit — Property in class VersionFeed

Allchanges feed limit of items.

VersionFeedController::allchanges() — Method in class VersionFeedController

Get all changes from the site in a RSS feed.

ArchiveAdmin — Class in namespace SilverStripe\VersionedAdmin

Archive admin is a section of the CMS that displays archived records from versioned objects and allows for users to restore them.

ArchiveRestoreAction — Class in namespace SilverStripe\VersionedAdmin\Extensions

Adds a restore action to the item edit form of ArchiveAdmin

ArchiveViewProvider — Class in namespace SilverStripe\VersionedAdmin\Interfaces

A provider of a view for the archive admin

ChangeSet::addObject() — Method in class ChangeSet

Add a new change to this changeset. Will automatically include all owned changes as those are dependencies of this item.

$ ChangeSetItem#Added — Property in class ChangeSetItem

AbstractPublishOperationCreator — Class in namespace SilverStripe\Versioned\GraphQL\Operations

Scaffolds a generic update operation for DataObjects.

UnpublishOnDelete::apply() — Method in class UnpublishOnDelete

VersionedDataObject::apply() — Method in class VersionedDataObject

VersionedRead::apply() — Method in class VersionedRead

GridFieldArchiveAction::augmentColumns() — Method in class GridFieldArchiveAction

Add a column 'Actions'

GridFieldRestoreAction::augmentColumns() — Method in class GridFieldRestoreAction

Add a column 'Delete'

Versioned::augmentDataQueryCreation() — Method in class Versioned

Amend freshly created DataQuery objects with versioned-specific information.

Versioned::augmentSQL() — Method in class Versioned

Augment the the SQLSelect that is created by the DataQuery

Versioned::augmentLoadLazyFields() — Method in class Versioned

For lazy loaded fields requiring extra sql manipulation, ie versioning.

Versioned::augmentDatabase() — Method in class Versioned

Update the database schema as required by this extension.

Versioned::augmentWrite() — Method in class Versioned

Augment a write-record request.

Versioned::Author() — Method in class Versioned

Get author of this record.

VersionedGridFieldState::augmentColumns() — Method in class VersionedGridFieldState

Modify the list of columns displayed in the table.

Versioned_Version::Author() — Method in class Versioned_Version

Author of this DataObject

ArrayData — Class in namespace SilverStripe\View

Lets you wrap a bunch of array data, or object members, into a {@link ViewableData} object.

ArrayData::array_to_object() — Method in class ArrayData

Converts an associative array to a simple object

AttributesHTML — Class in namespace SilverStripe\View

This trait can be applied to a ViewableData class to add the logic to render attributes in an SS template.

Requirements::add_i18n_javascript() — Method in class Requirements

Add i18n files from the given javascript directory. SilverStripe expects that the given directory will contain a number of JavaScript files named by language: en_US.js, de_DE.js, etc.

Requirements_Backend::add_i18n_javascript() — Method in class Requirements_Backend

Add i18n files from the given javascript directory. SilverStripe expects that the given directory will contain a number of JavaScript files named by language: en_US.js, de_DE.js, etc.

SSTemplateParser::addClosedBlock() — Method in class SSTemplateParser

Add a closed block callable to allow <% name %><% end_name %> syntax

SSTemplateParser::addOpenBlock() — Method in class SSTemplateParser

Add a closed block callable to allow <% name %> syntax

SSTemplateParser::Argument_DollarMarkedLookup() — Method in class SSTemplateParser

If we get a bare value, we don't know enough to determine exactly what php would be the translation, because we don't know if the position of use indicates a lookup or a string argument.

SSTemplateParser::Argument_QuotedString() — Method in class SSTemplateParser

SSTemplateParser::Argument_Null() — Method in class SSTemplateParser

SSTemplateParser::Argument_Boolean() — Method in class SSTemplateParser

SSTemplateParser::Argument_IntegerOrFloat() — Method in class SSTemplateParser

SSTemplateParser::Argument_Lookup() — Method in class SSTemplateParser

SSTemplateParser::Argument_FreeString() — Method in class SSTemplateParser

SSViewer::add_themes() — Method in class SSViewer

Add to the list of active themes to apply

ThemeResourceLoader::addSet() — Method in class ThemeResourceLoader

Add a new theme manifest for a given identifier. E.g. '$default'

Method::applyRequirements() — Method in class Method

Leverage the Requirements API to ensure client requirements are included. This is called just after the base module requirements are specified

$ RegisterHandler#authenticator_attachment — Property in class RegisterHandler

The default attachment mode to use for Authentication Selection Criteria.

AssignUsersToWorkflowAction — Class in namespace Symbiote\AdvancedWorkflow\Actions

A workflow action that allows additional users or groups to be assigned to the workflow part-way through the workflow path.

AdvancedWorkflowAdmin — Class in namespace Symbiote\AdvancedWorkflow\Admin

AdvancedWorkflowActionController — Class in namespace Symbiote\AdvancedWorkflow\Controllers

Handles actions triggered from external sources, eg emails or web frontend

WorkflowActionInstance::actionStart() — Method in class WorkflowActionInstance

Called when this instance is started within the workflow

WorkflowActionInstance::actionComplete() — Method in class WorkflowActionInstance

Called when this action has been completed within the workflow

WorkflowTransition::Action() — Method in class WorkflowTransition

AdvancedWorkflowExtension — Class in namespace Symbiote\AdvancedWorkflow\Extensions

Handles interactions triggered by users in the backend of the CMS. Replicate this type of functionality wherever you need UI interaction with workflow.

WorkflowApplicable::AbsoluteEditLink() — Method in class WorkflowApplicable

Included in CMS-generated email templates for a NotifyUsersWorkflowAction.

WorkflowField::action() — Method in class WorkflowField

WorkflowField::ActionLink() — Method in class WorkflowField

AWRequiredFields — Class in namespace Symbiote\AdvancedWorkflow\Forms

Extends RequiredFields so we can prevent DO writes in AW's controller(s) without needing to catch Exceptions from DO->validate() all over the place.

GridFieldExportAction::augmentColumns() — Method in class GridFieldExportAction

Add a column 'Delete'

GridFieldWorkflowRestrictedEditButton::augmentColumns() — Method in class GridFieldWorkflowRestrictedEditButton

Add a column

GridFieldAddExistingSearchHandler::add() — Method in class GridFieldAddExistingSearchHandler

GridFieldExternalLink::augmentColumns() — Method in class GridFieldExternalLink

Add a column for the actions

GridFieldOrderableRows::augmentColumns() — Method in class GridFieldOrderableRows

Modify the list of columns displayed in the table.

QueuedJobDescriptor::activateOnQueue() — Method in class QueuedJobDescriptor

Called to indicate that the job is ready to be run on the queue. This is done either as the result of creating the job and adding it, or when resuming.

GridFieldQueuedJobExecute::augmentColumns() — Method in class GridFieldQueuedJobExecute

Add a column 'Delete'

QJUtils::ajaxResponse() — Method in class QJUtils

AbstractQueuedJob — Class in namespace Symbiote\QueuedJobs\Services

A base implementation of a queued job that provides some convenience for implementations

AbstractQueuedJob::afterComplete() — Method in class AbstractQueuedJob

Called when the job is determined to be 'complete'

AbstractQueuedJob::addMessage() — Method in class AbstractQueuedJob

QueuedJob::addMessage() — Method in class QueuedJob

Add an arbitrary text message into a job

FluentExtension::augmentDatabase() — Method in class FluentExtension

Update the database schema as required by this extension.

FluentExtension::augmentSQL() — Method in class FluentExtension

Edit the given query object to support queries for this extension

FluentExtension::augmentWrite() — Method in class FluentExtension

Augment a write-record request.

FluentFilteredExtension::augmentSQL() — Method in class FluentFilteredExtension

FluentGridFieldExtension::actionComplete() — Method in class FluentGridFieldExtension

FluentIsolatedExtension::augmentDataQueryCreation() — Method in class FluentIsolatedExtension

Amend freshly created DataQuery objects with the current locale and frontend status

FluentIsolatedExtension::augmentDatabase() — Method in class FluentIsolatedExtension

Safety checks for config are done on dev/build

FluentIsolatedExtension::augmentSQL() — Method in class FluentIsolatedExtension

FluentLeftAndMainExtension::actionComplete() — Method in class FluentLeftAndMainExtension

FluentSiteTreeExtension::actionComplete() — Method in class FluentSiteTreeExtension

FluentVersionedExtension::augmentDatabase() — Method in class FluentVersionedExtension

Update the database schema as required by this extension.

FluentVersionedExtension::augmentSQL() — Method in class FluentVersionedExtension

Edit the given query object to support queries for this extension

FluentVersionedExtension::augmentWrite() — Method in class FluentVersionedExtension

Apply versioning to write

FluentVersionedExtension::augmentMaxVersionSubSelect() — Method in class FluentVersionedExtension

Localise max version lookup Extension point in see Versioned::prepareMaxVersionSubSelect()

FluentAdminTrait::actionComplete() — Method in class FluentAdminTrait

FluentAdminTrait::archiveFluent() — Method in class FluentAdminTrait

Archives the current object from all locales (versioned)

FluentObjectTrait::augmentDataQueryCreation() — Method in class FluentObjectTrait

Amend freshly created DataQuery objects with the current locale and frontend status

DeleteAllLocalesAction::augmentColumns() — Method in class DeleteAllLocalesAction

Add a column 'Delete'

LocaleToggleColumn::augmentColumns() — Method in class LocaleToggleColumn

VisibleLocalesColumn::augmentColumns() — Method in class VisibleLocalesColumn

Modify the list of columns displayed in the table.

$ InitStateMiddleware#admin_url_paths — Property in class InitStateMiddleware

URL paths that should be considered as admin only, i.e. not frontend

ArchiveRecordPolicy — Class in namespace TractorCow\Fluent\Model\Delete

Archives a record, not just deletes

FluentSearchVariant::appliesTo() — Method in class FluentSearchVariant

FluentSearchVariant::activateState() — Method in class FluentSearchVariant

FluentSearchVariant::alterQuery() — Method in class FluentSearchVariant

FluentSearchVariant::alterDefinition() — Method in class FluentSearchVariant

B

ComposerLoader::build() — Method in class ComposerLoader

Load and build the composer.json and composer.lock files

EditHandler::bulkEditForm() — Method in class EditHandler

Return a form for all the selected DataObjects with their respective editable fields.

EditHandler::Breadcrumbs() — Method in class EditHandler

Edited version of the GridFieldEditForm function adds the 'Bulk Upload' at the end of the crums.

BulkManager — Class in namespace Colymba\BulkManager

GridField component for editing attached models in bulk.

BulkUploadField — Class in namespace Colymba\BulkUpload

Custom UploadField used to override Link() and redirect UploadField action properly through the GridField.

BulkUploadHandler — Class in namespace Colymba\BulkUpload

Handles request from the GridFieldBulkUpload component.

BulkUploader — Class in namespace Colymba\BulkUpload

GridField component for uploading images in bulk.

BulkUploader::bulkUploadField() — Method in class BulkUploader

Returned a configured UploadField instance embedded in the gridfield heard.

BaseElement — Class in namespace DNADesign\Elemental\Models

Class BaseElement

ElementalArea::Breadcrumbs() — Method in class ElementalArea

Necessary to display results in CMS site search.

CMSBatchAction::batchaction() — Method in class CMSBatchAction

Helper method for processing batch actions.

$ CMSBatchActionHandler#batch_actions — Property in class CMSBatchActionHandler

CMSBatchActionHandler::batchActionList() — Method in class CMSBatchActionHandler

Return a SS_List of ArrayData objects containing the following pieces of info about each batch action:

Link
Title

CMSBatchActionHandler::batchActions() — Method in class CMSBatchActionHandler

Get all registered actions through the static defaults set by {@link register()}.

CMSProfileController::Breadcrumbs() — Method in class CMSProfileController

Only show first element, as the profile form is limited to editing the current member it doesn't make much sense to show the member name in the breadcrumbs.

LeftAndMain::Breadcrumbs() — Method in class LeftAndMain

LeftAndMain::batchactions() — Method in class LeftAndMain

Batch Actions Handler

LeftAndMain::BatchActionsForm() — Method in class LeftAndMain

LeftAndMain::BaseCSSClasses() — Method in class LeftAndMain

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

ModelAdmin::Breadcrumbs() — Method in class ModelAdmin

$ AssetAdmin#bust_cache — Property in class AssetAdmin

Whatever the front end should try to bust cache by appending the version id to the image URL.

AssetAdmin::breadcrumbs() — Method in class AssetAdmin

AssetAdmin::baseCSSClasses() — Method in class AssetAdmin

Don't include class namespace in auto-generated CSS class

Builder — Class in namespace SilverStripe\AssetAdmin\GraphQL\Schema

$ TestAssetStore#basedir — Property in class TestAssetStore

Base dir of current file

TestAssetStore::base_path() — Method in class TestAssetStore

Get absolute path to basedir

File::BackLinkTracking() — Method in class File

Get the back-link tracking objects that link to this file via HTML fields

File::BackLinkTrackingCount() — Method in class File

Count of backlinks Note: Doesn't filter broken records

File::BackLinks() — Method in class File

List of SiteTreeLink objects attached to this page

FileIDHelper::buildFileID() — Method in class FileIDHelper

Map file tuple (hash, name, variant) to a filename to be used by flysystem

FileIDHelperResolutionStrategy::buildFileID() — Method in class FileIDHelperResolutionStrategy

Build a file ID for the provided tuple, irrespective of its existence.

FileResolutionStrategy::buildFileID() — Method in class FileResolutionStrategy

Build a file ID for the provided tuple, irrespective of its existence.

HashFileIDHelper::buildFileID() — Method in class HashFileIDHelper

Map file tuple (hash, name, variant) to a filename to be used by flysystem

NaturalFileIDHelper::buildFileID() — Method in class NaturalFileIDHelper

Map file tuple (hash, name, variant) to a filename to be used by flysystem

BlogAdminSidebar — Class in namespace SilverStripe\Blog\Forms

Blog — Class in namespace SilverStripe\Blog\Model

Blog Holder

BlogCategory — Class in namespace SilverStripe\Blog\Model

A blog category for generalising blog posts.

$ BlogCategory#BlogID — Property in class BlogCategory

BlogCategory::Blog() — Method in class BlogCategory

BlogCommentExtension — Class in namespace SilverStripe\Blog\Model

Adds Blog specific behaviour to Comment.

BlogController — Class in namespace SilverStripe\Blog\Model

BlogFilter — Class in namespace SilverStripe\Blog\Model

This class is responsible for filtering the SiteTree when necessary and also overlaps into filtering only published posts.

BlogFilterGridField — Class in namespace SilverStripe\Blog\Model\BlogFilter

Enables children of non-editable pages to be edited.

BlogMemberExtension — Class in namespace SilverStripe\Blog\Model

This class is responsible for add Blog specific behaviour to Members.

BlogObject — Class in namespace SilverStripe\Blog\Model

An object shared by BlogTag and BlogCategory.

BlogObject::BlogPosts() — Method in class BlogObject

BlogPost — Class in namespace SilverStripe\Blog\Model

An individual blog post.

BlogPostController — Class in namespace SilverStripe\Blog\Model

BlogPostFeaturedExtension — Class in namespace SilverStripe\Blog\Model

Adds a checkbox field for featured blog posts widget.

BlogPostFilter — Class in namespace SilverStripe\Blog\Model

This is responsible for filtering only published posts to users who do not have permission to view non-published posts.

BlogPostNotifications — Class in namespace SilverStripe\Blog\Model

Customise blog post to support comment notifications.

BlogTag — Class in namespace SilverStripe\Blog\Model

A blog tag for keyword descriptions of a blog post.

$ BlogTag#BlogID — Property in class BlogTag

BlogTag::Blog() — Method in class BlogTag

CategorisationObject::BlogPosts() — Method in class CategorisationObject

BlogArchiveWidget — Class in namespace SilverStripe\Blog\Widgets

BlogArchiveWidget::Blog() — Method in class BlogArchiveWidget

BlogArchiveWidgetController — Class in namespace SilverStripe\Blog\Widgets

BlogCategoriesWidget — Class in namespace SilverStripe\Blog\Widgets

BlogCategoriesWidget::Blog() — Method in class BlogCategoriesWidget

BlogCategoriesWidgetController — Class in namespace SilverStripe\Blog\Widgets

BlogFeaturedPostsWidget — Class in namespace SilverStripe\Blog\Widgets

BlogFeaturedPostsWidget::Blog() — Method in class BlogFeaturedPostsWidget

BlogRecentPostsWidget — Class in namespace SilverStripe\Blog\Widgets

BlogRecentPostsWidget::Blog() — Method in class BlogRecentPostsWidget

BlogRecentPostsWidgetController — Class in namespace SilverStripe\Blog\Widgets

BlogTagsCloudWidget — Class in namespace SilverStripe\Blog\Widgets

BlogTagsCloudWidget::Blog() — Method in class BlogTagsCloudWidget

BlogTagsCloudWidgetController — Class in namespace SilverStripe\Blog\Widgets

BlogTagsWidget — Class in namespace SilverStripe\Blog\Widgets

BlogTagsWidget::Blog() — Method in class BlogTagsWidget

BlogTagsWidgetController — Class in namespace SilverStripe\Blog\Widgets

CMSMain::Breadcrumbs() — Method in class CMSMain

CMSMain::batchactions() — Method in class CMSMain

Batch Actions Handler

CMSMain::BatchActionParameters() — Method in class CMSMain

Returns a LiteralField containing parameter field HTML for batch actions

CMSMain::BatchActionList() — Method in class CMSMain

Returns a list of batch actions

CMSPagesController::Breadcrumbs() — Method in class CMSPagesController

$ SiteTree#base_plural_name — Property in class SiteTree

Plural form for SiteTree / Page classes. Not inherited by subclasses.

$ SiteTree#base_singular_name — Property in class SiteTree

Plural form for SiteTree / Page classes. Not inherited by subclasses.

$ SiteTree#base_description — Property in class SiteTree

Description for Page and SiteTree classes, but not inherited by subclasses.

SiteTree::Breadcrumbs() — Method in class SiteTree

Return a breadcrumb trail to this page. Excludes "hidden" pages (with ShowInMenus=0) by default.

SiteTree::BackLinkTracking() — Method in class SiteTree

Get the back-link tracking objects that link to this page

SiteTree::BackLinks() — Method in class SiteTree

List of SiteTreeLink objects attached to this page

BrokenFilesReport — Class in namespace SilverStripe\CMS\Reports

BrokenLinksReport — Class in namespace SilverStripe\CMS\Reports

Content side-report listing pages with broken links

BrokenRedirectorPagesReport — Class in namespace SilverStripe\CMS\Reports

BrokenVirtualPagesReport — Class in namespace SilverStripe\CMS\Reports

Director::baseURL() — Method in class Director

Return the root-relative url for the baseurl

Director::baseFolder() — Method in class Director

Returns the root filesystem folder for the site. It will be automatically calculated unless it is overridden with {@link setBaseFolder()}.

Bypass — Class in namespace SilverStripe\Control\Middleware\ConfirmationMiddleware

A bypass for manual confirmation by user (depending on some runtime conditions)

URLSpecialsMiddleware::buildImpactRedirect() — Method in class URLSpecialsMiddleware

Looks up for the special flags passed in the request and schedules the changes accordingly for the next request.

BaseKernel — Class in namespace SilverStripe\Core

Simple Kernel container

BaseKernel::boot() — Method in class BaseKernel

CoreConfigFactory::buildStaticTransformer() — Method in class CoreConfigFactory

CoreConfigFactory::buildYamlTransformerForPath() — Method in class CoreConfigFactory

Convert::base64url_encode() — Method in class Convert

Encode a value into a string that can be used as part of a filename.

Convert::base64url_decode() — Method in class Convert

Decode a value that was encoded with Convert::base64url_encode.

Convert::bytes2memstring() — Method in class Convert

CoreKernel::boot() — Method in class CoreKernel

$ AopProxyService#beforeCall — Property in class AopProxyService

BeforeCallAspect — Class in namespace SilverStripe\Core\Injector

A BeforeCallAspect is run before a method is executed.

BeforeCallAspect::beforeCall() — Method in class BeforeCallAspect

Call this aspect before a method is executed

Kernel::boot() — Method in class Kernel

ClassManifestVisitor::beforeTraverse() — Method in class ClassManifestVisitor

Backtrace — Class in namespace SilverStripe\Dev

Backtrace helper

Backtrace::backtrace() — Method in class Backtrace

Render or return a backtrace from the given scope.

BehatFixtureFactory — Class in namespace SilverStripe\Dev

BuildTask — Class in namespace SilverStripe\Dev

Interface for a generic build task. Does not support dependencies. This will simply run a chunk of code when called.

BulkLoader — Class in namespace SilverStripe\Dev

A base for bulk loaders of content into the SilverStripe database.

BulkLoader_Result — Class in namespace SilverStripe\Dev

Encapsulates the result of a {@link BulkLoader} import (usually through the {@link BulkLoader->processAll()} method).

DebugView::Breadcrumbs() — Method in class DebugView

Generate breadcrumb links to the URL path being displayed

DevBuildController::build() — Method in class DevBuildController

DevelopmentAdmin::buildDefaults() — Method in class DevelopmentAdmin

Build the default data, calling requireDefaultRecords on all DataObject classes Should match the $url_handlers rule: 'build/defaults' => 'buildDefaults',

BannerBlock — Class in namespace SilverStripe\ElementalBannerBlock\Block

BlockLinkField — Class in namespace SilverStripe\ElementalBannerBlock\Form

BlockLinkField_Readonly — Class in namespace SilverStripe\ElementalBannerBlock\Form

Readonly version of a {@link BlockLinkField} field, which displays the data fields as readonly text inputs and a checkbox for "target blank".

BrokenExternalLink — Class in namespace SilverStripe\ExternalLinks\Model

Represents a single link checked for a single run that is broken

BrokenExternalPageTrack — Class in namespace SilverStripe\ExternalLinks\Model

Represents a track for a single page

BrokenExternalPageTrackStatus — Class in namespace SilverStripe\ExternalLinks\Model

Represents the status of a track run

BrokenExternalPageTrackStatus::BrokenLinks() — Method in class BrokenExternalPageTrackStatus

BrokenExternalLinksReport — Class in namespace SilverStripe\ExternalLinks\Reports

Content side-report listing pages with external broken links

$ CurlLinkChecker#bypass_cache — Property in class CurlLinkChecker

If we want to bypass the cache Set via YAML file

FormRequestHandler::buttonClicked() — Method in class FormRequestHandler

Get instance of button which was clicked for this request

GridFieldDetailForm_ItemRequest::Breadcrumbs() — Method in class GridFieldDetailForm_ItemRequest

CMS-specific functionality: Passes through navigation breadcrumbs to the template, and includes the currently edited record (if any).

$ TinyMCEConfig#base_dir — Property in class TinyMCEConfig

Location of module relative to BASE_DIR. This must contain the following dirs

plugins
themes
skins

BasicAuthAuthenticator — Class in namespace SilverStripe\GraphQL\Auth

An authenticator using SilverStripe's BasicAuth

Build — Class in namespace SilverStripe\GraphQL\Dev

Build::build() — Method in class Build

Build::buildSchema() — Method in class Build

BulkLoaderSet — Class in namespace SilverStripe\GraphQL\Schema\BulkLoader

Composed with a list of bulk loaders to be executed in serial and return the aggregate result of all their collect() calls

DBFieldArgs::baseFormatResolver() — Method in class DBFieldArgs

Resolver::baseResolve() — Method in class Resolver

Just the basic ViewableData field accessor bit, without all the property mapping overhead. Useful for custom dataobject types that circumvent the model layer.

BaseFieldsProvider — Class in namespace SilverStripe\GraphQL\Schema\Interfaces

Defines a model that provides required fields for all the types it creates

SchemaBuilder::build() — Method in class SchemaBuilder

Stores a schema and fetches the graphql-php instance

SchemaBuilder::buildByName() — Method in class SchemaBuilder

Boots a schema, persists it, and fetches it

SchemaBuilder::boot() — Method in class SchemaBuilder

Auto-discovers the schema based on the provided schema key in Silverstripe's configuration layer. Merges the global schema with specifics for this schema key.

NestedInputBuilder::buildPathsFromArgs() — Method in class NestedInputBuilder

Public API that can be used by a resolver to flatten the input argument into dot.separated.paths that can be normalised

AbstractTypeRegistry::Boolean() — Method in class AbstractTypeRegistry

ModelType::buildOperations() — Method in class ModelType

BaseStore — Class in namespace SilverStripe\HybridSessions\Store

DatabaseStore::binaryDataJsonEncode() — Method in class DatabaseStore

Encode binary data into ASCII string (a subset of UTF-8)

DatabaseStore::binaryDataJsonDecode() — Method in class DatabaseStore

Decode ASCII string into original binary data (a php string)

LDAPUtil::bin_to_str_guid() — Method in class LDAPUtil

LDAPUtil::bin_to_str_sid() — Method in class LDAPUtil

EnablerExtension::beforeCallActionHandler() — Method in class EnablerExtension

BaseHandlerTrait — Class in namespace SilverStripe\MFA\RequestHandler

BackupCodeGenerator — Class in namespace SilverStripe\MFA\Service

$ BackupCodeGenerator#backup_code_count — Property in class BackupCodeGenerator

The number of back-up codes that should be generated for a user. Note that changing this value will not regenerate or generate new codes to meet the new number. The user will have to manually regenerate codes to receive the new number of codes.

$ BackupCodeGenerator#backup_code_length — Property in class BackupCodeGenerator

The length of each individual backup code.

BackupCodeGeneratorInterface — Class in namespace SilverStripe\MFA\Service

A service class implementation for generating and hashing backup codes.

BackupCode — Class in namespace SilverStripe\MFA\State

A container for a backup code and its hash, normally used during backup code generation

ArrayList::byIDs() — Method in class ArrayList

Filter this list to only contain the given Primary IDs

ArrayList::byID() — Method in class ArrayList

Return the first item with the given ID

DBQueryBuilder::buildSQL() — Method in class DBQueryBuilder

Builds a sql query with the specified connection

DBQueryBuilder::buildDeleteFragment() — Method in class DBQueryBuilder

Return the DELETE clause ready for inserting into a query.

DBQueryBuilder::buildUpdateFragment() — Method in class DBQueryBuilder

Return the UPDATE clause ready for inserting into a query.

DBQueryBuilder::buildFromFragment() — Method in class DBQueryBuilder

Return the FROM clause ready for inserting into a query.

DBQueryBuilder::buildWhereFragment() — Method in class DBQueryBuilder

Returns the WHERE clauses ready for inserting into a query.

DBQueryBuilder::buildOrderByFragment() — Method in class DBQueryBuilder

Returns the ORDER BY clauses ready for inserting into a query.

DBQueryBuilder::buildGroupByFragment() — Method in class DBQueryBuilder

Returns the GROUP BY clauses ready for inserting into a query.

DBQueryBuilder::buildHavingFragment() — Method in class DBQueryBuilder

Returns the HAVING clauses ready for inserting into a query.

DBQueryBuilder::buildLimitFragment() — Method in class DBQueryBuilder

Return the LIMIT clause ready for inserting into a query.

DBSchemaManager::boolean() — Method in class DBSchemaManager

Returns data type for 'boolean' column

MySQLQueryBuilder::buildLimitFragment() — Method in class MySQLQueryBuilder

Return the LIMIT clause ready for inserting into a query.

MySQLSchemaManager::boolean() — Method in class MySQLSchemaManager

Return a boolean type-formatted string

MySQLSchemaManager::bigint() — Method in class MySQLSchemaManager

Return a bigint type-formatted string

MySQLiConnector::bindParameters() — Method in class MySQLiConnector

Binds a list of parameters to a statement

TableBuilder::buildTables() — Method in class TableBuilder

TempDatabase::build() — Method in class TempDatabase

Create temp DB without creating extra objects

DB::build_sql() — Method in class DB

Builds a sql query with the specified connection

DataList::byIDs() — Method in class DataList

Filter this list to only contain the given Primary IDs

DataList::byID() — Method in class DataList

Return the first DataObject with the given ID

$ DataObject#belongs_to — Property in class DataObject

A meta-relationship that allows you to define the reverse side of a {@link DataObject::$has_one}.

$ DataObject#belongs_many_many — Property in class DataObject

The inverse side of a many-many relationship.

DataObject::belongsTo() — Method in class DataObject

Returns the class of a remote belongs_to relationship. If no component is specified a map of all components and their class name will be returned.

DataObject::baseTable() — Method in class DataObject

Get the name of the base table for this object

DataObject::baseClass() — Method in class DataObject

Get the base class for this object

DataObjectSchema::baseDataClass() — Method in class DataObjectSchema

Returns the root class (the first to extend from DataObject) for the passed class.

DataObjectSchema::baseDataTable() — Method in class DataObjectSchema

Get the base table

DataObjectSchema::belongsToComponent() — Method in class DataObjectSchema

Return data for a specific belongs_to component.

DataQueryManipulator::beforeGetFinalisedQuery() — Method in class DataQueryManipulator

Invoked prior to getFinalisedQuery()

DatabaseAdmin::build() — Method in class DatabaseAdmin

Updates the database schema, creating tables & fields as necessary.

DatabaseAdmin::buildDefaults() — Method in class DatabaseAdmin

Build the default data, calling requireDefaultRecords on all DataObject classes

DBComposite::bindTo() — Method in class DBComposite

Bind this field to the dataobject, and set the underlying table to that of the owner

Filterable::byID() — Method in class Filterable

Return the first item with the given ID

Filterable::byIDs() — Method in class Filterable

Filter this list to only contain the given Primary IDs

ManyManyThroughQueryManipulator::beforeGetFinalisedQuery() — Method in class ManyManyThroughQueryManipulator

Invoked prior to getFinalisedQuery()

$ FederatedIdentity#BirthInfoQuality — Property in class FederatedIdentity

$ FederatedIdentity#BirthYear — Property in class FederatedIdentity

$ FederatedIdentity#BirthMonth — Property in class FederatedIdentity

$ FederatedIdentity#BirthDay — Property in class FederatedIdentity

$ FederatedIdentity#BirthPlaceQuality — Property in class FederatedIdentity

$ FederatedIdentity#BirthPlaceCountry — Property in class FederatedIdentity

$ FederatedIdentity#BirthPlaceLocality — Property in class FederatedIdentity

RegistryPage::Breadcrumbs() — Method in class RegistryPage

Modified version of Breadcrumbs, to cater for viewing items.

ReportAdmin::Breadcrumbs() — Method in class ReportAdmin

Returns the Breadcrumbs for the ReportAdmin

ReportWrapper::beforeQuery() — Method in class ReportWrapper

Override this method to perform some actions prior to querying.

BasicRestfulAuthenticator — Class in namespace SilverStripe\RestfulServer

A simple authenticator for the Restful server.

BasicAuth — Class in namespace SilverStripe\Security

Provides an interface to HTTP basic authentication.

BasicAuthMiddleware — Class in namespace SilverStripe\Security

Member::beforeMemberLoggedIn() — Method in class Member

Called before a member is logged in via session/cookie/etc

Member::beforeMemberLoggedOut() — Method in class Member

Audit logging hook, called before a member is logged out

Security::basicauthlogin() — Method in class Security

SiteConfigLeftAndMain::Breadcrumbs() — Method in class SiteConfigLeftAndMain

$ SolrCellTextExtractor#base_url — Property in class SolrCellTextExtractor

Base URL to use for Solr text extraction.

$ UserForm#button_text — Property in class UserForm

EditableCustomRule::buildExpression() — Method in class EditableCustomRule

Substitutes configured rule logic with it's JS equivalents and returns them as array elements

$ UserForm#block_default_userforms_css — Property in class UserForm

Set this to true to disable automatic inclusion of CSS files

$ UserForm#block_default_userforms_js — Property in class UserForm

Set this to true to disable automatic inclusion of JavaScript files

ArchiveAdmin::Breadcrumbs() — Method in class ArchiveAdmin

Use 'Archive' as the top title rather than the model title

BlockArchiveExtension — Class in namespace SilverStripe\VersionedAdmin\Extensions

Adds a archive view for Elemental blocks

VersionedGridFieldItemRequest::Breadcrumbs() — Method in class VersionedGridFieldItemRequest

Requirements::backend() — Method in class Requirements

Requirements::block() — Method in class Requirements

Block inclusion of a specific file

Requirements_Backend::block() — Method in class Requirements_Backend

Block inclusion of a specific file

BaseHandlerTrait — Class in namespace SilverStripe\WebAuthn

Contains logic which is shared between both WebAuthn's RegisterHandler and VerifyHandler, such as the attestation configuration options.

$ i18nTextCollector#basePath — Property in class i18nTextCollector

The directory base on which the collector should act.

$ i18nTextCollector#baseSavePath — Property in class i18nTextCollector

Save path

WorkflowInstance::beginWorkflow() — Method in class WorkflowInstance

Start a workflow based on a particular definition for a particular object.

BaseRunner — Class in namespace Symbiote\QueuedJobs\Tasks\Engines

Class BaseRunner

$ FluentExtension#batch_actions_enabled — Property in class FluentExtension

Enable batch actions in the edit form

FluentExtension::BaseURLForLocale() — Method in class FluentExtension

Determine the baseurl within a specified $locale.

BaseAction — Class in namespace TractorCow\Fluent\Forms

Base action for acting on a single locale / record pair

BrowserLocaleDetector — Class in namespace TractorCow\Fluent\State

Detects locale based on browser locale

C

CheckForUpdatesJob — Class in namespace BringYourOwnIdeas\Maintenance\Jobs

Refresh report job. Runs as a queued job.

SiteSummary::columns() — Method in class SiteSummary

Provide column selection and formatting rules for the CMS report. You can extend data columns by extending {@link Package::summary_fields}, or you can extend this method to adjust the formatting rules, or to provide composite fields (such as Summary below) for the CMS report but not the CSV export.

ComposerLoader — Class in namespace BringYourOwnIdeas\Maintenance\Util

The composer loader class is responsible for dealing directly with composer.json and composer.lock files, in terms of loading and parsing their contents.

CheckComposerUpdatesExtension — Class in namespace BringYourOwnIdeas\UpdateChecker\Extensions

Task which does the actual checking of updates

ComposerLoaderExtension — Class in namespace BringYourOwnIdeas\UpdateChecker\Extensions

ComposerUpdateExtension — Class in namespace BringYourOwnIdeas\UpdateChecker\Extensions

Describes any available updates to an installed Composer package

UpdateChecker::checkForUpdates() — Method in class UpdateChecker

Checks the given package for available and latest updates, and writes them to data models if found

CWPPageExtension — Class in namespace CWP\AgencyExtensions\Extensions

Class CWPPageExtension

CWPSiteConfigExtension — Class in namespace CWP\AgencyExtensions\Extensions

Class CWPCleanupSiteConfigExtension

CarouselPageExtension — Class in namespace CWP\AgencyExtensions\Extensions

ColorPickerField — Class in namespace CWP\AgencyExtensions\Forms

CarouselItem — Class in namespace CWP\AgencyExtensions\Model

CarouselItem::canCreate() — Method in class CarouselItem

CarouselItem::canEdit() — Method in class CarouselItem

CarouselItem::canDelete() — Method in class CarouselItem

CarouselItem::canView() — Method in class CarouselItem

HTTPBulkToolsResponse::createBody() — Method in class HTTPBulkToolsResponse

Creates the response JSON body

$ ElementalAreasExtension#clear_contentfield — Property in class ElementalAreasExtension

On saving the element area, should Elemental reset the main website $Content field.

BaseElement::canView() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::canEdit() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::canDelete() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::canCreate() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::CMSEditLink() — Method in class BaseElement

ElementalArea::canEdit() — Method in class ElementalArea

ElementalArea::canView() — Method in class ElementalArea

ElementTypeReport::columns() — Method in class ElementTypeReport

ElementsInUseReport::columns() — Method in class ElementsInUseReport

$ MigrateContentToElement#clear_content — Property in class MigrateContentToElement

Configures if the existing content should be cleared once the migration task has completed.

CMSBatchAction — Class in namespace SilverStripe\Admin

A class representing back actions.

CMSBatchAction::canView() — Method in class CMSBatchAction

If you wish to restrict the batch action to some users, overload this function.

CMSBatchActionHandler — Class in namespace SilverStripe\Admin

Special request handler for admin/batchaction

CMSEditLinkExtension — Class in namespace SilverStripe\Admin

An extension that automatically generates a CMS edit link for DataObjects even if they are canonically edited in some nested {@link GridField}.

CMSEditLinkExtension::CMSEditLink() — Method in class CMSEditLinkExtension

Get a link to edit this DataObject in the CMS.

CMSMenu — Class in namespace SilverStripe\Admin

The object manages the main CMS menu. See {@link LeftAndMain::init()} for example usage.

CMSMenu::clear_menu() — Method in class CMSMenu

Clears the entire menu

CMSMenuItem — Class in namespace SilverStripe\Admin

A simple CMS menu item.

$ CMSMenuItem#controller — Property in class CMSMenuItem

Parent controller class name

CMSProfileController — Class in namespace SilverStripe\Admin

CMSProfileController::canView() — Method in class CMSProfileController

LeftAndMain::canView() — Method in class LeftAndMain

LeftAndMain::Content() — Method in class LeftAndMain

LeftAndMain::currentPageID() — Method in class LeftAndMain

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"

LeftAndMain::currentPage() — Method in class LeftAndMain

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

LeftAndMain::CMSVersion() — Method in class LeftAndMain

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

LeftAndMain::CMSVersionNumber() — Method in class LeftAndMain

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

SilverStripeNavigatorItem::canView() — Method in class SilverStripeNavigatorItem

Filters items based on member permissions or other criteria, such as if a state is generally available for the current record.

SilverStripeNavigatorItem_Unversioned::canView() — Method in class SilverStripeNavigatorItem_Unversioned

True if the record doesn't have the Versioned extension and is configured to display this item.

SudoModeController::check() — Method in class SudoModeController

Checks whether sudo mode is active for the current user

AssetAdmin::createfolder() — Method in class AssetAdmin

AssetAdmin::canView() — Method in class AssetAdmin

CampaignAdminExtension — Class in namespace SilverStripe\AssetAdmin\Extensions

Extension that updates the Popover menu of FileFormFactory.

TestAssetStore::cleanFilename() — Method in class TestAssetStore

$ File#class_for_file_extension — Property in class File

Map of file extensions to class type

$ File#Content — Property in class File

File::canView() — Method in class File

File::canEdit() — Method in class File

Check if this file can be modified

File::canCreate() — Method in class File

Check if a file can be created

File::canDelete() — Method in class File

Check if this file can be deleted

File::collateDescendants() — Method in class File

Collate selected descendants of this page.

File::copyFile() — Method in class File

Copy to new filename.

File::canViewFile() — Method in class File

Check if the current user can view the given file.

File::CMSEditLink() — Method in class File

FileDefaultPermissions::canEdit() — Method in class FileDefaultPermissions

Can root be edited?

FileDefaultPermissions::canView() — Method in class FileDefaultPermissions

Can root be viewed?

FileDefaultPermissions::canDelete() — Method in class FileDefaultPermissions

Can root be deleted?

FileDefaultPermissions::canCreate() — Method in class FileDefaultPermissions

Can root objects be created?

FileIDHelper::cleanFilename() — Method in class FileIDHelper

Clean up filename to remove constructs that might clash with the underlying path format of this FileIDHelper.

FileIDHelperResolutionStrategy::cleanFilename() — Method in class FileIDHelperResolutionStrategy

Normalise a filename to be consistent with this file resolution strategy.

FileResolutionStrategy::cleanFilename() — Method in class FileResolutionStrategy

Normalise a filename to be consistent with this file resolution strategy.

HashFileIDHelper::cleanFilename() — Method in class HashFileIDHelper

Clean up filename to remove constructs that might clash with the underlying path format of this FileIDHelper.

NaturalFileIDHelper::cleanFilename() — Method in class NaturalFileIDHelper

Clean up filename to remove constructs that might clash with the underlying path format of this FileIDHelper.

FlysystemAssetStore::copy() — Method in class FlysystemAssetStore

Copy a file (and all variants) to a new filename

FlysystemAssetStore::canView() — Method in class FlysystemAssetStore

Check if the current user can view the given file.

Folder::ChildFolders() — Method in class Folder

Get the children of this folder that are also folders.

ImageBackendFactory::create() — Method in class ImageBackendFactory

Creates a new service instance.

$ ImageManipulation#cms_thumbnail_width — Property in class ImageManipulation

The width of an image thumbnail in the CMS.

$ ImageManipulation#cms_thumbnail_height — Property in class ImageManipulation

The height of an image thumbnail in the CMS.

ImageManipulation::CropWidth() — Method in class ImageManipulation

Crop image on X axis if it exceeds specified width. Retain height.

ImageManipulation::CropHeight() — Method in class ImageManipulation

Crop image on Y axis if it exceeds specified height. Retain width.

ImageManipulation::CMSThumbnail() — Method in class ImageManipulation

Default CMS thumbnail

Image_Backend::croppedResize() — Method in class Image_Backend

Resize an image to cover the given width/height completely, and crop off any overhanging edges.

Image_Backend::crop() — Method in class Image_Backend

Crop's part of image.

InterventionBackend::croppedResize() — Method in class InterventionBackend

Resize an image to cover the given width/height completely, and crop off any overhanging edges.

InterventionBackend::crop() — Method in class InterventionBackend

Crop's part of image.

AssetContainer::copyFile() — Method in class AssetContainer

Copy to new filename.

AssetContainer::canViewFile() — Method in class AssetContainer

Check if the current user can view the given file.

AssetStore::copy() — Method in class AssetStore

Copy a file (and all variants) to a new filename

AssetStore::canView() — Method in class AssetStore

Check if the current user can view the given file.

DBFile::canViewFile() — Method in class DBFile

Check if the current user can view the given file.

DBFile::copyFile() — Method in class DBFile

Copy to new filename.

DefaultAssetNameGenerator::current() — Method in class DefaultAssetNameGenerator

FileHashingService::computeFromStream() — Method in class FileHashingService

Compute the Hash value of the provided stream.

FileHashingService::computeFromFile() — Method in class FileHashingService

Compute the hash of the provided file

FileHashingService::compare() — Method in class FileHashingService

Compare 2 full or partial hashes.

Sha1FileHashingService::computeFromStream() — Method in class Sha1FileHashingService

Compute the Hash value of the provided stream.

Sha1FileHashingService::computeFromFile() — Method in class Sha1FileHashingService

Compute the hash of the provided file

Sha1FileHashingService::compare() — Method in class Sha1FileHashingService

Compare 2 full or partial hashes.

Upload::clearErrors() — Method in class Upload

Clear out all errors (mostly set by {loadUploaded()}) including the validator's errors

Upload_Validator::clearErrors() — Method in class Upload_Validator

Clear out all errors

AuditFactory::create() — Method in class AuditFactory

Creates a new service instance.

Blog::canEdit() — Method in class Blog

{@inheritdoc}

Blog::canAddChildren() — Method in class Blog

{@inheritdoc}

Blog::canEditEditors() — Method in class Blog

Determine if this user can edit the editors list.

Blog::canEditWriters() — Method in class Blog

Determine if this user can edit writers list.

Blog::canEditContributors() — Method in class Blog

Determines if this user can edit the contributors list.

Blog::Categories() — Method in class Blog

List of categories in this blog

Blog::Contributors() — Method in class Blog

List of contributors

BlogController::category() — Method in class BlogController

Renders the blog posts for a given category.

BlogObject::canView() — Method in class BlogObject

Inherits from the parent blog or can be overwritten using a DataExtension.

BlogObject::canCreate() — Method in class BlogObject

{@inheritdoc}

BlogObject::canDelete() — Method in class BlogObject

Inherits from the parent blog or can be overwritten using a DataExtension.

BlogObject::canEdit() — Method in class BlogObject

Inherits from the parent blog or can be overwritten using a DataExtension.

BlogPost::canEditAuthors() — Method in class BlogPost

Determine if this user can edit the authors list.

BlogPost::canCreateCategories() — Method in class BlogPost

Determine whether user can create new categories.

BlogPost::canCreateTags() — Method in class BlogPost

Determine whether user can create new tags.

BlogPost::canView() — Method in class BlogPost

{@inheritdoc}

BlogPost::canPublish() — Method in class BlogPost

{@inheritdoc}

BlogPost::canEdit() — Method in class BlogPost

{@inheritdoc}

BlogPost::Categories() — Method in class BlogPost

CategorisationObject — Class in namespace SilverStripe\Blog\Model

CMSBatchAction_Archive — Class in namespace SilverStripe\CMS\BatchActions

Delete items batch action.

CMSBatchAction_Publish — Class in namespace SilverStripe\CMS\BatchActions

Publish items batch action.

CMSBatchAction_Restore — Class in namespace SilverStripe\CMS\BatchActions

Batch restore of pages

CMSBatchAction_Unpublish — Class in namespace SilverStripe\CMS\BatchActions

Unpublish items batch action.

CMSMain — Class in namespace SilverStripe\CMS\Controllers

The main "content" area of the CMS.

CMSMain::clearCache() — Method in class CMSMain

Clears all dependent cache backends

CMSMain::CanOrganiseSitetree() — Method in class CMSMain

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

CMSMain::childfilter() — Method in class CMSMain

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

CMSMain::currentPageID() — Method in class CMSMain

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"

CMSPageAddController — Class in namespace SilverStripe\CMS\Controllers

CMSPageEditController — Class in namespace SilverStripe\CMS\Controllers

CMSPageSettingsController — Class in namespace SilverStripe\CMS\Controllers

CMSPagesController — Class in namespace SilverStripe\CMS\Controllers

CMSSiteTreeFilter — Class in namespace SilverStripe\CMS\Controllers

Base class for filtering the subtree for certain node statuses.

CMSSiteTreeFilter_ChangedPages — Class in namespace SilverStripe\CMS\Controllers

Gets all pages which have changed on stage.

CMSSiteTreeFilter_DeletedPages — Class in namespace SilverStripe\CMS\Controllers

Works a bit different than the other filters: Shows all pages including those deleted from stage and live.

CMSSiteTreeFilter_PublishedPages — Class in namespace SilverStripe\CMS\Controllers

This filter will display the SiteTree as a site visitor might see the site, i.e only the pages that is currently published.

CMSSiteTreeFilter_Search — Class in namespace SilverStripe\CMS\Controllers

CMSSiteTreeFilter_StatusDeletedPages — Class in namespace SilverStripe\CMS\Controllers

Filters pages which have a status "Deleted".

CMSSiteTreeFilter_StatusDraftPages — Class in namespace SilverStripe\CMS\Controllers

Filters pages which have a status "Draft".

CMSSiteTreeFilter_StatusRemovedFromDraftPages — Class in namespace SilverStripe\CMS\Controllers

Filters pages which have a status "Removed from Draft".

ContentController — Class in namespace SilverStripe\CMS\Controllers

The most common kind of controller; effectively a controller linked to a {@link DataObject}.

ContentController::ChildrenOf() — Method in class ContentController

Return the children of a given page. The parent reference can either be a page link or an ID.

ContentController::ContentLocale() — Method in class ContentController

Returns an RFC1766 compliant locale string, e.g. 'fr-CA'.

ModelAsController::controller_for() — Method in class ModelAsController

Get the appropriate {@link ContentController} for handling a {@link SiteTree} object, link it to the object and return it.

SilverStripeNavigatorItem_CMSLink::canView() — Method in class SilverStripeNavigatorItem_CMSLink

Filters items based on member permissions or other criteria, such as if a state is generally available for the current record.

CurrentPageIdentifier — Class in namespace SilverStripe\CMS\Model

This interface lets us set up objects that will tell us what the current page is.

CurrentPageIdentifier::currentPageID() — Method in class CurrentPageIdentifier

Get the current page ID.

RedirectorPage::ContentSource() — Method in class RedirectorPage

Returns this page if the redirect is external, otherwise returns the target page or file.

$ SiteTree#can_be_root — Property in class SiteTree

Controls whether a page can be in the root of the site tree.

$ SiteTree#controller_name — Property in class SiteTree

You can define the class of the controller that maps to your SiteTree object here if you don't want to rely on the magic of appending Controller to the Classname

$ SiteTree#can_create — Property in class SiteTree

If this is false, the class cannot be created in the CMS by regular content authors, only by ADMINs.

$ SiteTree#create_default_pages — Property in class SiteTree

$ SiteTree#Content — Property in class SiteTree

HTML content of the page.

SiteTree::CMSEditLink() — Method in class SiteTree

Generates a link to edit this page in the CMS.

SiteTree::can() — Method in class SiteTree

This function should return true if the current user can execute this action. It can be overloaded to customise the security model for an application.

SiteTree::canAddChildren() — Method in class SiteTree

This function should return true if the current user can add children to this page. It can be overloaded to customise the security model for an application.

SiteTree::canView() — Method in class SiteTree

This function should return true if the current user can view this page. It can be overloaded to customise the security model for an application.

SiteTree::canPublish() — Method in class SiteTree

Check if this page can be published

SiteTree::canDelete() — Method in class SiteTree

This function should return true if the current user can delete this page. It can be overloaded to customise the security model for an application.

SiteTree::canCreate() — Method in class SiteTree

This function should return true if the current user can create new pages of this class, regardless of class. It can be overloaded to customise the security model for an application.

SiteTree::canEdit() — Method in class SiteTree

This function should return true if the current user can edit this page. It can be overloaded to customise the security model for an application.

SiteTree::collateDescendants() — Method in class SiteTree

Collate selected descendants of this page.

SiteTree::ContentSource() — Method in class SiteTree

Returns the object that contains the content that a user would associate with this page.

SiteTree::creatableChildPages() — Method in class SiteTree

Gets a list of the page types that can be created under this specific page, including font icons

SiteTree::CMSTreeClasses() — Method in class SiteTree

Return the CSS classes to apply to this node in the CMS tree.

SiteTree::classDescription() — Method in class SiteTree

Get description for this page type

SiteTreeExtension::canAddChildren() — Method in class SiteTreeExtension

Hook called to determine if a user may add children to this SiteTree object

SiteTreeExtension::canPublish() — Method in class SiteTreeExtension

Hook called to determine if a user may publish this SiteTree object

$ VirtualPage#CopyContentFromID — Property in class VirtualPage

VirtualPage::ContentSource() — Method in class VirtualPage

VirtualPage::canPublish() — Method in class VirtualPage

We can only publish the page if there is a published source page

VirtualPage::CMSTreeClasses() — Method in class VirtualPage

VirtualPage::castingHelper() — Method in class VirtualPage

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

VirtualPage::CopyContentFrom() — Method in class VirtualPage

BrokenFilesReport::columns() — Method in class BrokenFilesReport

BrokenLinksReport::columns() — Method in class BrokenLinksReport

BrokenRedirectorPagesReport::columns() — Method in class BrokenRedirectorPagesReport

BrokenVirtualPagesReport::columns() — Method in class BrokenVirtualPagesReport

EmptyPagesReport::columns() — Method in class EmptyPagesReport

RecentlyEditedReport::columns() — Method in class RecentlyEditedReport

ContentControllerSearchExtension — Class in namespace SilverStripe\CMS\Search

Extension to provide a search interface when applied to ContentController

SearchForm::classesToSearch() — Method in class SearchForm

Set the classes to search.

CampaignAdmin — Class in namespace SilverStripe\CampaignAdmin

Campaign section of the CMS

CampaignAdmin::campaignEditForm() — Method in class CampaignAdmin

Url handler for edit form

CampaignAdmin::campaignCreateForm() — Method in class CampaignAdmin

Url handler for create form

CampaignAdminExtension — Class in namespace SilverStripe\CampaignAdmin

CampaignAdminList — Class in namespace SilverStripe\CampaignAdmin

Warning: Volatile API as placeholder for standard "GridField"

CachedConfigCollection — Class in namespace SilverStripe\Config\Collections

CachedConfigCollection::create() — Method in class CachedConfigCollection

ConfigCollectionInterface — Class in namespace SilverStripe\Config\Collections

This represents a collection of config keys and values.

DeltaConfigCollection::createFromCollection() — Method in class DeltaConfigCollection

Create a delta collection from a parent collection

MemoryConfigCollection::create() — Method in class MemoryConfigCollection

MemoryConfigCollection::checkForDeprecatedConfig() — Method in class MemoryConfigCollection

YamlTransformer::create() — Method in class YamlTransformer

ContentReviewCompatability — Class in namespace SilverStripe\ContentReview\Compatibility

This is a helper class which lets us do things with content review data without subsites messing our SQL queries up.

ContentReviewCMSExtension — Class in namespace SilverStripe\ContentReview\Extensions

CMSPageEditController extension to receive the additional action button from SiteTreeContentReview::updateCMSActions()

ContentReviewDefaultSettings — Class in namespace SilverStripe\ContentReview\Extensions

This extensions add a default schema for new pages and pages without a content review setting.

$ ContentReviewDefaultSettings#content_review_template — Property in class ContentReviewDefaultSettings

Template to use for content review emails.

ContentReviewDefaultSettings::ContentReviewOwners() — Method in class ContentReviewDefaultSettings

Get all Members that are default Content Owners. This includes checking group hierarchy and adding any direct users.

ContentReviewLeftAndMainExtension — Class in namespace SilverStripe\ContentReview\Extensions

ContentReviewOwner — Class in namespace SilverStripe\ContentReview\Extensions

$ SiteTreeContentReview#ContentReviewType — Property in class SiteTreeContentReview

SiteTreeContentReview::ContentReviewOwners() — Method in class SiteTreeContentReview

Get all Members that are Content Owners to this page. This includes checking group hierarchy and adding any direct users.

SiteTreeContentReview::canBeReviewedBy() — Method in class SiteTreeContentReview

Check if a review is due by a member for this owner.

SiteTreeContentReview::ContentReviewGroups() — Method in class SiteTreeContentReview

SiteTreeContentReview::ContentReviewUsers() — Method in class SiteTreeContentReview

ReviewContentHandler::canSubmitReview() — Method in class ReviewContentHandler

Determine whether the user can submit a review

ContentReviewNotificationJob — Class in namespace SilverStripe\ContentReview\Jobs

Allows the content review module to use the optional queued jobs module to automatically process content review emails. If the module isn't installed, nothing is done - SilverStripe will never include this class declaration.

ContentReviewLog — Class in namespace SilverStripe\ContentReview\Models

ContentReviewLog::canView() — Method in class ContentReviewLog

PagesDueForReviewReport::columns() — Method in class PagesDueForReviewReport

PagesWithoutReviewScheduleReport::columns() — Method in class PagesWithoutReviewScheduleReport

ContentReviewEmails — Class in namespace SilverStripe\ContentReview\Tasks

Daily task to send emails to the owners of content items when the review date rolls around.

ContentReviewOwnerMigrationTask — Class in namespace SilverStripe\ContentReview\Tasks

Task which migrates the ContentReview Module's SiteTree->OwnerID column to a new column name.

CLIRequestBuilder — Class in namespace SilverStripe\Control

CLI specific request building logic

CLIRequestBuilder::cleanEnvironment() — Method in class CLIRequestBuilder

Clean up HTTP global vars for $_GET / $_REQUEST prior to bootstrapping

CLIRequestBuilder::createFromVariables() — Method in class CLIRequestBuilder

CliController — Class in namespace SilverStripe\Control

Base class invoked from CLI rather than the webserver (Cron jobs, handling email bounces).

ContentNegotiator — Class in namespace SilverStripe\Control

The content negotiator performs "text/html" or "application/xhtml+xml" switching. It does this through the public static function ContentNegotiator::process(). By default, ContentNegotiator will comply to the Accept headers the clients sends along with the HTTP request, which is most likely "application/xhtml+xml" (see "Order of selection" below).

$ ContentNegotiator#content_type — Property in class ContentNegotiator

Controller — Class in namespace SilverStripe\Control

Controllers are the cornerstone of all site functionality in SilverStripe. The {@link Director} selects a controller to pass control to, and then calls {@link handleRequest()}. This method will execute the appropriate action - either by calling the action method, or displaying the action's template.

Controller::curr() — Method in class Controller

Returns the current controller.

Controller::can() — Method in class Controller

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

Cookie — Class in namespace SilverStripe\Control

A set of static methods for manipulating cookies.

CookieJar — Class in namespace SilverStripe\Control

A default backend for the setting and getting of cookies

Cookie_Backend — Class in namespace SilverStripe\Control

The Cookie_Backend interface for use with Cookie::$inst.

HTTPRequestBuilder::createFromEnvironment() — Method in class HTTPRequestBuilder

Create HTTPRequest instance from the current environment variables.

HTTPRequestBuilder::createFromVariables() — Method in class HTTPRequestBuilder

Build HTTPRequest from given variables

HTTPRequestBuilder::cleanEnvironment() — Method in class HTTPRequestBuilder

Clean up HTTP global vars for $_GET / $_REQUEST prior to bootstrapping

CanonicalURLMiddleware — Class in namespace SilverStripe\Control\Middleware

Implements the following URL normalisation rules

redirect basic auth requests to HTTPS
force WWW, redirect to the subdomain "www."
force SSL, redirect to https
force the correct path (with vs without trailing slash)

ChangeDetectionMiddleware — Class in namespace SilverStripe\Control\Middleware

Handles internal change detection via etag / ifmodifiedsince headers, conditionally sending a 304 not modified if possible.

ConfirmationMiddleware — Class in namespace SilverStripe\Control\Middleware

Checks whether user manual confirmation is required for HTTPRequest depending on the rules given.

ConfirmationMiddleware::canBypass() — Method in class ConfirmationMiddleware

Check whether the rules can be bypassed without user confirmation

AjaxBypass::checkRequestForBypass() — Method in class AjaxBypass

Returns true for AJAX requests

Bypass::checkRequestForBypass() — Method in class Bypass

Check the request for whether we can bypass the confirmation

CliBypass — Class in namespace SilverStripe\Control\Middleware\ConfirmationMiddleware

Allows a bypass when the request has been run in CLI mode

CliBypass::checkRequestForBypass() — Method in class CliBypass

Returns true if the current process is running in CLI mode

EnvironmentBypass::checkRequestForBypass() — Method in class EnvironmentBypass

Checks whether the current environment type in the list of allowed ones

GetParameter::checkRequestForBypass() — Method in class GetParameter

Check the request for whether we can bypass the confirmation

HttpMethodBypass::checkRequestForBypass() — Method in class HttpMethodBypass

Returns true if the current process is running in CLI mode

Url::checkRequestForBypass() — Method in class Url

Check the request for whether we can bypass the confirmation

Url::checkRequest() — Method in class Url

Match the request against the rules

UrlPathStartswith::checkRequestForBypass() — Method in class UrlPathStartswith

Check the request for whether we can bypass the confirmation

RequestHandler::checkAccessAction() — Method in class RequestHandler

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

$ Session#cookie_domain — Property in class Session

$ Session#cookie_path — Property in class Session

$ Session#cookie_secure — Property in class Session

$ Session#cookie_name_secure — Property in class Session

$ Session#cookie_samesite — Property in class Session

Must be "Strict", "Lax", or "None".

Session::clear() — Method in class Session

Clear session value

Session::clearAll() — Method in class Session

Clear all values

Session::changedData() — Method in class Session

Returns the list of changed keys

IPUtils::checkIP() — Method in class IPUtils

Checks if an IPv4 or IPv6 address is contained in the list of given IPs or subnets.

IPUtils::checkIP4() — Method in class IPUtils

Compares two IPv4 addresses.

IPUtils::checkIP6() — Method in class IPUtils

Compares two IPv6 addresses.

ApcuCacheFactory::create() — Method in class ApcuCacheFactory

CacheFactory — Class in namespace SilverStripe\Core\Cache

CacheFactory::create() — Method in class CacheFactory

Note: While the returned object is used as a singleton (by the originating Injector->get() call), this cache object shouldn't be a singleton itself - it has varying constructor args for the same service name.

DefaultCacheFactory::create() — Method in class DefaultCacheFactory

FilesystemCacheFactory::create() — Method in class FilesystemCacheFactory

ManifestCacheFactory::create() — Method in class ManifestCacheFactory

MemcachedCacheFactory::create() — Method in class MemcachedCacheFactory

RateLimiter::clearAttempts() — Method in class RateLimiter

RateLimiter::canAccess() — Method in class RateLimiter

ClassInfo — Class in namespace SilverStripe\Core

Provides introspection information about the class tree.

ClassInfo::class_name() — Method in class ClassInfo

Convert a class name in any case and return it as it was defined in PHP

ClassInfo::classImplements() — Method in class ClassInfo

Returns true if the given class implements the given interface

ClassInfo::classes_for_file() — Method in class ClassInfo

Get all classes contained in a file.

ClassInfo::classes_for_folder() — Method in class ClassInfo

Returns all classes contained in a certain folder.

ClassInfo::classesWithExtension() — Method in class ClassInfo

Returns a list of classes with a particular extension applied

Config — Class in namespace SilverStripe\Core\Config

ConfigLoader — Class in namespace SilverStripe\Core\Config

Registers config sources via ConfigCollectionInterface

ConfigLoader::countManifests() — Method in class ConfigLoader

Check number of manifests

Config_ForClass — Class in namespace SilverStripe\Core\Config

Configurable — Class in namespace SilverStripe\Core\Config

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

Configurable::config() — Method in class Configurable

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

CoreConfigFactory — Class in namespace SilverStripe\Core\Config

Factory for silverstripe configs

CoreConfigFactory::createRoot() — Method in class CoreConfigFactory

Create root application config.

CoreConfigFactory::createCore() — Method in class CoreConfigFactory

Rebuild new uncached config, which is mutable

Convert — Class in namespace SilverStripe\Core

Library of conversion functions, implemented as static methods.

CoreKernel — Class in namespace SilverStripe\Core

Simple Kernel container

CustomMethods — Class in namespace SilverStripe\Core

Allows an object to declare a set of custom methods

Extension::clearOwner() — Method in class Extension

Clear the current owner, and restore extension to the state prior to the last setOwner()

Factory::create() — Method in class Factory

Creates a new service instance.

Injectable::create() — Method in class Injectable

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

InjectionCreator::create() — Method in class InjectionCreator

Create a new instance of a class

Injector::convertServiceProperty() — Method in class Injector

Recursively convert a value into its proper representation with service references resolved to actual objects

Injector::create() — Method in class Injector

Similar to get() but always returns a new object of the given type

Injector::createWithArgs() — Method in class Injector

Creates an object with the supplied argument array

InjectorLoader::countManifests() — Method in class InjectorLoader

Check number of manifests

ClassContentRemover — Class in namespace SilverStripe\Core\Manifest

Class ClassContentRemover

ClassLoader — Class in namespace SilverStripe\Core\Manifest

A class that handles loading classes and interfaces from a class manifest instance.

ClassManifest — Class in namespace SilverStripe\Core\Manifest

A utility class which builds a manifest of all classes, interfaces and caches it.

ClassManifestErrorHandler — Class in namespace SilverStripe\Core\Manifest

Error handler which throws, but retains the original path context.

ClassManifestVisitor — Class in namespace SilverStripe\Core\Manifest

ModuleLoader::countManifests() — Method in class ModuleLoader

Check number of manifests

CallbackFlushDiscoverer — Class in namespace SilverStripe\Core\Startup

Handle a callable object as a discoverer

CompositeFlushDiscoverer — Class in namespace SilverStripe\Core\Startup

Implements the composite over flush discoverers

CronTaskController — Class in namespace SilverStripe\CronTask\Controllers

This is the controller that finds, checks and process all crontasks

CronTaskStatus — Class in namespace SilverStripe\CronTask

Record status of each cron task execution

CronTask — Class in namespace SilverStripe\CronTask\Interfaces

By implementing this interface a /dev/cron will be able to start in on the expression that you return frmo getSchedule();

BehatFixtureFactory::createObject() — Method in class BehatFixtureFactory

Writes the fixture into the database using DataObjects

$ BulkLoader#columnMap — Property in class BulkLoader

Map columns to DataObject-properties.

BulkLoader_Result::Count() — Method in class BulkLoader_Result

Returns the count of all objects which were created or updated.

BulkLoader_Result::CreatedCount() — Method in class BulkLoader_Result

BulkLoader_Result::Created() — Method in class BulkLoader_Result

Returns all created objects. Each object might contain specific importer feedback in the "_BulkLoaderMessage" property.

CLI — Class in namespace SilverStripe\Dev

Class to facilitate command-line output.

CSSContentParser — Class in namespace SilverStripe\Dev

CSSContentParser enables parsing & assertion running of HTML content via CSS selectors.

CliDebugView — Class in namespace SilverStripe\Dev

A basic HTML wrapper for stylish rendering of a development info view.

CsvBulkLoader — Class in namespace SilverStripe\Dev

Utility class to facilitate complex CSV-imports by defining column-mappings and custom converters.

Debug::caller() — Method in class Debug

Returns the caller for a specific method

Debug::create_debug_view() — Method in class Debug

Create an instance of an appropriate DebugView object.

$ DebugView#columns — Property in class DebugView

Column size to wrap long strings to

FixtureBlueprint::createObject() — Method in class FixtureBlueprint

FixtureFactory::createObject() — Method in class FixtureFactory

Writes the fixture into the database using DataObjects

FixtureFactory::createRaw() — Method in class FixtureFactory

Writes the fixture into the database directly using a database manipulation.

FixtureFactory::clear() — Method in class FixtureFactory

Remove all fixtures previously defined through {@link createObject()} or {@link createRaw()}, both from the internal fixture mapping and the database.

FunctionalTest::content() — Method in class FunctionalTest

Return the most recent content

FunctionalTest::cssParser() — Method in class FunctionalTest

Return a CSSContentParser for the most recent content.

MySQLDatabaseConfigurationHelper::checkValidDatabaseName() — Method in class MySQLDatabaseConfigurationHelper

Determines if a given database name is a valid Silverstripe name.

MySQLDatabaseConfigurationHelper::checkDatabasePermissionGrant() — Method in class MySQLDatabaseConfigurationHelper

Checks if a specified grant proves that the current user has the specified permission on the specified database

MySQLDatabaseConfigurationHelper::checkDatabasePermission() — Method in class MySQLDatabaseConfigurationHelper

Checks if the current user has the specified permission on the specified database

SapphireTest::clearFixtures() — Method in class SapphireTest

Clear all fixtures which were previously loaded through {@link loadFixture()}

SapphireTest::clearEmails() — Method in class SapphireTest

Clear the log of emails sent

SapphireTest::createInvalidArgumentException() — Method in class SapphireTest

Reimplementation of phpunit5 PHPUnit_Util_InvalidArgumentHelper::factory()

CleanupTestDatabasesTask — Class in namespace SilverStripe\Dev\Tasks

Cleans up leftover databases from aborted test executions (starting with ss_tmpdb) Task is restricted to users with administrator rights or running through CLI.

TestMailer::clearEmails() — Method in class TestMailer

Clear the log of emails sent

TestSession::cssParser() — Method in class TestSession

Return a CSSContentParser containing the most recent response

RelationValidationService::clearErrors() — Method in class RelationValidationService

BannerBlock::CallToActionLink() — Method in class BannerBlock

Used for the frontend templates, returns a parsed set of data

CacheHeadersCheck — Class in namespace SilverStripe\EnvironmentCheck\Checks

Check cache headers for any response, can specify directives that must be included and also must be excluded from Cache-Control headers in response. Also checks for existence of ETag.

CacheHeadersCheck::check() — Method in class CacheHeadersCheck

Check that correct caching headers are present.

DatabaseCheck::check() — Method in class DatabaseCheck

EnvTypeCheck::check() — Method in class EnvTypeCheck

Check the environment setting.

ExternalURLCheck::check() — Method in class ExternalURLCheck

FileAccessibilityAndValidationCheck::check() — Method in class FileAccessibilityAndValidationCheck

FileAgeCheck::check() — Method in class FileAgeCheck

FileWriteableCheck::check() — Method in class FileWriteableCheck

HasClassCheck::check() — Method in class HasClassCheck

HasFunctionCheck::check() — Method in class HasFunctionCheck

SMTPConnectCheck::check() — Method in class SMTPConnectCheck

SessionCheck::check() — Method in class SessionCheck

Check that the response for URL does not create a session

SolrIndexCheck::check() — Method in class SolrIndexCheck

URLCheck::check() — Method in class URLCheck

EnvironmentCheck::check() — Method in class EnvironmentCheck

EnvironmentChecker::canAccess() — Method in class EnvironmentChecker

Determine if the current member can access the environment checker

ClientFactory — Class in namespace SilverStripe\EnvironmentCheck\Services

Factory class for creating HTTP client which are injected into some env check classes. Inject via YAML, arguments for Guzzle client can be supplied using "constructor" property or set as default_config.

ClientFactory::create() — Method in class ClientFactory

Wrapper to create a Guzzle client.

$ Fetcher#client — Property in class Fetcher

Client for making requests, set vi Injector.

ErrorPage::canAddChildren() — Method in class ErrorPage

CMSExternalLinksController — Class in namespace SilverStripe\ExternalLinks\Controllers

CheckExternalLinksJob — Class in namespace SilverStripe\ExternalLinks\Jobs

A Job for running a external link check for published pages

BrokenExternalLink::canEdit() — Method in class BrokenExternalLink

BrokenExternalLink::canView() — Method in class BrokenExternalLink

$ BrokenExternalPageTrackStatus#CompletedPages — Property in class BrokenExternalPageTrackStatus

Get completed pages count

BrokenExternalPageTrackStatus::create_status() — Method in class BrokenExternalPageTrackStatus

Create and prepare a new status

BrokenExternalLinksReport::columns() — Method in class BrokenExternalLinksReport

CheckExternalLinksTask — Class in namespace SilverStripe\ExternalLinks\Tasks

CurlLinkChecker — Class in namespace SilverStripe\ExternalLinks\Tasks

Check links using curl

CurlLinkChecker::checkLink() — Method in class CurlLinkChecker

Determine the http status code for a given link

LinkChecker::checkLink() — Method in class LinkChecker

Determine the http status code for a given link

CheckboxField — Class in namespace SilverStripe\Forms

Single checkbox field.

CheckboxField_Readonly — Class in namespace SilverStripe\Forms

Readonly version of a checkbox field - "Yes" or "No".

CheckboxSetField — Class in namespace SilverStripe\Forms

Displays a set of checkboxes as a logical group.

CompositeField — Class in namespace SilverStripe\Forms

Base class for all fields that contain other fields.

CompositeField::collateDataFields() — Method in class CompositeField

Add all of the non-composite fields contained within this field to the list.

CompositeValidator — Class in namespace SilverStripe\Forms

CompositeValidator can contain between 0 and many different types of Validators. Each Validator is itself still responsible for Validating its form and generating its ValidationResult.

CompositeValidator::canBeCached() — Method in class CompositeValidator

Each Validator is aware of whether or not it can be cached. If even one Validator cannot be cached, then the CompositeValidator as a whole also cannot be cached.

ConfirmedPasswordField — Class in namespace SilverStripe\Forms

Two masked input fields, checks for matching passwords.

$ ConfirmedPasswordField#canBeEmpty — Property in class ConfirmedPasswordField

Allow empty fields in serverside validation

$ ConfirmedPasswordField#children — Property in class ConfirmedPasswordField

Child fields (_Password, _ConfirmPassword)

CurrencyField — Class in namespace SilverStripe\Forms

Renders a text field, validating its input as a currency.

CurrencyField_Disabled — Class in namespace SilverStripe\Forms

Readonly version of a {@link CurrencyField}.

CurrencyField_Readonly — Class in namespace SilverStripe\Forms

Readonly version of a {@link CurrencyField}.

FieldList::changeFieldOrder() — Method in class FieldList

Change the order of fields in this FieldList by specifying an ordered list of field names.

$ Form#casting — Property in class Form

Form::clearFormState() — Method in class Form

Flush persistent form state details

Form::clearMessage() — Method in class Form

Clear form message (and in session)

Form::castingHelper() — Method in class Form

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.

$ FormAction#casting — Property in class FormAction

FormField::castingHelper() — Method in class FormField

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.

FormField::castedCopy() — Method in class FormField

Returns another instance of this field, but "cast" to a different class. The logic tries to retain all of the instance properties, and may be overloaded by subclasses to set additional ones.

FormField::canSubmitValue() — Method in class FormField

Determine if the value of this formfield accepts front-end submitted values and is saveable.

FormRequestHandler::checkAccessAction() — Method in class FormRequestHandler

GridFieldFilterHeader::canFilterAnyColumns() — Method in class GridFieldFilterHeader

Returns whether this {@link GridField} has any columns to filter on at all

ReadonlyField::castingHelper() — Method in class ReadonlyField

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.

RequiredFields::canBeCached() — Method in class RequiredFields

AbstractSegmentFieldModifier::create() — Method in class AbstractSegmentFieldModifier

SelectField::castedCopy() — Method in class SelectField

Returns another instance of this field, but "cast" to a different class.

SingleSelectField::castedCopy() — Method in class SingleSelectField

Returns another instance of this field, but "cast" to a different class.

TreeDropdownField::castedCopy() — Method in class TreeDropdownField

Validator::canBeCached() — Method in class Validator

When Validators are set on the form, it can affect whether or not the form cannot be cached.

Configuration — Class in namespace SilverStripe\GraphQL\Config

Controller — Class in namespace SilverStripe\GraphQL

Top level controller for handling graphql requests.

$ Controller#cors — Property in class Controller

Cors default config

ClientConfigProvider — Class in namespace SilverStripe\GraphQL\Extensions

CSRFMiddleware — Class in namespace SilverStripe\GraphQL\Middleware

Adds functionality that checks a request for a token before allowing a mutation to happen. Protects against CSRF attacks

AbstractBulkLoader::collect() — Method in class AbstractBulkLoader

Collection — Class in namespace SilverStripe\GraphQL\Schema\BulkLoader

Defines a collection of class names paired with file paths

Collection::createFromClassList() — Method in class Collection

ExtensionLoader::collect() — Method in class ExtensionLoader

FilepathLoader::collect() — Method in class FilepathLoader

InheritanceLoader::collect() — Method in class InheritanceLoader

NamespaceLoader::collect() — Method in class NamespaceLoader

CreateCreator — Class in namespace SilverStripe\GraphQL\Schema\DataObject

Creates a "create" mutation for a DataObject

CreateCreator::createOperation() — Method in class CreateCreator

DeleteCreator::createOperation() — Method in class DeleteCreator

InheritanceUnionBuilder::createUnions() — Method in class InheritanceUnionBuilder

InterfaceBuilder::createInterfaces() — Method in class InterfaceBuilder

ModelCreator::createModel() — Method in class ModelCreator

CanViewPermission — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin

A permission checking plugin for DataLists

QueryCollector::collectQueries() — Method in class QueryCollector

QueryCollector::collectQueriesForType() — Method in class QueryCollector

ContainsFilter — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter\Filters

A filter that selects records that partially match a keyword

ReadCreator::createOperation() — Method in class ReadCreator

ReadOneCreator::createOperation() — Method in class ReadOneCreator

UpdateCreator::createOperation() — Method in class UpdateCreator

ConfigurationApplier — Class in namespace SilverStripe\GraphQL\Schema\Interfaces

Applies an array of config to a class

ContextProvider — Class in namespace SilverStripe\GraphQL\Schema\Interfaces

A class that can store a generic array of context

OperationCreator::createOperation() — Method in class OperationCreator

SchemaModelCreatorInterface::createModel() — Method in class SchemaModelCreatorInterface

SchemaStorageCreator::createStore() — Method in class SchemaStorageCreator

SchemaStorageInterface::clear() — Method in class SchemaStorageInterface

Logger::critical() — Method in class Logger

PaginationPlugin::createPaginationResult() — Method in class PaginationPlugin

ComposedResolver — Class in namespace SilverStripe\GraphQL\Schema\Resolver

Given a stack of resolver middleware and afterware, compress it into one composed function, passing along the return value.

Schema::createStoreableSchema() — Method in class Schema

Creates a readonly object that can be used by a storage service.

Schema::createModel() — Method in class Schema

SchemaConfig::createModel() — Method in class SchemaConfig

CodeGenerationStore — Class in namespace SilverStripe\GraphQL\Schema\Storage

$ CodeGenerationStore#configFilename — Property in class CodeGenerationStore

CodeGenerationStore::clear() — Method in class CodeGenerationStore

CodeGenerationStoreCreator — Class in namespace SilverStripe\GraphQL\Schema\Storage

CodeGenerationStoreCreator::createStore() — Method in class CodeGenerationStoreCreator

CanonicalModelAware — Class in namespace SilverStripe\GraphQL\Schema\Type

TypeReference::createFromPath() — Method in class TypeReference

GridFieldQueuedExportButton::checkExport() — Method in class GridFieldQueuedExportButton

Handle the export, for both the action button and the URL

$ GenerateCSVJob#chunk_size — Property in class GenerateCSVJob

CryptoHandler — Class in namespace SilverStripe\HybridSessions\Crypto

HybridSession::close() — Method in class HybridSession

CookieStore — Class in namespace SilverStripe\HybridSessions\Store

A session store which stores the session data in an encrypted & signed cookie.

CookieStore::close() — Method in class CookieStore

DatabaseStore::close() — Method in class DatabaseStore

LDAPAuthenticator::checkPassword() — Method in class LDAPAuthenticator

Check if the passed password matches the stored one (if the member is not locked out).

LDAPChangePasswordHandler::changePasswordForm() — Method in class LDAPChangePasswordHandler

Factory method for the lost password form

$ LDAPMemberExtension#create_users_in_ldap — Property in class LDAPMemberExtension

If enabled, Member records with a Username field have the user created in LDAP on write.

LDAPIterator::current() — Method in class LDAPIterator

LDAPGateway::changePassword() — Method in class LDAPGateway

Changes user password via LDAP.

LDAPService::createLDAPUser() — Method in class LDAPService

Creates a new LDAP user from the passed Member record.

LDAPService::createLDAPGroup() — Method in class LDAPService

Creates a new LDAP group from the passed Group record.

EnablerExtension::ContentLocale() — Method in class EnablerExtension

Returns an RFC1766 compliant locale string, e.g. 'fr-CA'.

ChangePasswordHandler — Class in namespace SilverStripe\MFA\Authenticator

Extends the "MemberAuthenticator version of the ChangePasswordHandler in order to allow MFA to be inserted into the flow when an AutoLoginHash is being used - that is when the user has clicked a reset password link in an email after using the "forgot password" functionality.

ChangePasswordHandler::changepassword() — Method in class ChangePasswordHandler

Handle the change password request

MemberExtension::currentUserCanViewMFAConfig() — Method in class MemberExtension

Determines whether the logged in user has sufficient permission to see the MFA config for this Member.

MemberExtension::currentUserCanEditMFAConfig() — Method in class MemberExtension

Determines whether the logged in user has sufficient permission to modify the MFA config for this Member.

EnabledMembers::columns() — Method in class EnabledMembers

List the columns configured to display in the resulting reports GridField

RegistrationHandlerTrait::createStartRegistrationResponse() — Method in class RegistrationHandlerTrait

Create a response that can be consumed by a front-end for starting a registration

RegistrationHandlerTrait::completeRegistrationRequest() — Method in class RegistrationHandlerTrait

Complete a registration request, returning a result object with a message and context for the result of the registration attempt.

EnforcementManager::canSkipMFA() — Method in class EnforcementManager

Whether the provided member can skip the MFA registration process.

RegisteredMethodManager::canRemoveMethod() — Method in class RegisteredMethodManager

Determines if a method can be removed

Result::create() — Method in class Result

SessionStore::clear() — Method in class SessionStore

Clear any stored values for the given request

StoreInterface::clear() — Method in class StoreInterface

Clear any stored state for the given request

MimeUploadValidator::compareMime() — Method in class MimeUploadValidator

Check two MIME types roughly match eachother.

ArrayList::count() — Method in class ArrayList

Return the number of items in this list

ArrayList::column() — Method in class ArrayList

Returns an array of a single field value for all items in the list.

ArrayList::columnUnique() — Method in class ArrayList

Returns a unique array of a single field value for all the items in the list

ArrayList::canSortBy() — Method in class ArrayList

You can always sort a ArrayList

ArrayList::canFilterBy() — Method in class ArrayList

Returns true if the given column can be used to filter the records.

CMSPreviewable — Class in namespace SilverStripe\ORM

Interface to provide enough information about a record to make it previewable through the CMS. It uses the record database ID, its "frontend" and "backend" links to link up the edit form with its preview.

CMSPreviewable::CMSEditLink() — Method in class CMSPreviewable

DBConnector::connect() — Method in class DBConnector

Link this connector to the database given the specified parameters Will throw an exception rather than return a success state.

$ DBSchemaManager#check_and_repair_on_build — Property in class DBSchemaManager

DBSchemaManager::cancelSchemaUpdate() — Method in class DBSchemaManager

Cancels the schema updates requested during (but not after) schemaUpdate() call.

DBSchemaManager::checkAndRepairTable() — Method in class DBSchemaManager

Checks a table's integrity and repairs it if necessary.

DBSchemaManager::createDatabase() — Method in class DBSchemaManager

Create a database with the specified name

DBSchemaManager::createTable() — Method in class DBSchemaManager

Create a new table.

DBSchemaManager::createField() — Method in class DBSchemaManager

Create a new field on a table.

DBSchemaManager::clearCachedFieldlist() — Method in class DBSchemaManager

This allows the cached values for a table's field list to be erased.

Database::clearAllData() — Method in class Database

Clear all data out of the database

Database::clearTable() — Method in class Database

Clear all data in a given table

Database::comparisonClause() — Method in class Database

Generate a WHERE clause for text matching.

Database::concatOperator() — Method in class Database

String operator for concatenation of strings

Database::canLock() — Method in class Database

Returns if the lock is available.

Database::connect() — Method in class Database

Instruct the database to generate a live connection

$ MySQLDatabase#connection_charset — Property in class MySQLDatabase

Default connection charset (may be overridden in $databaseConfig)

$ MySQLDatabase#connection_collation — Property in class MySQLDatabase

Default connection collation

$ MySQLDatabase#charset — Property in class MySQLDatabase

Default charset

$ MySQLDatabase#collation — Property in class MySQLDatabase

Default collation

MySQLDatabase::connect() — Method in class MySQLDatabase

Instruct the database to generate a live connection

MySQLDatabase::comparisonClause() — Method in class MySQLDatabase

Generate a WHERE clause for text matching.

MySQLDatabase::canLock() — Method in class MySQLDatabase

Returns if the lock is available.

MySQLDatabase::clearTable() — Method in class MySQLDatabase

Clear all data in a given table

MySQLSchemaManager::createTable() — Method in class MySQLSchemaManager

Create a new table.

MySQLSchemaManager::checkAndRepairTable() — Method in class MySQLSchemaManager

Checks a table's integrity and repairs it if necessary.

MySQLSchemaManager::createField() — Method in class MySQLSchemaManager

Create a new field on a table.

MySQLSchemaManager::createDatabase() — Method in class MySQLSchemaManager

Create a database with the specified name

MySQLSchemaManager::createIndex() — Method in class MySQLSchemaManager

Create an index on a table.

MySQLiConnector::connect() — Method in class MySQLiConnector

Link this connector to the database given the specified parameters Will throw an exception rather than return a success state.

Query::column() — Method in class Query

Return an array containing all the values from a specific column. If no column is set, then the first will be returned

TempDatabase::clearAllData() — Method in class TempDatabase

Remove all content from the temporary database.

DB::connect() — Method in class DB

Specify connection to a database

DB::connection_attempted() — Method in class DB

Returns true if a database connection has been attempted.

DB::create_database() — Method in class DB

Create the database and connect to it. This can be called if the initial database connection is not successful because the database does not exist.

DB::create_table() — Method in class DB

Create a new table.

DB::create_field() — Method in class DB

Create a new field on a table.

DB::check_and_repair_table() — Method in class DB

Checks a table's integrity and repairs it if necessary.

DataExtension::can() — Method in class DataExtension

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

DataExtension::canEdit() — Method in class DataExtension

Influence the owner's canEdit() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

DataExtension::canDelete() — Method in class DataExtension

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

DataExtension::canCreate() — Method in class DataExtension

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

DataList::canSortBy() — Method in class DataList

Returns true if this DataList can be sorted by the given field.

DataList::canFilterBy() — Method in class DataList

Returns true if this DataList can be filtered by the given field.

DataList::createDataObject() — Method in class DataList

Create a DataObject from the given SQL row If called without $row['ID'] set, then a new object will be created rather than rehydrated.

DataList::count() — Method in class DataList

Return the number of items in this DataList

DataList::column() — Method in class DataList

Returns an array of a single field value for all items in the list.

DataList::columnUnique() — Method in class DataList

Returns a unique array of a single field value for all items in the list.

DataList::chunkedFetch() — Method in class DataList

Iterate over this DataList in "chunks". This will break the query in smaller subsets and avoid loading the entire result set in memory at once. Beware not to perform any operations on the results that might alter the return order. Otherwise, you might break subsequent chunks.

$ DataObject#cascade_deletes — Property in class DataObject

List of relations that should be cascade deleted, similar to owns Note: This will trigger delete on many_many objects, not only the mapping table.

$ DataObject#create_table_options — Property in class DataObject

Specify custom options for a CREATE TABLE call.

$ DataObject#ClassName — Property in class DataObject

Class name of the DataObject

$ DataObject#Created — Property in class DataObject

Date and time of DataObject creation.

DataObject::castedUpdate() — Method in class DataObject

Pass changes as a map, and try to get automatic casting for these fields.

DataObject::castingHelper() — Method in class DataObject

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.

DataObject::can() — Method in class DataObject

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

DataObject::canView() — Method in class DataObject

DataObject::canEdit() — Method in class DataObject

DataObject::canDelete() — Method in class DataObject

DataObject::canCreate() — Method in class DataObject

DataObjectSchema::classHasTable() — Method in class DataObjectSchema

Check if the given class has a table

DataObjectSchema::compositeFields() — Method in class DataObjectSchema

Returns a list of all the composite if the given db field on the class is a composite field.

DataObjectSchema::compositeField() — Method in class DataObjectSchema

Get a composite field for a class

DataObjectSchema::classForField() — Method in class DataObjectSchema

Returns the class name in the class hierarchy which contains a given field column for a {@link DataObject}. If the field does not exist, this will return null.

DataQuery::count() — Method in class DataQuery

Return the number of records in this query.

DataQuery::conjunctiveGroup() — Method in class DataQuery

Create a conjunctive subgroup

DataQuery::column() — Method in class DataQuery

Query the given field column from the database and return as an array.

DataQuery_SubGroup::conditionSQL() — Method in class DataQuery_SubGroup

Determines the resulting SQL along with parameters for the group

DatabaseAdmin::cleanup() — Method in class DatabaseAdmin

Remove invalid records from tables - that is, records that don't have corresponding records in their parent class tables.

$ DBComposite#composite_db — Property in class DBComposite

Similar to {@link DataObject::$db}, holds an array of composite field names.

DBComposite::compositeDatabaseFields() — Method in class DBComposite

Return array in the format of {@link $composite_db}.

DBComposite::castingHelper() — Method in class DBComposite

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.

$ DBCurrency#currency_symbol — Property in class DBCurrency

DBDatetime::clear_mock_now() — Method in class DBDatetime

Clear any mocked date, which causes {@link Now()} to return the current system date.

DBField::create_field() — Method in class DBField

Create a DBField object that's not bound to any particular field.

DBField::CDATA() — Method in class DBField

Safely escape for XML string

DBHTMLText::CDATA() — Method in class DBHTMLText

Safely escape for XML string

DBHTMLVarchar::CDATA() — Method in class DBHTMLVarchar

Safely escape for XML string

DBText::ContextSummary() — Method in class DBText

Perform context searching to give some context to searches, optionally highlighting the search term.

Filterable::canFilterBy() — Method in class Filterable

Returns TRUE if the list can be filtered by a given field expression.

ComparisonFilter — Class in namespace SilverStripe\ORM\Filters

Base class for creating comparison filters, eg; greater than, less than, greater than or equal, etc

Hierarchy::Children() — Method in class Hierarchy

Get the children for this DataObject filtered by canView()

MarkedSet::clearMarks() — Method in class MarkedSet

Reset marked nodes

ManyManyList::createDataObject() — Method in class ManyManyList

Create a DataObject from the given SQL row.

ManyManyThroughList::createDataObject() — Method in class ManyManyThroughList

Create a DataObject from the given SQL row If called without $row['ID'] set, then a new object will be created rather than rehydrated.

Map::count() — Method in class Map

Returns the count of items in the list including the additional items set through {@link Map::push()} and {@link Map::unshift}.

PaginatedList::CurrentPage() — Method in class PaginatedList

SQLAssignmentRow::clear() — Method in class SQLAssignmentRow

Clears all assignment values

SQLConditionGroup::conditionSQL() — Method in class SQLConditionGroup

Determines the resulting SQL along with parameters for the group

SQLDelete::create() — Method in class SQLDelete

Construct a new SQLDelete.

SQLInsert::create() — Method in class SQLInsert

Construct a new SQLInsert object

SQLInsert::currentRow() — Method in class SQLInsert

Returns the currently set row

SQLInsert::clearRow() — Method in class SQLInsert

Clears all currently set assignment values on the current row

SQLInsert::clear() — Method in class SQLInsert

Clears all rows

SQLSelect::create() — Method in class SQLSelect

Construct a new SQLSelect.

SQLSelect::canSortBy() — Method in class SQLSelect

Returns true if this query can be sorted by the given field.

SQLSelect::count() — Method in class SQLSelect

Return the number of rows in this query, respecting limit and offset.

SQLUpdate::create() — Method in class SQLUpdate

Construct a new SQLUpdate object

SQLUpdate::clear() — Method in class SQLUpdate

Clears all currently set assignment values

SS_List::column() — Method in class SS_List

Returns an array of a single field value for all items in the list.

SearchContext::clearEmptySearchFields() — Method in class SearchContext

Callback map function to filter fields with empty values from being included in the search expression.

Sortable::canSortBy() — Method in class Sortable

Returns TRUE if the list can be sorted by a field.

UnsavedRelationList::changeToList() — Method in class UnsavedRelationList

Save all the items in this list into the RelationList

UnsavedRelationList::column() — Method in class UnsavedRelationList

Returns an array of a single field value for all items in the list.

UnsavedRelationList::columnUnique() — Method in class UnsavedRelationList

Returns a unique array of a single field value for all items in the list.

ValidationResult::combineAnd() — Method in class ValidationResult

Combine this Validation Result with the ValidationResult given in other.

Authenticator::checkPassword() — Method in class Authenticator

Check if the passed password matches the stored one (if the member is not locked out).

SiteTreeExtension::canView() — Method in class SiteTreeExtension

This function is an extension of the default SiteTree canView(), and allows viewing permissions for a SiteTree object which has allowed a page to be presented to logged in users. With RealMe a logged in user is a user which has authenticated with the identity provider, and we have stored a FLT in session.

FederatedIdentity::createFromXML() — Method in class FederatedIdentity

Constructor that sets the expected federated identity details based on a provided DOMDocument. The expected XML structure for the DOMDocument is the following:

FederatedIdentity::createFromJSON() — Method in class FederatedIdentity

create a FederatedIdentity from a JSON string.

RealMeService::current_realme_user() — Method in class RealMeService

Calls available user data and checks for validity

RealMeService::currentRealMeUser() — Method in class RealMeService

A helpful static method that follows SilverStripe naming for Member::currentUser();

RealMeService::clearLogin() — Method in class RealMeService

Clear the RealMe credentials from Session, called during Security->logout() overrides

RegistryAdmin::canView() — Method in class RegistryAdmin

Hide the registry section completely if we have no registries to manage.

RegistryPageController::canSortBy() — Method in class RegistryPageController

Loosely check if the record can be sorted by a property

RegistryPageController::Columns() — Method in class RegistryPageController

Format a set of columns, used for headings and row data

Report::columns() — Method in class Report

Report::canView() — Method in class Report

ReportAdmin::canView() — Method in class ReportAdmin

Does the parent permission checks, but also makes sure that instantiatable subclasses of {@link SilverStripe\Reports\Report} exist. By default, the CMS doesn't include any Reports, so there's no point in showing

ReportWrapper::columns() — Method in class ReportWrapper

ReportWrapper::canView() — Method in class ReportWrapper

SideReportWrapper::columns() — Method in class SideReportWrapper

DataFormatter::convertDataObject() — Method in class DataFormatter

Convert a single data object to this format. Return a string.

DataFormatter::convertDataObjectSet() — Method in class DataFormatter

Convert a data object set to this format. Return a string.

DataFormatter::convertArray() — Method in class DataFormatter

Convert an array to this format. Return a string.

DataFormatter::convertStringToArray() — Method in class DataFormatter

FormEncodedDataFormatter::convertStringToArray() — Method in class FormEncodedDataFormatter

JSONDataFormatter::convertArray() — Method in class JSONDataFormatter

JSONDataFormatter::convertDataObject() — Method in class JSONDataFormatter

Generate a JSON representation of the given {@link DataObject}.

JSONDataFormatter::convertDataObjectToJSONObject() — Method in class JSONDataFormatter

Internal function to do the conversion of a single data object. It builds an empty object and dynamically adds the properties it needs to it. If it's done as a nested array, json_encode or equivalent won't use JSON object notation { ... }.

JSONDataFormatter::convertDataObjectSet() — Method in class JSONDataFormatter

Generate a JSON representation of the given {@link SS_List}.

JSONDataFormatter::convertStringToArray() — Method in class JSONDataFormatter

JSONDataFormatter::cast() — Method in class JSONDataFormatter

XMLDataFormatter::convertArray() — Method in class XMLDataFormatter

XMLDataFormatter::convertArrayWithoutHeader() — Method in class XMLDataFormatter

XMLDataFormatter::convertDataObject() — Method in class XMLDataFormatter

Generate an XML representation of the given {@link DataObject}.

XMLDataFormatter::convertDataObjectWithoutHeader() — Method in class XMLDataFormatter

XMLDataFormatter::convertDataObjectSet() — Method in class XMLDataFormatter

Generate an XML representation of the given {@link SS_List}.

XMLDataFormatter::convertStringToArray() — Method in class XMLDataFormatter

$ MemberReportExtension#casting — Property in class MemberReportExtension

Set cast of additional fields

$ SubsiteMemberReportExtension#casting — Property in class SubsiteMemberReportExtension

Set cast of additional field

$ UserSecurityReport#columns — Property in class UserSecurityReport

Columns in the report

UserSecurityReport::columns() — Method in class UserSecurityReport

Returns the column names of the report

UserSecurityReport::canView() — Method in class UserSecurityReport

Restrict access to this report to users with security admin access

Authenticator::checkPassword() — Method in class Authenticator

Check if the passed password matches the stored one (if the member is not locked out).

CMSSecurity — Class in namespace SilverStripe\Security

Provides a security interface functionality within the cms

Item::confirm() — Method in class Item

Mark the item as confirmed

Storage::cleanup() — Method in class Storage

Remove all the data from the storage Cleans up Session and Cookie related to this storage

Storage::confirm() — Method in class Storage

Gets user input data (usually POST array), checks all the items in the storage has been confirmed and marks them as such.

Storage::check() — Method in class Storage

Check all items to be confirmed in the storage

DefaultAdminService::clearDefaultAdmin() — Method in class DefaultAdminService

Flush the default admin credentials.

DefaultPermissionChecker::canEdit() — Method in class DefaultPermissionChecker

Can root be edited?

DefaultPermissionChecker::canView() — Method in class DefaultPermissionChecker

Can root be viewed?

DefaultPermissionChecker::canDelete() — Method in class DefaultPermissionChecker

Can root be deleted?

DefaultPermissionChecker::canCreate() — Method in class DefaultPermissionChecker

Can root objects be created?

$ Group#Code — Property in class Group

Group code

Group::collateFamilyIDs() — Method in class Group

Return a set of this record's "family" of IDs - the IDs of this record and all its descendants.

Group::collateAncestorIDs() — Method in class Group

Returns an array of the IDs of this group and all its parents

Group::cmsCleanup_parentChanged() — Method in class Group

This isn't a descendant of SiteTree, but needs this in case the group is "reorganised";

Group::canEdit() — Method in class Group

Checks for permission-code CMS_ACCESS_SecurityAdmin.

Group::canView() — Method in class Group

Checks for permission-code CMS_ACCESS_SecurityAdmin.

Group::canDelete() — Method in class Group

InheritedPermissions::canEditMultiple() — Method in class InheritedPermissions

InheritedPermissions::canViewMultiple() — Method in class InheritedPermissions

InheritedPermissions::canDeleteMultiple() — Method in class InheritedPermissions

InheritedPermissions::canDelete() — Method in class InheritedPermissions

InheritedPermissions::canEdit() — Method in class InheritedPermissions

InheritedPermissions::canView() — Method in class InheritedPermissions

InheritedPermissions::clearCache() — Method in class InheritedPermissions

$ InheritedPermissionsExtension#CanViewType — Property in class InheritedPermissionsExtension

$ InheritedPermissionsExtension#CanEditType — Property in class InheritedPermissionsExtension

$ Member#casting — Property in class Member

Member::canLogin() — Method in class Member

Check if this user can login

Member::canView() — Method in class Member

Users can view their own record.

Member::canEdit() — Method in class Member

Users can edit their own record.

Member::canDelete() — Method in class Member

Users can edit their own record.

Member::changePassword() — Method in class Member

Change password. This will cause rehashing according to the PasswordEncryption property via the onBeforeWrite() method. This method will allow extensions to perform actions and augment the validation result if required before the password is written and can check it after the write also.

CMSLoginHandler — Class in namespace SilverStripe\Security\MemberAuthenticator

CMSMemberAuthenticator — Class in namespace SilverStripe\Security\MemberAuthenticator

Provides authentication for the user within the CMS

CMSMemberLoginForm — Class in namespace SilverStripe\Security\MemberAuthenticator

Provides the in-cms session re-authentication form for the "member" authenticator

ChangePasswordForm — Class in namespace SilverStripe\Security\MemberAuthenticator

Standard Change Password Form

ChangePasswordHandler — Class in namespace SilverStripe\Security\MemberAuthenticator

ChangePasswordHandler::changepassword() — Method in class ChangePasswordHandler

Handle the change password request

ChangePasswordHandler::changePasswordForm() — Method in class ChangePasswordHandler

Factory method for the lost password form

CookieAuthenticationHandler — Class in namespace SilverStripe\Security\MemberAuthenticator

Authenticate a member passed on a session cookie

LoginHandler::checkLogin() — Method in class LoginHandler

Try to authenticate the user

MemberAuthenticator::checkPassword() — Method in class MemberAuthenticator

Check if the passed password matches the stored one (if the member is not locked out).

MemberPassword::checkPassword() — Method in class MemberPassword

Check if the given password is the same as the one stored in this record.

$ Member_Validator#customRequired — Property in class Member_Validator

Fields that are required by this validator

NullSecurityToken::check() — Method in class NullSecurityToken

NullSecurityToken::checkRequest() — Method in class NullSecurityToken

PasswordEncryptor::create_for_algorithm() — Method in class PasswordEncryptor

PasswordEncryptor::check() — Method in class PasswordEncryptor

This usually just returns a strict string comparison, but is necessary for retain compatibility with password hashed with flawed algorithms - see {@link PasswordEncryptor_LegacyPHPHash} and {@link PasswordEncryptor_Blowfish}

PasswordEncryptor_Blowfish::checkAEncryptionLevel() — Method in class PasswordEncryptor_Blowfish

The algorithm returned by using '$2a$' is not consistent - it might be either the correct (y), incorrect (x) or mostly-correct (a) version, depending on the version of PHP and the operating system, so we need to test it.

PasswordEncryptor_Blowfish::check() — Method in class PasswordEncryptor_Blowfish

PasswordEncryptor_LegacyPHPHash::check() — Method in class PasswordEncryptor_LegacyPHPHash

$ PasswordValidator#character_strength_tests — Property in class PasswordValidator

Permission::check() — Method in class Permission

Check that the current member has the given permission.

Permission::checkMember() — Method in class Permission

Check that the given member has the given permission.

PermissionChecker::canEditMultiple() — Method in class PermissionChecker

Get the 'can edit' information for a number of SiteTree pages.

PermissionChecker::canViewMultiple() — Method in class PermissionChecker

Get the canView information for a number of objects

PermissionChecker::canDeleteMultiple() — Method in class PermissionChecker

Get the 'can edit' information for a number of SiteTree pages.

PermissionChecker::canDelete() — Method in class PermissionChecker

Check delete permission for a single record ID

PermissionChecker::canEdit() — Method in class PermissionChecker

Check edit permission for a single record ID

PermissionChecker::canView() — Method in class PermissionChecker

Check view permission for a single record ID

PermissionRole::canView() — Method in class PermissionRole

PermissionRole::canCreate() — Method in class PermissionRole

PermissionRole::canEdit() — Method in class PermissionRole

PermissionRole::canDelete() — Method in class PermissionRole

PermissionRole::Codes() — Method in class PermissionRole

List of PermissionRoleCode objects

PermissionRoleCode::canCreate() — Method in class PermissionRoleCode

PermissionRoleCode::canEdit() — Method in class PermissionRoleCode

PermissionRoleCode::canDelete() — Method in class PermissionRoleCode

RememberLoginHash::clear() — Method in class RememberLoginHash

Deletes existing tokens for this member if logout_across_devices is true, all tokens are deleted, otherwise only the token for the provided device ID will be removed

Security::clearSessionMessage() — Method in class Security

Clear login message

Security::changepassword() — Method in class Security

Show the "change password" page.

Security::clear_database_is_ready() — Method in class Security

Resets the database_is_ready cache

SecurityToken::check() — Method in class SecurityToken

Checks for an existing CSRF token in the current users session.

SecurityToken::checkRequest() — Method in class SecurityToken

See {@link check()}.

SudoModeService::check() — Method in class SudoModeService

Checks the current session to see if sudo mode was activated within the last section of lifetime allocation.

SudoModeServiceInterface::check() — Method in class SudoModeServiceInterface

Checks the current session to see if sudo mode was activated within the last section of lifetime allocation.

LoginSession::canCreate() — Method in class LoginSession

LoginSession::canView() — Method in class LoginSession

LoginSession::canEdit() — Method in class LoginSession

LoginSession::canDelete() — Method in class LoginSession

GarbageCollectionService::collect() — Method in class GarbageCollectionService

Delete expired LoginSession and RememberLoginHash records

$ ShareDraftController#controller — Property in class ShareDraftController

Controller for rendering draft pages.

SiteConfig::CMSEditLink() — Method in class SiteConfig

SiteConfig::current_site_config() — Method in class SiteConfig

Get the current sites SiteConfig, and creates a new one through {@link make_site_config()} if none is found.

SiteConfig::canView() — Method in class SiteConfig

Can a user view this SiteConfig instance?

SiteConfig::canViewPages() — Method in class SiteConfig

Can a user view pages on this site? This method is only called if a page is set to Inherit, but there is nothing to inherit from.

SiteConfig::canEditPages() — Method in class SiteConfig

Can a user edit pages on this site? This method is only called if a page is set to Inherit, but there is nothing to inherit from, or on new records without a parent.

SiteConfig::canEdit() — Method in class SiteConfig

SiteConfig::canCreateTopLevel() — Method in class SiteConfig

Can a user create pages in the root of this site?

SiteConfig::CreateTopLevelGroups() — Method in class SiteConfig

List of groups that can create root-level pages.

SiteConfigPagePermissions::canEdit() — Method in class SiteConfigPagePermissions

Can root be edited?

SiteConfigPagePermissions::canView() — Method in class SiteConfigPagePermissions

Can root be viewed?

SiteConfigPagePermissions::canDelete() — Method in class SiteConfigPagePermissions

Can root be deleted?

SiteConfigPagePermissions::canCreate() — Method in class SiteConfigPagePermissions

Can root objects be created?

SitewideContentReport::columns() — Method in class SitewideContentReport

Returns columns for the grid fields on this report.

$ EditableSpamProtectionField#check_fields — Property in class EditableSpamProtectionField

Fields to include spam detection for

CommentSpamProtection — Class in namespace SilverStripe\SpamProtection\Extension

Apply the spam protection to the comments module if it is installed.

SiteTreePublishingEngine::collectChanges() — Method in class SiteTreePublishingEngine

Collect all changes for the given context.

$ Job#chunk_size — Property in class Job

Number of URLs processed during one call of see AbstractQueuedJob::process() This number should be set to a value which represents number of URLs which is reasonable to process in one go This number will vary depending on project, more specifically it depends on:

time to render your pages
infrastructure

$ DeleteStaticCacheJob#chunk_size — Property in class DeleteStaticCacheJob

SubsiteXHRController::canView() — Method in class SubsiteXHRController

Relax the access permissions, so anyone who has access to any CMS subsite can access this controller.

SubsiteXHRController::canAccess() — Method in class SubsiteXHRController

Allow access if user allowed into the CMS at all.

CMSPageAddControllerExtension — Class in namespace SilverStripe\Subsites\Extensions

ControllerSubsites — Class in namespace SilverStripe\Subsites\Extensions

ControllerSubsites::controllerAugmentInit() — Method in class ControllerSubsites

ControllerSubsites::CurrentSubsite() — Method in class ControllerSubsites

FileSubsites::canEdit() — Method in class FileSubsites

Influence the owner's canEdit() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

FileSubsites::cacheKeyComponent() — Method in class FileSubsites

Return a piece of text to keep DataObject cache keys appropriately specific

LeftAndMainSubsites::CanAddSubsites() — Method in class LeftAndMainSubsites

LeftAndMainSubsites::canAccess() — Method in class LeftAndMainSubsites

Check if the current controller is accessible for this user on this subsite.

LeftAndMainSubsites::copytosubsite() — Method in class LeftAndMainSubsites

SiteConfigSubsites::cacheKeyComponent() — Method in class SiteConfigSubsites

Return a piece of text to keep DataObject cache keys appropriately specific

SiteTreeSubsites::canEdit() — Method in class SiteTreeSubsites

Only allow editing of a page if the member satisfies one of the following conditions:

Is in a group which has access to the subsite this page belongs to
Is in a group with edit permissions on the "main site"

SiteTreeSubsites::canDelete() — Method in class SiteTreeSubsites

SiteTreeSubsites::canAddChildren() — Method in class SiteTreeSubsites

SiteTreeSubsites::canPublish() — Method in class SiteTreeSubsites

SiteTreeSubsites::contentcontrollerInit() — Method in class SiteTreeSubsites

Called by ContentController::init();

SiteTreeSubsites::cacheKeyComponent() — Method in class SiteTreeSubsites

Return a piece of text to keep DataObject cache keys appropriately specific

SiteTreeSubsites::canCreate() — Method in class SiteTreeSubsites

WildcardDomainField::checkHostname() — Method in class WildcardDomainField

Check if the given hostname is valid.

$ Subsite#check_is_public — Property in class Subsite

Respects the IsPublic flag when retrieving subsites

Subsite::currentSubsite() — Method in class Subsite

Gets the subsite currently set in the session.

Subsite::changeSubsite() — Method in class Subsite

Switch to another subsite through storing the subsite identifier in the current PHP session.

Subsite::canEdit() — Method in class Subsite

SubsiteReportWrapper::columns() — Method in class SubsiteReportWrapper

$ Method#code_length — Property in class Method

The TOTP code length

TaxonomyTerm::canView() — Method in class TaxonomyTerm

TaxonomyTerm::canEdit() — Method in class TaxonomyTerm

TaxonomyTerm::canDelete() — Method in class TaxonomyTerm

TaxonomyTerm::canCreate() — Method in class TaxonomyTerm

TaxonomyTerm::Children() — Method in class TaxonomyTerm

Cache — Class in namespace SilverStripe\TextExtraction\Cache\FileTextCache

Uses SS_Cache with a lifetime to cache extracted content

Cache::clear() — Method in class Cache

Alias for $this->flush()

$ FileTextExtractable#casting — Property in class FileTextExtractable

UserDefinedFormAdmin::confirmfolderformschema() — Method in class UserDefinedFormAdmin

This returns a Confirm Folder form schema used to verify the upload folder for EditableFileFields

UserDefinedFormAdmin::ConfirmFolderForm() — Method in class UserDefinedFormAdmin

Return the ConfirmFolderForm. This is only exposed so the treeview has somewhere to direct it's AJAX calss.

UserDefinedFormAdmin::confirmfolder() — Method in class UserDefinedFormAdmin

Sets the selected folder as the upload folder for an EditableFileField

UserFormFieldEditorExtension::createInitialFormStep() — Method in class UserFormFieldEditorExtension

A UserForm must have at least one step.

UserFormsFieldList::clearEmptySteps() — Method in class UserFormsFieldList

Remove all empty steps

$ EditableCustomRule#ConditionOption — Property in class EditableCustomRule

$ EditableCustomRule#ConditionFieldID — Property in class EditableCustomRule

EditableCustomRule::canDelete() — Method in class EditableCustomRule

EditableCustomRule::canEdit() — Method in class EditableCustomRule

EditableCustomRule::canView() — Method in class EditableCustomRule

EditableCustomRule::canCreate() — Method in class EditableCustomRule

Return whether a user can create an object of this type

EditableCustomRule::canPublish() — Method in class EditableCustomRule

EditableCustomRule::canUnpublish() — Method in class EditableCustomRule

EditableCustomRule::ConditionField() — Method in class EditableCustomRule

$ EditableFormField#CustomErrorMessage — Property in class EditableFormField

EditableFormField::canDelete() — Method in class EditableFormField

Return whether a user can delete this form field based on whether they can edit the page

EditableFormField::canEdit() — Method in class EditableFormField

Return whether a user can edit this form field based on whether they can edit the page

EditableFormField::canView() — Method in class EditableFormField

Return whether a user can view this form field based on whether they can view the page, regardless of the ReadOnly status of the field

EditableFormField::canCreate() — Method in class EditableFormField

Return whether a user can create an object of this type

$ EditableCheckbox#CheckedDefault — Property in class EditableCheckbox

EditableFileField::createProtectedFolder() — Method in class EditableFileField

$ EditableLiteralField#Content — Property in class EditableLiteralField

EditableOption::canEdit() — Method in class EditableOption

EditableOption::canDelete() — Method in class EditableOption

EditableOption::canView() — Method in class EditableOption

EditableOption::canCreate() — Method in class EditableOption

Return whether a user can create an object of this type

EditableOption::canPublish() — Method in class EditableOption

EditableOption::canUnpublish() — Method in class EditableOption

$ EmailRecipient#CustomRulesCondition — Property in class EmailRecipient

EmailRecipient::canCreate() — Method in class EmailRecipient

Return whether a user can create an object of this type

EmailRecipient::canView() — Method in class EmailRecipient

EmailRecipient::canEdit() — Method in class EmailRecipient

EmailRecipient::canDelete() — Method in class EmailRecipient

EmailRecipient::canSend() — Method in class EmailRecipient

Determine if this recipient may receive notifications for this submission

EmailRecipient::CustomRules() — Method in class EmailRecipient

$ EmailRecipientCondition#condition_options — Property in class EmailRecipientCondition

List of options

$ EmailRecipientCondition#ConditionFieldID — Property in class EmailRecipientCondition

$ EmailRecipientCondition#ConditionOption — Property in class EmailRecipientCondition

$ EmailRecipientCondition#ConditionValue — Property in class EmailRecipientCondition

EmailRecipientCondition::canCreate() — Method in class EmailRecipientCondition

Return whether a user can create an object of this type

EmailRecipientCondition::canView() — Method in class EmailRecipientCondition

EmailRecipientCondition::canEdit() — Method in class EmailRecipientCondition

EmailRecipientCondition::canDelete() — Method in class EmailRecipientCondition

EmailRecipientCondition::ConditionField() — Method in class EmailRecipientCondition

SubmittedForm::canCreate() — Method in class SubmittedForm

SubmittedForm::canView() — Method in class SubmittedForm

SubmittedForm::canEdit() — Method in class SubmittedForm

SubmittedForm::canDelete() — Method in class SubmittedForm

SubmittedFormField::canCreate() — Method in class SubmittedFormField

SubmittedFormField::canView() — Method in class SubmittedFormField

SubmittedFormField::canEdit() — Method in class SubmittedFormField

SubmittedFormField::canDelete() — Method in class SubmittedFormField

$ UserForm#casting — Property in class UserForm

CachedContentFilter — Class in namespace SilverStripe\VersionFeed\Filters

Caches results of a callback

$ CachedContentFilter#cache_enabled — Property in class CachedContentFilter

Enable caching

ContentFilter — Class in namespace SilverStripe\VersionFeed\Filters

Conditionally executes a given callback, attempting to return the desired results of its execution.

$ ContentFilter#cache_lifetime — Property in class ContentFilter

Cache lifetime

$ VersionFeed#changes_enabled — Property in class VersionFeed

Enables RSS feed for page-specific changes

$ VersionFeed#changes_limit — Property in class VersionFeed

Changes feed limit of items.

VersionFeedController::changes() — Method in class VersionFeedController

Get page-specific changes in a RSS feed.

ArchiveAdmin::createArchiveGridField() — Method in class ArchiveAdmin

Create a gridfield which displays archived objects

CMSPageHistoryViewerController — Class in namespace SilverStripe\VersionedAdmin\Controllers

The history viewer controller uses the React based {@link HistoryViewerField} to display the history for a {@link DataObject} that has the {@link Versioned} extension.

HistoryViewerController::compareForm() — Method in class HistoryViewerController

SilverStripeNavigatorItem_ArchiveLink::canView() — Method in class SilverStripeNavigatorItem_ArchiveLink

Filters items based on member permissions or other criteria, such as if a state is generally available for the current record.

SilverStripeNavigatorItem_LiveLink::canView() — Method in class SilverStripeNavigatorItem_LiveLink

Filters items based on member permissions or other criteria, such as if a state is generally available for the current record.

SilverStripeNavigatorItem_StageLink::canView() — Method in class SilverStripeNavigatorItem_StageLink

Filters items based on member permissions or other criteria, such as if a state is generally available for the current record.

ProxyCacheAdapter::clear() — Method in class ProxyCacheAdapter

{@inheritdoc}

ProxyCacheFactory::create() — Method in class ProxyCacheFactory

ChangeSet — Class in namespace SilverStripe\Versioned

The ChangeSet model tracks several VersionedAndStaged objects for later publication as a single atomic action

ChangeSet::canView() — Method in class ChangeSet

ChangeSet::canEdit() — Method in class ChangeSet

ChangeSet::canCreate() — Method in class ChangeSet

ChangeSet::canDelete() — Method in class ChangeSet

ChangeSet::canPublish() — Method in class ChangeSet

Check if this item is allowed to be published

ChangeSet::canRevert() — Method in class ChangeSet

Check if this changeset (if published) can be reverted

ChangeSet::can() — Method in class ChangeSet

Default permissions for this changeset

ChangeSet::Changes() — Method in class ChangeSet

ChangeSetItem — Class in namespace SilverStripe\Versioned

A single line in a changeset

$ ChangeSetItem#ChangeSetID — Property in class ChangeSetItem

ID of parent ChangeSet object

ChangeSetItem::canView() — Method in class ChangeSetItem

ChangeSetItem::canEdit() — Method in class ChangeSetItem

ChangeSetItem::canCreate() — Method in class ChangeSetItem

ChangeSetItem::canDelete() — Method in class ChangeSetItem

ChangeSetItem::canRevert() — Method in class ChangeSetItem

Check if the BeforeVersion of this changeset can be restored to draft

ChangeSetItem::canPublish() — Method in class ChangeSetItem

Check if this ChangeSetItem can be published

ChangeSetItem::can() — Method in class ChangeSetItem

Default permissions for this ChangeSetItem

ChangeSetItem::CMSEditLink() — Method in class ChangeSetItem

Get edit link for this item

ChangeSetItem::ChangeSet() — Method in class ChangeSetItem

Parent changeset

DataDifferencer::ChangedFields() — Method in class DataDifferencer

Get a SS_List of the changed fields.

DataDifferencer::changedFieldNames() — Method in class DataDifferencer

Get an array of the names of every fields that has changed.

AbstractPublishOperationCreator::createOperation() — Method in class AbstractPublishOperationCreator

CopyToStageCreator — Class in namespace SilverStripe\Versioned\GraphQL\Operations

Scaffolds a "copy to stage" operation for DataObjects.

CopyToStageCreator::createOperation() — Method in class CopyToStageCreator

RollbackCreator::createOperation() — Method in class RollbackCreator

$ Versioned#casting — Property in class Versioned

Ensure versioned records cast extra fields properly

Versioned::canPublish() — Method in class Versioned

This function should return true if the current user can publish this record.

Versioned::canUnpublish() — Method in class Versioned

Check if the current user can delete this record from live

Versioned::canArchive() — Method in class Versioned

Check if the current user is allowed to archive this record.

Versioned::canRevertToLive() — Method in class Versioned

Check if the user can revert this record to live

Versioned::canRestoreToDraft() — Method in class Versioned

Check if the user can restore this record to draft

Versioned::canView() — Method in class Versioned

Extend permissions to include additional security for objects that are not published to live.

Versioned::canViewVersioned() — Method in class Versioned

Determine if there are any additional restrictions on this object for the given reading version.

Versioned::canViewStage() — Method in class Versioned

Determines canView permissions for the latest version of this object on a specific stage.

Versioned::canBeVersioned() — Method in class Versioned

Determine if a class is supporting the Versioned extensions (e.g.

Versioned::copyVersionToStage() — Method in class Versioned

Move a database record from one stage to the other.

Versioned::compareVersions() — Method in class Versioned

Compare two version, and return the diff between them.

Versioned::can_choose_site_stage() — Method in class Versioned

Determine if the current user is able to set the given site stage / archive

Versioned::choose_site_stage() — Method in class Versioned

Choose the stage the site is currently on.

Versioned::current_archived_date() — Method in class Versioned

Get the current archive date.

Versioned::current_archived_stage() — Method in class Versioned

Get the current archive stage.

Versioned::cacheKeyComponent() — Method in class Versioned

Return a piece of text to keep DataObject cache keys appropriately specific.

HTML::createTag() — Method in class HTML

Construct and return HTML tag.

$ HTMLCleaner#config — Property in class HTMLCleaner

Configuration variables for HTMLCleaners that support configuration (like Tidy)

HTMLCleaner::cleanHTML() — Method in class HTMLCleaner

Passed a string, return HTML that has been tidied.

HtmlDiff::compareHtml() — Method in class HtmlDiff

Get a diff between two sets of HTML content. The result is an HTML fragment which can be added directly into the DOM. elements are used to indicate new content, and ~~elements are used to indicate removed content.~~

PurifierHTMLCleaner::cleanHTML() — Method in class PurifierHTMLCleaner

Passed a string, return HTML that has been tidied.

ShortcodeParser::clear() — Method in class ShortcodeParser

Remove all registered shortcodes.

ShortcodeParser::callShortcode() — Method in class ShortcodeParser

Call a shortcode and return its replacement text Returns false if the shortcode isn't registered

TidyHTMLCleaner::cleanHTML() — Method in class TidyHTMLCleaner

Passed a string, return HTML that has been tidied.

Requirements::customScript() — Method in class Requirements

Requirements::customCSS() — Method in class Requirements

Requirements::css() — Method in class Requirements

Requirements::clear() — Method in class Requirements

Clear either a single or all requirements

Requirements::combine_files() — Method in class Requirements

Concatenate several css or javascript files into a single dynamically generated file. This increases performance by fewer HTTP requests.

Requirements::clear_combined_files() — Method in class Requirements

Re-sets the combined files definition. See {@link Requirements_Backend::clear_combined_files()}

$ Requirements_Backend#combine_in_dev — Property in class Requirements_Backend

Determine if files should be combined automatically on dev mode.

$ Requirements_Backend#combine_hash_querystring — Property in class Requirements_Backend

Flag to include the hash in the querystring instead of the filename for combined files.

Requirements_Backend::customScript() — Method in class Requirements_Backend

Requirements_Backend::customCSS() — Method in class Requirements_Backend

Requirements_Backend::css() — Method in class Requirements_Backend

Requirements_Backend::clear() — Method in class Requirements_Backend

Clear either a single or all requirements

Requirements_Backend::combineFiles() — Method in class Requirements_Backend

Concatenate several css or javascript files into a single dynamically generated file. This increases performance by fewer HTTP requests.

Requirements_Backend::clearCombinedFiles() — Method in class Requirements_Backend

Clear all registered CSS and JavaScript file combinations

SSTemplateParser::construct() — Method in class SSTemplateParser

Override the function that constructs the result arrays to also prepare a 'php' item in the array

SSTemplateParser::CallArguments_Argument() — Method in class SSTemplateParser

Values are bare words in templates, but strings in PHP. We rely on PHP's type conversion to back-convert strings to numbers when needed.

SSTemplateParser::Comparison_Argument() — Method in class SSTemplateParser

SSTemplateParser::Comparison_ComparisonOperator() — Method in class SSTemplateParser

SSTemplateParser::CacheBlockArgument_DollarMarkedLookup() — Method in class SSTemplateParser

SSTemplateParser::CacheBlockArgument_QuotedString() — Method in class SSTemplateParser

SSTemplateParser::CacheBlockArgument_Lookup() — Method in class SSTemplateParser

SSTemplateParser::CacheBlockArguments_CacheBlockArgument() — Method in class SSTemplateParser

SSTemplateParser::CacheRestrictedTemplate_CacheBlock() — Method in class SSTemplateParser

SSTemplateParser::CacheRestrictedTemplate_UncachedBlock() — Method in class SSTemplateParser

SSTemplateParser::CacheBlock__construct() — Method in class SSTemplateParser

SSTemplateParser::CacheBlock_CacheBlockArguments() — Method in class SSTemplateParser

SSTemplateParser::CacheBlock_Condition() — Method in class SSTemplateParser

SSTemplateParser::CacheBlock_CacheBlock() — Method in class SSTemplateParser

SSTemplateParser::CacheBlock_UncachedBlock() — Method in class SSTemplateParser

SSTemplateParser::CacheBlock_CacheBlockTemplate() — Method in class SSTemplateParser

SSTemplateParser::ClosedBlock__construct() — Method in class SSTemplateParser

As mentioned in the parser comment, block handling is kept fairly generic for extensibility. The match rule builds up two important elements in the match result array: 'ArgumentCount' - how many arguments were passed in the opening tag 'Arguments' an array of the Argument match rule result arrays

SSTemplateParser::ClosedBlock_BlockArguments() — Method in class SSTemplateParser

SSTemplateParser::ClosedBlock__finalise() — Method in class SSTemplateParser

SSTemplateParser::ClosedBlock_Handle_Loop() — Method in class SSTemplateParser

This is an example of a block handler function. This one handles the loop tag.

SSTemplateParser::ClosedBlock_Handle_With() — Method in class SSTemplateParser

The closed block handler for with blocks

SSTemplateParser::Comment__construct() — Method in class SSTemplateParser

SSTemplateParser::compileString() — Method in class SSTemplateParser

Compiles some passed template source code into the php code that will execute as per the template source.

SSTemplateParser::compileFile() — Method in class SSTemplateParser

Compiles some file that contains template source code, and returns the php code that will execute as per that source

SSViewer::chooseTemplate() — Method in class SSViewer

Find the template to use for a given list

$ SSViewer_FromString#cache_template — Property in class SSViewer_FromString

The global template caching behaviour if no instance override is specified

TemplateParser::compileString() — Method in class TemplateParser

Compiles some passed template source code into the php code that will execute as per the template source.

$ ViewableData#casting — Property in class ViewableData

An array of objects to cast certain fields to. This is set up as an array in the format:

ViewableData::customise() — Method in class ViewableData

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.

ViewableData::castingHelper() — Method in class ViewableData

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.

ViewableData::castingClass() — Method in class ViewableData

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

ViewableData::cachedCall() — Method in class ViewableData

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

ViewableData::CSSClasses() — Method in class ViewableData

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

ViewableData_Customised::cachedCall() — Method in class ViewableData_Customised

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

CredentialRepository — Class in namespace SilverStripe\WebAuthn

Implements the required interface from the WebAuthn library - but it does not implement the repository pattern in the usual way. This is expected to be stored on a DataObject for persistence. Use the

CredentialRepositoryProviderTrait — Class in namespace SilverStripe\WebAuthn

IntlLocales::countryName() — Method in class IntlLocales

Get name of country

IntlLocales::countryFromLocale() — Method in class IntlLocales

Returns the country code / suffix on any locale

Locales::countryName() — Method in class Locales

Get name of country by code

Locales::countryFromLocale() — Method in class Locales

Returns the country code / suffix on any locale

i18nTextCollector::collect() — Method in class i18nTextCollector

Extract all strings from modules and return these grouped by module name

i18nTextCollector::collectFromCode() — Method in class i18nTextCollector

Extracts translatables from .php files.

i18nTextCollector::collectFromTemplate() — Method in class i18nTextCollector

Extracts translatables from .ss templates (Self referencing)

i18nTextCollector::collectFromEntityProviders() — Method in class i18nTextCollector

Allows classes which implement i18nEntityProvider to provide additional translation strings.

i18nTextCollector::collectFromORM() — Method in class i18nTextCollector

Extracts translations for ORM fields

i18n::convert_rfc1766() — Method in class i18n

Gets a RFC 1766 compatible language code, e.g. "en-US".

CancelWorkflowAction — Class in namespace Symbiote\AdvancedWorkflow\Actions

Description

PublishItemWorkflowAction::canPublishTarget() — Method in class PublishItemWorkflowAction

Publish action allows a user who is currently assigned at this point of the workflow to

UnpublishItemWorkflowAction::canPublishTarget() — Method in class UnpublishItemWorkflowAction

AdvancedWorkflowAdmin::columns() — Method in class AdvancedWorkflowAdmin

WorkflowAction::canEditTarget() — Method in class WorkflowAction

Can documents in the current workflow state be edited?

WorkflowAction::canViewTarget() — Method in class WorkflowAction

Does this action restrict viewing of the document?

WorkflowAction::canPublishTarget() — Method in class WorkflowAction

Does this action restrict the publishing of a document?

WorkflowAction::canCreate() — Method in class WorkflowAction

Allows users who have permission to create a WorkflowDefinition, to create actions on it too.

WorkflowAction::canEdit() — Method in class WorkflowAction

WorkflowAction::canDelete() — Method in class WorkflowAction

WorkflowAction::canAddTransition() — Method in class WorkflowAction

WorkflowActionInstance::canEditTarget() — Method in class WorkflowActionInstance

Can documents in the current workflow state be edited?

WorkflowActionInstance::canViewTarget() — Method in class WorkflowActionInstance

Does this action restrict viewing of the document?

WorkflowActionInstance::canPublishTarget() — Method in class WorkflowActionInstance

Does this action restrict the publishing of a document?

WorkflowActionInstance::canView() — Method in class WorkflowActionInstance

WorkflowActionInstance::canEdit() — Method in class WorkflowActionInstance

WorkflowActionInstance::canDelete() — Method in class WorkflowActionInstance

WorkflowDefinition::canWorkflowPublish() — Method in class WorkflowDefinition

Determines if target can be published directly when no workflow has started yet Opens extension hook to allow an extension to determine if this is allowed as well

WorkflowDefinition::canCreate() — Method in class WorkflowDefinition

WorkflowDefinition::canView() — Method in class WorkflowDefinition

WorkflowDefinition::canEdit() — Method in class WorkflowDefinition

WorkflowDefinition::canDelete() — Method in class WorkflowDefinition

WorkflowInstance::canView() — Method in class WorkflowInstance

WorkflowInstance::canEdit() — Method in class WorkflowInstance

WorkflowInstance::canDelete() — Method in class WorkflowInstance

WorkflowInstance::canEditTarget() — Method in class WorkflowInstance

Can documents in the current workflow state be edited?

WorkflowInstance::canViewTarget() — Method in class WorkflowInstance

Does this action restrict viewing of the document?

WorkflowInstance::canPublishTarget() — Method in class WorkflowInstance

Does this action restrict the publishing of a document?

WorkflowInstance::CurrentAction() — Method in class WorkflowInstance

WorkflowTransition::canExecute() — Method in class WorkflowTransition

Check if the current user can execute this transition

WorkflowTransition::canCreate() — Method in class WorkflowTransition

Allows users who have permission to create a WorkflowDefinition, to create actions on it too.

WorkflowTransition::canEdit() — Method in class WorkflowTransition

WorkflowTransition::canDelete() — Method in class WorkflowTransition

WorkflowApplicable::canPublish() — Method in class WorkflowApplicable

Content can never be directly publishable if there's a workflow applied.

WorkflowApplicable::canEdit() — Method in class WorkflowApplicable

Can only edit content that's NOT in another person's content changeset

WorkflowApplicable::canEditWorkflow() — Method in class WorkflowApplicable

Can a user edit the current workflow attached to this item?

WorkflowEmbargoExpiryExtension::clearPublishJob() — Method in class WorkflowEmbargoExpiryExtension

Clears any existing publish job against this dataobject

WorkflowEmbargoExpiryExtension::clearUnPublishJob() — Method in class WorkflowEmbargoExpiryExtension

Clears any existing unpublish job

WorkflowEmbargoExpiryExtension::canEdit() — Method in class WorkflowEmbargoExpiryExtension

Add edit check for when publishing has been scheduled and if any workflow definitions want the item to be disabled.

WorkflowField::CreateableActions() — Method in class WorkflowField

WorkflowTemplate::createRelations() — Method in class WorkflowTemplate

Creates the relevant data objects for this structure, returning an array of actions in the order they've been created

MultiValueTextField::createReadonlyInput() — Method in class MultiValueTextField

MultiValueTextField::createInput() — Method in class MultiValueTextField

MultiValueField::csv() — Method in class MultiValueField

Convert to a textual list of items.

QueuedJobsAdmin::createjob() — Method in class QueuedJobsAdmin

QueuedJobDescriptor::cleanupJob() — Method in class QueuedJobDescriptor

Called when the job has completed and we want to cleanup anything the descriptor has lying around in caches or the like.

CleanupJob — Class in namespace Symbiote\QueuedJobs\Jobs

An queued job to clean out the QueuedJobDescriptor Table which often gets too full

$ CleanupJob#cleanup_method — Property in class CleanupJob

How we will determine "stale" Possible values: age, number

$ CleanupJob#cleanup_value — Property in class CleanupJob

Value associated with cleanupMethod age => days, number => integer

$ CleanupJob#cleanup_statuses — Property in class CleanupJob

Which JobStatus values are OK to be deleted

DoormanQueuedJobTask::canRunTask() — Method in class DoormanQueuedJobTask

EmailService::createMissingDefaultJobReport() — Method in class EmailService

EmailService::createStalledJobReport() — Method in class EmailService

EmailService::createReport() — Method in class EmailService

Create a generic email report useful for reporting queue service issues

JobErrorHandler::clear() — Method in class JobErrorHandler

$ QueuedJobService#cache_dir — Property in class QueuedJobService

The location for immediate jobs to be stored in

QueuedJobService::checkJobHealth() — Method in class QueuedJobService

Runs an explicit check on all currently running jobs to make sure their "processed" count is incrementing between each run. If it's not, then we need to flag it as paused due to an error.

QueuedJobService::checkDefaultJobs() — Method in class QueuedJobService

Checks through ll the scheduled jobs that are expected to exist

CheckJobHealthTask — Class in namespace Symbiote\QueuedJobs\Tasks

CreateQueuedJobTask — Class in namespace Symbiote\QueuedJobs\Tasks

A task that can be used to create a queued job.

$ DoormanRunner#child_runner — Property in class DoormanRunner

Name of the dev task used to run the child process

$ FluentExtension#copy_to_locale_enabled — Property in class FluentExtension

Enable copy to locale action in the localisation manager

$ FluentExtension#copy_from_locale_enabled — Property in class FluentExtension

Enable copy from locale action in the localisation manager

FluentExtension::cacheKeyComponent() — Method in class FluentExtension

Ensure has_one cache is segmented by locale

FluentExtension::copyToLocale() — Method in class FluentExtension

Copy data object content from current locale to the target locale

FluentAdminTrait::clearFluent() — Method in class FluentAdminTrait

FluentAdminTrait::copyFluent() — Method in class FluentAdminTrait

Copy this record to other localisations (not published)

CopyLocaleAction — Class in namespace TractorCow\Fluent\Forms

CachableModel — Class in namespace TractorCow\Fluent\Model

Allows you to cache a full list of objects without multiple DB queries

CachableModel::clearCached() — Method in class CachableModel

DeletePolicyFactory::create() — Method in class DeletePolicyFactory

Creates a new service instance.

Locale::canView() — Method in class Locale

Locale::canEdit() — Method in class Locale

Locale::canDelete() — Method in class Locale

Locale::canCreate() — Method in class Locale

RecordLocale::canViewInLocale() — Method in class RecordLocale

Check if this object can be viewed in this locale

FluentSearchVariant::currentState() — Method in class FluentSearchVariant

CopyToLocaleService — Class in namespace TractorCow\Fluent\Service

Copy content between locales

CopyToLocaleService::copyToLocale() — Method in class CopyToLocaleService

Copy data object content between locales

CloudflareLocaleDetector — Class in namespace TractorCow\Fluent\State

Detects locale based on cloudflare geo-location headers

ConvertTranslatableTask — Class in namespace TractorCow\Fluent\Task

Provides migration from the Translatable module in a SilverStripe 3 website to the Fluent format for SilverStripe 4.

D

$ UpdatePackageInfoTask#dependencies — Property in class UpdatePackageInfoTask

ApiLoader::doRequest() — Method in class ApiLoader

Perform an HTTP request for module health information

DeleteHandler — Class in namespace Colymba\BulkManager\BulkAction

Bulk action handler for deleting records.

DeleteHandler::delete() — Method in class DeleteHandler

Delete the selected records passed from the delete bulk action.

EditHandler::doSave() — Method in class EditHandler

Handles bulkEditForm submission and parses and saves each records data.

$ ElementController#default_styles — Property in class ElementController

A list of default (example) styles to include

$ BaseElement#description — Property in class BaseElement

Describe the purpose of this element

$ BaseElement#displays_title_in_template — Property in class BaseElement

Display a show title button

DBObjectType — Class in namespace DNADesign\Elemental\ORM\FieldType

DataExtension — Class in namespace DNADesign\Elemental\TopPage

Class DataExtension

$ AdminRootController#default_panel — Property in class AdminRootController

LeftAndMain::delete() — Method in class LeftAndMain

DeleteAssets — Class in namespace SilverStripe\AssetAdmin\BatchAction

Delete multiple {@link Folder} records (and the associated filesystem nodes).

$ TestAssetStore#denied_response_code — Property in class TestAssetStore

Enable disclosure of secure assets

File::deleteFile() — Method in class File

Delete a file (and all variants).

$ FileNameFilter#default_use_transliterator — Property in class FileNameFilter

$ FileNameFilter#default_replacements — Property in class FileNameFilter

$ AssetAdapter#default_server — Property in class AssetAdapter

Default server configuration to use if the server type defined by the environment is not found

$ FlysystemAssetStore#denied_response_code — Property in class FlysystemAssetStore

Set HTTP error code for requests to secure denied assets.

FlysystemAssetStore::delete() — Method in class FlysystemAssetStore

Delete a file (and all variants) identified by the given filename and hash

$ FileLinkTracking#dependencies — Property in class FileLinkTracking

Inject parser for each page

AssetContainer::deleteFile() — Method in class AssetContainer

Delete a file (and all variants).

AssetStore::delete() — Method in class AssetStore

Delete a file (and all variants) identified by the given filename and hash

DBFile — Class in namespace SilverStripe\Assets\Storage

Represents a file reference stored in a database

DBFile::deleteFile() — Method in class DBFile

Delete a file (and all variants).

DefaultAssetNameGenerator — Class in namespace SilverStripe\Assets\Storage

Basic filename renamer

FileHashingService::disableCache() — Method in class FileHashingService

Disable caching of computed hash.

$ Sha1FileHashingService#default_cachable — Property in class Sha1FileHashingService

Whetever Sha1FileHashingService should cache hash values by default.

Sha1FileHashingService::disableCache() — Method in class Sha1FileHashingService

Disable caching of computed hash.

$ Upload_Validator#default_max_file_size — Property in class Upload_Validator

Contains a list of the max file sizes shared by all upload fields. This is then duplicated into the "allowedMaxFileSize" instance property on construct.

$ BlogController#disable_profiles — Property in class BlogController

If enabled, blog author profiles will be turned off for this site

CMSMain::doSearch() — Method in class CMSMain

CMSMain::delete() — Method in class CMSMain

Delete the current page from draft stage.

CMSMain::doRollback() — Method in class CMSMain

Rolls a site back to a given version ID

CMSMain::duplicate() — Method in class CMSMain

CMSMain::duplicatewithchildren() — Method in class CMSMain

CMSPageAddController::doAdd() — Method in class CMSPageAddController

CMSPageAddController::doCancel() — Method in class CMSPageAddController

ContentController::data() — Method in class ContentController

Returns the associated database record

ContentController::deleteinstallfiles() — Method in class ContentController

$ RootURLController#default_homepage_link — Property in class RootURLController

$ SiteTree#default_child — Property in class SiteTree

The default child class for this page.

$ SiteTree#default_classname — Property in class SiteTree

Default value for SiteTree.ClassName enum {see DBClassName::getDefault}

$ SiteTree#default_parent — Property in class SiteTree

The default parent class for this page.

$ SiteTree#description — Property in class SiteTree

Description of the class functionality, typically shown to a user when selecting which page type to create. Translated through {@link provideI18nEntities()}.

SiteTree::duplicateWithChildren() — Method in class SiteTree

Duplicates each child of this node recursively and returns the top-level duplicate node.

SiteTree::duplicateAsChild() — Method in class SiteTree

Duplicate this node and its children as a child of the node with the given ID

SiteTree::DependentPages() — Method in class SiteTree

Returns the pages that depend on this page. This includes virtual pages, pages that link to it, etc.

SiteTree::doRestoreToStage() — Method in class SiteTree

Restore the content in the active copy of this SiteTree page to the stage site.

SiteTree::defaultChild() — Method in class SiteTree

Returns the class name of the default class for children of this page.

SiteTree::defaultParent() — Method in class SiteTree

Returns the class name of the default class for the parent of this page.

SiteTree::disableCMSFieldsExtensions() — Method in class SiteTree

Stops extendCMSFields() being called on getCMSFields(). This is useful when you need access to fields added by subclasses of SiteTree in a extension. Call before calling parent::getCMSFields(), and reenable afterwards.

$ SiteTreeLinkTracking#dependencies — Property in class SiteTreeLinkTracking

Inject parser for each page

CampaignAdmin::deleteCampaign() — Method in class CampaignAdmin

REST endpoint to delete a campaign.

DeltaConfigCollection — Class in namespace SilverStripe\Config\Collections

Applies config modifications as a set of deltas on top of the middleware, instead of as modifications to the underlying list.

DeltaMiddleware — Class in namespace SilverStripe\Config\Middleware

Applies a set of user-customised modifications to config

ContentReviewCompatability::done() — Method in class ContentReviewCompatability

$ ContentReviewDefaultSettings#db — Property in class ContentReviewDefaultSettings

$ ContentReviewDefaultSettings#defaults — Property in class ContentReviewDefaultSettings

$ ContentNegotiator#default_format — Property in class ContentNegotiator

Controller::doInit() — Method in class Controller

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

Controller::defaultAction() — Method in class Controller

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

$ Cookie#default_samesite — Property in class Cookie

Must be "Strict", "Lax", or "None"

Director — Class in namespace SilverStripe\Control

Director is responsible for processing URLs, and providing environment information.

$ Director#default_base_url — Property in class Director

Base url to populate if cannot be determined otherwise.

$ HTTPCacheControlMiddleware#defaultState — Property in class HTTPCacheControlMiddleware

Set default state

$ HTTPCacheControlMiddleware#defaultForcingLevel — Property in class HTTPCacheControlMiddleware

Default forcing level

HTTPCacheControlMiddleware::disableCache() — Method in class HTTPCacheControlMiddleware

Simple way to set cache control header to a non-cacheable state.

RSSFeed::Description() — Method in class RSSFeed

Get the description of this feed

RSSFeed_Entry::Description() — Method in class RSSFeed_Entry

Get the description of this entry

Session::destroy() — Method in class Session

Destroy this session

DefaultCacheFactory — Class in namespace SilverStripe\Core\Cache

Returns the most performant combination of caches available on the system:

PhpFilesCache (PHP 7 with opcache enabled)
ApcuCache (requires APC) with a FilesystemCache fallback (for larger cache volumes)
FilesystemCache if none of the above is available

ClassInfo::dataClassesFor() — Method in class ClassInfo

Returns an array of the current class and all its ancestors and children which require a DB table.

DeployFlushDiscoverer — Class in namespace SilverStripe\Core\Startup

Checks whether a filesystem resource has been changed since the manifest generation

$ BulkLoader#duplicateChecks — Property in class BulkLoader

Specifies how to determine duplicates based on one or more provided fields in the imported data, matching to properties on the used {@link DataObject} class.

$ BulkLoader#deleteExistingRecords — Property in class BulkLoader

BulkLoader_Result::DeletedCount() — Method in class BulkLoader_Result

BulkLoader_Result::Deleted() — Method in class BulkLoader_Result

CliDebugView::debugVariable() — Method in class CliDebugView

Similar to renderVariable() but respects debug() method on object if available

CliDebugView::debugVariableText() — Method in class CliDebugView

Get debug text for this object

$ CsvBulkLoader#delimiter — Property in class CsvBulkLoader

Delimiter character (Default: comma).

Debug — Class in namespace SilverStripe\Dev

Supports debugging and core error handling.

Debug::dump() — Method in class Debug

Quick dump of a variable.

DebugView — Class in namespace SilverStripe\Dev

A basic HTML wrapper for stylish rendering of a development info view.

DebugView::debugVariable() — Method in class DebugView

Similar to renderVariable() but respects debug() method on object if available

DebugView::debugVariableText() — Method in class DebugView

Get debug text for this object

Deprecation — Class in namespace SilverStripe\Dev

Handles raising an notice when accessing a deprecated method, class, configuration, or behaviour.

Deprecation::disable() — Method in class Deprecation

Disable throwing deprecation warnings.

DevBuildController — Class in namespace SilverStripe\Dev

DevConfigController — Class in namespace SilverStripe\Dev

Outputs the full configuration.

DevConfirmationController — Class in namespace SilverStripe\Dev

A simple controller using DebugView to wrap up the confirmation form with a template similar to other DevelopmentAdmin endpoints and UIs

DevelopmentAdmin — Class in namespace SilverStripe\Dev

Base class for development tools.

$ DevelopmentAdmin#deny_non_cli — Property in class DevelopmentAdmin

Deny all non-cli requests (browser based ones) to dev admin

$ FixtureBlueprint#dependencies — Property in class FixtureBlueprint

FixtureFactory::define() — Method in class FixtureFactory

DatabaseAdapterRegistry — Class in namespace SilverStripe\Dev\Install

This class keeps track of the available database adapters and provides a meaning of registering community built adapters in to the installer process.

DatabaseConfigurationHelper — Class in namespace SilverStripe\Dev\Install

Interface for database helper classes.

MigrationTask::down() — Method in class MigrationTask

DatabaseAdminExtension — Class in namespace SilverStripe\Dev\Validation

Hook up static validation to the deb/build process

DBLink — Class in namespace SilverStripe\ElementalBannerBlock\ORM\FieldType

A DBLink field will be stored as serialised JSON, and contain link information presented via a "insert link" modal popup, similar to those used in TinyMCE.

DatabaseCheck — Class in namespace SilverStripe\EnvironmentCheck\Checks

Check that the connection to the database is working, by ensuring that the table exists and that the table contains some records.

DevCheckController — Class in namespace SilverStripe\EnvironmentCheck\Controllers

Class DevCheckController

DevHealthController — Class in namespace SilverStripe\EnvironmentCheck\Controllers

Class DevHealthController

EnvironmentCheckSuiteResult::Details() — Method in class EnvironmentCheckSuiteResult

Returns detailed status information about each check.

CheckboxField::dataValue() — Method in class CheckboxField

Returns the field value suitable for insertion into the data object.

CompositeField::debug() — Method in class CompositeField

CurrencyField::dataValue() — Method in class CurrencyField

Overwrite the datavalue before saving to the db ;-) return 0.00 if no value, or value is non-numeric

DatalessField — Class in namespace SilverStripe\Forms

Abstract class for all fields without data.

DateField — Class in namespace SilverStripe\Forms

Form used for editing a date string

DateField_Disabled — Class in namespace SilverStripe\Forms

Disabled version of {@link DateField}.

DatetimeField — Class in namespace SilverStripe\Forms

Form field used for editing date time strings.

DisabledTransformation — Class in namespace SilverStripe\Forms

Transformation that disables all the fields on the form.

DropdownField — Class in namespace SilverStripe\Forms

Dropdown field, created from a select tag.

FieldList::dataFields() — Method in class FieldList

Return a sequential set of all fields that have data. This excludes wrapper composite fields as well as heading / help text fields.

FieldList::dataFieldNames() — Method in class FieldList

Return array of all field names

FieldList::dataFieldByName() — Method in class FieldList

Returns a named field in a sequential set.

$ Form#default_classes — Property in class Form

Form::defaultAction() — Method in class Form

Return the default button that should be clicked when another one isn't available.

Form::disableDefaultAction() — Method in class Form

Disable the default button.

Form::disableSecurityToken() — Method in class Form

Disable the requirement of a security token on this form instance. This security protects against CSRF attacks, but you should disable this if you don't want to tie a form to a session - eg a search form.

Form::debug() — Method in class Form

$ FormField#default_classes — Property in class FormField

FormField::dataValue() — Method in class FormField

Returns the field value suitable for insertion into the data object.

FormField::debug() — Method in class FormField

GridFieldAddExistingAutocompleter::doSearch() — Method in class GridFieldAddExistingAutocompleter

Returns a json array of a search results that can be used by for example Jquery.ui.autosuggestion

GridFieldDetailForm_ItemRequest::doSave() — Method in class GridFieldDetailForm_ItemRequest

GridFieldDetailForm_ItemRequest::doDelete() — Method in class GridFieldDetailForm_ItemRequest

$ GridFieldPaginator#default_items_per_page — Property in class GridFieldPaginator

Specifies default items per page

GridState::dataValue() — Method in class GridState

Returns a json encoded string representation of this state.

$ HTMLEditorConfig#default_config — Property in class HTMLEditorConfig

Name of default config. This will be ignored if $current is assigned a value.

$ HTMLEditorField#default_rows — Property in class HTMLEditorField

Number of rows

TinyMCEConfig::disablePlugins() — Method in class TinyMCEConfig

Enable one or several plugins. Will properly handle being passed a plugin that is already disabled

MoneyField::dataValue() — Method in class MoneyField

Returns the field value suitable for insertion into the data object.

NullableField::debug() — Method in class NullableField

NumericField::dataValue() — Method in class NumericField

Get internal database value

RequiredFields::debug() — Method in class RequiredFields

Debug helper

TreeMultiselectField::dataValue() — Method in class TreeMultiselectField

Returns the field value suitable for insertion into the data object.

DevelopmentAdmin — Class in namespace SilverStripe\GraphQL\Dev

DebugSchemaState — Class in namespace SilverStripe\GraphQL\Dev\State

DisableTypeCacheState — Class in namespace SilverStripe\GraphQL\Dev\State

DevBuildExtension — Class in namespace SilverStripe\GraphQL\Extensions

DevErrorHandler — Class in namespace SilverStripe\GraphQL\QueryHandler

Throws everything, including notices, so the JSON response doesn't get corruped by E_NOTICE, E_WARN outputs.

DataObjectModel — Class in namespace SilverStripe\GraphQL\Schema\DataObject

Defines the model that generates types, queries, and mutations based on DataObjects

DeleteCreator — Class in namespace SilverStripe\GraphQL\Schema\DataObject

Creates a delete operation for a DataObject

InheritanceUnionBuilder::defaultUnionFormatter() — Method in class InheritanceUnionBuilder

InterfaceBuilder::defaultInterfaceFormatter() — Method in class InterfaceBuilder

DBDateArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs

DBDatetimeArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs

DBDecimalArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs

DBFieldArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs

Defines a set of arguments that applies to a field that maps to a DBField.

DBFieldArgsPlugin — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs

DBFloatArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs

DBHTMLTextArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs

DBTextArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs

DBTimeArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs

DBFieldTypes — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin

DefaultFieldsProvider — Class in namespace SilverStripe\GraphQL\Schema\Interfaces

For models that can provide a default set of fields

Logger::debug() — Method in class Logger

$ PaginationPlugin#default_limit — Property in class PaginationPlugin

DefaultResolver — Class in namespace SilverStripe\GraphQL\Schema\Resolver

Default field resolver for any type

DefaultResolver::defaultFieldResolver() — Method in class DefaultResolver

Note: this is copied and pasted from Executor::defaultFieldResolver(), but migrated out of thirdparty so it will be easy to update if we need to.

DefaultResolverStrategy — Class in namespace SilverStripe\GraphQL\Schema\Resolver

A good starting point for a resolver discovery implementation.

SchemaConfig::discoverResolver() — Method in class SchemaConfig

$ CodeGenerationStore#dirName — Property in class CodeGenerationStore

GridFieldQueuedExportButton::downloadExport() — Method in class GridFieldQueuedExportButton

CryptoHandler::decrypt() — Method in class CryptoHandler

OpenSSLCrypto::decrypt() — Method in class OpenSSLCrypto

Check the signature on an encrypted-and-signed message, and if valid decrypt the content

HybridSession::destroy() — Method in class HybridSession

CookieStore::destroy() — Method in class CookieStore

DatabaseStore — Class in namespace SilverStripe\HybridSessions\Store

DatabaseStore::destroy() — Method in class DatabaseStore

LDAPDebugController::DefaultGroup() — Method in class LDAPDebugController

$ LDAPMemberExtension#delete_users_in_ldap — Property in class LDAPMemberExtension

If enabled, deleting Member records mapped to LDAP deletes the LDAP user.

LDAPGateway::delete() — Method in class LDAPGateway

Deletes an LDAP object.

$ LDAPService#default_group — Property in class LDAPService

If this is configured to a "Code" value of a {@link Group} in SilverStripe, the user will always be added to this group's membership when imported, regardless of any sort of group mappings.

LDAPService::deleteLDAPMember() — Method in class LDAPService

Delete an LDAP user mapped to the Member record

LDAPService::delete() — Method in class LDAPService

A simple proxy to LDAP delete operation.

$ LDAPGroupSyncTask#destructive — Property in class LDAPGroupSyncTask

Setting this to true causes the sync to delete any local Group records that were previously imported, but no longer existing in LDAP.

$ LDAPMemberSyncTask#destructive — Property in class LDAPMemberSyncTask

Setting this to true causes the sync to delete any local Member records that were previously imported, but no longer existing in LDAP.

DebugViewFriendlyErrorFormatter — Class in namespace SilverStripe\Logging

Produce a friendly error message

DetailedErrorFormatter — Class in namespace SilverStripe\Logging

Monolog-compatible error handler that will output a detailed error message to the screen.

EnablerExtension::darkModeIsEnabled() — Method in class EnablerExtension

LoginHandler::doLogin() — Method in class LoginHandler

Override the parent "doLogin" to insert extra steps into the flow

SecurityExtension::doResetAccount() — Method in class SecurityExtension

Resets the user's password, and triggers other account reset procedures

$ MemberExtension#DefaultRegisteredMethod — Property in class MemberExtension

$ MemberExtension#DefaultRegisteredMethodID — Property in class MemberExtension

$ RegisteredMethod#Data — Property in class RegisteredMethod

EnabledMembers::description() — Method in class EnabledMembers

Return the description of this report.

DefusePHPEncryptionAdapter — Class in namespace SilverStripe\MFA\Service

An encryption adapter for defuse/php-encryption, enabled by default.

DefusePHPEncryptionAdapter::decrypt() — Method in class DefusePHPEncryptionAdapter

Decrypts the given cipher text using the given key, and returns the output plain text

EncryptionAdapterInterface::decrypt() — Method in class EncryptionAdapterInterface

Decrypts the given cipher text using the given key, and returns the output plain text

$ MethodRegistry#default_backup_method — Property in class MethodRegistry

A string referring to the classname of the method (implementing SilverStripe\MFA\Method\MethodInterface) that is to be used as the back-up method for MFA. This alters the registration of this method to be required - a forced registration once the user has registered at least one other method. Additionally it cannot be set as the default method for a user to log in with.

$ Notification#dependencies — Property in class Notification

RegisteredMethodManager::deleteFromMember() — Method in class RegisteredMethodManager

Delete a registration for the given method from the given member, provided it exists. This will also remove a registered back-up method if it will leave the member with only the back-up method remaing

ArrayList::dataClass() — Method in class ArrayList

Return the class of items in this list, by looking at the first item inside it.

ArrayList::debug() — Method in class ArrayList

DBConnector — Class in namespace SilverStripe\ORM\Connect

Represents an object responsible for wrapping DB connector api

$ DBConnector#ddl_operations — Property in class DBConnector

List of operations to treat as DDL

DBQueryBuilder — Class in namespace SilverStripe\ORM\Connect

Builds a SQL query string from a SQLExpression object

DBSchemaManager — Class in namespace SilverStripe\ORM\Connect

Represents and handles all schema management for a database

DBSchemaManager::doesSchemaNeedUpdating() — Method in class DBSchemaManager

Returns true if schema modifications were requested during (but not after) schemaUpdate() call.

DBSchemaManager::dontRequireTable() — Method in class DBSchemaManager

If the given table exists, move it out of the way by renaming it to obsolete(tablename).

DBSchemaManager::dontRequireField() — Method in class DBSchemaManager

If the given field exists, move it out of the way by renaming it to obsolete(fieldname).

DBSchemaManager::dbDataType() — Method in class DBSchemaManager

DBSchemaManager::databaseList() — Method in class DBSchemaManager

Retrieves the list of all databases the user has access to

DBSchemaManager::databaseExists() — Method in class DBSchemaManager

Determine if the database with the specified name exists

DBSchemaManager::dropDatabase() — Method in class DBSchemaManager

Drops a database with the specified name

DBSchemaManager::date() — Method in class DBSchemaManager

Returns data type for 'date' column

DBSchemaManager::decimal() — Method in class DBSchemaManager

Returns data type for 'decimal' column

DBSchemaManager::datetime() — Method in class DBSchemaManager

Returns data type for 'datetime' column

Database — Class in namespace SilverStripe\ORM\Connect

Abstract database connectivity class.

Database::datetimeIntervalClause() — Method in class Database

function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime addition

Database::datetimeDifferenceClause() — Method in class Database

function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime subtraction

Database::databaseExists() — Method in class Database

Determine if the database with the specified name exists

Database::databaseList() — Method in class Database

Retrieves the list of all databases the user has access to

Database::dropSelectedDatabase() — Method in class Database

Drop the database that this object is currently connected to.

DatabaseException — Class in namespace SilverStripe\ORM\Connect

Error class for database exceptions

MySQLDatabase::datetimeIntervalClause() — Method in class MySQLDatabase

function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime addition

MySQLDatabase::datetimeDifferenceClause() — Method in class MySQLDatabase

function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime subtraction

MySQLSchemaManager::databaseList() — Method in class MySQLSchemaManager

Retrieves the list of all databases the user has access to

MySQLSchemaManager::databaseExists() — Method in class MySQLSchemaManager

Determine if the database with the specified name exists

MySQLSchemaManager::dropDatabase() — Method in class MySQLSchemaManager

Drops a database with the specified name

MySQLSchemaManager::dbDataType() — Method in class MySQLSchemaManager

MySQLSchemaManager::date() — Method in class MySQLSchemaManager

Return a date type-formatted string For MySQL, we simply return the word 'date', no other parameters are necessary

MySQLSchemaManager::decimal() — Method in class MySQLSchemaManager

Return a decimal type-formatted string

MySQLSchemaManager::datetime() — Method in class MySQLSchemaManager

Return a datetime type-formatted string For MySQL, we simply return the word 'datetime', no other parameters are necessary

TempDatabase::deleteAll() — Method in class TempDatabase

Clear all temp DBs on this connection

DB — Class in namespace SilverStripe\ORM

Global database interface, complete with static methods.

DB::dont_require_table() — Method in class DB

If the given table exists, move it out of the way by renaming it to obsolete(tablename).

DB::dont_require_field() — Method in class DB

See {@link SS_Database->dontRequireField()}.

DataExtension — Class in namespace SilverStripe\ORM

An extension that adds additional functionality to a {@link DataObject}.

DataList — Class in namespace SilverStripe\ORM

Implements a "lazy loading" DataObjectSet.

DataList::dataClass() — Method in class DataList

Get the dataClass name for this DataList, ie the DataObject ClassName

DataList::dataQuery() — Method in class DataList

Return a copy of the internal {@link DataQuery} object

DataList::distinct() — Method in class DataList

Return a new DataList instance with distinct records or not

DataList::debug() — Method in class DataList

DataList::dbObject() — Method in class DataList

DataObject — Class in namespace SilverStripe\ORM

A single database record & abstract class for the data-access-model.

$ DataObject#default_classname — Property in class DataObject

Allows specification of a default value for the ClassName field.

$ DataObject#db — Property in class DataObject

Database field definitions.

$ DataObject#defaults — Property in class DataObject

Inserts standard column-values when a DataObject is instantiated. Does not insert default records {see $default_records}.

$ DataObject#default_records — Property in class DataObject

Multidimensional array which inserts default data into the database on a db/build-call as long as the database-table is empty. Please use this only for simple constructs, not for SiteTree-Objects etc. which need special behaviour such as publishing and ParentNodes.

$ DataObject#default_sort — Property in class DataObject

The default sort expression. This will be inserted in the ORDER BY clause of a SQL query if no other sort expression is provided.

DataObject::destroy() — Method in class DataObject

Destroy all of this objects dependent objects and local caches.

DataObject::duplicate() — Method in class DataObject

Create a duplicate of this node. Can duplicate many_many relations

DataObject::defineMethods() — Method in class DataObject

Adds methods from the extensions.

DataObject::data() — Method in class DataObject

Returns the associated database record - in this case, the object itself.

DataObject::delete() — Method in class DataObject

Delete this data object.

DataObject::delete_by_id() — Method in class DataObject

Delete the record with the given ID.

DataObject::database_extensions() — Method in class DataObject

This returns an array (if it exists) describing the database extensions that are required, or false if none

DataObject::debug() — Method in class DataObject

Debugging used by Debug::show()

DataObject::dbObject() — Method in class DataObject

Return the DBField object that represents the given field.

DataObject::defaultSearchFilters() — Method in class DataObject

Defines a default list of filters for the search context.

DataObject::disable_subclass_access() — Method in class DataObject

Temporarily disable subclass access in data object qeur

DataObjectInterface — Class in namespace SilverStripe\ORM

DataObjectInterface is an interface that other data systems in your application can implement in order to behave in a manner similar to DataObject.

DataObjectInterface::delete() — Method in class DataObjectInterface

Remove this object from the database. Doesn't do anything if this object isn't in the database.

DataObjectSchema — Class in namespace SilverStripe\ORM

Provides dataobject and database schema mapping functionality

DataObjectSchema::databaseFields() — Method in class DataObjectSchema

Return the complete map of fields to specification on this object, including fixed_fields.

DataObjectSchema::databaseField() — Method in class DataObjectSchema

Gets a single database field.

DataObjectSchema::databaseIndexes() — Method in class DataObjectSchema

DataQuery — Class in namespace SilverStripe\ORM

An object representing a query of data from the DataObject's supporting database.

DataQuery::dataClass() — Method in class DataQuery

Return the {@link DataObject} class that is being queried.

DataQuery::disjunctiveGroup() — Method in class DataQuery

Create a disjunctive subgroup.

DataQuery::distinct() — Method in class DataQuery

Set whether this query should be distinct or not.

DataQueryManipulator — Class in namespace SilverStripe\ORM

Allows middleware to modily finalised dataquery on a per-instance basis

DataQuery_SubGroup — Class in namespace SilverStripe\ORM

Represents a subgroup inside a WHERE clause in a {@link DataQuery}

DatabaseAdmin — Class in namespace SilverStripe\ORM

DatabaseAdmin class

DatabaseAdmin::doBuild() — Method in class DatabaseAdmin

Updates the database schema, creating tables & fields as necessary.

DBBigInt — Class in namespace SilverStripe\ORM\FieldType

Represents a signed 8 byte integer field. Do note PHP running as 32-bit might not work with Bigint properly, as it would convert the value to a float when queried from the database since the value is a 64-bit one.

DBBoolean — Class in namespace SilverStripe\ORM\FieldType

Represents a boolean field.

DBClassName — Class in namespace SilverStripe\ORM\FieldType

Represents a classname selector, which respects obsolete clasess.

DBComposite — Class in namespace SilverStripe\ORM\FieldType

Extend this class when designing a {@link DBField} that doesn't have a 1-1 mapping with a database field.

DBComposite::dbObject() — Method in class DBComposite

Get a db object for the named field

DBCurrency — Class in namespace SilverStripe\ORM\FieldType

Represents a decimal field containing a currency amount.

DBDate — Class in namespace SilverStripe\ORM\FieldType

Represents a date field.

DBDate::DayOfWeek() — Method in class DBDate

Returns the day of the week

DBDate::DayOfMonth() — Method in class DBDate

Returns the day of the month.

DBDatetime — Class in namespace SilverStripe\ORM\FieldType

Represents a date-time field.

DBDatetime::Date() — Method in class DBDatetime

Returns the standard localised date

DBDecimal — Class in namespace SilverStripe\ORM\FieldType

Represents a Decimal field.

DBDouble — Class in namespace SilverStripe\ORM\FieldType

Supports double precision DB types

DBEnum — Class in namespace SilverStripe\ORM\FieldType

Class Enum represents an enumeration of a set of strings.

DBField — Class in namespace SilverStripe\ORM\FieldType

Single field in the database.

$ DBField#default_search_filter_class — Property in class DBField

Subclass of {@link SearchFilter} for usage in {@link defaultSearchFilter()}.

DBField::defaultSearchFilter() — Method in class DBField

DBField::debug() — Method in class DBField

DBFloat — Class in namespace SilverStripe\ORM\FieldType

Represents a floating point field.

DBForeignKey — Class in namespace SilverStripe\ORM\FieldType

A special type Int field used for foreign keys in has_one relationships.

$ DBForeignKey#dropdown_field_threshold — Property in class DBForeignKey

This represents the number of related objects to show in a dropdown before it reverts to a NumericField. If you are tweaking this value, you should also consider constructing your form field manually rather than allowing it to be scaffolded

DBHTMLText — Class in namespace SilverStripe\ORM\FieldType

Represents a large text field that contains HTML content.

DBHTMLVarchar — Class in namespace SilverStripe\ORM\FieldType

Represents a short text field that is intended to contain HTML content.

DBIndexable — Class in namespace SilverStripe\ORM\FieldType

Classes that implement the DBIndexable interface will provide options to set various index types and index contents, which will be processed by {@link \SilverStripe\ORM\DataObjectSchema}

DBInt — Class in namespace SilverStripe\ORM\FieldType

Represents a signed 32 bit integer field.

DBLocale — Class in namespace SilverStripe\ORM\FieldType

Locale database field

DBMoney — Class in namespace SilverStripe\ORM\FieldType

Provides storage of a localised money object in currency and amount components.

DBMultiEnum — Class in namespace SilverStripe\ORM\FieldType

Represents an multi-select enumeration field.

DBPercentage — Class in namespace SilverStripe\ORM\FieldType

Represents a decimal field from 0-1 containing a percentage value.

DBPolymorphicForeignKey — Class in namespace SilverStripe\ORM\FieldType

A special ForeignKey class that handles relations with arbitrary class types

DBPrimaryKey — Class in namespace SilverStripe\ORM\FieldType

A special type Int field used for primary keys.

DBString — Class in namespace SilverStripe\ORM\FieldType

An abstract base class for the string field types (i.e. Varchar and Text)

DBString::defaultEllipsis() — Method in class DBString

Get the default string to indicate that a string was cut off.

DBText — Class in namespace SilverStripe\ORM\FieldType

Represents a variable-length string of up to 16 megabytes, designed to store raw text

DBTime — Class in namespace SilverStripe\ORM\FieldType

Represents a column in the database with the type 'Time'.

DBVarchar — Class in namespace SilverStripe\ORM\FieldType

Class Varchar represents a variable-length string of up to 255 characters, designed to store raw text

DBYear — Class in namespace SilverStripe\ORM\FieldType

Represents a single year field.

Relation::dbObject() — Method in class Relation

Return the DBField object that represents the given field on the related class.

Relation::dataClass() — Method in class Relation

UnsavedRelationList::dataClass() — Method in class UnsavedRelationList

Get the dataClass name for this relation, ie the DataObject ClassName

UnsavedRelationList::dbObject() — Method in class UnsavedRelationList

Return the DBField object that represents the given field on the related class.

RegistryImportFeedEntry::Description() — Method in class RegistryImportFeedEntry

RegistryImportFeedEntry::Date() — Method in class RegistryImportFeedEntry

RegistryPageController::doRegistryFilter() — Method in class RegistryPageController

Build up search filters from user's search criteria and hand off to the {@link query()} method to search against the database.

RegistryPageController::doRegistryFilterReset() — Method in class RegistryPageController

Report::description() — Method in class Report

Return the description of this report.

Report::dataClass() — Method in class Report

Return the data class for this report

ReportWrapper::description() — Method in class ReportWrapper

Return the description of this report.

DataFormatter — Class in namespace SilverStripe\RestfulServer

A DataFormatter object handles transformation of data from SilverStripe model objects to a particular output format, and vice versa. This is most commonly used in developing RESTful APIs.

$ RestfulServer#default_extension — Property in class RestfulServer

If no extension is given in the request, resolve to this extension (and subsequently the {@link self::$default_mimetype}.

UserSecurityReport::description() — Method in class UserSecurityReport

Builds a report description which is the current hostname with the current date and time

Form::doRefuse() — Method in class Form

The form refusal handler. Cleans up the confirmation storage and returns the failure redirection (kept in the storage)

Form::doConfirm() — Method in class Form

The form confirmation handler. Checks all the items in the storage has been confirmed and marks them as such. Returns a redirect when all the storage items has been verified and marked as confirmed.

DefaultAdminService — Class in namespace SilverStripe\Security

Provides access to the default admin

DefaultPermissionChecker — Class in namespace SilverStripe\Security

Allows objects to enforce permissions for the "root" level, where permissions can not be tied to a particular database record.

$ Group#Description — Property in class Group

Description of the group

Group::DirectMembers() — Method in class Group

Return only the members directly added to this group

$ GroupCsvBulkLoader#duplicateChecks — Property in class GroupCsvBulkLoader

$ Member#DateFormat — Property in class Member

Member::DirectGroups() — Method in class Member

ChangePasswordHandler::doChangePassword() — Method in class ChangePasswordHandler

Change the password

LoginHandler::doLogin() — Method in class LoginHandler

LogoutHandler::doLogOut() — Method in class LogoutHandler

$ MemberCsvBulkLoader#duplicateChecks — Property in class MemberCsvBulkLoader

$ PasswordExpirationMiddleware#default_redirect — Property in class PasswordExpirationMiddleware

Where users with expired passwords get redirected by default when login form didn't register a custom one with {see SilverStripe\Security\AuthenticationMiddleware::setRedirect}

Permission::deny() — Method in class Permission

Deny the given permission code/arg to the given group

$ RememberLoginHash#device_expiry_days — Property in class RememberLoginHash

Number of days the device ID will be valid for

$ RememberLoginHash#DeviceID — Property in class RememberLoginHash

$ Security#default_message_set — Property in class Security

Default message set used in permission failures.

$ Security#default_login_dest — Property in class Security

$ Security#default_reset_password_dest — Property in class Security

Security::database_is_ready() — Method in class Security

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

SecurityToken::disable() — Method in class SecurityToken

Globally disable the token (override with {@link NullSecurityToken}) implementation. Note: Does not apply for

$ LoginSession#default_session_lifetime — Property in class LoginSession

The length of time a session can be inactive for before it is discarded and the user is logged out

SitewideContentReport::description() — Method in class SitewideContentReport

$ FormSpamProtectionExtension#default_spam_protector — Property in class FormSpamProtectionExtension

DeleteStaticCacheJob — Class in namespace SilverStripe\StaticPublishQueue\Job

Class DeleteStaticCacheJob remove pages from static cache based on list of URLs

DeleteWholeCache — Class in namespace SilverStripe\StaticPublishQueue\Job

$ Publisher#domain_based_caching — Property in class Publisher

$ FileSubsites#default_root_folders_global — Property in class FileSubsites

If this is set to true, all folders created will be default be considered 'global', unless set otherwise

SiteTreeSubsites::duplicateToSubsitePrep() — Method in class SiteTreeSubsites

Does the basic duplication, but doesn't write anything this means we can subclass this easier and do more complex relation duplication.

SiteTreeSubsites::duplicateToSubsite() — Method in class SiteTreeSubsites

Create a duplicate of this page and save it to another subsite

SiteTreeSubsites::duplicateSubsiteRelations() — Method in class SiteTreeSubsites

Duplicate relations using a static property to define which ones we want to duplicate

GridFieldSubsiteDetailFormItemRequest::doSave() — Method in class GridFieldSubsiteDetailFormItemRequest

$ Subsite#disable_subsite_filter — Property in class Subsite

Subsite::disable_subsite_filter() — Method in class Subsite

Disable the sub-site filtering; queries will select from all subsites

Subsite::domain() — Method in class Subsite

Return the primary domain of this site. Tries to "normalize" the domain name, by replacing potential wildcards.

Subsite::duplicate() — Method in class Subsite

Duplicate this subsite

$ SubsiteDomain#Domain — Property in class SubsiteDomain

domain name of this subsite. Can include wildcards. Do not include the URL scheme here

StringTagField::dataValue() — Method in class StringTagField

Ensure that arrays are imploded before being saved

Database — Class in namespace SilverStripe\TextExtraction\Cache\FileTextCache

Caches the extracted content on the record for the file.

$ FileTextExtractable#db — Property in class FileTextExtractable

$ FileTextExtractable#dependencies — Property in class FileTextExtractable

$ EditableCustomRule#Display — Property in class EditableCustomRule

$ EditableFormField#default_sort — Property in class EditableFormField

Default sort order

$ EditableFormField#db — Property in class EditableFormField

$ EditableFormField#Default — Property in class EditableFormField

$ EditableFormField#DisplayRulesConjunction — Property in class EditableFormField

EditableFormField::doUpdateFormField() — Method in class EditableFormField

Updates a formfield with extensions

EditableFormField::DisplayRulesConjunctionNice() — Method in class EditableFormField

Replaces the set DisplayRulesConjunction with their JS logical operators

EditableFormField::DisplayRules() — Method in class EditableFormField

List of EditableCustomRule objects

$ EditableDateField#DefaultToToday — Property in class EditableDateField

EditableMultipleOptionField::duplicate() — Method in class EditableMultipleOptionField

Duplicate a pages content. We need to make sure all the fields attached to that page go with it {@inheritDoc}

$ EditableOption#Default — Property in class EditableOption

DisambiguationSegmentFieldModifier — Class in namespace SilverStripe\UserForms\Modifier

ArchiveRestoreAction::doRestore() — Method in class ArchiveRestoreAction

Restore the record to its original place or top level if that's not possible

DataObjectVersionFormFactory — Class in namespace SilverStripe\VersionedAdmin\Forms

DiffField — Class in namespace SilverStripe\VersionedAdmin\Forms

This form field is both a field object in it's own right, and a decorator for another field type.

DiffTransformation — Class in namespace SilverStripe\VersionedAdmin\Forms

$ HistoryViewerField#default_page_size — Property in class HistoryViewerField

The default pagination page size

ProxyCacheAdapter::delete() — Method in class ProxyCacheAdapter

{@inheritdoc}

ProxyCacheAdapter::deleteMultiple() — Method in class ProxyCacheAdapter

{@inheritdoc}

DataDifferencer — Class in namespace SilverStripe\Versioned

Utility class to render views of the differences between two data objects (or two versions of the same data object).

DataDifferencer::diffedData() — Method in class DataDifferencer

Get a DataObject with altered values replaced with HTML diff strings, incorporating and ~~tags.~~

$ CopyToStageCreator#default_plugins — Property in class CopyToStageCreator

$ RollbackCreator#default_plugins — Property in class RollbackCreator

RecursivePublishable::deleteFromChangeSets() — Method in class RecursivePublishable

Remove this item from any changesets

$ Versioned#draft_site_secured — Property in class Versioned

Default config for $is_draft_site_secured

$ Versioned#db — Property in class Versioned

Versioned::doArchive() — Method in class Versioned

Removes the record from both live and stage

Versioned::doUnpublish() — Method in class Versioned

Removes this record from the live site

Versioned::doRevertToLive() — Method in class Versioned

Revert the draft changes: replace the draft content with the content on live

Versioned::deleteFromStage() — Method in class Versioned

Delete this record from the given stage

VersionedGridFieldItemRequest::doArchive() — Method in class VersionedGridFieldItemRequest

Archive this versioned record

VersionedGridFieldItemRequest::doPublish() — Method in class VersionedGridFieldItemRequest

Publish this versioned record

VersionedGridFieldItemRequest::doUnpublish() — Method in class VersionedGridFieldItemRequest

Delete this record from the live site

$ URLSegmentFilter#default_use_transliterator — Property in class URLSegmentFilter

$ URLSegmentFilter#default_replacements — Property in class URLSegmentFilter

$ URLSegmentFilter#default_allow_multibyte — Property in class URLSegmentFilter

Doesn't try to replace or transliterate non-ASCII filters.

$ Requirements#disable_flush_combined — Property in class Requirements

Flag whether combined files should be deleted on flush.

Requirements::delete_all_combined_files() — Method in class Requirements

Deletes all generated combined files in the configured combined files directory, but doesn't delete the directory itself

Requirements::debug() — Method in class Requirements

Output debugging information

$ Requirements_Backend#default_combined_files_folder — Property in class Requirements_Backend

Configures the default prefix for combined files.

Requirements_Backend::deleteAllCombinedFiles() — Method in class Requirements_Backend

Clears all combined files

Requirements_Backend::debug() — Method in class Requirements_Backend

Output debugging information.

SSTemplateParser::DollarMarkedLookup_STR() — Method in class SSTemplateParser

SSViewer::dontRewriteHashlinks() — Method in class SSViewer

Call this to disable rewriting of links. This is useful in Ajax applications.

$ ViewableData#default_cast — Property in class ViewableData

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

ViewableData::defineMethods() — Method in class ViewableData

Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.

ViewableData::Debug() — Method in class ViewableData

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

$ RegisterHandler#dependencies — Property in class RegisterHandler

Dependency injection configuration

$ VerifyHandler#dependencies — Property in class VerifyHandler

Dependency injection configuration

$ i18n#default_locale — Property in class i18n

$ i18n#date_format — Property in class i18n

System-wide date format. Will be overruled for CMS UI display by the format defaults inferred from the browser as well as any user-specific locale preferences.

FrontEndWorkflowController::doFrontEndAction() — Method in class FrontEndWorkflowController

Save the Form Data to the defined Context Object

WorkflowActionInstance::doFrontEndAction() — Method in class WorkflowActionInstance

$ WorkflowDefinition#default_workflow_title_base — Property in class WorkflowDefinition

WorkflowInstance::doFrontEndAction() — Method in class WorkflowInstance

WorkflowInstance::Definition() — Method in class WorkflowInstance

WorkflowField::Definition() — Method in class WorkflowField

WorkflowFieldItemController::doSave() — Method in class WorkflowFieldItemController

WorkflowFieldItemController::delete() — Method in class WorkflowFieldItemController

WorkflowService::defineFromTemplate() — Method in class WorkflowService

Generate a workflow definition based on a template

GridFieldAddExistingSearchHandler::doSearch() — Method in class GridFieldAddExistingSearchHandler

$ GridFieldConfigurablePaginator#default_page_sizes — Property in class GridFieldConfigurablePaginator

Specifies default page sizes

MultiValueCheckboxField::dataValue() — Method in class MultiValueCheckboxField

Return the CheckboxSetField value as a string selected item keys.

DeleteObjectJob — Class in namespace Symbiote\QueuedJobs\Jobs

A job used to delete a data object. Typically used for deletes that need to happen on a schedule, or where the delete may have some onflow affect that takes a while to finish the deletion.

DoormanQueuedJobTask — Class in namespace Symbiote\QueuedJobs\Jobs

QJUtils::dbQuote() — Method in class QJUtils

Quote up a filter of the form

DefaultQueueHandler — Class in namespace Symbiote\QueuedJobs\Services

Default method for handling items run via the cron

$ QueuedJobService#disable_health_check — Property in class QueuedJobService

Disable health checks that usually occur when a runner first picks up a queue. Note that completely disabling health checks could result in many jobs that are always marked as running - that will never be restarted. If this option is disabled you may alternatively use the build task

$ QueuedJobService#defaultJobs — Property in class QueuedJobService

Config controlled list of default/required jobs

QueuedJobService::disableMaintenanceLock() — Method in class QueuedJobService

DeleteAllJobsTask — Class in namespace Symbiote\QueuedJobs\Tasks

An administrative task to delete all queued jobs records from the database.

DummyQueuedJob — Class in namespace Symbiote\QueuedJobs\Tasks

DoormanRunner — Class in namespace Symbiote\QueuedJobs\Tasks\Engines

Runs all jobs through the doorman engine

$ FluentDirectorExtension#detect_locale — Property in class FluentDirectorExtension

Determine if the site should detect the browser locale for new users. Turn this off to disable 302 redirects on the home page.

$ FluentDirectorExtension#disable_default_prefix — Property in class FluentDirectorExtension

Allow the prefix for the default {@link Locale} (IsDefault = 1) to be disabled.

$ FluentExtension#db_for_localised_table — Property in class FluentExtension

DB fields to be used added in when creating a localised version of the owner's table

$ FluentExtension#data_include — Property in class FluentExtension

Filter whitelist of field types to localise Note: Blacklist takes priority over whitelist.

$ FluentExtension#data_exclude — Property in class FluentExtension

Filter blacklist of field types to localise.

FluentExtension::deleteTableTarget() — Method in class FluentExtension

Public accessor for getDeleteTableTarget

FluentAdminTrait::deleteFluent() — Method in class FluentAdminTrait

Delete the current object from all locales (non-versioned)

DeleteAllLocalesAction — Class in namespace TractorCow\Fluent\Forms

This class is a {@link GridField} component that adds a delete from locale action for objects.

DeleteLocaleAction — Class in namespace TractorCow\Fluent\Forms

Provides the "delete this locale" action

DetectLocaleMiddleware — Class in namespace TractorCow\Fluent\Middleware

DetectLocaleMiddleware will detect if a locale has been requested (or is default) and is not the current locale, and will redirect the user to that locale if needed.

ArchiveRecordPolicy::delete() — Method in class ArchiveRecordPolicy

DeleteFilterPolicy — Class in namespace TractorCow\Fluent\Model\Delete

A policy that deletes the filtered rows.

DeleteFilterPolicy::delete() — Method in class DeleteFilterPolicy

DeleteLocalisationPolicy — Class in namespace TractorCow\Fluent\Model\Delete

A policy that deletes all localisations for a record

DeleteLocalisationPolicy::delete() — Method in class DeleteLocalisationPolicy

DeletePolicy — Class in namespace TractorCow\Fluent\Model\Delete

DeletePolicy::delete() — Method in class DeletePolicy

DeletePolicyFactory — Class in namespace TractorCow\Fluent\Model\Delete

Generate a delete policy for a class

DeleteRecordPolicy — Class in namespace TractorCow\Fluent\Model\Delete

A policy that deletes the root record

DeleteRecordPolicy::delete() — Method in class DeleteRecordPolicy

Domain — Class in namespace TractorCow\Fluent\Model

$ Domain#Domain — Property in class Domain

$ Domain#DefaultLocaleID — Property in class Domain

Domain::DefaultLocale() — Method in class Domain

Get default locale for this domain

Domain::DefaultLocaleTitle() — Method in class Domain

$ Locale#db — Property in class Locale

$ Locale#DomainID — Property in class Locale

Locale::Domain() — Method in class Locale

BrowserLocaleDetector::detectLocale() — Method in class BrowserLocaleDetector

Determines the locale best matching the given list of browser locales

CloudflareLocaleDetector::detectLocale() — Method in class CloudflareLocaleDetector

Determines the locale best matching the given list of browser locales

LocaleDetector::detectLocale() — Method in class LocaleDetector

Detects locale

E

$ CWPSiteConfigExtension#enable_theme_color_picker — Property in class CWPSiteConfigExtension: Defines if the theme colour picker is enabled in the CMS
EditHandler — Class in namespace Colymba\BulkManager\BulkAction: Bulk action handler for editing records.
ElementFormController — Class in namespace DNADesign\ElementalUserForms\Control
ElementForm — Class in namespace DNADesign\ElementalUserForms\Model
ElementController — Class in namespace DNADesign\Elemental\Controllers: Optional controller for every element which has its own logic, e.g. in forms.
ElementSiteTreeFilterSearch — Class in namespace DNADesign\Elemental\Controllers
ElementalAreaController — Class in namespace DNADesign\Elemental\Controllers: Controller for "ElementalArea" - handles loading and saving of in-line edit forms in an elemental area in admin
ElementalAreaController::elementForm() — Method in class ElementalAreaController
ElementalAreaUsedOnTableExtension — Class in namespace DNADesign\Elemental\Extensions
ElementalAreasExtension — Class in namespace DNADesign\Elemental\Extensions: This extension handles most of the relationships between pages and element area, it doesn't add an ElementArea to the page however. Because of this, developers can add multiple {@link ElementArea} areas to to a page.
ElementalAreasExtension::ensureElementalAreasExist() — Method in class ElementalAreasExtension: Set all has_one relationships to an ElementalArea to a valid ID if they're unset
ElementalCMSMainExtension — Class in namespace DNADesign\Elemental\Extensions
ElementalContentControllerExtension — Class in namespace DNADesign\Elemental\Extensions
ElementalLeftAndMainExtension — Class in namespace DNADesign\Elemental\Extensions
ElementalPageExtension — Class in namespace DNADesign\Elemental\Extensions
ElementalPageExtension::ElementalArea() — Method in class ElementalPageExtension
EditFormFactory — Class in namespace DNADesign\Elemental\Forms
ElementalAreaConfig — Class in namespace DNADesign\Elemental\Forms
ElementalAreaField — Class in namespace DNADesign\Elemental\Forms
$ BaseElement#ExtraClass — Property in class BaseElement
BaseElement::EvenOdd() — Method in class BaseElement
ElementContent — Class in namespace DNADesign\Elemental\Models
ElementalArea — Class in namespace DNADesign\Elemental\Models: Class ElementalArea
ElementalArea::Elements() — Method in class ElementalArea: A cache-aware accessor for the elements
ElementalArea::ElementControllers() — Method in class ElementalArea: Used in template instead of {@link Elements()} to wrap each element in its' controller, making it easier to access and process form logic and actions stored in {@link ElementController}.
ElementTypeReport — Class in namespace DNADesign\Elemental\Reports
ElementsInUseReport — Class in namespace DNADesign\Elemental\Reports
ElementTypeRegistry — Class in namespace DNADesign\Elemental\Services
EditorEmailLinkFormFactory — Class in namespace SilverStripe\Admin\Forms
EditorExternalLinkFormFactory — Class in namespace SilverStripe\Admin\Forms
$ LeftAndMain#extra_requirements_javascript — Property in class LeftAndMain: Register additional requirements through the {@link Requirements} class.
$ LeftAndMain#extra_requirements_css — Property in class LeftAndMain: YAML configuration example: LeftAndMain: extra_requirements_css: mysite/css/mystyle.css: media: screen
$ LeftAndMain#extra_requirements_themedCss — Property in class LeftAndMain
LeftAndMain::EditForm() — Method in class LeftAndMain: Retrieves an edit form, either for display, or to process submitted data.
LeftAndMain::EmptyForm() — Method in class LeftAndMain: Returns a placeholder form, used by {@link getEditForm()} if no record is selected.
LeftAndMain::EditFormTools() — Method in class LeftAndMain: Renders a panel containing tools which apply to the currently displayed edit form.
ModalController::EditorExternalLink() — Method in class ModalController: Builds and returns the external link form
ModalController::EditorEmailLink() — Method in class ModalController: Builds and returns the external link form
$ RemoteFileFormFactory#enabled — Property in class RemoteFileFormFactory: Allow oembed to be disabled
File::exists() — Method in class File: A file only exists if the file_exists() and is in the DB as a record
FlysystemAssetStore::exists() — Method in class FlysystemAssetStore: Determine if a file exists with the given tuple
Folder::exists() — Method in class Folder: A file only exists if the file_exists() and is in the DB as a record
ImageManipulation::existingOnly() — Method in class ImageManipulation: Return clone of self which promises to only return existing thumbnails
ImageManipulation::exists() — Method in class ImageManipulation: Determine if this container has a valid value
$ InterventionBackend#error_cache_ttl — Property in class InterventionBackend: How long to cache each error type
AssetContainer::exists() — Method in class AssetContainer: Determine if this container has a valid value
AssetStore::exists() — Method in class AssetStore: Determine if a file exists with the given tuple
DBFile::exists() — Method in class DBFile: Composite field defaults to exists only if all fields have values
FileHashingService::enableCache() — Method in class FileHashingService: Enable caching of computed hash.
Sha1FileHashingService::enableCache() — Method in class Sha1FileHashingService: Enable caching of computed hash.
Blog::Editors() — Method in class Blog: List of editors
BlogPost::Excerpt() — Method in class BlogPost: Returns the post excerpt.
$ CMSMain#enable_dynamic_archive_warning_message — Property in class CMSMain: Should the archive warning message be dynamic based on the specific content? This is slow on larger sites and can be disabled.
CMSMain::ExtraTreeTools() — Method in class CMSMain
CMSMain::EditForm() — Method in class CMSMain: Retrieves an edit form, either for display, or to process submitted data.
CMSMain::EmptyForm() — Method in class CMSMain: Returns a placeholder form, used by {@link getEditForm()} if no record is selected.
InternalLinkModalExtension::editorInternalLink() — Method in class InternalLinkModalExtension: Form for inserting internal link pages
InternalLinkModalExtension::editorAnchorLink() — Method in class InternalLinkModalExtension
$ RedirectorPage#ExternalURL — Property in class RedirectorPage: URL to redirect to if $RedirectionType is 'External'
$ SiteTree#enforce_strict_hierarchy — Property in class SiteTree: Deleting this page also deletes all its children when set to true.
$ SiteTree#ExtraMeta — Property in class SiteTree
SiteTree::ElementName() — Method in class SiteTree: Return a CSS identifier generated from this page's link.
SiteTree::enableCMSFieldsExtensions() — Method in class SiteTree: Reenables extendCMSFields() being called on getCMSFields() after it has been disabled by disableCMSFieldsExtensions().
SiteTree::EditorGroups() — Method in class SiteTree: List of groups that can edit this object.
EmptyPagesReport — Class in namespace SilverStripe\CMS\Reports
CampaignAdmin::EditForm() — Method in class CampaignAdmin: Retrieves an edit form, either for display, or to process submitted data.
CachedConfigCollection::exists() — Method in class CachedConfigCollection: Checks to see if a config item exists, or a property on that class
ConfigCollectionInterface::exists() — Method in class ConfigCollectionInterface: Checks to see if a config item exists, or a property on that class
MemoryConfigCollection::exists() — Method in class MemoryConfigCollection: Checks to see if a config item exists, or a property on that class
$ ContentNegotiator#encoding — Property in class ContentNegotiator
$ ContentNegotiator#enabled — Property in class ContentNegotiator
ContentNegotiator::enabled_for() — Method in class ContentNegotiator: Returns true if negotiation is enabled for the given response. By default, negotiation is only enabled for pages that have the xml header.
Email — Class in namespace SilverStripe\Control\Email
HTTPApplication::execute() — Method in class HTTPApplication: Safely boot the application and execute the given main action
HTTPRequestBuilder::extractRequestHeaders() — Method in class HTTPRequestBuilder: Takes a $_SERVER data array and extracts HTTP request headers.
EnvironmentBypass — Class in namespace SilverStripe\Control\Middleware\ConfirmationMiddleware: Allows a bypass for a list of environment types (e.g. DEV, TEST, LIVE)
ExecMetricMiddleware — Class in namespace SilverStripe\Control\Middleware: Display execution metrics for the current request if in dev mode and execmetric is provided as a request variable.
HTTPCacheControlMiddleware::enableCache() — Method in class HTTPCacheControlMiddleware: Simple way to set cache control header to a cacheable state.
RSSFeed::Entries() — Method in class RSSFeed: Get the RSS feed entries
Application::execute() — Method in class Application: Safely boot the application and execute the given main action
ClassInfo::exists() — Method in class ClassInfo: Returns true if a class or interface name exists.
ExtensionMiddleware — Class in namespace SilverStripe\Core\Config\Middleware
Environment — Class in namespace SilverStripe\Core: Consolidates access and modification of PHP global variables and settings.
EnvironmentLoader — Class in namespace SilverStripe\Core: Loads environment variables from .env files Loosely based on https://github.com/vlucas/phpdotenv/blob/master/src/Loader.php
Extensible — Class in namespace SilverStripe\Core: Allows an object to have extensions applied to it.
$ Extensible#extensions — Property in class Extensible: An array of extension names and parameters to be applied to this object upon construction.
Extensible::extend() — Method in class Extensible: 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
Extension — Class in namespace SilverStripe\Core: Add extension that can be added to an object with {@link Object::add_extension()}.
ClassManifestVisitor::enterNode() — Method in class ClassManifestVisitor
ModuleResource::exists() — Method in class ModuleResource: Determine if this resource exists
CLI::end_colour() — Method in class CLI: Send control codes for returning to normal colour
SSListContains::evaluate() — Method in class SSListContains: Evaluates the constraint for parameter $other
SSListContainsOnly::evaluate() — Method in class SSListContainsOnly: Evaluates the constraint for parameter $other
SSListContainsOnlyMatchingItems::evaluate() — Method in class SSListContainsOnlyMatchingItems: Evaluates the constraint for parameter $other
ViewableDataContains::evaluate() — Method in class ViewableDataContains: Evaluates the constraint for parameter $other
$ CsvBulkLoader#enclosure — Property in class CsvBulkLoader: Enclosure character (Default: doublequote)
Debug::endshow() — Method in class Debug: Close out the show dumper.
Deprecation::enable() — Method in class Deprecation: Enable throwing deprecation warnings. By default, this excludes warnings for deprecated code which is called by core Silverstripe modules.
DevelopmentAdmin::errors() — Method in class DevelopmentAdmin
ExtensionTestState — Class in namespace SilverStripe\Dev\State: Manages illegal and required extensions for sapphiretest
RelationValidationService::executeValidation() — Method in class RelationValidationService
EnvTypeCheck — Class in namespace SilverStripe\EnvironmentCheck\Checks: Check whether the environment setting is safe. Useful for live sites where a non "Live" setting might disclose sensitive information.
ExternalURLCheck — Class in namespace SilverStripe\EnvironmentCheck\Checks: Checks that one or more URLs are reachable via HTTP.
EnvironmentCheck — Class in namespace SilverStripe\EnvironmentCheck: Interface for environment checks
EnvironmentCheckSuite — Class in namespace SilverStripe\EnvironmentCheck: Represents a suite of environment checks.
EnvironmentCheckSuiteResult — Class in namespace SilverStripe\EnvironmentCheck: A single set of results from running an EnvironmentCheckSuite
EnvironmentChecker — Class in namespace SilverStripe\EnvironmentCheck: Provides an interface for checking the given EnvironmentCheckSuite.
ErrorPage — Class in namespace SilverStripe\ErrorPage: ErrorPage holds the content for the page of an error response.
$ ErrorPage#enable_static_file — Property in class ErrorPage: Allows control over writing directly to the configured GeneratedAssetStore.
$ ErrorPage#ErrorCode — Property in class ErrorPage: HTTP Error code
ErrorPageController — Class in namespace SilverStripe\ErrorPage: Controller for ErrorPages.
ErrorPageControllerExtension — Class in namespace SilverStripe\ErrorPage: Enhances error handling for a controller with ErrorPage generated output
ErrorPageErrorFormatter — Class in namespace SilverStripe\ErrorPage: Provides {see ErrorPage}-gnostic error handling
ErrorPageFileExtension — Class in namespace SilverStripe\ErrorPage: Decorates {see File} with ErrorPage support
CompositeField::extraClass() — Method in class CompositeField: Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
EmailField — Class in namespace SilverStripe\Forms: Text input field with validation for correct email format according to RFC 2822.
Form::enableSecurityToken() — Method in class Form: Enable {@link SecurityToken} protection for this form instance.
Form::extraClass() — Method in class Form: Compiles all CSS-classes.
FormField::extraClass() — Method in class FormField: Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
GridFieldDetailForm_ItemRequest::edit() — Method in class GridFieldDetailForm_ItemRequest
$ TinyMCEConfig#editor_css — Property in class TinyMCEConfig: Extra editor.css file paths.
TinyMCEConfig::enablePlugins() — Method in class TinyMCEConfig: Enable one or several plugins. Will maintain unique list if already enabled plugin is re-passed. If passed in as a map of plugin-name to path, the plugin will be loaded by tinymce.PluginManager.load() instead of through tinyMCE.init().
Tab::extraClass() — Method in class Tab: Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
TreeDropdownField::extraClass() — Method in class TreeDropdownField: Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
$ DevBuildExtension#enabled — Property in class DevBuildExtension
$ QueryHandler#errorHandler — Property in class QueryHandler
AbstractBulkLoader::exclude() — Method in class AbstractBulkLoader
ExtensionLoader — Class in namespace SilverStripe\GraphQL\Schema\BulkLoader: Loads classes that have a given extension assigned to them.
ExtensionLoader::exclude() — Method in class ExtensionLoader
InheritanceLoader::exclude() — Method in class InheritanceLoader
EndsWithFilter — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter\Filters: A query filter that filters records by the end of a field's contents
EqualToFilter — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter\Filters: A query filter that filters records by exact match of a keyword
EmptySchemaException — Class in namespace SilverStripe\GraphQL\Schema\Exception
Encoder — Class in namespace SilverStripe\GraphQL\Schema\Interfaces: A class that is capable of expressing itself in generated code
Encoder::encode() — Method in class Encoder
ExtraTypeProvider — Class in namespace SilverStripe\GraphQL\Schema\Interfaces: For models that provide extra types to the schema
SchemaStorageInterface::exists() — Method in class SchemaStorageInterface
Logger::emergency() — Method in class Logger
Logger::error() — Method in class Logger
EncodedResolver — Class in namespace SilverStripe\GraphQL\Schema\Resolver: A resolver function that can be expressed in generated PHP code
EncodedResolver::encode() — Method in class EncodedResolver
Schema::exists() — Method in class Schema
Schema::eagerLoad() — Method in class Schema: Some types must be eagerly loaded into the schema if they cannot be discovered through introspection.
StorableSchema::exists() — Method in class StorableSchema
CodeGenerationStore::exists() — Method in class CodeGenerationStore
Encoder — Class in namespace SilverStripe\GraphQL\Schema\Storage
Encoder::encode() — Method in class Encoder
EncodedType — Class in namespace SilverStripe\GraphQL\Schema\Type: A type that can be expressed as generated PHP code
EncodedType::encode() — Method in class EncodedType
Enum — Class in namespace SilverStripe\GraphQL\Schema\Type: Abstraction for enum types
Type::exists() — Method in class Type
CryptoHandler::encrypt() — Method in class CryptoHandler
OpenSSLCrypto::encrypt() — Method in class OpenSSLCrypto: Encrypt and then sign some cleartext
LDAPService::enabled() — Method in class LDAPService: Checkes whether or not the service is enabled.
ErrorHandler — Class in namespace SilverStripe\Logging: Core error handler for a SilverStripe application
EnablerExtension — Class in namespace SilverStripe\LoginForms: Applies to the {see Security} controller in order to detect requests for actions related to the log in process or other such credential management (such as the forgot password flow).
$ EnablerExtension#excluded_actions — Property in class EnablerExtension: Aids in preventing themes from being overridden in the case of delegating handlers e.g. if an extension adds a route that should not be styled by login-forms, this config setting can be used to prevent the otherwise blanket override applying to all actions.
EncryptionAdapterException — Class in namespace SilverStripe\MFA\Exception: Representing a failure during encryption or decryption with an EncryptionAdapterInterface
EnabledMembers — Class in namespace SilverStripe\MFA\Report
DefusePHPEncryptionAdapter::encrypt() — Method in class DefusePHPEncryptionAdapter: Encrypts the given plain text string with the given key, and returns the output cipher text
EncryptionAdapterInterface — Class in namespace SilverStripe\MFA\Service: A generic encryption service implementation, responsible for encrypting and decrypting strings.
EncryptionAdapterInterface::encrypt() — Method in class EncryptionAdapterInterface: Encrypts the given plain text string with the given key, and returns the output cipher text
EnforcementManager — Class in namespace SilverStripe\MFA\Service: The EnforcementManager class is responsible for making decisions regarding multi-factor authentication app flow, e.g. "should we redirect to the MFA section", "can the user skip MFA registration" etc.
$ EnforcementManager#enabled — Property in class EnforcementManager: Whether enforcement of MFA is enabled. If this is disabled, users will not be redirected to MFA registration or verification on login flows.
$ Notification#enabled — Property in class Notification: Whether sending emails is enabled for MFA changes
ArrayList::exists() — Method in class ArrayList: Returns true if this list has items
ArrayList::each() — Method in class ArrayList: Walks the list using the specified callback
ArrayList::exclude() — Method in class ArrayList: Exclude the list to not contain items with these characteristics
DBConnector::escapeString() — Method in class DBConnector: Given a value escape this for use in a query for the current database connector. Note that this does not quote the value.
DBSchemaManager::enumValuesForField() — Method in class DBSchemaManager: Returns the values of the given enum field
DBSchemaManager::enum() — Method in class DBSchemaManager: Returns data type for 'set' column
Database::escapeString() — Method in class Database: Returns an escaped string. This string won't be quoted, so would be suitable for appending to other quoted strings.
Database::escapeIdentifier() — Method in class Database: Escapes an identifier (table / database name). Typically the value is simply double quoted. Don't pass in already escaped identifiers in, as this will double escape the value!
MySQLSchemaManager::enumValuesForField() — Method in class MySQLSchemaManager: Returns the values of the given enum field
MySQLSchemaManager::enum() — Method in class MySQLSchemaManager: Return a enum type-formatted string
MySQLiConnector::escapeString() — Method in class MySQLiConnector: Given a value escape this for use in a query for the current database connector. Note that this does not quote the value.
DataExtension::extraStatics() — Method in class DataExtension: Define extra database fields
DataList::exclude() — Method in class DataList: Return a copy of this list which does not contain any items that match all params
DataList::excludeAny() — Method in class DataList: Return a copy of this list which does not contain any items with any of these params
DataList::each() — Method in class DataList: Walks the list using the specified callback
DataList::exists() — Method in class DataList: Returns true if this DataList has items
DataObject::exists() — Method in class DataObject: Returns true if this object "exists", i.e., has a sensible value.
DataObject::extendedCan() — Method in class DataObject: Process tri-state responses from permission-alterting extensions. The extensions are expected to return one of three values:
DataObject::enable_subclass_access() — Method in class DataObject
DataQuery::execute() — Method in class DataQuery: Execute the query and return the result as {@link SS_Query} object.
DataQuery::exists() — Method in class DataQuery: Return whether this dataquery will have records. This will use EXISTS statements in SQL which are more performant - especially when used in combination with indexed columns (that you're filtering on)
DBComposite::exists() — Method in class DBComposite: Composite field defaults to exists only if all fields have values
DBEnum::enumValues() — Method in class DBEnum: Returns the values of this enum as an array, suitable for insertion into a {@link DropdownField}
$ DBField#escape_type — Property in class DBField: The escape type for this field when inserted into a template - either "xml" or "raw".
DBField::exists() — Method in class DBField: Determines if the field has a value which is not considered to be 'null' in a database context.
DBHTMLText::exists() — Method in class DBHTMLText: (non-PHPdoc)
DBHTMLVarchar::exists() — Method in class DBHTMLVarchar: (non-PHPdoc)
DBMoney::exists() — Method in class DBMoney
DBString::exists() — Method in class DBString: (non-PHPdoc)
Filterable::exclude() — Method in class Filterable: Return a new instance of this list that excludes any items with these characteristics
EndsWithFilter — Class in namespace SilverStripe\ORM\Filters: Matches textual content with a substring match on a text fragment leading to the end of the string.
ExactMatchFilter — Class in namespace SilverStripe\ORM\Filters: Selects textual content with an exact match between columnname and keyword.
SearchFilter::exclude() — Method in class SearchFilter: Exclude filter criteria from a SQL query.
ManyManyThroughQueryManipulator::extractInheritableQueryParameters() — Method in class ManyManyThroughQueryManipulator: Calculate the query parameters that should be inherited from the base many_many to the nested has_many list.
SQLExpression::execute() — Method in class SQLExpression: Execute this query.
SQLSelect::expressionForField() — Method in class SQLSelect: Return the SQL expression for the given field alias.
SS_List::each() — Method in class SS_List: Walks the list using the specified callback
FulltextSearchable::enable() — Method in class FulltextSearchable: Enable the default configuration of MySQL full-text searching on the given data classes.
Exception — Class in namespace SilverStripe\RealMe
RealMeService::enforceLogin() — Method in class RealMeService: Enforce login via RealMe. This can be used in controllers to force users to be authenticated via RealMe (not necessarily logged in as a {@link Member}), in the form of: Session::set('RealMeBackURL', '/path/to/the/controller/method'); if($service->enforceLogin()) { // User has a valid RealMe account, $service->getAuthData() will return you their details } else { // Something went wrong processing their details, show an error }
RegistryPageController::export() — Method in class RegistryPageController: Exports out all the data for the current search results.
$ Report#excluded_reports — Property in class Report: Reports which should not be collected and returned in get_reports
Report::extendedCan() — Method in class Report: Helper to assist with permission extension
$ RestfulServer#endpoint_aliases — Property in class RestfulServer: Custom endpoints that map to a specific class.
$ BasicAuth#entire_site_protected — Property in class BasicAuth
$ BasicAuth#entire_site_protected_code — Property in class BasicAuth
$ BasicAuth#entire_site_protected_message — Property in class BasicAuth
CMSSecurity::enabled() — Method in class CMSSecurity: Determine if CMSSecurity is enabled
InheritedPermissionsExtension::EditorGroups() — Method in class InheritedPermissionsExtension
$ LoginAttempt#EmailHashed — Property in class LoginAttempt: sha1 hashed Email address used for login attempt
$ Member#Email — Property in class Member
Member::encryptWithUserSettings() — Method in class Member: Utility for generating secure password hashes for this member.
$ PasswordEncryptor#encryptors — Property in class PasswordEncryptor
PasswordEncryptor::encrypt() — Method in class PasswordEncryptor: Return a string value stored in the {@link Member->Password} property.
PasswordEncryptor_Blowfish::encrypt() — Method in class PasswordEncryptor_Blowfish: Return a string value stored in the {@link Member->Password} property.
PasswordEncryptor_Blowfish::encryptX() — Method in class PasswordEncryptor_Blowfish
PasswordEncryptor_Blowfish::encryptY() — Method in class PasswordEncryptor_Blowfish
PasswordEncryptor_Blowfish::encryptA() — Method in class PasswordEncryptor_Blowfish
PasswordEncryptor_LegacyPHPHash::encrypt() — Method in class PasswordEncryptor_LegacyPHPHash: Return a string value stored in the {@link Member->Password} property.
PasswordEncryptor_MySQLOldPassword::encrypt() — Method in class PasswordEncryptor_MySQLOldPassword: Return a string value stored in the {@link Member->Password} property.
PasswordEncryptor_MySQLPassword::encrypt() — Method in class PasswordEncryptor_MySQLPassword: Return a string value stored in the {@link Member->Password} property.
PasswordEncryptor_None::encrypt() — Method in class PasswordEncryptor_None: Return a string value stored in the {@link Member->Password} property.
PasswordEncryptor_PHPHash::encrypt() — Method in class PasswordEncryptor_PHPHash: Return a string value stored in the {@link Member->Password} property.
$ RememberLoginHash#ExpiryDate — Property in class RememberLoginHash
Security::encrypt_password() — Method in class Security: Encrypt a password according to the current password encryption settings.
SecurityToken::enable() — Method in class SecurityToken: Globally enable tokens that have been previously disabled through {@link disable}.
SiteConfig::EditorGroups() — Method in class SiteConfig: List of groups that can edit SiteConfig.
SitewideContentTaxonomy::enabled() — Method in class SitewideContentTaxonomy: Check if this field is enabled.
EditableSpamProtectionField — Class in namespace SilverStripe\SpamProtection: Editable Spam Protecter Field. Used with the User Defined Forms module (if installed) to allow the user to have captcha fields with their custom forms
FormSpamProtectionExtension::enableSpamProtection() — Method in class FormSpamProtectionExtension: Activates the spam protection module.
ErrorPageSubsite — Class in namespace SilverStripe\Subsites\Extensions
FileTextExtractable::extractFileAsText() — Method in class FileTextExtractable: Tries to parse the file contents if a FileTextExtractor class exists to handle the file type, and returns the text. The value is also cached into the File record itself.
Exception — Class in namespace SilverStripe\TextExtraction\Extractor\FileTextExtractor
EditableCustomRule — Class in namespace SilverStripe\UserForms\Model: A custom rule for showing / hiding an EditableFormField based the value of another EditableFormField.
$ EditableCustomRule#extensions — Property in class EditableCustomRule: Built in extensions required
EditableFormField — Class in namespace SilverStripe\UserForms\Model: Represents the base class of a editable form field object like {@link EditableTextField}.
$ EditableFormField#extensions — Property in class EditableFormField: Built in extensions required
$ EditableFormField#ExtraClass — Property in class EditableFormField
EditableCheckbox — Class in namespace SilverStripe\UserForms\Model\EditableFormField: EditableCheckbox
EditableCheckboxGroupField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: EditableCheckboxGroup
EditableCountryDropdownField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: A dropdown field which allows the user to select a country
$ EditableCountryDropdownField#EmptyString — Property in class EditableCountryDropdownField
EditableDateField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: EditableDateField
EditableDropdown — Class in namespace SilverStripe\UserForms\Model\EditableFormField: EditableDropdown
$ EditableDropdown#EmptyString — Property in class EditableDropdown
EditableEmailField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: EditableEmailField
EditableFieldGroup — Class in namespace SilverStripe\UserForms\Model\EditableFormField: Specifies that this ends a group of fields
$ EditableFieldGroup#EditableFieldGroupEndID — Property in class EditableFieldGroup
EditableFieldGroup::EditableFieldGroupEnd() — Method in class EditableFieldGroup
EditableFieldGroupEnd — Class in namespace SilverStripe\UserForms\Model\EditableFormField: Specifies that this ends a group of fields
EditableFileField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: Allows a user to add a field that can be used to upload a file.
EditableFormHeading — Class in namespace SilverStripe\UserForms\Model\EditableFormField: Allows an editor to insert a generic heading into a field
EditableFormStep — Class in namespace SilverStripe\UserForms\Model\EditableFormField: A step in multi-page user form
EditableLiteralField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: Editable Literal Field. A literal field is just a blank slate where you can add your own HTML / Images / Flash
$ EditableLiteralField#editor_config — Property in class EditableLiteralField: Get the name of the editor config to use for HTML sanitisation. Defaults to the active config.
EditableMemberListField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: Creates an editable field that displays members in a given group
EditableMultipleOptionField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: Base class for multiple option fields such as {@link EditableDropdownField} and radio sets.
EditableNumericField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: EditableNumericField
EditableOption — Class in namespace SilverStripe\UserForms\Model\EditableFormField: Base Class for EditableOption Fields such as the ones used in dropdown fields and in radio check box groups
EditableRadioField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: EditableRadioField
EditableTextField — Class in namespace SilverStripe\UserForms\Model\EditableFormField: EditableTextField
EmailRecipient — Class in namespace SilverStripe\UserForms\Model\Recipient: A Form can have multiply members / emails to email the submission to and custom subjects
$ EmailRecipient#EmailAddress — Property in class EmailRecipient
$ EmailRecipient#EmailBody — Property in class EmailRecipient
$ EmailRecipient#EmailBodyHtml — Property in class EmailRecipient
$ EmailRecipient#EmailFrom — Property in class EmailRecipient
$ EmailRecipient#EmailReplyTo — Property in class EmailRecipient
$ EmailRecipient#EmailSubject — Property in class EmailRecipient
$ EmailRecipient#EmailTemplate — Property in class EmailRecipient
EmailRecipient::emailTemplateExists() — Method in class EmailRecipient: Make sure the email template saved against the recipient exists on the file system.
EmailRecipientCondition — Class in namespace SilverStripe\UserForms\Model\Recipient: Declares a condition that determines whether an email can be sent to a given recipient
$ UserForm#extensions — Property in class UserForm: Built in extensions required by this page.
$ UserForm#error_container_id — Property in class UserForm: Error container selector which matches the element for grouped messages
$ UserForm#enable_are_you_sure — Property in class UserForm: The configuration used to determine whether a confirmation message is to appear when navigating away from a partially completed form.
VersionableExtension::extendWithSuffix() — Method in class VersionableExtension: Modify table name with suffix.
Versioned::extendWithSuffix() — Method in class Versioned
EmbedContainer — Class in namespace SilverStripe\View\Embed: This class acts as a wrapper around the third party requirement embed/embed v4
$ EmbedContainer#embed — Property in class EmbedContainer
Embeddable — Class in namespace SilverStripe\View\Embed: Abstract interface for an embeddable resource
$