Index | SilverStripe API

We can't use ORM filtering for PHP methods, so we'll perform our own PHP "search" and get a list of matching SiteTree record IDs, then add that to the original ORM query.

$ ElementalAreaController#allowed_actions — Property in class ElementalAreaController

ElementalAreaController::apiSaveForm() — Method in class ElementalAreaController

This method should not be used and will be removed

$ ElementalContentControllerExtension#allowed_actions — Property in class ElementalContentControllerExtension

$ ElementalAreaField#area — Property in class ElementalAreaField

$ BaseElement#anchor — Property in class BaseElement

For caching 'getAnchor'

BaseElement::AbsoluteLink() — Method in class BaseElement

DataExtension::assignTopPage() — Method in class DataExtension

Assigns top page relation

DataExtension::assignFixedTopPage() — Method in class DataExtension

Assigns top page relation based on fixed id

FluentExtension::assignTopPage() — Method in class FluentExtension

Assigns top page relation

FluentExtension::assignFixedTopPage() — Method in class FluentExtension

Assigns top page relation based on fixed id

SiteTreeExtension::addDuplicatedObject() — Method in class SiteTreeExtension

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

AdminRootController::add_rule_for_controller() — Method in class AdminRootController

Add the appropriate k/v pair to AdminRootController::$rules for the given controller.

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.

$ CMSBatchActionHandler#allowed_actions — Property in class CMSBatchActionHandler

CMSBatchActionHandler::actionByName() — Method in class CMSBatchActionHandler

Get an action for a given name

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.

CMSMenu::add_menu_item_obj() — Method in class CMSMenu

Add a previously built menu item object to the menu

$ CMSMenuItem#attributes — Property in class CMSMenuItem

Attributes for the link. For instance, custom data attributes or standard HTML anchor properties.

$ UsedOnTable#allowed_actions — Property in class UsedOnTable

$ LeftAndMain#allowed_actions — Property in class LeftAndMain

$ 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

Cleanup for the handleRequest method

LeftAndMain::ApplicationLink() — Method in class LeftAndMain

LeftAndMainExtension::accessedCMS() — Method in class LeftAndMainExtension

LeftAndMainExtension::augmentNewSiteTreeItem() — Method in class LeftAndMainExtension

$ ModalController#allowed_actions — Property in class ModalController

$ ModelAdmin#allowed_actions — Property in class ModelAdmin

$ SecurityAdmin#allowed_actions — Property in class SecurityAdmin

$ SudoModeController#allowed_actions — Property in class SudoModeController

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#allowed_actions — Property in class AssetAdmin

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

$ RemoteFileModalExtension#allowed_actions — Property in class RemoteFileModalExtension

AssetFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms

$ UploadField#allowed_actions — Property in class UploadField

$ UploadField#attachEnabled — Property in class UploadField

Set if selecting existing files is enabled.

$ UploadField#allowedMaxFileNumber — Property in class UploadField

The number of files allowed for this field

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.

AssetControlExtension::addAssetsFromOtherStages() — Method in class AssetControlExtension

Checks all stages other than the current stage, and check the visibility of assets attached to those records.

AssetControlExtension::addAssetsFromRecord() — Method in class AssetControlExtension

Given a record, add all assets it contains to the given manipulation.

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.

FileFinder::acceptDir() — Method in class FileFinder

Returns TRUE if the directory should be traversed. This can be overloaded to customise functionality, or extended with callbacks.

FileFinder::acceptFile() — Method in class FileFinder

Returns TRUE if the file should be included in the results. This can be overloaded to customise functionality, or extended via callbacks.

AbstractFileIDHelper — Class in namespace SilverStripe\Assets\FilenameParsing

AssetAdapter — Class in namespace SilverStripe\Assets\Flysystem

Adapter for local filesystem based on assets directory

FlysystemAssetStore::applyToFileOnFilesystem() — Method in class FlysystemAssetStore

Generic method to apply an action to a file regardless of what FileSystem it's on. The action to perform should be provided as a closure expecting the following signature:

function(ParsedFileID $parsedFileID, FileSystem $fs, FileResolutionStrategy $strategy, $visibility)

FlysystemAssetStore::applyToFileIDOnFilesystem() — Method in class FlysystemAssetStore

Equivalent to applyToFileOnFilesystem, only it expects a `fileID1 string instead of a ParsedFileID.

$ GeneratedAssets#assetStore — Property in class GeneratedAssets

Flysystem store for files

$ ImageManipulation#allowGeneration — Property in class ImageManipulation

If image resizes are allowed

$ 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 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#allowedCategories — Property in class DBFile

List of allowed file categories.

DBFile::AbsoluteLink() — Method in class DBFile

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

DBFile::assertFilenameValid() — Method in class DBFile

Check filename, and raise a ValidationException if invalid

$ ProtectedFileController#allowed_actions — Property in class ProtectedFileController

Sha1FileHashingService::algo() — Method in class Sha1FileHashingService

Valid hashing algorithm constant that can be passed to hash_init.

$ Upload#allowed_actions — Property in class Upload

$ 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::authenticationFailedUnknownUser() — Method in class AuditHook

Log failed login attempts when the email address doesn't map to an existing member record

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

AuditHookManyManyList is meant to override ManyManyList. When a Member is removed from a Group, it logs the event.

AuditHookMemberGroupSet — Class in namespace SilverStripe\Auditor

AuditHookMemberGroupSet is meant to override Member_GroupSet. When a Group is removed from a Member, it logs the event.

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.

$ Blog#allowed_children — Property in class Blog

Blog::addCMSRequirements() — Method in class Blog

Adds CMS related css and js overrides

Blog::assignGroup() — Method in class Blog

Assign users as necessary to the blog group.

$ BlogCategory#allow_urlsegment_multibyte — Property in class BlogCategory

$ BlogController#allowed_actions — Property in class BlogController

BlogController::archive() — Method in class BlogController

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

$ BlogPost#allowed_children — Property in class BlogPost

$ BlogPost#add_default_author — Property in class BlogPost

Control whether the current member is added to list of authors when a post is created

$ BlogPost#AuthorNames — Property 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}

$ BlogTag#allow_urlsegment_multibyte — Property in class BlogTag

$ 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

{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#allowed_actions — Property in class CMSMain

CMSMain::archive() — Method in class CMSMain

Delete this page from both live and stage

$ CMSPageAddController#allowed_actions — Property in class CMSPageAddController

CMSPageAddController::AddForm() — Method in class CMSPageAddController

$ CMSPageEditController#allowed_actions — Property in class CMSPageEditController

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

CMSSiteTreeFilter::applyDefaultFilters() — Method in class CMSSiteTreeFilter

Applies the default filters to a specified DataList of pages

$ ContentController#allowed_actions — Property in class ContentController

AnchorLinkFormFactory — Class in namespace SilverStripe\CMS\Forms

AnchorSelectorField — Class in namespace SilverStripe\CMS\Forms

Assists with selecting anchors on a given page

$ AnchorSelectorField#allowed_actions — Property in class AnchorSelectorField

AnchorSelectorField::anchors() — Method in class AnchorSelectorField

Find all anchors available on the given page.

$ InternalLinkModalExtension#allowed_actions — Property in class InternalLinkModalExtension

$ SiteTreeURLSegmentField#allowed_actions — Property in class SiteTreeURLSegmentField

LinkablePlugin::apply() — Method in class LinkablePlugin

LinkablePlugin::applyLinkFilter() — Method in class LinkablePlugin

$ RedirectorPageController#allowed_actions — Property in class RedirectorPageController

$ 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 owner to scrape for links that need tracking

VirtualPage::allowedChildren() — Method in class VirtualPage

VirtualPage::allMethodNames() — Method in class VirtualPage

{@inheritdoc}

$ ContentControllerSearchExtension#allowed_actions — Property in class ContentControllerSearchExtension

SearchForm::addStarsToKeywords() — Method in class SearchForm

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

$ CampaignAdmin#allowed_actions — Property in class CampaignAdmin

ConfigCollectionInterface::addMiddleware() — Method in class ConfigCollectionInterface

DeltaConfigCollection::addDelta() — Method in class DeltaConfigCollection

Push new delta

DeltaMiddleware::applyDelta() — Method in class DeltaMiddleware

Apply a single delta to a class config

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.

YamlTransformer::addDependencies() — Method in class YamlTransformer

Incapsulates the logic for adding before/after dependencies.

$ ContentReviewCMSExtension#allowed_actions — Property in class ContentReviewCMSExtension

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

$ CliController#allowed_actions — Property in class CliController

$ Controller#action — Property in class Controller

The URL part matched on the current controller as determined by the "$Action" part of the $url_handlers definition. Should correlate to a public method on this controller.

$ Controller#add_trailing_slash — Property in class Controller

If true, a trailing slash is added to the end of URLs, e.g. from Controller::join_links()

$ Controller#allowed_actions — Property in class Controller

Controller::afterHandleRequest() — Method in class Controller

Cleanup for the handleRequest method

$ 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#admin_email — Property in class Email

The default "from" email address or array of [email => name], or the email address as a string This will be set in the config on a site-by-site basis

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#allParams — Property in class HTTPRequest

Contains an associative array of all arguments matched in all calls to RequestHandler->handleRequest().

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::applyChangeLevel() — Method in class HTTPCacheControlMiddleware

Instruct the cache to apply a change with a given level, optionally modifying it with a force flag to increase priority of this action.

HTTPCacheControlMiddleware::applyToResponse() — Method in class HTTPCacheControlMiddleware

Generate all headers to add to this object

HTTPCacheControlMiddleware::augmentState() — Method in class HTTPCacheControlMiddleware

Update state based on current request and response objects

HTTPMiddlewareAware::addMiddleware() — Method in class HTTPMiddlewareAware

RateLimitMiddleware::addHeadersToResponse() — Method in class RateLimitMiddleware

$ RSSFeed#authorField — Property in class RSSFeed

Name of the author field of feed entries

$ RSSFeed_Entry#authorField — Property in class RSSFeed_Entry

Name of the author field of feed entries

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::addBackURLParam() — Method in class RequestHandler

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

IPUtils::anonymize() — Method in class IPUtils

Anonymizes an IP/IPv6.

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

$ DefaultCacheFactory#args — Property in class DefaultCacheFactory

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

CustomMethods::addMethodsFrom() — Method in class CustomMethods

Add all the methods from an object property.

CustomMethods::addWrapperMethod() — Method in class CustomMethods

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

CustomMethods::addCallbackMethod() — Method in class CustomMethods

Add callback as a method.

$ Extensible#afterExtendCallbacks — Property in class Extensible

List of callbacks to call after extensions having extend called on them, each grouped by methodName.

Extensible::afterExtending() — Method in class Extensible

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

Extensible::add_extension() — Method in class Extensible

Add an extension to a specific class.

$ Extension#allowed_actions — Property in class Extension

This is used by extensions designed to be applied to controllers.

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

Returns TRUE if the directory should be traversed. This can be overloaded to customise functionality, or extended with callbacks.

ManifestFileFinder::anyParents() — Method in class ManifestFileFinder

Check if any parents match the given callback

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.

PrioritySorter::addVariables() — Method in class PrioritySorter

If variables are defined, interpolate their values

BulkLoader_Result::addCreated() — Method in class BulkLoader_Result

BulkLoader_Result::addUpdated() — Method in class BulkLoader_Result

BulkLoader_Result::addDeleted() — Method in class BulkLoader_Result

$ DevBuildController#allowed_actions — Property in class DevBuildController

$ DevConfigController#allowed_actions — Property in class DevConfigController

DevConfigController::audit() — Method in class DevConfigController

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

$ DevelopmentAdmin#allowed_actions — Property in class DevelopmentAdmin

$ 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#autoFollowRedirection — Property in class FunctionalTest

If this is true, then 30x Location headers will be automatically followed.

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#adapters — Property in class DatabaseAdapterRegistry

Internal array of registered database adapters

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::allFixtureIDs() — Method in class SapphireTest

Return all of the IDs in the fixture of a particular class name.

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

$ TaskRunner#allowed_actions — Property in class TaskRunner

TaskRunner::addCssToHeader() — Method in class TaskRunner

Inject task runner CSS into the heaader

$ RelationValidationService#allow_rules — Property in class RelationValidationService

Only inspect classes with the following namespaces/class prefixes Empty string is a special value which represents classes without namespaces Set the value to null to disable the rule (useful when overriding configuration)

$ ImportField#allowed_actions — Property in class ImportField

$ DevCheckController#allowed_actions — Property in class DevCheckController

$ DevHealthController#allowed_actions — Property in class DevHealthController

EnvironmentCheckSuiteResult::addResult() — Method in class EnvironmentCheckSuiteResult

$ ErrorPage#allowed_children — Property in class ErrorPage

$ ErrorPage#allowed_error_codes — Property in class ErrorPage

An array of error codes to allow in the CMS If null, defaults to all available codes (see ErrorPage::getCodes())

$ CMSExternalLinksController#allowed_actions — Property in class CMSExternalLinksController

CompositeValidator::addValidator() — Method in class CompositeValidator

$ DatalessField#allowHTML — Property in class DatalessField

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#actions — Property in class Form

$ Form#attributes — Property in class Form

Any custom form attributes set through setAttributes().

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#action — Property in class FormAction

Action name, normally prefixed with 'action_'

FormAction::actionName() — Method in class FormAction

Get the action name

$ FormField#autofocus — Property in class FormField

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.

FormMessage::appendMessage() — Method in class FormMessage

Appends a message to the existing message if the types and casts match.

$ FormRequestHandler#allowed_actions — Property in class FormRequestHandler

FormRequestHandler::addBackURLParam() — Method in class FormRequestHandler

Helper to add ?BackURL= to any link

$ 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#allowed_actions — Property in class GridField

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'

$ GridFieldDetailForm_ItemRequest#allowed_actions — Property in class GridFieldDetailForm_ItemRequest

GridFieldEditButton::augmentColumns() — Method in class GridFieldEditButton

Add a column 'Delete'

GridFieldEditButton::addExtraClass() — Method in class GridFieldEditButton

Add an extra HTML class

$ GridFieldLevelup#attributes — Property in class GridFieldLevelup

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.

$ GridField_FormAction#args — Property in class GridField_FormAction

$ GridField_FormAction#actionName — Property in class GridField_FormAction

GridState::array_to_object() — Method in class GridState

GridState::attrValue() — Method in class GridState

HTMLEditorSanitiser::addValidElements() — Method in class HTMLEditorSanitiser

Given a valid_elements string, parse out the actual element and attribute rules and add to the internal whitelist

HTMLEditorSanitiser::attributeMatchesRule() — Method in class HTMLEditorSanitiser

Given a DOMAttr and an attribute rule, check if that attribute passes the rule

$ TinyMCECombinedGenerator#assetHandler — Property in class TinyMCECombinedGenerator

TinyMCEConfig::addButtonsToLine() — Method in class TinyMCEConfig

Add buttons to the end of a line

$ MoneyField#allowedCurrencies — Property in class MoneyField

Limit the currencies

$ PasswordField#autocomplete — Property in class PasswordField

Controls the autocomplete attribute on the field.

$ PasswordField#allowValuePostback — Property in class PasswordField

If true, the field can accept a value attribute, e.g. from posted form data

$ RequiredFields#allow_whitespace_only — Property in class RequiredFields

Whether to globally allow whitespace only as a valid value for a required field Can be overridden on a per-instance basis

RequiredFields::addRequiredField() — Method in class RequiredFields

Adds a single required field to required fields stack.

RequiredFields::appendRequiredFields() — Method in class RequiredFields

Add RequiredField objects together

$ SearchableDropdownTrait#allowed_actions — Property in class SearchableDropdownTrait

$ SegmentField#allowed_actions — Property in class SegmentField

AbstractSegmentFieldModifier — Class in namespace SilverStripe\Forms\SegmentFieldModifier

$ TreeDropdownField#allowed_actions — Property in class TreeDropdownField

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#autobuildSchema — Property in class Controller

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.

Controller::applyContext() — Method in class Controller

$ Build#allowed_actions — Property in class Build

$ DevelopmentAdmin#allowed_actions — Property in class DevelopmentAdmin

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

NestedInputBuilder::addInputTypesToSchema() — Method in class NestedInputBuilder

$ SchemaTranscriber#assetHandler — Property in class SchemaTranscriber

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#allow_email_login — Property in class LDAPAuthenticator

Set to 'yes' to indicate if this module should look up usernames in LDAP by matching the email addresses.

LDAPAuthenticator::authenticate() — Method in class LDAPAuthenticator

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

$ LDAPChangePasswordHandler#allowed_actions — Property in class LDAPChangePasswordHandler

$ LDAPLoginHandler#allowed_actions — Property in class LDAPLoginHandler

$ LDAPLostPasswordHandler#authenticatorClass — Property in class LDAPLostPasswordHandler

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

$ LDAPDebugController#allowed_actions — Property in class LDAPDebugController

$ 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 IdentityStore::logIn(). When successfully logged in, this will update the Member record from LDAP data.

$ LDAPLoginForm#authenticator_class — Property in class LDAPLoginForm

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.

$ LinkFieldController#allowed_actions — Property in class LinkFieldController

AbstractLinkField — Class in namespace SilverStripe\LinkField\Form

Abstract form field for managing Link records

$ Link#allowed_by_default — Property in class Link

Whether this link type is allowed by default If this is set to false then this type of Link can still be manually allowed on a per field basis with AbstractLinkField::setAllowedTypes();

$ SiteTreeLink#Anchor — Property in class SiteTreeLink

EnablerExtension::afterCallActionHandler() — Method in class EnablerExtension

GridFieldSiteTreeState::augmentColumns() — Method in class GridFieldSiteTreeState

Modify the list of columns displayed in the table.

$ ChangePasswordHandler#allowed_actions — Property in class ChangePasswordHandler

$ LoginHandler#allowed_actions — Property in class LoginHandler

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.

$ AdminRegistrationController#allowed_actions — Property in class AdminRegistrationController

AuthenticationFailedException — Class in namespace SilverStripe\MFA\Exception

$ MemberExtension#AccountResetHash — Property in class MemberExtension

$ MemberExtension#AccountResetExpired — Property in class MemberExtension

$ SecurityAdminExtension#allowed_actions — Property in class SecurityAdminExtension

$ SecurityExtension#allowed_actions — Property in class SecurityExtension

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

BaseHandlerTrait::applyRequirements() — Method in class BaseHandlerTrait

Perform the necessary "Requirements" calls to ensure client side scripts are available in the response

AvailableMethodDetails — Class in namespace SilverStripe\MFA\State

AvailableMethodDetailsInterface — Class in namespace SilverStripe\MFA\State

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

$ BackupCode#algorithm — Property in class BackupCode

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

DataList::addFilter() — Method in class DataList

DataList::applyRelation() — Method in class DataList

DataList::avg() — Method in class DataList

Return the average value of the given field in this DataList

DataList::addMany() — Method in class DataList

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

DataObject::afterUpdateCMSFields() — Method in class DataObject

Allows user code to hook into DataObject::getCMSFields after updateCMSFields being called on extensions

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

$ DatabaseAdmin#allowed_actions — Property in class DatabaseAdmin

EagerLoadedList::addEagerLoadedData() — Method in class EagerLoadedList

Pass in any eager-loaded data which applies to relations on a specific record in this list

EagerLoadedList::addRow() — Method in class EagerLoadedList

Add a single row of database data.

EagerLoadedList::addRows() — Method in class EagerLoadedList

Add multiple rows of database data.

EagerLoadedList::add() — Method in class EagerLoadedList

Not implemented - use addRow instead.

EagerLoadedList::avg() — Method in class EagerLoadedList

Return the average value of the given field in this list

EagerLoadedList::addFilter() — Method in class EagerLoadedList

DBComposite::addToQuery() — Method in class DBComposite

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

DBDate::Ago() — Method in class DBDate

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

$ DBField#arrayValue — Property in class DBField

Used for generating DB schema. {DBSchemaManager}

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

$ DBPrimaryKey#autoIncrement — Property in class DBPrimaryKey

ComparisonFilter::applyOne() — Method in class ComparisonFilter

Applies a comparison filter to the query Handles SQL escaping for both numeric and string values

ExactMatchFilter::applyOne() — Method in class ExactMatchFilter

Applies an exact match (equals) on a field value.

ExactMatchFilter::applyMany() — Method in class ExactMatchFilter

Applies an exact match (equals) on a field value against multiple possible values.

FulltextFilter::applyOne() — Method in class FulltextFilter

Apply filter criteria to a SQL query with a single value.

PartialMatchFilter::apply() — Method in class PartialMatchFilter

Apply filter criteria to a SQL query.

PartialMatchFilter::applyOne() — Method in class PartialMatchFilter

Apply filter criteria to a SQL query with a single value.

PartialMatchFilter::applyMany() — Method in class PartialMatchFilter

Apply filter criteria to a SQL query with an array of values.

$ SearchFilter#aggregate — Property in class SearchFilter

An array of data about an aggregate column being used ex: [ 'function' => 'COUNT', 'column' => 'ID' ]

SearchFilter::addRelation() — Method in class SearchFilter

Called by constructor to convert a string pathname into a well defined relationship sequence.

SearchFilter::addAggregate() — Method in class SearchFilter

Parses the name for any aggregate functions and stores them in the $aggregate array

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.

SearchFilter::applyOne() — Method in class SearchFilter

Apply filter criteria to a SQL query with a single value.

SearchFilter::applyMany() — Method in class SearchFilter

Apply filter criteria to a SQL query with an array of values.

WithinRangeFilter::applyOne() — Method in class WithinRangeFilter

Apply filter criteria to a SQL query with a single value.

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.

ListDecorator::add() — Method in class ListDecorator

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

ManyManyList::appendExtraFieldsToQuery() — Method in class ManyManyList

Adds the many_many_extraFields to the select of the underlying DataQuery.

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#assignments — Property in class SQLAssignmentRow

List of field values to store for this query

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::addRightJoin() — Method in class SQLConditionalExpression

Add a RIGHT 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::addUnion() — Method in class SQLSelect

Add a select query to UNION with.

SQLSelect::addWith() — Method in class SQLSelect

Adds a Common Table Expression (CTE), aka WITH clause.

SQLSelect::aggregate() — Method in class SQLSelect

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

$ SQLUpdate#assignment — Property in class SQLUpdate

The assignment to create for this update

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 — Property in class RelationList

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::applyBaseTableFields() — Method in class SearchContext

SearchContext::addFilter() — Method in class SearchContext

Adds a instance of SearchFilter.

SearchContext::addField() — Method in class SearchContext

Adds a new 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.

$ LoginForm#authenticator_class — Property in class LoginForm

$ LoginHandler#allowed_actions — Property in class LoginHandler

LoginHandler::acs() — Method in class LoginHandler

$ RealMeService#allowed_realme_environments — Property in class RealMeService

$ RealMeService#allowed_realme_integration_types — Property in class RealMeService

$ RealMeService#authn_contexts — Property in class RealMeService

$ RealMeService#allowed_authn_context_list — Property in class RealMeService

$ RegistryImportFeed#assetHandler — Property in class RegistryImportFeed

The class used to manipulate imported feed files on the filesystem

$ RegistryImportFeed#assetsDir — Property in class RegistryImportFeed

The "assets" folder name

$ RegistryImportFeedController#allowed_actions — Property in class RegistryImportFeedController

$ RegistryPageController#allowed_actions — Property in class RegistryPageController

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

$ RestfulServer#allowed_actions — Property in class RestfulServer

RestfulServer::authenticate() — Method in class RestfulServer

A function to authenticate a user

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

$ AuthenticationMiddleware#authenticationHandler — Property in class AuthenticationMiddleware

Authenticator — Class in namespace SilverStripe\Security

Abstract base class for an authentication method

Authenticator::authenticate() — Method in class Authenticator

Method to authenticate an user.

$ CMSSecurity#allowed_actions — Property in class CMSSecurity

$ Handler#allowed_actions — Property in class Handler

Group::AllChildrenIncludingDeleted() — Method in class Group

Returns all of the children for the CMS Tree.

$ LoginForm#authenticatorClass — Property in class LoginForm

Authenticator class to use with this login form

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

$ CMSLoginHandler#allowed_actions — Property in class CMSLoginHandler

CMSMemberAuthenticator::authenticateMember() — Method in class CMSMemberAuthenticator

$ ChangePasswordHandler#authenticator — Property in class ChangePasswordHandler

$ ChangePasswordHandler#allowed_actions — Property in class ChangePasswordHandler

CookieAuthenticationHandler::authenticateRequest() — Method in class CookieAuthenticationHandler

$ LoginHandler#authenticator — Property in class LoginHandler

$ LoginHandler#allowed_actions — Property in class LoginHandler

$ LogoutHandler#allowed_actions — Property in class LogoutHandler

$ LostPasswordHandler#authenticatorClass — Property in class LostPasswordHandler

Authentication class to use

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

MemberAuthenticator::authenticateMember() — Method in class MemberAuthenticator

Attempt to find and authenticate member if possible from the given data

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

$ PasswordEncryptor_PHPHash#algorithm — Property in class PasswordEncryptor_PHPHash

PasswordExpirationMiddleware::absoluteUrl() — Method in class PasswordExpirationMiddleware

Builds an absolute URL for the given path, adds base url if the path configured as absolute

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#allowed_actions — Property in class Security

$ Security#autologin_enabled — Property in class Security

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

Security::aggregateTabbedForms() — Method in class Security

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

Security::aggregateAuthenticatorResponses() — Method in class Security

We have three possible scenarios.

SecurityToken::addToUrl() — Method in class SecurityToken

SudoModeService::activate() — Method in class SudoModeService

SudoModeServiceInterface::activate() — Method in class SudoModeServiceInterface

$ LoginSessionController#allowed_actions — Property in class LoginSessionController

$ LoginSession#anonymize_ip — Property in class LoginSession

LogInAuthenticationHandler::authenticateRequest() — Method in class LogInAuthenticationHandler

LogOutAuthenticationHandler::authenticateRequest() — Method in class LogOutAuthenticationHandler

$ ShareDraftController#allowed_actions — Property in class ShareDraftController

$ ShareDraftContentControllerExtension#allowed_actions — Property in class ShareDraftContentControllerExtension

$ ShareDraftContentSiteTreeExtension#allowed_actions — Property in class ShareDraftContentSiteTreeExtension

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

Add URLs to this bundle

UrlBundleService::assignPriorityToUrls() — Method in class UrlBundleService

Add priority data to URLs

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#allowed_actions — Property in class LeftAndMainSubsites

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.

$ GridFieldSubsiteDetailFormItemRequest#allowed_actions — Property in class GridFieldSubsiteDetailFormItemRequest

$ SubsitesTreeDropdownField#allowed_actions — Property in class SubsitesTreeDropdownField

$ InitStateMiddleware#admin_url_paths — Property in class InitStateMiddleware

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

$ Subsite#allowed_themes — Property in class Subsite

Numeric array of all themes which are allowed to be selected for all subsites.

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

Returns an ArrayList of the subsites accessible to the current user.

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

$ StringTagField#allowed_actions — Property in class StringTagField

$ TagField#allowed_actions — Property in class TagField

$ TaxonomyDirectoryController#allowed_actions — Property in class TaxonomyDirectoryController

$ UserDefinedFormAdmin#allowed_actions — Property in class UserDefinedFormAdmin

$ UserDefinedFormController#allowed_actions — Property in class UserDefinedFormController

UserDefinedFormController::addUserFormsValidatei18n() — Method in class UserDefinedFormController

Add the necessary jQuery validate i18n translation files, either by locale or by langauge, e.g. 'en_NZ' or 'en'. This adds "methods_abc.min.js" as well as "messages_abc.min.js" from the jQuery validate thirdparty library from dist/js.

$ 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 — Property in class EditableOption

EditableOption::allow_empty_values() — Method in class EditableOption

Returns whether to allow empty values or not.

$ EditableTextField#autocomplete_options — Property in class EditableTextField

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

$ UserFormRecipientItemRequest#allowed_actions — Property in class UserFormRecipientItemRequest

$ VersionFeed#allchanges_enabled — Property in class VersionFeed

Enable the allchanges feed

$ VersionFeed#allchanges_limit — Property in class VersionFeed

Allchanges feed limit of items.

$ VersionFeedController#allowed_actions — Property in class VersionFeedController

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.

$ HistoryViewerController#allowed_actions — Property in class HistoryViewerController

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::augmentSQLStage() — Method in class Versioned

Reading a specific stage (Stage or Live)

Versioned::augmentSQLStageUnique() — Method in class Versioned

Reading a specific stage, but only return items that aren't in any other stage

Versioned::augmentSQLVersioned() — Method in class Versioned

Augment SQL to select from _Versions table instead.

Versioned::augmentSQLVersionedArchive() — Method in class Versioned

Filter the versioned history by a specific date and archive stage

Versioned::augmentSQLVersionedLatestSingle() — Method in class Versioned

Return latest version instance, regardless of whether it is on a particular stage.

Versioned::augmentSQLVersionedLatest() — Method in class Versioned

Return latest version instances, regardless of whether they are on a particular stage.

Versioned::augmentSQLVersionedVersion() — Method in class Versioned

If selecting a specific version, filter it here

Versioned::augmentSQLVersionedAll() — Method in class Versioned

If all versions are requested, ensure that records are sorted by this field

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::augmentWriteVersioned() — Method in class Versioned

Generates a ($table)_version DB manipulation and injects it into the current $manipulation

Versioned::augmentWriteStaged() — Method in class Versioned

Rewrite the given manipulation to update the selected (non-default) stage

Versioned::augmentWrite() — Method in class Versioned

Augment a write-record request.

Versioned::Author() — Method in class Versioned

Get author of this record.

VersionedGridFieldItemRequest::addVersionedButtons() — Method in class VersionedGridFieldItemRequest

Getting buttons that are for versioned objects

VersionedGridFieldItemRequest::addUnversionedButtons() — Method in class VersionedGridFieldItemRequest

Getting buttons that are for unversioned objects

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 ViewableData object.

$ ArrayData#array — Property in class ArrayData

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.

$ AttributesHTML#attributes — Property in class AttributesHTML

List of attributes to render on the frontend

SQLFormatter::addNewlines() — Method in class SQLFormatter

Newlines for tokens defined in $newline_before_tokens.

$ ShortcodeParser#active_instance — Property in class ShortcodeParser

$ ShortcodeParser#attrrx — Property in class ShortcodeParser

ShortcodeParser::attrrx() — Method in class ShortcodeParser

$ URLSegmentFilter#allowMultibyte — Property in class URLSegmentFilter

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#assetHandler — Property in class Requirements_Backend

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'

CredentialRepository::assertCredentialID() — Method in class CredentialRepository

Assert that the given credential ID matches a stored credential

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

$ AdvancedWorkflowAdmin#allowed_actions — Property in class AdvancedWorkflowAdmin

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.

$ AdvancedWorkflowExtension#allowed_actions — Property in class AdvancedWorkflowExtension

WorkflowApplicable::AbsoluteEditLink() — Method in class WorkflowApplicable

Included in CMS-generated email templates for a NotifyUsersWorkflowAction.

$ WorkflowField#allowed_actions — Property in class WorkflowField

WorkflowField::action() — Method in class WorkflowField

WorkflowField::ActionLink() — Method in class WorkflowField

$ WorkflowFieldActionController#allowed_actions — Property in class WorkflowFieldActionController

$ WorkflowFieldItemController#allowed_actions — Property in class WorkflowFieldItemController

$ WorkflowFieldTransitionController#allowed_actions — Property in class WorkflowFieldTransitionController

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

WorkflowTemplate::addManyManyToObject() — Method in class WorkflowTemplate

Given an object, first check it has a ManyMany relation on it and add() Member and Group relations as required.

$ GridFieldAddExistingSearchButton#allowed_actions — Property in class GridFieldAddExistingSearchButton

$ GridFieldAddExistingSearchHandler#allowed_actions — Property in class GridFieldAddExistingSearchHandler

GridFieldAddExistingSearchHandler::add() — Method in class GridFieldAddExistingSearchHandler

$ GridFieldAddNewMultiClass#allowed_actions — Property in class GridFieldAddNewMultiClass

$ GridFieldEditableColumns#allowed_actions — Property in class GridFieldEditableColumns

GridFieldExternalLink::augmentColumns() — Method in class GridFieldExternalLink

Add a column for the actions

$ GridFieldNestedForm#allowed_actions — Property in class GridFieldNestedForm

GridFieldNestedForm::atMaxNestingLevel() — Method in class GridFieldNestedForm

Check if we are currently at the max nesting level allowed.

GridFieldNestedForm::augmentColumns() — Method in class GridFieldNestedForm

Modify the list of columns displayed in the table.

$ GridFieldOrderableRows#allowed_actions — Property in class GridFieldOrderableRows

GridFieldOrderableRows::augmentColumns() — Method in class GridFieldOrderableRows

Modify the list of columns displayed in the table.

$ GridFieldRequestHandler#allowed_actions — Property in class GridFieldRequestHandler

$ QueuedJobsAdmin#allowed_actions — Property in class QueuedJobsAdmin

$ QueuedTaskRunner#allowed_actions — Property in class QueuedTaskRunner

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#action — Property in class GridFieldQueuedJobExecute

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

$ FluentCMSMainExtension#allowed_actions — Property in class FluentCMSMainExtension

FluentExtension::anyMatch() — Method in class FluentExtension

Helper function to check if the value given is present in any of the patterns.

FluentExtension::augmentDatabase() — Method in class FluentExtension

Update the database schema as required by this extension.

FluentExtension::augmentDatabaseDontRequire() — Method in class FluentExtension

FluentExtension::augmentDatabaseRequireTable() — Method in class FluentExtension

Require the given localisation table

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::addLocaleStatusMessage() — Method in class FluentSiteTreeExtension

Adds a UI message to indicate whether you're editing in the default locale or not

FluentSiteTreeExtension::addLocalePrefixToUrlSegment() — Method in class FluentSiteTreeExtension

Add the locale's URLSegment to the URL prefix for a page's URL segment field

FluentSiteTreeExtension::actionComplete() — Method in class FluentSiteTreeExtension

FluentVersionedExtension::augmentDatabase() — Method in class FluentVersionedExtension

Update the database schema as required by this extension.

FluentVersionedExtension::augmentDatabaseDontRequire() — Method in class FluentVersionedExtension

FluentVersionedExtension::augmentDatabaseRequireTable() — Method in class FluentVersionedExtension

Require the given localisation table

FluentVersionedExtension::augmentSQL() — Method in class FluentVersionedExtension

Edit the given query object to support queries for this extension

FluentVersionedExtension::addLocaleFallbackChain() — Method in class FluentVersionedExtension

Update all joins to include Version as well as Locale / Record

FluentVersionedExtension::augmentWrite() — Method in class FluentVersionedExtension

Apply versioning to write

FluentVersionedExtension::augmentMaxVersionSubSelect() — Method in class FluentVersionedExtension

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

FluentAdminTrait::actionComplete() — Method in class FluentAdminTrait

FluentAdminTrait::archiveFluent() — Method in class FluentAdminTrait

Archives the current object from all locales (versioned)

FluentBadgeTrait::addFluentBadge() — Method in class FluentBadgeTrait

Add the Fluent state badge before any existing badges and return the result

FluentObjectTrait::augmentDataQueryCreation() — Method in class FluentObjectTrait

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

BaseAction::appliesToRecord() — Method in class BaseAction

Check if this item is enabled for the given record in locale

CopyLocaleAction::appliesToRecord() — Method in class CopyLocaleAction

Item needs to be translated before it can be published

DeleteAllLocalesAction::augmentColumns() — Method in class DeleteAllLocalesAction

Add a column 'Delete'

DeleteLocaleAction::appliesToRecord() — Method in class DeleteLocaleAction

Record must be published before it can be unpublished

LocaleToggleColumn::augmentColumns() — Method in class LocaleToggleColumn

PublishAction::appliesToRecord() — Method in class PublishAction

Item needs to be translated before it can be published

SaveLocaleAction::appliesToRecord() — Method in class SaveLocaleAction

Item must either be localised, or filtered

UnpublishAction::appliesToRecord() — Method in class UnpublishAction

Record must be published before it can be unpublished

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

$ Package#badges — Property in class Package

$ ComposerLoader#basePath — Property in class ComposerLoader

ComposerLoader::build() — Method in class ComposerLoader

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

$ ArchiveHandler#buttonClasses — Property in class ArchiveHandler

Extra classes to add to the bulk action button for this handler Can also be used to set the button font-icon e.g. font-icon-trash

$ DeleteHandler#buttonClasses — Property in class DeleteHandler

Extra classes to add to the bulk action button for this handler Can also be used to set the button font-icon e.g. font-icon-trash

$ EditHandler#buttonClasses — Property in class EditHandler

Extra classes to add to the bulk action button for this handler Can also be used to set the button font-icon e.g. font-icon-trash

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.

$ Handler#buttonClasses — Property in class Handler

Extra classes to add to the bulk action button for this handler Can also be used to set the button font-icon e.g. font-icon-trash

$ PublishHandler#buttonClasses — Property in class PublishHandler

Extra classes to add to the bulk action button for this handler Can also be used to set the button font-icon e.g. font-icon-trash

$ UnPublishHandler#buttonClasses — Property in class UnPublishHandler

Extra classes to add to the bulk action button for this handler Can also be used to set the button font-icon e.g. font-icon-trash

$ UnlinkHandler#buttonClasses — Property in class UnlinkHandler

Extra classes to add to the bulk action button for this handler Can also be used to set the button font-icon e.g. font-icon-trash

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::buildAction() — Method in class CMSBatchActionHandler

Safely generate batch action object for a given classname

CMSBatchActionHandler::batchActions() — Method in class CMSBatchActionHandler

Get all registered actions through the static defaults set by 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 ViewableData->CSSClasses(), but with a changed name to avoid problems when using 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

AssetFormFactory::buildFileStatusIcon() — Method in class AssetFormFactory

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

AbstractFileIDHelper::buildFileID() — Method in class AbstractFileIDHelper

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

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.

BlogAdminSidebar — Class in namespace SilverStripe\Blog\Forms

$ GridFieldAddByDBField#buttonName — Property in class GridFieldAddByDBField

Name for the buttons displayed in the CMS

Blog — Class in namespace SilverStripe\Blog\Model

Blog Holder

BlogCategory — Class in namespace SilverStripe\Blog\Model

A blog category for generalising blog posts.

$ BlogCategory#belongs_many_many — Property in class BlogCategory

$ 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

$ BlogController#blogPosts — Property in class BlogController

The current Blog Post DataList query.

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.

$ BlogMemberExtension#belongs_many_many — Property in class BlogMemberExtension

BlogMemberExtension::BlogProfileImage() — Method in class BlogMemberExtension

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#belongs_many_many — Property in class BlogTag

$ 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

ModelAsController::beforeHandleRequest() — Method in class ModelAsController

A bootstrap for the handleRequest method

RootURLController::beforeHandleRequest() — Method in class RootURLController

A bootstrap for the handleRequest method

$ 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#base_class_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

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

$ CachedConfigCollection#building — Property in class CachedConfigCollection

Set to true while building config.

$ YamlTransformer#baseDirectory — Property in class YamlTransformer

Base directory used to find yaml files.

$ SiteTreeContentReview#belongs_many_many — Property in class SiteTreeContentReview

$ Controller#baseInitCalled — Property in class Controller

Controller::beforeHandleRequest() — Method in class Controller

A bootstrap for the handleRequest method

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

$ Email#bcc_all_emails_to — Property in class Email

$ HTTPRequest#body — Property in class HTTPRequest

Raw HTTP body, used by PUT and POST requests.

$ HTTPResponse#body — Property in class HTTPResponse

$ ConfirmationMiddleware#bypasses — Property in class ConfirmationMiddleware

The list of bypasses

ConfirmationMiddleware::buildConfirmationRedirect() — Method in class ConfirmationMiddleware

Initialize the confirmation session storage with the confirmation items and return an HTTPResponse redirecting to the according confirmation form.

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

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

GetParameter::buildConfirmationItem() — Method in class GetParameter

Generates the confirmation item

Url::buildConfirmationItem() — Method in class Url

Generates the confirmation item

UrlPathStartswith::buildConfirmationItem() — Method in class UrlPathStartswith

Generates the confirmation item

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.

$ RequestHandler#brokenOnConstruct — Property in class RequestHandler

This variable records whether RequestHandler::construct() was called or not. Useful for checking if subclasses have called parent::construct()

BaseKernel — Class in namespace SilverStripe\Core

Simple Kernel container

$ BaseKernel#basePath — Property in class BaseKernel

BaseKernel::bootPHP() — Method in class BaseKernel

Initialise PHP with default variables

BaseKernel::bootManifests() — Method in class BaseKernel

Boot all manifests

BaseKernel::bootConfigs() — Method in class BaseKernel

Include all _config.php files

BaseKernel::bootErrorHandling() — Method in class BaseKernel

Turn on error handling

BaseKernel::boot() — Method in class BaseKernel

BaseKernel::buildManifestCacheFactory() — Method in class BaseKernel

CoreConfigFactory::buildYamlTransformer() — Method in class CoreConfigFactory

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#bootDatabase — Property in class CoreKernel

CoreKernel::boot() — Method in class CoreKernel

CoreKernel::bootDatabaseGlobals() — Method in class CoreKernel

Load default database configuration from the $database and $databaseConfig globals

CoreKernel::bootDatabaseEnvVars() — Method in class CoreKernel

Load default database configuration from environment variable

$ CustomMethods#built_in_methods — Property in class CustomMethods

Non-custom public methods.

$ Extensible#beforeExtendCallbacks — Property in class Extensible

List of callbacks to call prior to extensions having extend called on them, each grouped by methodName.

Extensible::beforeExtending() — Method in class Extensible

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

$ 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

$ ClassManifest#base — Property in class ClassManifest

base manifest directory

ClassManifestVisitor::beforeTraverse() — Method in class ClassManifestVisitor

$ Module#basePath — Property in class Module

Base folder of application with no trailing slash

$ ModuleManifest#base — Property in class ModuleManifest

The base path used when building the manifest

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 BulkLoader import (usually through the 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',

$ FixtureFactory#blueprints — Property in class FixtureFactory

$ SapphireTest#backupGlobals — Property in class SapphireTest

We need to disabling backing up of globals to avoid overriding the few globals SilverStripe relies on, like $lang for the i18n subsystem.

TestKernel::bootPHP() — Method in class TestKernel

Initialise PHP with default variables

TestKernel::bootErrorHandling() — Method in class TestKernel

Turn on error handling

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

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

Form::buildRequestHandler() — Method in class Form

Scaffold new request handler for this form

$ FormAction#buttonContent — Property in class FormAction

Literal button content, used when useButtonTag is true.

$ FormMessageBootstrapExtension#bootstrapAlertsMap — Property in class FormMessageBootstrapExtension

$ FormRequestHandler#buttonClickedFunc — Property in class FormRequestHandler

FormRequestHandler::buttonClicked() — Method in class FormRequestHandler

Get instance of button which was clicked for this request

GridField::buildColumnDispatch() — Method in class GridField

Build an columnDispatch that maps a GridField_ColumnProvider to a column for reference later.

$ GridFieldAddNewButton#buttonName — Property in class GridFieldAddNewButton

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

$ TinyMCEConfig#buttons — Property in class TinyMCEConfig

Holder list of buttons, organised by line. This array is 1-based indexed array

MoneyField::buildAmountField() — Method in class MoneyField

Builds a field to input the amount of money

MoneyField::buildCurrencyField() — Method in class MoneyField

Builds a new currency field based on the allowed currencies configured

$ PopoverField#buttonTooltip — Property in class PopoverField

Tooltip to put on button

$ TreeDropdownField#baseID — Property in class TreeDropdownField

Filter for base record

BasicAuthAuthenticator — Class in namespace SilverStripe\GraphQL\Auth

An authenticator using SilverStripe's BasicAuth

Handler::buildAuthenticator() — Method in class Handler

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

QuerySort::buildAllFieldsConfig() — Method in class QuerySort

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::buildAllFieldsConfig() — Method in class NestedInputBuilder

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

LinkTypeService::byKey() — Method in class LinkTypeService

Return a Link instance by key

$ GorriecoeMigrationTask#base_link_columns — Property in class GorriecoeMigrationTask

Mapping for columns in the base link table.

$ LinkableMigrationTask#base_link_columns — Property in class LinkableMigrationTask

Mapping for columns in the base link table.

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

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::buildTraceComment() — Method in class DBQueryBuilder

Builds an SQL comment indicating where the query was executed from.

DBQueryBuilder::buildSelectQuery() — Method in class DBQueryBuilder

Builds a query from a SQLSelect expression

DBQueryBuilder::buildDeleteQuery() — Method in class DBQueryBuilder

Builds a query from a SQLDelete expression

DBQueryBuilder::buildInsertQuery() — Method in class DBQueryBuilder

Builds a query from a SQLInsert expression

DBQueryBuilder::buildUpdateQuery() — Method in class DBQueryBuilder

Builds a query from a SQLUpdate expression

DBQueryBuilder::buildWithFragment() — Method in class DBQueryBuilder

Returns the WITH clauses ready for inserting into a query.

DBQueryBuilder::buildSelectFragment() — Method in class DBQueryBuilder

Returns the SELECT clauses ready for inserting into a query.

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::buildUnionFragment() — Method in class DBQueryBuilder

Return the UNION clause(s) 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

Database::benchmarkQuery() — Method in class Database

Allows the display and benchmarking of queries as they are being run

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

$ MySQLStatement#bound — Property in class MySQLStatement

Is the statement bound to the current resultset?

$ MySQLStatement#boundValues — Property in class MySQLStatement

List of bound variables in the current row

MySQLStatement::bind() — Method in class MySQLStatement

Binds this statement to the variables

MySQLiConnector::beforeQuery() — Method in class MySQLiConnector

Invoked before any query is executed

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

DataList::byID() — Method in class DataList

Return the first DataObject with the given ID

$ DataObject#brokenOnDelete — Property in class DataObject

Used by onBeforeDelete() to ensure child classes call parent::onBeforeDelete()

$ DataObject#brokenOnWrite — Property in class DataObject

Used by onBeforeWrite() to ensure child classes call parent::onBeforeWrite()

$ DataObject#belongs_to — Property in class DataObject

A meta-relationship that allows you to define the reverse side of a 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::beforeUpdateCMSFields() — Method in class DataObject

Allows user code to hook into DataObject::getCMSFields prior to updateCMSFields being called on extensions

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::buildTableName() — Method in class DataObjectSchema

Generate table name for a class.

DataObjectSchema::buildCustomDatabaseIndexes() — Method in class DataObjectSchema

Look for custom indexes declared on the class

DataObjectSchema::buildSortDatabaseIndexes() — Method in class DataObjectSchema

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

EagerLoadedList::byID() — Method in class EagerLoadedList

Return the first item with the given ID

EagerLoadedList::byIDs() — Method in class EagerLoadedList

$ DBClassNameTrait#baseClass — Property in class DBClassNameTrait

Base classname of class to enumerate.

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

ListDecorator::byID() — Method in class ListDecorator

Return the first item with the given ID

ListDecorator::byIDs() — Method in class ListDecorator

Filter this list to only contain the given Primary IDs

ManyManyThroughQueryManipulator::beforeGetFinalisedQuery() — Method in class ManyManyThroughQueryManipulator

Invoked prior to getFinalisedQuery()

BasicSearchContext — Class in namespace SilverStripe\ORM\Search

A SearchContext that can be used with non-ORM data.

$ UnsavedRelationList#baseClass — Property in class UnsavedRelationList

The DataObject class name that this relation is on

$ 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#baseReport — Property in class ReportWrapper

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

Form::buildActionList() — Method in class Form

Form::buildFieldList() — Method in class Form

Builds the form fields taking the confirmation items from the storage

Form::buildEmptyFieldList() — Method in class Form

Builds the fields showing the form is empty and there's nothing to confirm

$ InheritedPermissions#baseClass — Property in class InheritedPermissions

Class name

InheritedPermissions::batchPermissionCheck() — Method in class InheritedPermissions

This method is NOT a full replacement for the individual can*() methods, e.g. canEdit(). Rather than checking (potentially slow) PHP logic, it relies on the database group associations, e.g. the "CanEditType" field plus the "SiteTree_EditorGroups" many-many table. By batch checking multiple records, we can combine the queries efficiently.

InheritedPermissions::batchPermissionCheckForStage() — Method in class InheritedPermissions

$ Member#belongs_many_many — Property in class Member

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

$ PermissionRole#belongs_many_many — Property in class PermissionRole

Security::basicauthlogin() — Method in class Security

$ LoginSession#belongs_to — Property in class LoginSession

$ GarbageCollectionService#batch_remove_limit — Property in class GarbageCollectionService

Limit the number of records collected per run.

SiteConfigLeftAndMain::Breadcrumbs() — Method in class SiteConfigLeftAndMain

BaseElementSubsites — Class in namespace SilverStripe\Subsites\Extensions

Extension for the BaseElement object to add subsites support for CMS previews

$ Subsite#belongs_many_many — Property in class Subsite

$ PDFTextExtractor#binary_location — Property in class PDFTextExtractor

Set to bin path this extractor can execute

PDFTextExtractor::bin() — Method in class PDFTextExtractor

Accessor to get the location of the binary

$ SolrCellTextExtractor#base_url — Property in class SolrCellTextExtractor

Base URL to use for Solr text extraction.

UserDefinedFormController::buildWatchJS() — Method in class UserDefinedFormController

Outputs the required JS from the $watch input

$ UserFormFileExtension#belongs_to — Property in class UserFormFileExtension

$ GridFieldAddClassesButton#buttonName — Property in class GridFieldAddClassesButton

Button title

$ GridFieldAddClassesButton#buttonClass — Property in class GridFieldAddClassesButton

Additonal CSS classes for the button

$ 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

$ EditableFieldGroupEnd#belongs_to — Property in class EditableFieldGroupEnd

$ 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

$ ChangeSetItem#belongs_many_many — Property in class ChangeSetItem

Versioned::baseTable() — Method in class Versioned

Return the base table - the class that directly extends DataObject.

VersionedGridFieldItemRequest::Breadcrumbs() — Method in class VersionedGridFieldItemRequest

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

$ RequirementsTestState#backend — Property in class RequirementsTestState

$ ShortcodeParser#block_level_elements — Property in class ShortcodeParser

$ Requirements#backend — Property in class Requirements

Instance of the requirements for storage. You can create your own backend to change the default JS and CSS inclusion behaviour.

Requirements::backend() — Method in class Requirements

Requirements::block() — Method in class Requirements

Block inclusion of a specific file

$ Requirements_Backend#blocked — Property in class Requirements_Backend

The file paths (relative to docroot) or uniquenessIDs of any included requirements which should be blocked when executing inlcudeInHTML(). This is useful, for example, to block scripts included by a superclass without having to override entire functions and duplicate a lot of code.

Requirements_Backend::block() — Method in class Requirements_Backend

Block inclusion of a specific file

$ ThemeManifest#base — Property in class ThemeManifest

Base path

$ ThemeResourceLoader#base — Property in class ThemeResourceLoader

The base path of the application

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

WorkflowActionInstance::BaseAction() — Method in class WorkflowActionInstance

WorkflowInstance::beginWorkflow() — Method in class WorkflowInstance

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

$ GridFieldAddExistingSearchHandler#button — Property in class GridFieldAddExistingSearchHandler

GridFieldNestedFormItemRequest::Breadcrumbs() — Method in class GridFieldNestedFormItemRequest

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

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

$ GridFieldLinkButton#caption — Property in class GridFieldLinkButton

Caption text for the button to show

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

$ UpdatePackageInfoTask#composerLoader — Property in class UpdatePackageInfoTask

$ ApiLoader#cache — Property in class ApiLoader

ApiLoader::createRequest() — Method in class ApiLoader

Create a request with some standard headers

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

$ ComposerLoaderExtension#composer — Property in class ComposerLoaderExtension

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

CWPSiteConfigExtension — Class in namespace CWP\AgencyExtensions\Extensions

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

$ Handler#component — Property in class Handler

GridFieldBulkManager instance.

$ BulkManager#config — Property in class BulkManager

component configuration.

HTTPBulkToolsResponse::createBody() — Method in class HTTPBulkToolsResponse

Creates the response JSON body

$ BulkUploadHandler#component — Property in class BulkUploadHandler

Bulk upload component.

BulkUploadHandler::createDataObject() — Method in class BulkUploadHandler

Creates a new DataObject Add file ID to the Dataobject Add DataObject to Gridfield list Publish DataObject if enabled

$ BulkUploader#config — Property in class BulkUploader

Component configuration.

$ ElementForm#controller_class — Property in class ElementForm

$ ElementForm#class_description — Property in class ElementForm

$ ElementalAreasExtension#clear_contentfield — Property in class ElementalAreasExtension

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

$ ElementalPageExtension#cascade_duplicates — Property in class ElementalPageExtension

$ BaseElement#class_description — Property in class BaseElement

$ BaseElement#casting — Property in class BaseElement

$ BaseElement#controller_class — Property in class BaseElement

$ BaseElement#controller_template — Property in class BaseElement

$ BaseElement#controller — Property in class BaseElement

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

$ ElementContent#class_description — Property in class ElementContent

$ ElementalArea#cascade_deletes — Property in class ElementalArea

$ ElementalArea#cascade_duplicates — Property in class ElementalArea

ElementalArea::canEdit() — Method in class ElementalArea

ElementalArea::canView() — Method in class ElementalArea

ElementTypeReport::columns() — Method in class ElementTypeReport

ElementsInUseReport::columns() — Method in class ElementsInUseReport

$ ElementTypeRegistry#cache — Property in class ElementTypeRegistry

$ MigrateContentToElement#clear_content — Property in class MigrateContentToElement

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

DataExtension::clearTopPage() — Method in class DataExtension

Clears top page relation, this is useful when duplicating object as the new object doesn't necessarily belong to the original page

FluentExtension::clearTopPage() — Method in class FluentExtension

Clears top page relation, this is useful when duplicating object as the new object doesn't necessarily belong to the original page

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

CMSBatchActionHandler::cleanIDs() — Method in class CMSBatchActionHandler

Sanitise ID list from string input

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

$ CMSEditLinkExtension#cms_edit_owner — Property in class CMSEditLinkExtension

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 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#client_debugging — Property in class LeftAndMain

Enable front-end debugging (increases verbosity) in dev mode.

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::currentRecordID() — 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 getRecord()} and {@link currentPageID() to get the currently selected record.

LeftAndMain::currentRecord() — Method in class LeftAndMain

Uses getRecord()} and {@link currentRecordID() 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

$ ModalController#controller — Property in class ModalController

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.

FileConverter::convert() — Method in class FileConverter

Converts the given DBFile instance to another file type.

$ FileConverterManager#converters — Property in class FileConverterManager

An array of classes or injector service names for classes that implement the FileConverter interface.

FileConverterManager::convert() — Method in class FileConverterManager

Convert the file to the given format using the first available converter that can perform the conversion.

InterventionImageFileConverter::convert() — Method in class InterventionImageFileConverter

Converts the given DBFile instance to another file type.

TestAssetStore::cleanFilename() — Method in class TestAssetStore

$ File#casting — Property in class File

$ 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?

AbstractFileIDHelper::cleanFilename() — Method in class AbstractFileIDHelper

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

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.

$ Filesystem#cache_folderModTime — Property in class Filesystem

AssetAdapter::configureServer() — Method in class AssetAdapter

Configure server files for this store

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.

FlysystemAssetStore::createResponseFor() — Method in class FlysystemAssetStore

Generate an {HTTPResponse} for the given file from the source filesystem

FlysystemAssetStore::createDeniedResponse() — Method in class FlysystemAssetStore

Generate a response for requests to a denied protected file

FlysystemAssetStore::createMissingResponse() — Method in class FlysystemAssetStore

Generate a response for missing file requests

FlysystemAssetStore::createErrorResponse() — Method in class FlysystemAssetStore

Create a response with the given error code

GeneratedAssets::checkOrCreate() — Method in class GeneratedAssets

Check if the file exists or that the $callback provided was able to regenerate it.

Folder::ChildFolders() — Method in class Folder

Get the children of this folder that are also folders.

$ ImageBackendFactory#cache — Property in class ImageBackendFactory

In memory cache keyed by hash/variant

$ ImageBackendFactory#creator — Property in class ImageBackendFactory

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

ImageManipulation::Convert() — Method in class ImageManipulation

Convert the file to another format if there's a registered converter that can handle it.

ImageManipulation::castDimension() — Method in class ImageManipulation

Validate a width or size is valid and casts it to integer

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.

InterventionBackend::createCloneWithResource() — Method in class InterventionBackend

Modify this image backend with either a provided resource, or transformation

ImageShortcodeProvider::createImageTag() — Method in class ImageShortcodeProvider

Construct and return HTML image tag.

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#composite_db — Property in class DBFile

$ DBFile#casting — Property in class DBFile

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.

GridFieldCategorisationConfig::changeColumnOrder() — Method in class GridFieldCategorisationConfig

Reorders GridField columns so that Actions is last.

$ GridFieldMergeAction#childMethod — Property in class GridFieldMergeAction

Relationship method to reference child (i.e BlogPosts).

$ Blog#class_description — Property in class Blog

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.

$ BlogController#casting — Property in class BlogController

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#casting — Property in class BlogPost

$ BlogPost#can_be_root — Property in class BlogPost

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}

CategorisationObject — Class in namespace SilverStripe\Blog\Model

$ BlogArchiveWidget#cmsTitle — Property in class BlogArchiveWidget

$ BlogCategoriesWidget#cmsTitle — Property in class BlogCategoriesWidget

$ BlogFeaturedPostsWidget#cmsTitle — Property in class BlogFeaturedPostsWidget

$ BlogRecentPostsWidget#cmsTitle — Property in class BlogRecentPostsWidget

$ BlogTagsCloudWidget#cmsTitle — Property in class BlogTagsCloudWidget

$ BlogTagsWidget#cmsTitle — Property in class BlogTagsWidget

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#casting — Property in class CMSMain

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::canOrganiseTree() — Method in class CMSMain

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

CMSMain::collateDescendants() — Method in class CMSMain

Find IDs of all descendant pages for the provided ID lists.

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"

CMSMain::currentRecordID() — 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#childrenMethod — Property in class CMSSiteTreeFilter

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_DeletedPages#childrenMethod — Property in class CMSSiteTreeFilter_DeletedPages

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_PublishedPages#childrenMethod — Property in class CMSSiteTreeFilter_PublishedPages

CMSSiteTreeFilter_Search — Class in namespace SilverStripe\CMS\Controllers

CMSSiteTreeFilter_StatusDeletedPages — Class in namespace SilverStripe\CMS\Controllers

Filters pages which have a status "Deleted".

$ CMSSiteTreeFilter_StatusDeletedPages#childrenMethod — Property in class CMSSiteTreeFilter_StatusDeletedPages

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

$ ContentController#casting — Property in class ContentController

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 ContentController} for handling a {@link SiteTree object, link it to the object and return it.

$ RootURLController#cached_homepage_link — Property in class RootURLController

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#class_description — Property in class RedirectorPage

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#cms_edit_owner — Property in class SiteTree

The class of the LeftAndMain controller where this class is managed.

$ SiteTree#cascade_deletes — Property in class SiteTree

$ SiteTree#casting — Property in class SiteTree

$ 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#creatableChildrenCache — 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#class_description — Property in class VirtualPage

$ 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 — Property in class SearchForm

Classes to search

$ SearchForm#casting — Property in class SearchForm

SearchForm::classesToSearch() — Method in class SearchForm

Set the classes to search.

$ AddToCampaignHandler#controller — Property in class AddToCampaignHandler

Parent controller for this form

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#cache — Property in class CachedConfigCollection

$ CachedConfigCollection#collection — Property in class CachedConfigCollection

Nested config to delegate to

$ CachedConfigCollection#collectionCreator — Property in class CachedConfigCollection

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

DeltaConfigCollection::clearDeltas() — Method in class DeltaConfigCollection

Remove all deltas for the given class and/or key combination

$ MemoryConfigCollection#config — Property in class MemoryConfigCollection

Stores a list of key/value config prior to middleware being applied

$ MemoryConfigCollection#callCache — Property in class MemoryConfigCollection

Call cache for non-trivial config calls including middleware

MemoryConfigCollection::create() — Method in class MemoryConfigCollection

MemoryConfigCollection::checkForDeprecatedConfig() — Method in class MemoryConfigCollection

$ DeltaMiddleware#collection — Property in class DeltaMiddleware

Source for deltas

MiddlewareAware::callMiddleware() — Method in class MiddlewareAware

Call middleware to get decorated class config

$ PrivateStaticTransformer#classes — Property in class PrivateStaticTransformer

YamlTransformer::create() — Method in class YamlTransformer

YamlTransformer::calculateDependencies() — Method in class YamlTransformer

This generates an array of all document depndencies, keyed by document name.

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.

$ ReviewContentHandler#controller — Property in class ReviewContentHandler

Parent controller for this form

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

$ ContentNegotiator#current_enabled — Property in class ContentNegotiator

Controller — Class in namespace SilverStripe\Control

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

$ Controller#controller_stack — Property in class Controller

Stack of current controllers. Controller::$controller_stack[0] is the current controller.

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

$ CookieJar#current — Property in class CookieJar

Hold the current cookies (ie: a mix of those that were sent to us and we have set without the ones we've cleared)

Cookie_Backend — Class in namespace SilverStripe\Control

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

Director::currentRequest() — Method in class Director

Helper to validate or check the current request object

$ Email#cc_all_emails_to — Property in class Email

TransportFactory::create() — Method in class TransportFactory

Creates a new service instance.

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

$ HTTPStreamResponse#consumed — Property in class HTTPStreamResponse

Set to true if this stream has been consumed.

HTTPStreamResponse::consumeStream() — Method in class HTTPStreamResponse

Safely consume the stream

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#confirmationId — Property in class ConfirmationMiddleware

The confirmation storage identifier

$ ConfirmationMiddleware#confirmationFormUrl — Property in class ConfirmationMiddleware

Confirmation form URL WARNING: excluding SS_BASE_URL

ConfirmationMiddleware::canBypass() — Method in class ConfirmationMiddleware

Check whether the rules can be bypassed without user confirmation

ConfirmationMiddleware::confirmedEffect() — Method in class ConfirmationMiddleware

The middleware own effects that should be performed on 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::checkRequestHasParameter() — Method in class GetParameter

Check request contains the GET parameter

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

Url::checkPath() — Method in class Url

Checks the given path by the rules and returns true if it is matching

UrlPathStartswith::checkPath() — Method in class UrlPathStartswith

Checks the given path by the rules and returns whether it should be protected

UrlPathStartswith::checkRequestForBypass() — Method in class UrlPathStartswith

Check the request for whether we can bypass the confirmation

UrlPathStartswithCaseInsensitive::checkPath() — Method in class UrlPathStartswithCaseInsensitive

Checks the given path by the rules and returns whether it should be protected

HTTPCacheControlMiddleware::combineVary() — Method in class HTTPCacheControlMiddleware

Combine vary strings/arrays into a single array, or normalise a single vary

HTTPMiddlewareAware::callMiddleware() — Method in class HTTPMiddlewareAware

Call middleware

URLSpecialsMiddleware::confirmedEffect() — Method in class URLSpecialsMiddleware

The middleware own effects that should be performed on confirmation

$ PjaxResponseNegotiator#callbacks — Property in class PjaxResponseNegotiator

See respond()

$ RSSFeed#casting — Property in class RSSFeed

Casting information for this object's methods.

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#changedData — Property in class Session

List of keys changed. This is a nested array which represents the keys modified in $this->data. The value of each item is either "true" or a nested array.

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.

$ BaseKernel#container — Property in class BaseKernel

$ BaseKernel#classLoader — Property in class BaseKernel

$ BaseKernel#configLoader — Property in class BaseKernel

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

DefaultCacheFactory::createCache() — Method in class DefaultCacheFactory

Creates an object with a PSR-16 interface, usually from a PSR-6 class name

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

$ Config_ForClass#class — Property in class Config_ForClass

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#cacheFactory — Property in class CoreConfigFactory

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#configLocator — Property in class Injector

Locator for determining Config properties for services

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

$ SilverStripeServiceConfigurationLocator#configs — Property in class SilverStripeServiceConfigurationLocator

List of Injector configurations cached from Config in class => config format.

SilverStripeServiceConfigurationLocator::configFor() — Method in class SilverStripeServiceConfigurationLocator

Retrieves the config for a named service without performing a hierarchy walk

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.

$ ClassManifest#cacheFactory — Property in class ClassManifest

Used to build cache during boot

$ ClassManifest#cache — Property in class ClassManifest

Cache to use, if caching.

$ ClassManifest#cacheKey — Property in class ClassManifest

Key to use for the top level cache of all items

$ ClassManifest#classes — Property in class ClassManifest

Map of lowercase class names to paths

$ ClassManifest#classNames — Property in class ClassManifest

Map of lowercase class names to case-correct names

$ ClassManifest#children — Property in class ClassManifest

List of direct children for any class.

ClassManifest::coalesceDescendants() — Method in class ClassManifest

Recursively coalesces direct child information into full descendant information.

ClassManifestErrorHandler — Class in namespace SilverStripe\Core\Manifest

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

ClassManifestVisitor — Class in namespace SilverStripe\Core\Manifest

$ Module#composerData — Property in class Module

Cache of composer data

ModuleLoader::countManifests() — Method in class ModuleLoader

Check number of manifests

$ ModuleManifest#cacheKey — Property in class ModuleManifest

A string to prepend to all cache keys to ensure all keys are unique to just this $base

$ ModuleManifest#cacheFactory — Property in class ModuleManifest

Factory to use to build cache

$ ModuleManifest#cache — Property in class ModuleManifest

CallbackFlushDiscoverer — Class in namespace SilverStripe\Core\Startup

Handle a callable object as a discoverer

$ CallbackFlushDiscoverer#callback — Property in class CallbackFlushDiscoverer

Callback incapsulating the discovery logic

CompositeFlushDiscoverer — Class in namespace SilverStripe\Core\Startup

Implements the composite over flush discoverers

ConstraintValidator — Class in namespace SilverStripe\Core\Validation

Helper class to abstract away wiring up symfony/validator and getting ValidationResult from validating symfony validator constraints.

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#created — Property in class BulkLoader_Result

Stores a map of ID and ClassNames which can be reconstructed to DataObjects.

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.

SSListContains::checkIfItemEvaluatesRemainingMatches() — Method in class SSListContains

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

DevBuildController::canInit() — Method in class DevBuildController

DevConfigController::canInit() — Method in class DevConfigController

DevelopmentAdmin::canViewAll() — Method in class DevelopmentAdmin

$ FixtureBlueprint#class — Property in class FixtureBlueprint

$ FixtureBlueprint#callbacks — Property in class FixtureBlueprint

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 createObject() or createRaw(), both from the internal fixture mapping and the database.

$ FunctionalTest#cssParser — Property in class FunctionalTest

CSSContentParser for the most recently requested page.

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::createConnection() — Method in class MySQLDatabaseConfigurationHelper

Create a connection of the appropriate type

MySQLDatabaseConfigurationHelper::column() — Method in class MySQLDatabaseConfigurationHelper

Helper function to quickly extract a column from a mysqi_result

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#cache_generatedMembers — Property in class SapphireTest

Cache for logInWithPermission()

SapphireTest::currentTestEnablesDatabase() — Method in class SapphireTest

Helper method to check, if the current test uses the database.

SapphireTest::currentTestDisablesDatabase() — Method in class SapphireTest

Helper method to check, if the current test uses the database.

SapphireTest::clearFixtures() — Method in class SapphireTest

Clear all fixtures which were previously loaded through loadFixture()

SapphireTest::clearEmails() — Method in class SapphireTest

Clear the log of emails sent

SapphireTest::createMemberWithPermission() — Method in class SapphireTest

Create Member and Group objects on demand with specific permission code

SapphireTest::createInvalidArgumentException() — Method in class SapphireTest

Reimplementation of phpunit5 PHPUnit_Util_InvalidArgumentHelper::factory()

$ TaskRunner#css — Property in class TaskRunner

TaskRunner::canViewAllTasks() — Method in class TaskRunner

TaskRunner::canInit() — Method in class TaskRunner

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.

CleanupTestDatabasesTask::canView() — Method in class CleanupTestDatabasesTask

TestMailer::createData() — Method in class TestMailer

TestMailer::clearEmails() — Method in class TestMailer

Clear the log of emails sent

$ TestSession#controller — Property in class TestSession

Necessary to use the mock session created in session in the normal controller stack, e.g. to overwrite Security::getCurrentUser() with custom login data.

TestSession::cssParser() — Method in class TestSession

Return a CSSContentParser containing the most recent response

RelationValidationService::clearErrors() — Method in class RelationValidationService

$ ServiceConnector#chosenFolderID — Property in class ServiceConnector

$ DynamoDbSession#client — Property in class DynamoDbSession

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#checkTable — Property in class DatabaseCheck

DatabaseCheck::check() — Method in class DatabaseCheck

EnvTypeCheck::check() — Method in class EnvTypeCheck

Check the environment setting.

ExternalURLCheck::check() — Method in class ExternalURLCheck

$ FileAccessibilityAndValidationCheck#checkType — Property in class FileAccessibilityAndValidationCheck

Constant, check for a single file to match age criteria, or all of them.

FileAccessibilityAndValidationCheck::check() — Method in class FileAccessibilityAndValidationCheck

$ FileAgeCheck#checkFn — Property in class FileAgeCheck

The function to use for checking file age: so filemtime(), filectime(), or fileatime().

$ FileAgeCheck#checkType — Property in class FileAgeCheck

Constant, check for a single file to match age criteria, or all of them.

$ FileAgeCheck#compareOperand — Property in class FileAgeCheck

Type of comparison (either > or <).

FileAgeCheck::check() — Method in class FileAgeCheck

FileWriteableCheck::check() — Method in class FileWriteableCheck

$ HasClassCheck#className — Property in class HasClassCheck

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

$ EnvironmentCheckSuite#checks — Property in class EnvironmentCheckSuite

EnvironmentCheckSuite::checkInstances() — Method in class EnvironmentCheckSuite

Get instances of all the environment checks.

$ EnvironmentChecker#checkSuiteName — Property in class EnvironmentChecker

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#class_description — Property in class ErrorPage

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

CheckExternalLinksTask::checkPageLink() — Method in class CheckExternalLinksTask

Check the status of a single link on a page

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#children — Property in class CompositeField

$ CompositeField#columnCount — Property in class CompositeField

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 when entering the password for the first time If this is set to true then a random password may be generated if the field is empty depending on the value of $ConfirmedPasswordField::generateRandomPasswordOnEmtpy

$ ConfirmedPasswordField#confirmValue — Property in class ConfirmedPasswordField

A place to temporarily store the confirm password value

$ ConfirmedPasswordField#currentPasswordValue — Property in class ConfirmedPasswordField

Store value of "Current Password" field

$ ConfirmedPasswordField#children — Property in class ConfirmedPasswordField

Child fields (_Password, _ConfirmPassword)

$ ConfirmedPasswordField#confirmPasswordfield — Property in class ConfirmedPasswordField

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

CurrencyField_Readonly — Class in namespace SilverStripe\Forms

Readonly version of a CurrencyField.

$ FieldList#containerField — Property in class FieldList

If this fieldlist is owned by a parent field (e.g. CompositeField) this is the parent field.

FieldList::changeFieldOrder() — Method in class FieldList

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

FieldsValidator::canBeCached() — Method in class FieldsValidator

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

FileUploadReceiver::constructFileUploadReceiver() — Method in class FileUploadReceiver

$ Form#controller — Property in class Form

Parent (optional) request handler

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

Form::canBeCached() — Method in class Form

Can the body of this form be cached?

$ FormAction#casting — Property in class FormAction

$ FormField#containerFieldList — Property in class FormField

Stores a reference to the FieldList that contains this object.

$ FormField#customValidationMessage — Property in class FormField

Custom validation message for the field.

$ FormField#casting — Property in class FormField

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

FormRequestHandler::checkFieldsForAction() — Method in class FormRequestHandler

Fields can have action to, let's check if anyone of the responds to $funcname them

$ GridField#config — Property in class GridField

$ GridField#components — Property in class GridField

Components list.

$ GridField#columnDispatch — Property in class GridField

Internal dispatcher for column handlers.

$ GridField#customDataFields — Property in class GridField

Map of callbacks for custom data fields.

$ GridFieldConfig#components — Property in class GridFieldConfig

GridFieldDataColumns::castValue() — Method in class GridFieldDataColumns

Casts a field to a string which is safe to insert into HTML

$ GridFieldDetailForm_ItemRequest#component — Property in class GridFieldDetailForm_ItemRequest

$ GridFieldExportButton#csvSeparator — Property in class GridFieldExportButton

$ GridFieldExportButton#csvEnclosure — Property in class GridFieldExportButton

$ GridFieldExportButton#csvHasHeader — Property in class GridFieldExportButton

GridFieldFilterHeader::checkDataType() — Method in class GridFieldFilterHeader

Check that this dataList is of the right data type.

GridFieldFilterHeader::canFilterAnyColumns() — Method in class GridFieldFilterHeader

Returns whether this GridField has any columns to filter on at all

GridFieldGroupDeleteAction::canUnlink() — Method in class GridFieldGroupDeleteAction

$ GridFieldLevelup#currentID — Property in class GridFieldLevelup

GridFieldPaginator::checkDataType() — Method in class GridFieldPaginator

Check that this dataList is of the right data type.

GridFieldSortableHeader::checkDataType() — Method in class GridFieldSortableHeader

Check that this dataList is of the right data type.

$ HTMLEditorConfig#configs — Property in class HTMLEditorConfig

Array of registered configurations

$ HTMLEditorConfig#current — Property in class HTMLEditorConfig

Identifier key of current config. This will match an array key in $configs.

$ HTMLEditorConfig#current_themes — Property in class HTMLEditorConfig

List of the current themes set for this config

$ HTMLEditorField#casting — Property in class HTMLEditorField

$ HTMLEditorField_Readonly#casting — Property in class HTMLEditorField_Readonly

TinyMCECombinedGenerator::checkName() — Method in class TinyMCECombinedGenerator

Check if this config is registered under a given key

$ TinyMCEConfig#contentCSS — Property in class TinyMCEConfig

List of content css files to use for this instance, or null to default to editor_css config.

$ HTMLReadonlyField#casting — Property in class HTMLReadonlyField

$ LiteralField#casting — Property in class LiteralField

$ LiteralField#content — Property in class LiteralField

MultiSelectField::csvEncode() — Method in class MultiSelectField

Encode a list of values into a string as a comma separated list.

MultiSelectField::csvDecode() — Method in class MultiSelectField

Decode a list of values from a comma separated string.

NumericField::cast() — Method in class NumericField

Helper to cast non-localised strings to their native type

$ PopoverField#cast — Property in class PopoverField

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. The logic tries to retain all of the instance properties, and may be overloaded by subclasses to set additional ones.

SingleSelectField::castedCopy() — Method in class SingleSelectField

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.

TabSet::changeTabOrder() — Method in class TabSet

Change the order of tabs which are direct children of this TabSet by specifying an ordered list of tab names.

$ TextareaField#casting — Property in class TextareaField

Value should be XML

$ TextareaField#cols — Property in class TextareaField

Visible number of text columns.

$ TreeDropdownField#childrenMethod — Property in class TreeDropdownField

Default child method in Hierarchy->getChildrenAsUL

$ TreeDropdownField#cacheKeyCache — Property in class TreeDropdownField

TreeDropdownField::castedCopy() — Method in class TreeDropdownField

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.

UploadReceiver::constructUploadReceiver() — Method in class UploadReceiver

Bootstrap Uploadable field

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

$ Controller#corsConfig — Property in class Controller

Override the default cors config per instance

DevelopmentAdmin::canInit() — Method in class DevelopmentAdmin

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

$ HTTPProvider#client — Property in class HTTPProvider

QueryHandler::callMiddleware() — Method in class QueryHandler

Call middleware to evaluate a graphql query

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#csvSeparator — Property in class GridFieldQueuedExportButton

$ GridFieldQueuedExportButton#csvHasHeader — Property in class GridFieldQueuedExportButton

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#crypto — Property in class CookieStore

Encryption service

$ CookieStore#cookie — Property in class CookieStore

Name of cookie

$ CookieStore#currentCookieData — Property in class CookieStore

Known unmodified value of this cookie. If the cookie backend has been read into the application, then the backend is unable to verify the modification state of this value internally within the system, so this will be left null unless written back.

CookieStore::close() — Method in class CookieStore

CookieStore::canWrite() — Method in class CookieStore

Determine if the session could be verifiably written to cookie storage

DatabaseStore::close() — Method in class DatabaseStore

$ IFramePage#class_description — Property in class IFramePage

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.

Link::canView() — Method in class Link

Link::canEdit() — Method in class Link

Link::canDelete() — Method in class Link

Link::canCreate() — Method in class Link

Link::can() — Method in class Link

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

$ GorriecoeMigrationTask#chunk_size — Property in class GorriecoeMigrationTask

The number of links to process at once, for operations that operate on each link individually.

$ LinkableMigrationTask#chunk_size — Property in class LinkableMigrationTask

The number of links to process at once, for operations that operate on each link individually.

$ MigrationTaskTrait#classes_that_are_not_link_owners — Property in class MigrationTaskTrait

Classes which should be skipped when finding owners of links.

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

BaseHandlerTrait::createStore() — Method in class BaseHandlerTrait

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.

VerificationHandlerTrait::createStartVerificationResponse() — Method in class VerificationHandlerTrait

Create an HTTPResponse that provides information to the client side React MFA app to prompt the user to login with their configured MFA method

VerificationHandlerTrait::completeVerificationRequest() — Method in class VerificationHandlerTrait

Attempt to verify a login attempt provided by the given request

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

$ BackupCode#code — Property in class BackupCode

$ Result#context — Property in class Result

Context provided by the handler returning this result

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::convertIndexSpec() — Method in class DBSchemaManager

This takes the index spec which has been provided by a class (ie static $indexes = blah blah) and turns it into a proper string.

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#connector — Property in class Database

Database connector object

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

$ MySQLQuery#columns — Property in class MySQLQuery

Metadata about the columns of this query

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.

$ MySQLStatement#columns — Property in class MySQLStatement

List of column names

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.

$ NestedTransactionManager#child — Property in class NestedTransactionManager

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#connections — Property in class DB

The global database connection.

$ DB#configs — Property in class DB

List of configurations for each connection

$ DB#connection_attempted — Property in class DB

Internal flag to keep track of when db connection was attempted.

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#class_description — Property in class DataObject

Description of the class.

$ DataObject#components — Property in class DataObject

Non-static relationship cache, indexed by component name.

$ 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#cascade_duplicates — Property in class DataObject

List of relations that should be cascade duplicate.

$ DataObject#casting — Property in class DataObject

Use a casting object for a field. This is a map from field name to class name of the casting object.

$ 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::classDescription() — Method in class DataObject

Get description for this class

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#compositeFields — Property in class DataObjectSchema

Cache of composite database field

DataObjectSchema::cacheTableNames() — Method in class DataObjectSchema

Cache all table names if necessary

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::cacheDatabaseFields() — Method in class DataObjectSchema

Cache all database and composite fields for the given class.

DataObjectSchema::cacheDatabaseIndexes() — Method in class DataObjectSchema

Cache all indexes for the given class. Will do nothing if already cached.

DataObjectSchema::cacheDefaultDatabaseIndexes() — Method in class DataObjectSchema

Get "default" database indexable field types

DataObjectSchema::classForField() — Method in class DataObjectSchema

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

DataObjectSchema::checkManyManyFieldClass() — Method in class DataObjectSchema

Validate the to or from field on a has_many mapping class

DataObjectSchema::checkManyManyJoinClass() — Method in class DataObjectSchema

DataObjectSchema::checkRelationClass() — Method in class DataObjectSchema

Validate a given class is valid for a relation

$ DataQuery#collidingFields — Property in class DataQuery

Map of all field names to an array of conflicting column SQL

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#classname_value_remapping — Property in class DatabaseAdmin

Obsolete classname values that should be remapped in dev/build

DatabaseAdmin::canInit() — Method in class DatabaseAdmin

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.

EagerLoadedList::column() — Method in class EagerLoadedList

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

EagerLoadedList::columnUnique() — Method in class EagerLoadedList

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

EagerLoadedList::count() — Method in class EagerLoadedList

EagerLoadedList::canFilterBy() — Method in class EagerLoadedList

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

EagerLoadedList::canSortBy() — Method in class EagerLoadedList

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

EagerLoadedList::createDataObject() — Method in class EagerLoadedList

Create a DataObject from the given SQL row.

$ DBComposite#composite_db — Property in class DBComposite

Similar to DataObject::$db, holds an array of composite field names.

DBComposite::compositeDatabaseFields() — Method in class DBComposite

Return array in the format of $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 Now() to return the current system date.

$ DBField#casting — Property in class DBField

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#casting — Property in class DBHTMLText

DBHTMLText::CDATA() — Method in class DBHTMLText

Safely escape for XML string

$ DBHTMLVarchar#casting — Property in class DBHTMLVarchar

DBHTMLVarchar::CDATA() — Method in class DBHTMLVarchar

Safely escape for XML string

$ DBMoney#composite_db — Property in class DBMoney

$ DBPolymorphicForeignKey#composite_db — Property in class DBPolymorphicForeignKey

$ DBPolymorphicRelationAwareForeignKey#composite_db — Property in class DBPolymorphicRelationAwareForeignKey

$ DBString#casting — Property in class DBString

$ DBText#casting — Property in class DBText

DBText::ContextSummary() — Method in class DBText

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

$ DBVarchar#casting — Property in class DBVarchar

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

SearchFilterable::createSearchFilter() — Method in class SearchFilterable

Given a filter expression and value construct a {SearchFilter} instance

$ Hierarchy#cache_numChildren — Property in class Hierarchy

A cache used by numChildren().

Hierarchy::Children() — Method in class Hierarchy

Get the children for this DataObject filtered by canView()

$ MarkedSet#childrenMethod — Property in class MarkedSet

Method to use for getting children. Defaults to 'AllChildrenIncludingDeleted'

MarkedSet::clearMarks() — Method in class MarkedSet

Reset marked nodes

ListDecorator::Count() — Method in class ListDecorator

ListDecorator::column() — Method in class ListDecorator

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

ListDecorator::columnUnique() — Method in class ListDecorator

ListDecorator::canSortBy() — Method in class ListDecorator

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

ListDecorator::canFilterBy() — Method in class ListDecorator

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

ManyManyList::createDataObject() — Method in class ManyManyList

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

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 Map::push()} and {@link Map::unshift.

PaginatedList::CurrentPage() — Method in class PaginatedList

$ PolymorphicHasManyList#classForeignKey — Property in class PolymorphicHasManyList

Name of foreign key field that references the class name of the relation

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

$ SQLConditionalExpression#connective — Property in class SQLConditionalExpression

The logical connective used to join WHERE clauses. Defaults to AND.

SQLDelete::create() — Method in class SQLDelete

Construct a new SQLDelete.

SQLExpression::copyTo() — Method in class SQLExpression

Copies the query parameters contained in this object to another SQLExpression

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.

$ RegistryImportFeedEntry#casting — Property in class RegistryImportFeedEntry

$ RegistryPage#class_description — Property in class RegistryPage

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

$ SideReportView#controller — Property in class SideReportView

SideReportWrapper::columns() — Method in class SideReportWrapper

$ DataFormatter#customFields — Property in class DataFormatter

Allows overriding of the fields which are rendered for the processed dataobjects. By default, this includes all fields in DataObject::inheritedDatabaseFields().

$ DataFormatter#customAddFields — Property in class DataFormatter

Allows addition of fields (e.g. custom getters on a DataObject)

$ DataFormatter#customRelations — Property in class DataFormatter

Allows to limit or add relations.

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

XMLDataFormatter::convertDataObjectWithoutHeader() — Method in class XMLDataFormatter

XMLDataFormatter::convertDataObjectSet() — Method in class XMLDataFormatter

Generate an XML representation of the given 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).

BasicAuthMiddleware::checkMatchingURL() — Method in class BasicAuthMiddleware

Check if global basic auth is enabled for the given request

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#cachePermissions — Property in class InheritedPermissions

Cache of permissions

$ InheritedPermissions#cacheService — Property in class InheritedPermissions

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::checkDefaultPermissions() — Method in class InheritedPermissions

Determine default permission for a givion check

InheritedPermissions::clearCache() — Method in class InheritedPermissions

$ InheritedPermissionsExtension#cascade_duplicates — Property in class InheritedPermissionsExtension

$ 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

ChangePasswordHandler::checkPassword() — Method in class ChangePasswordHandler

Check if password is ok

CookieAuthenticationHandler — Class in namespace SilverStripe\Security\MemberAuthenticator

Authenticate a member passed on a session cookie

CookieAuthenticationHandler::clearCookies() — Method in class CookieAuthenticationHandler

Clear the cookies set for the user

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_GroupSet::canAddGroups() — Method in class Member_GroupSet

Determine if the following groups IDs can be added

$ 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 PasswordEncryptor_LegacyPHPHash and PasswordEncryptor_Blowfish

$ PasswordEncryptor_Blowfish#cost — Property in class PasswordEncryptor_Blowfish

Cost of encryption.

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

PasswordExpirationMiddleware::checkForExpiredPassword() — Method in class PasswordExpirationMiddleware

Check if the just authenticated member has the password expired.

$ PasswordValidator#character_strength_tests — Property in class PasswordValidator

$ Permission#cache_permissions — Property in class Permission

Permissions cache. The format is a map, where the keys are member IDs, and the values are arrays of permission codes.

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

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#currentUser — Property in class Security

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

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 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#cache_accessible_sites — Property in class Subsite

Memory cache of accessible sites

$ Subsite#cache_subsite_for_domain — Property in class Subsite

Memory cache of subsite id for domains

$ 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

Subsite::createDefaultPages() — Method in class Subsite

Automatically create default pages for new subsites

$ SubsiteDomain#casting — Property in class SubsiteDomain

$ SubsitesVirtualPage#class_description — Property in class SubsitesVirtualPage

SubsiteReportWrapper::columns() — Method in class SubsiteReportWrapper

$ Method#code_length — Property in class Method

The TOTP code length

$ StringTagField#canCreate — Property in class StringTagField

$ TagField#canCreate — Property in class TagField

$ TaxonomyTerm#casting — Property in class TaxonomyTerm

TaxonomyTerm::canView() — Method in class TaxonomyTerm

TaxonomyTerm::canEdit() — Method in class TaxonomyTerm

TaxonomyTerm::canDelete() — Method in class TaxonomyTerm

TaxonomyTerm::canCreate() — 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

PDFTextExtractor::cleanupLigatures() — Method in class PDFTextExtractor

Removes utf-8 ligatures.

$ TikaServerTextExtractor#client — Property in class TikaServerTextExtractor

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#cascade_deletes — Property in class UserFormFieldEditorExtension

UserFormFieldEditorExtension::createInitialFormStep() — Method in class UserFormFieldEditorExtension

A UserForm must have at least one step.

UserFormsFieldList::clearEmptySteps() — Method in class UserFormsFieldList

Remove all empty steps

$ UserFormsStepField#casting — Property in class UserFormsStepField

$ UserFormsGridFieldFilterHeader#columns — Property in class UserFormsGridFieldFilterHeader

A map of name => value of columns from all submissions

$ EditableCustomRule#condition_options — Property in class EditableCustomRule

$ 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#cascade_deletes — Property in class EditableFormField

$ EditableFormField#cascade_duplicates — Property in class EditableFormField

$ 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

$ EditableFieldGroup#cascade_deletes — Property in class EditableFieldGroup

EditableFileField::createProtectedFolder() — Method in class EditableFileField

$ EditableLiteralField#Content — Property in class EditableLiteralField

$ EditableMultipleOptionField#cascade_deletes — Property in class EditableMultipleOptionField

$ EditableMultipleOptionField#cascade_duplicates — Property in class EditableMultipleOptionField

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#cascade_deletes — Property in class EmailRecipient

$ EmailRecipient#cascade_duplicates — Property in class EmailRecipient

$ 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

$ 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

$ SubmittedFileField#cascade_deletes — Property in class SubmittedFileField

$ SubmittedForm#cascade_deletes — Property in class SubmittedForm

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

$ UserDefinedForm#class_description — Property in class UserDefinedForm

$ UserDefinedForm#controller_name — Property in class UserDefinedForm

$ UserForm#cascade_deletes — Property in class UserForm

$ UserForm#cascade_duplicates — Property in class UserForm

$ 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#contentFilter — Property in class VersionFeedController

Content handler

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 HistoryViewerField to display the history for a DataObject} that has the {@link Versioned extension.

HistoryViewerController::compareForm() — Method in class HistoryViewerController

$ DiffField#comparisonField — Property in class DiffField

$ HistoryViewerField#contextKey — Property in class HistoryViewerField

Unique context key used to differentiate the different use cases for HistoryViewer

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#containerClass — Property in class ProxyCacheFactory

Class name of a psr-16 cache

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#casting — Property in class ChangeSet

ChangeSet::calculateImplicit() — Method in class ChangeSet

List of all implicit items inferred from all currently assigned explicit changes

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

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

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

AbstractPublishOperationCreator::createOperationName() — 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

PublishCreator::createOperationName() — Method in class PublishCreator

RollbackCreator::createOperation() — Method in class RollbackCreator

UnpublishCreator::createOperationName() — Method in class UnpublishCreator

$ Versioned#cache_versionnumber — Property in class Versioned

A cache used by get_versionnumber_by_stage().

$ Versioned#casting — Property in class Versioned

Ensure versioned records cast extra fields properly

Versioned::cleanupVersionedOrphans() — Method in class Versioned

Cleanup orphaned records in the _Versions table

Versioned::createDeletedVersion() — Method in class Versioned

Adds a WasDeleted=1 version entry for this record, and records any stages the deletion applies to

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.

$ VersionedGridFieldState#column — Property in class VersionedGridFieldState

VersionedHTTPMiddleware::checkPermissions() — Method in class VersionedHTTPMiddleware

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::customScriptWithAttributes() — 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 Requirements_Backend::clear_combined_files()

$ Requirements_Backend#combinedFilesEnabled — Property in class Requirements_Backend

Whether to combine CSS and JavaScript files

$ Requirements_Backend#combine_in_dev — Property in class Requirements_Backend

Determine if files should be combined automatically on dev mode.

$ Requirements_Backend#css — Property in class Requirements_Backend

Paths to all required CSS files relative to the docroot.

$ Requirements_Backend#customScript — Property in class Requirements_Backend

All custom javascript code that is inserted into the page's HTML

$ Requirements_Backend#customCSS — Property in class Requirements_Backend

All custom CSS rules which are inserted directly at the bottom of the HTML <head> tag

$ Requirements_Backend#customHeadTags — Property in class Requirements_Backend

All custom HTML markup which is added before the closing <head> tag, e.g. additional metatags.

$ Requirements_Backend#combinedFiles — Property in class Requirements_Backend

A list of combined files registered via combine_files(). Keys are the output file names, values are lists of input files.

$ Requirements_Backend#combinedFilesFolder — Property in class Requirements_Backend

Where to save combined files. By default they're placed in assets/_combinedfiles, however this may be an issue depending on your setup, especially for CSS files which often contain relative paths.

$ 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::customScriptWithAttributes() — 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#closedBlocks — Property in class SSTemplateParser

Stores the user-supplied closed block extension rules in the form: [ 'name' => function (&$res) {} ] See SSTemplateParser::ClosedBlock_Handle_Loop for an example of what the callable should look like

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#current_themes — Property in class SSViewer

Overridden value of $themes config

$ SSViewer#current_rewrite_hash_links — Property in class SSViewer

Overridden value of rewrite_hash_links config

$ SSViewer#chosen — Property in class SSViewer

Absolute path to chosen template file

SSViewer::chooseTemplate() — Method in class SSViewer

Find the template to use for a given list

SSViewer_DataPresenter::cacheGlobalProperties() — Method in class SSViewer_DataPresenter

Build cache of global properties

SSViewer_DataPresenter::cacheIteratorProperties() — Method in class SSViewer_DataPresenter

Build cache of global iterator properties

SSViewer_DataPresenter::castValue() — Method in class SSViewer_DataPresenter

Ensure the value is cast safely

$ SSViewer_FromString#cache_template — Property in class SSViewer_FromString

The global template caching behaviour if no instance override is specified

$ SSViewer_FromString#content — Property in class SSViewer_FromString

The template to use

$ SSViewer_FromString#cacheTemplate — Property in class SSViewer_FromString

Indicates whether templates should be cached

TemplateParser::compileString() — Method in class TemplateParser

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

$ ThemeManifest#cache — Property in class ThemeManifest

Cache

$ ThemeManifest#cacheKey — Property in class ThemeManifest

Cache key

$ ThemeManifest#cacheFactory — Property in class ThemeManifest

$ ThemeResourceLoader#cache — Property in class ThemeResourceLoader

$ 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#casting_cache — Property in class ViewableData

$ ViewableData#customisedObject — Property in class ViewableData

ViewableData::customise() — Method in class ViewableData

Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.

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 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#customised — Property in class ViewableData_Customised

ViewableData_Customised::cachedCall() — Method in class ViewableData_Customised

A simple wrapper around 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#countries — Property in class IntlLocales

Standard list of countries

$ IntlLocales#cache_locales — Property in class IntlLocales

Cache of localised locales, keyed by locale localised in

$ IntlLocales#cache_languages — Property in class IntlLocales

Cache of localised languages, keyed by locale localised in

$ IntlLocales#cache_countries — Property in class IntlLocales

Cache of localised countries, keyed by locale localised in

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

$ Sources#cache_lang_dirs — Property in class Sources

Cache of found lang dirs

$ Sources#cache_lang_files — Property in class Sources

Cache of found lang files

FlushInvalidatedResource::canary() — Method in class FlushInvalidatedResource

Path to i18n canary

$ Parser#currentEntity — Property in class Parser

Current entity

$ Parser#currentEntityKey — Property in class Parser

Key of current entity

$ i18nTextCollector#classModuleCache — Property in class i18nTextCollector

Map of translation keys => module names

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#current_locale — Property in class i18n

This static variable is used to store the current defined locale.

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

$ FrontEndWorkflowController#contextObj — Property in class FrontEndWorkflowController

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::checkTransitions() — Method in class WorkflowInstance

Evaluate all the transitions of an action and determine whether we should follow any of them yet.

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

WorkflowBulkLoader::createImport() — Method in class WorkflowBulkLoader

Create the ImportedWorkflowTemplate record for the uploaded YML file.

$ WorkflowApplicable#currentInstance — Property in class WorkflowApplicable

A cache var for the current workflow instance

WorkflowApplicable::createActionMenu() — Method in class WorkflowApplicable

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

$ AWRequiredFields#caller — Property in class AWRequiredFields

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

WorkflowTemplate::createAction() — Method in class WorkflowTemplate

Create a workflow action based on a template

WorkflowTemplate::createUsers() — Method in class WorkflowTemplate

Create a WorkflowDefinition->Users relation based on template data. But only if the related groups from the export, can be foud in the target environment's DB.

WorkflowTemplate::createGroups() — Method in class WorkflowTemplate

Create a WorkflowDefinition->Groups relation based on template data, But only if the related groups from the export, can be foud in the target environment's DB.

$ GridFieldAddExistingSearchHandler#context — Property in class GridFieldAddExistingSearchHandler

$ GridFieldRequestHandler#component — Property in class GridFieldRequestHandler

KeyValueField::createSelectList() — Method in class KeyValueField

MultiValueDropdownField::createSelectList() — Method in class MultiValueDropdownField

MultiValueTextField::createReadonlyInput() — Method in class MultiValueTextField

MultiValueTextField::createInput() — Method in class MultiValueTextField

$ MultiValueField#composite_db — Property in class MultiValueField

$ MultiValueField#changed — Property in class MultiValueField

MultiValueField::csv() — Method in class MultiValueField

Convert to a textual list of items.

QueuedJobsAdmin::createjob() — Method in class QueuedJobsAdmin

$ QueuedTaskRunner#css — Property in class QueuedTaskRunner

$ QueuedJobDescriptor#casting — Property in class QueuedJobDescriptor

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

GenerateGoogleSitemapJob::completeJob() — Method in class GenerateGoogleSitemapJob

Outputs the completed file to the site's webroot

$ AbstractQueuedJob#currentStep — Property in class AbstractQueuedJob

EmailService::createMissingDefaultJobReport() — Method in class EmailService

EmailService::createStalledJobReport() — Method in class EmailService

EmailService::createBrokenJobsReport() — 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::copyJobToDescriptor() — Method in class QueuedJobService

Copies data from a job into a descriptor for persisting

QueuedJobService::copyDescriptorToJob() — Method in class QueuedJobService

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

$ GroupActionMenu#customTitle — Property in class GroupActionMenu

If set, show a custom header title

$ DetectLocaleMiddleware#cookiesPersisted — Property in class DetectLocaleMiddleware

Whether cookies have already been set during setPersistLocale()

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

DeleteLocalisationPolicy::checkIfBlocked() — Method in class DeleteLocalisationPolicy

Determine if this object has other localisations blocking deletion

DeletePolicyFactory::create() — Method in class DeletePolicyFactory

Creates a new service instance.

$ Locale#chain — Property in class Locale

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.

ConvertTranslatableTask::checkInstalled() — Method in class ConvertTranslatableTask

Checks that fluent is configured correctly

D

$ GridFieldDropdownFilter#defaultOption — Property in class GridFieldDropdownFilter

$ GridFieldRefreshButton#dependencies — Property in class GridFieldRefreshButton

$ Package#db — Property in class Package

$ UpdatePackageInfoTask#dependencies — Property in class UpdatePackageInfoTask

$ ApiLoader#dependencies — Property in class ApiLoader

ApiLoader::doRequest() — Method in class ApiLoader

Perform an HTTP request for module health information

$ CheckComposerUpdatesExtension#dependencies — Property in class CheckComposerUpdatesExtension

$ ComposerUpdateExtension#db — Property in class ComposerUpdateExtension

$ CWPSiteConfigExtension#db — Property in class CWPSiteConfigExtension

$ CarouselPageExtension#db — Property in class CarouselPageExtension

$ CarouselItem#db — Property in class CarouselItem

$ ArchiveHandler#destructive — Property in class ArchiveHandler

Set to true is this handler will destroy any data.

DeleteHandler — Class in namespace Colymba\BulkManager\BulkAction

Bulk action handler for deleting records.

$ DeleteHandler#destructive — Property in class DeleteHandler

Set to true is this handler will destroy any data.

DeleteHandler::delete() — Method in class DeleteHandler

Delete the selected records passed from the delete bulk action.

$ EditHandler#destructive — Property in class EditHandler

Set to true is this handler will destroy any data.

EditHandler::doSave() — Method in class EditHandler

Handles bulkEditForm submission and parses and saves each records data.

$ Handler#destructive — Property in class Handler

Set to true is this handler will destroy any data.

$ PublishHandler#destructive — Property in class PublishHandler

Set to true is this handler will destroy any data.

$ UnPublishHandler#destructive — Property in class UnPublishHandler

Set to true is this handler will destroy any data.

$ UnlinkHandler#destructive — Property in class UnlinkHandler

Set to true is this handler will destroy any data.

$ ElementForm#description — Property in class ElementForm

$ 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#db — Property in class BaseElement

$ BaseElement#default_sort — Property in class BaseElement

$ BaseElement#disable_pretty_anchor_name — Property in class BaseElement

Enable for backwards compatibility

$ BaseElement#displays_title_in_template — Property in class BaseElement

Display a show title button

$ ElementContent#db — Property in class ElementContent

$ ElementContent#description — Property in class ElementContent

$ ElementalArea#db — Property in class ElementalArea

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

$ MigrateContentToElement#description — Property in class MigrateContentToElement

DataExtension — Class in namespace DNADesign\Elemental\TopPage

Class DataExtension

$ FluentExtension#db — Property in class FluentExtension

$ SiteTreeExtension#duplicatedPages — Property in class SiteTreeExtension

List of pages currently undergoing duplication

$ SiteTreeExtension#duplicatedObjects — Property in class SiteTreeExtension

List of objects that need to udate their top page reference

$ AdminRootController#default_panel — Property in class AdminRootController

$ LeftAndMain#dependencies — Property in class LeftAndMain

LeftAndMain::delete() — Method in class LeftAndMain

$ SudoModeController#dependencies — Property in class SudoModeController

DeleteAssets — Class in namespace SilverStripe\AssetAdmin\BatchAction

Delete multiple Folder records (and the associated filesystem nodes).

$ FileTypeResolver#dependencies — Property in class FileTypeResolver

$ ImageThumbnailHelper#dependencies — Property in class ImageThumbnailHelper

AssetControlExtension::deleteAll() — Method in class AssetControlExtension

Delete all assets in the tuple list

$ AssetManipulationList#deleted — Property in class AssetManipulationList

List of deleted assets

$ InterventionBackendCacheFlushTask#description — Property in class InterventionBackendCacheFlushTask

$ TestAssetStore#denied_response_code — Property in class TestAssetStore

Enable disclosure of secure assets

$ File#default_sort — Property in class File

$ File#db — Property in class File

$ File#defaults — Property in class File

File::deleteFile() — Method in class File

Delete a file (and all variants).

$ FileFinder#default_options — Property in class FileFinder

The default options that are set on a new finder instance. Options not present in this array cannot be set.

$ FileNameFilter#default_use_transliterator — Property in class FileNameFilter

$ FileNameFilter#default_replacements — Property in class FileNameFilter

$ FileIDHelperResolutionStrategy#dependencies — Property in class FileIDHelperResolutionStrategy

$ 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

FlysystemAssetStore::deleteFromFileStore() — Method in class FlysystemAssetStore

Delete the given file (and any variants) in the given {Filesystem}

$ FolderNameFilter#default_replacements — Property in class FolderNameFilter

$ 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

$ DefaultAssetNameGenerator#directory — Property in class DefaultAssetNameGenerator

E

$ CWPSiteConfigExtension#enable_theme_color_picker — Property in class CWPSiteConfigExtension

Defines if the theme colour picker is enabled in the CMS

$ CarouselItem#extensions — Property in class CarouselItem

EditHandler — Class in namespace Colymba\BulkManager\BulkAction

Bulk action handler for editing records.

EditHandler::escapeFieldName() — Method in class EditHandler

Escape a fieldName with a unique prefix.

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.

$ ElementController#element — Property in class ElementController

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

Used for both:

GET requests to get the FormSchema via getElementForm() called from LeftAndMain::schema()
POST Requests to save the Form. Will be handled by to FormRequestHandler::httpSubmission() /admin/linkfield/elementForm/

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 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#extensions — Property in class BaseElement

$ 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#extensions — Property in 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 Elements() to wrap each element in its' controller, making it easier to access and process form logic and actions stored in ElementController.

ElementTypeReport — Class in namespace DNADesign\Elemental\Reports

ElementsInUseReport — Class in namespace DNADesign\Elemental\Reports

ElementTypeRegistry — Class in namespace DNADesign\Elemental\Services

$ ElementTypeRegistry#elementTypes — Property in class ElementTypeRegistry

$ ReorderElements#element — Property in class ReorderElements

EditorEmailLinkFormFactory — Class in namespace SilverStripe\Admin\Forms

EditorExternalLinkFormFactory — Class in namespace SilverStripe\Admin\Forms

$ LeftAndMain#extra_requirements_javascript — Property in class LeftAndMain

$ LeftAndMain#extra_requirements_i18n — Property in class LeftAndMain

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

$ LeftAndMainFormRequestHandler#extra — Property in class LeftAndMainFormRequestHandler

Extra form identifiers (e.g. ID, OtherID)

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#extensions — Property in class File

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

$ DefaultAssetNameGenerator#extension — Property in class DefaultAssetNameGenerator

Extension (including leading period)

FileHashingService::enableCache() — Method in class FileHashingService

Enable caching of computed hash.

Sha1FileHashingService::enableCache() — Method in class Sha1FileHashingService

Enable caching of computed hash.

$ Upload#errors — Property in class Upload

Processing errors that can be evaluated, e.g. by Form-validation.

$ Upload_Validator#errors — Property in class Upload_Validator

$ GridFieldFormAction#extraAttributes — Property in class GridFieldFormAction

$ Blog#extensions — Property in class Blog

$ BlogPost#extensions — Property in class BlogPost

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 getEditForm() if no record is selected.

$ ContentController#extensions — Property in class ContentController

$ ModelAsController#extensions — Property in class ModelAsController

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#extensions — Property in class SiteTree

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

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

MiddlewareCommon::enabled() — Method in class MiddlewareCommon

Check if this middlware is enabled

YamlTransformer::evaluateConditions() — Method in class YamlTransformer

Evaluate condition against a set of data using the appropriate conjuction for the flag

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

$ CookieJar#existing — Property in class CookieJar

Hold the cookies that were existing at time of instantiation (ie: The ones sent to PHP by the browser)

Email — Class in namespace SilverStripe\Control\Email

HTTPApplication::execute() — Method in class HTTPApplication

Safely boot the application and execute the given main action

$ HTTPRequest#extension — Property in class HTTPRequest

The URL extension (if present)

HTTPRequestBuilder::extractRequestHeaders() — Method in class HTTPRequestBuilder

Takes a $_SERVER data array and extracts HTTP request headers.

$ CanonicalURLMiddleware#enforceTrailingSlashConfig — Property in class CanonicalURLMiddleware

If set, the trailing slash configuration set in Controller::add_trailing_slash is enforced with a redirect.

$ CanonicalURLMiddleware#enforceTrailingSlashConfigIgnorePaths — Property in class CanonicalURLMiddleware

If enforceTrailingSlashConfig is enabled, this is the list of paths that are ignored

$ CanonicalURLMiddleware#enforceTrailingSlashConfigIgnoreUserAgents — Property in class CanonicalURLMiddleware

If enforceTrailingSlashConfig is enabled, this is the list of user agents that are ignored

$ CanonicalURLMiddleware#enabledEnvs — Property in class CanonicalURLMiddleware

Environment variables this middleware is enabled in, or a fixed boolean flag to apply to all environments. cli is disabled unless present here as cli, or set to true to force enabled.

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 — Property in class RSSFeed

Holds the feed entries

$ RSSFeed#etag — Property in class RSSFeed

ETag for the RSS feed (used for client-site caching)

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

$ BaseKernel#enviroment — Property in class BaseKernel

ClassInfo::exists() — Method in class ClassInfo

Returns true if a class or interface name exists.

ExtensionMiddleware — Class in namespace SilverStripe\Core\Config\Middleware

$ CustomMethods#extra_methods — Property in class CustomMethods

Custom method sources

$ CustomMethods#extra_method_registers — Property in class CustomMethods

Name of methods to invoke by defineMethods for this instance

Environment — Class in namespace SilverStripe\Core

Consolidates access and modification of PHP global variables and settings.

$ Environment#env — Property in class Environment

Local overrides for all $_ENV var protected from cross-process operations

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#extension_instances — Property in class Extensible

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 Object::add_extension().

$ ClassManifest#enums — Property in class ClassManifest

Map of lowercase enum names to paths

$ ClassManifest#enumNames — Property in class ClassManifest

Map of lowercase enum names to proper case

ClassManifestVisitor::enterNode() — Method in class ClassManifestVisitor

ModuleResource::exists() — Method in class ModuleResource

Determine if this resource exists

$ RequestFlushDiscoverer#env — Property in class RequestFlushDiscoverer

Environment type (dev, test or live)

$ BuildTask#enabled — Property in class BuildTask

CLI::end_colour() — Method in class CLI

Send control codes for returning to normal colour

$ SSListContains#exporter — Property in class SSListContains

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#exporter — Property in class SSListContainsOnlyMatchingItems

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.

$ DebugView#error_types — Property in class DebugView

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

$ SapphireTest#extra_dataobjects — Property in class SapphireTest

By default, the test database won't contain any DataObjects that have the interface TestOnly.

$ SapphireTest#extra_controllers — Property in class SapphireTest

List of class names of {Controller} objects to register routes for Controllers must implement Link() method

ExtensionTestState — Class in namespace SilverStripe\Dev\State

Manages illegal and required extensions for sapphiretest

$ ExtensionTestState#extensionsToReapply — Property in class ExtensionTestState

$ ExtensionTestState#extensionsToRemove — Property in class ExtensionTestState

$ RelationValidationService#errors — Property in class RelationValidationService

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.

$ EnvironmentChecker#errorCode — Property in class EnvironmentChecker

$ EnvironmentChecker#email_results — Property in class EnvironmentChecker

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 {ErrorPage}-gnostic error handling

ErrorPageFileExtension — Class in namespace SilverStripe\ErrorPage

Decorates {File} with ErrorPage support

$ CheckExternalLinksTask#enabled — Property in class CheckExternalLinksTask

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.

FileUploadReceiver::extractUploadedFileData() — Method in class FileUploadReceiver

Given an array of post variables, extract all temporary file data into an array

$ Form#extraClasses — Property in class Form

List of additional CSS classes for the form tag.

$ Form#encType — Property in class Form

Form::enableSecurityToken() — Method in class Form

Enable SecurityToken protection for this form instance.

Form::extraClass() — Method in class Form

Compiles all CSS-classes.

$ FormField#extraClass — Property in class FormField

$ FormField#extraClasses — Property in class FormField

Extra CSS classes for the FormField container.

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.

FormField::extendValidationResult() — Method in class FormField

Utility method to call an extension hook which allows the result of validate() calls to be adjusted

GridFieldDataColumns::escapeValue() — Method in class GridFieldDataColumns

Remove values from a value using FieldEscape setter

GridFieldDetailForm_ItemRequest::edit() — Method in class GridFieldDetailForm_ItemRequest

$ GridFieldEditButton#extraClass — Property in class GridFieldEditButton

HTML classes to be added to GridField edit buttons

$ GridFieldExportButton#exportColumns — Property in class GridFieldExportButton

$ HTMLEditorField#editorConfig — Property in class HTMLEditorField

ID or instance of editorconfig

$ HTMLEditorSanitiser#elements — Property in class HTMLEditorSanitiser

$ HTMLEditorSanitiser#elementPatterns — Property in class HTMLEditorSanitiser

HTMLEditorSanitiser::elementMatchesRule() — Method in class HTMLEditorSanitiser

Given a DOMElement and an element rule, check if that element passes the rule

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

$ SingleSelectField#emptyString — Property in class SingleSelectField

The title shown for an empty default selection, e.g. "Select...".

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#emptyString — Property in class TreeDropdownField

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

$ AbstractBulkLoader#excludeList — Property in class AbstractBulkLoader

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

$ GridFieldQueuedExportButton#exportColumns — Property in class GridFieldQueuedExportButton

CryptoHandler::encrypt() — Method in class CryptoHandler

OpenSSLCrypto::encrypt() — Method in class OpenSSLCrypto

Encrypt and then sign some cleartext

$ HybridSession#enabled — Property in class HybridSession

True if this session store has been initialised

LDAPService::enabled() — Method in class LDAPService

Checkes whether or not the service is enabled.

EmailLink — Class in namespace SilverStripe\LinkField\Models

A link to an Email address.

$ EmailLink#Email — Property in class EmailLink

ExternalLink — Class in namespace SilverStripe\LinkField\Models

A link to an external URL.

$ ExternalLink#ExternalUrl — Property in class ExternalLink

$ Link#extensions — Property in class Link

ErrorHandler — Class in namespace SilverStripe\Logging

Core error handler for a SilverStripe application

EnablerExtension — Class in namespace SilverStripe\LoginForms

Applies to the {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.

$ EnablerExtension#enable_dark_mode — Property in class EnablerExtension

Lumberjack::excludeSiteTreeClassNames() — Method in class Lumberjack

Excludes any hidden owner subclasses. Note that the returned DataList will be a different instance from the original.

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

ArrayList::excludeAny() — Method in class ArrayList

ArrayList::extractValue() — Method in class ArrayList

Extracts a value from an item in the list, where the item is either an object or array.

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#exclude_models_from_db_checks — Property in class DBSchemaManager

For large databases you can declare a list of DataObject classes which will be excluded from CHECK TABLE and REPAIR TABLE queries during dev/build. Note that the entire inheritance chain for that class will be excluded, including both ancestors and descendants.

DBSchemaManager::explodeColumnString() — Method in class DBSchemaManager

Splits a spec string safely, considering quoted columns, whitespace, and cleaning brackets

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!

Database::escapeColumnKeys() — Method in class Database

Escapes unquoted columns keys in an associative array

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

DataList::excludeAny() — Method in class DataList

DataList::each() — Method in class DataList

DataList::eagerLoad() — Method in class DataList

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::ensureSelectContainsOrderbyColumns() — Method in class DataQuery

Ensure that if a query has an order by clause, those columns are present in the select.

DataQuery::execute() — Method in class DataQuery

Execute the query and return the result as 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)

DataQuery::expressionForField() — Method in class DataQuery

EagerLoadedList — Class in namespace SilverStripe\ORM

Represents an "eager loaded" DataList - i.e. the data has already been fetched from the database for these records and likely for some of their relations.

EagerLoadedList::each() — Method in class EagerLoadedList

EagerLoadedList::exists() — Method in class EagerLoadedList

Returns true if this list has items

EagerLoadedList::exclude() — Method in class EagerLoadedList

EagerLoadedList::excludeAny() — Method in class EagerLoadedList

DBComposite::exists() — Method in class DBComposite

Composite field defaults to exists only if all fields have values

DBDate::explodeDateString() — Method in class DBDate

Attempt to split date string into year, month, day, and timestamp components.

$ DBEnum#enum — Property in class DBEnum

List of enum values

$ DBEnum#enum_cache — Property in class DBEnum

Internal cache for obsolete enum values. The top level keys are the table, each of which contains nested arrays with keys mapped to field names. The values of the lowest level array are the enum values

DBEnum::enumValues() — Method in class DBEnum

Returns the values of this enum as an array, suitable for insertion into a 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#escape_type — Property in class DBHTMLText

DBHTMLText::exists() — Method in class DBHTMLText

(non-PHPdoc)

$ DBHTMLVarchar#escape_type — Property in class DBHTMLVarchar

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

ComparisonFilter::excludeOne() — Method in class ComparisonFilter

Applies a exclusion(inverse) filter to the query Handles SQL escaping for both numeric and string values

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.

ExactMatchFilter::excludeOne() — Method in class ExactMatchFilter

Excludes an exact match (equals) on a field value.

ExactMatchFilter::excludeMany() — Method in class ExactMatchFilter

Excludes an exact match (equals) on a field value against multiple possible values.

FulltextFilter::excludeOne() — Method in class FulltextFilter

Exclude filter criteria from a SQL query with a single value.

PartialMatchFilter::excludeOne() — Method in class PartialMatchFilter

Exclude filter criteria from a SQL query with a single value.

PartialMatchFilter::excludeMany() — Method in class PartialMatchFilter

Exclude filter criteria from a SQL query with an array of values.

SearchFilter::exclude() — Method in class SearchFilter

Exclude filter criteria from a SQL query.

SearchFilter::excludeOne() — Method in class SearchFilter

Exclude filter criteria from a SQL query with a single value.

SearchFilter::excludeMany() — Method in class SearchFilter

Exclude filter criteria from a SQL query with an array of values.

WithinRangeFilter::excludeOne() — Method in class WithinRangeFilter

Exclude filter criteria from a SQL query with a single value.

$ MarkedSet#enableLimiting — Property in class MarkedSet

Enable limiting

$ MarkedSet#expanded — Property in class MarkedSet

Cache of DataObjects' expanded statuses: [ClassName][ID] = bool

ListDecorator::exists() — Method in class ListDecorator

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

ListDecorator::each() — Method in class ListDecorator

ListDecorator::exclude() — Method in class ListDecorator

Exclude the list to not contain items with these characteristics

$ ManyManyList#extraFields — Property in class ManyManyList

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.

Map::extractValue() — Method in class Map

Extracts a value from an item in the list, where the item is either an object or array.

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

FulltextSearchable::enable() — Method in class FulltextSearchable

Enable the default configuration of MySQL full-text searching on the given data classes.

$ UnsavedRelationList#extraFields — Property in class UnsavedRelationList

The extra fields associated with the relation

UnsavedRelationList::extractValue() — Method in class UnsavedRelationList

Extracts a value from an item in the list, where the item is either an object or array.

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

RegistryPageController::escapeSelect() — Method in class RegistryPageController

Safely escape a list of "select" candidates for a query

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

RestfulServer::exceptionThrown() — Method in class RestfulServer

$ 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

$ Group#extensions — Property in class Group

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

Member::encryptPassword() — Method in class Member

Takes a plaintext password (on the Member object) and encrypts it

$ PasswordEncryptor#encryptors — Property in class PasswordEncryptor

PasswordEncryptor::encrypt() — Method in class PasswordEncryptor

Return a string value stored in the Member->Password property.

PasswordEncryptor_Blowfish::encrypt() — Method in class PasswordEncryptor_Blowfish

Return a string value stored in the 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 Member->Password property.

PasswordEncryptor_MySQLOldPassword::encrypt() — Method in class PasswordEncryptor_MySQLOldPassword

Return a string value stored in the Member->Password property.

PasswordEncryptor_MySQLPassword::encrypt() — Method in class PasswordEncryptor_MySQLPassword

Return a string value stored in the Member->Password property.

PasswordEncryptor_None::encrypt() — Method in class PasswordEncryptor_None

Return a string value stored in the Member->Password property.

PasswordEncryptor_PHPHash::encrypt() — Method in class PasswordEncryptor_PHPHash

Return a string value stored in the 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#enabled — Property in class SecurityToken

SecurityToken::enable() — Method in class SecurityToken

Globally enable tokens that have been previously disabled through disable.

ShareDraftController::errorPage() — Method in class ShareDraftController

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

$ SubsitesTreeDropdownField#extraClasses — Property in class SubsitesTreeDropdownField

Extra HTML classes

$ TaxonomyTerm#extensions — Property in class TaxonomyTerm

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 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::End() — 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 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

$ EditableOption#extensions — Property in class EditableOption

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#email_template_directory — Property in class UserForm

$ 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::extendCanPublish() — Method in class Versioned

Versioned::extendCanUnpublish() — Method in class Versioned

Versioned::extendCanArchive() — Method in class Versioned

Versioned::extendCanRevertToLive() — Method in class Versioned

Versioned::extendcanRestoreToDraft() — Method in class Versioned

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

$ ShortcodeParser#error_behavior — Property in class ShortcodeParser

ShortcodeParser::extractTags() — Method in class ShortcodeParser

Look through a string that contains shortcode tags and pull out the locations and details of those tags

Requirements_Backend::escapeReplacement() — Method in class Requirements_Backend

Safely escape a literal string for use in preg_replace replacement

SSViewer::exists() — Method in class SSViewer

SSViewer::execute_template() — Method in class SSViewer

Execute the given template, passing it the given data.

SSViewer::execute_string() — Method in class SSViewer

Execute the evaluated string, passing it the given data.

SSViewer_BasicIteratorSupport::Even() — Method in class SSViewer_BasicIteratorSupport

Return true if this object is an even item in the set.

SSViewer_BasicIteratorSupport::EvenOdd() — Method in class SSViewer_BasicIteratorSupport

Return 'even' or 'odd' if this object is in an even or odd position in the set respectively.

EmbedShortcodeProvider — Class in namespace SilverStripe\View\Shortcodes

Provider for the [embed] shortcode tag used by the embedding service in the HTML Editor field.

EmbedShortcodeProvider::embeddableToHtml() — Method in class EmbedShortcodeProvider

ViewableData::exists() — Method in class ViewableData

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

ViewableData::escapeTypeForField() — Method in class ViewableData

Return the string-format type for the given field.

$ Parser#entities — Property in class Parser

List of all entities

i18n::encode_plurals() — Method in class i18n

Convert CLDR array plural form to | pipe-delimited string.

AssignUsersToWorkflowAction::execute() — Method in class AssignUsersToWorkflowAction

Perform whatever needs to be done for this action. If this action can be considered executed, then return true - if not (ie it needs some user input first), return false and 'execute' will be triggered again at a later point in time after the user has provided more data, either directly or indirectly.

NotifyUsersWorkflowAction::execute() — Method in class NotifyUsersWorkflowAction

PublishItemWorkflowAction::execute() — Method in class PublishItemWorkflowAction

SetPropertyWorkflowAction::execute() — Method in class SetPropertyWorkflowAction

SimpleApprovalWorkflowAction::execute() — Method in class SimpleApprovalWorkflowAction

UnpublishItemWorkflowAction::execute() — Method in class UnpublishItemWorkflowAction

AdvancedWorkflowAdmin::export() — Method in class AdvancedWorkflowAdmin

Spits out an exported version of the selected WorkflowDefinition for download.

$ WorkflowDefinitionExporter#export_filename_prefix — Property in class WorkflowDefinitionExporter

The base filename of the file to the exported

WorkflowDefinitionExporter::export() — Method in class WorkflowDefinitionExporter

Runs the export

WorkflowDefinitionExporter::ExportMetaData() — Method in class WorkflowDefinitionExporter

Generate template vars for metadata

WorkflowAction::execute() — Method in class WorkflowAction

WorkflowInstance::execute() — Method in class WorkflowInstance

Execute this workflow. In rare cases this will actually execute all actions, but typically, it will stop and wait for the user to input something

$ WorkflowTransition#extendedMethodReturn — Property in class WorkflowTransition

WorkflowTransition::extendedRequiredFieldsNotSame() — Method in class WorkflowTransition

$ WorkflowEmbargoExpiryExtension#extendedMethodReturn — Property in class WorkflowEmbargoExpiryExtension

A basic extended validation routine method return format

WorkflowEmbargoExpiryExtension::ensurePublishJob() — Method in class WorkflowEmbargoExpiryExtension

Ensure the existence of a publish job at the specified time

WorkflowEmbargoExpiryExtension::ensureUnPublishJob() — Method in class WorkflowEmbargoExpiryExtension

Ensure the existence of an unpublish job at the specified time

WorkflowEmbargoExpiryExtension::extendedRequiredFieldsEmbargoExpiry() — Method in class WorkflowEmbargoExpiryExtension

This is called in the AWRequiredFields class, this validates whether an Embargo and Expiry are not equal and that Embargo is before Expiry, returning the appropriate message when it fails.

WorkflowFieldItemController::edit() — Method in class WorkflowFieldItemController

ExistingWorkflowException — Class in namespace Symbiote\AdvancedWorkflow\Services

WorkflowService::executeTransition() — Method in class WorkflowService

Given a transition ID, figure out what should happen to the given $subject.

$ GridFieldOrderableRows#extraSortFields — Property in class GridFieldOrderableRows

Extra sort fields to apply before the sort field.

GridFieldOrderableRows::executeReorder() — Method in class GridFieldOrderableRows

MultiValueCheckboxField::ExtraOptions() — Method in class MultiValueCheckboxField

$ QueuedJobDescriptor#Expiry — Property in class QueuedJobDescriptor

QueuedJobDescriptor::execute() — Method in class QueuedJobDescriptor

EmailService — Class in namespace Symbiote\QueuedJobs\Services

Class EmailService

QueuedJobService::enableMaintenanceLock() — Method in class QueuedJobService

FluentDirectorExtension::encodeRoutePrefix() — Method in class FluentDirectorExtension

Safely encode urls

FluentExtension::existsInLocale() — Method in class FluentExtension

Check if this record exists (in either state) in this locale

FluentVersionedExtension::existsInLocale() — Method in class FluentVersionedExtension

Check if this record exists (in either state) in this locale

Exception — Class in namespace TractorCow\Fluent\Task\ConvertTranslatableTask

$ InitialDataObjectLocalisationTask#exclude_classes — Property in class InitialDataObjectLocalisationTask

When extending this class, you may choose to exclude these specific classes.

$ InitialPageLocalisationTask#exclude_classes — Property in class InitialPageLocalisationTask

F

$ GridFieldDropdownFilter#filterOptions — Property in class GridFieldDropdownFilter

UpdateChecker::findLatestPackage() — Method in class UpdateChecker

Given a package, this finds the latest package matching it

CWPSiteConfigExtension::FavIcon() — Method in class CWPSiteConfigExtension

CWPSiteConfigExtension::FooterLogo() — Method in class CWPSiteConfigExtension

CWPSiteConfigExtension::FooterLogoRetina() — Method in class CWPSiteConfigExtension

CWPSiteConfigExtension::FooterLogoSecondary() — Method in class CWPSiteConfigExtension

FontPickerField — Class in namespace CWP\AgencyExtensions\Forms

$ HTTPBulkToolsResponse#failedRecords — Property in class HTTPBulkToolsResponse

List of DataObject IDs that failed to be modified by the bulk action

$ HTTPBulkToolsResponse#failedClasses — Property in class HTTPBulkToolsResponse

List of css classes to add to gridfield row with errors

ElementFormController::Form() — Method in class ElementFormController

ElementFormController::finished() — Method in class ElementFormController

ElementForm::Form() — Method in class ElementForm

ElementController::forTemplate() — Method in class ElementController

Renders the managed BaseElement wrapped with the current ElementController.

ElementalAreaController::formAction() — Method in class ElementalAreaController

Provides action control for form fields that are request handlers when they're used in an in-line edit form.

ElementalAreaField::FieldHolder() — Method in class ElementalAreaField

Overloaded to skip GridField implementation - this is copied from FormField.

$ BaseElement#fields_excluded_from_cms_search — Property in class BaseElement

List of fields to exclude from CMS SiteTree seatch

BaseElement::forTemplate() — Method in class BaseElement

Default way to render element in templates. Note that all blocks should be rendered through their ElementController class as this contains the holder styles.

BaseElement::First() — Method in class BaseElement

ElementalArea::forTemplate() — Method in class ElementalArea

FluentExtension — Class in namespace DNADesign\Elemental\TopPage

Class FluentExtension

$ LeftAndMain#frame_options — Property in class LeftAndMain

Value of X-Frame-Options header

AssetAdmin::fileEditForm() — Method in class AssetAdmin

Get file edit form

AssetAdmin::fileInsertForm() — Method in class AssetAdmin

Get file insert media form

AssetAdmin::fileEditorLinkForm() — Method in class AssetAdmin

Get the file insert link form

AssetAdmin::fileSelectForm() — Method in class AssetAdmin

Get form for selecting a file

AssetAdmin::fileHistoryForm() — Method in class AssetAdmin

Get file history form

AssetAdmin::folderCreateForm() — Method in class AssetAdmin

AssetAdmin::fileSearchForm() — Method in class AssetAdmin

Scaffold a search form.

FileFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms

FileHistoryFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms

FileSearchFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms

Scaffolds a form for searching files

FolderCreateFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms

FolderFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms

Empty form factory, because the defaults from AssetFormFactory was enough

$ RemoteFileFormFactory#fileurl_scheme_whitelist — Property in class RemoteFileFormFactory

Force whitelist for resource protocols to the given list.

$ RemoteFileFormFactory#fileurl_scheme_blacklist — Property in class RemoteFileFormFactory

Blacklist of resources. Takes priority over whitelists if both are provided.

$ RemoteFileFormFactory#fileurl_domain_whitelist — Property in class RemoteFileFormFactory

Force whitelist for resource domains to the given list

$ RemoteFileFormFactory#fileurl_domain_blacklist — Property in class RemoteFileFormFactory

Blacklist of domains. For example, live sites should probably include 'localhost' and other protected urls.

$ RemoteFileFormFactory#fileurl_port_whitelist — Property in class RemoteFileFormFactory

Whitelist of ports allowed.

$ RemoteFileFormFactory#fileurl_port_blacklist — Property in class RemoteFileFormFactory

Blacklist of ports allowed.

FileFilter — Class in namespace SilverStripe\AssetAdmin\GraphQL

FileFilter::filterList() — Method in class FileFilter

Caution: Does NOT enforce canView permissions

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

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

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

AssetControlExtension::findAssets() — Method in class AssetControlExtension

Return a list of all tuples attached to this dataobject Note: Variants are excluded

FileConverter — Class in namespace SilverStripe\Assets\Conversion

Interface providing the public API for file converters, so that FileConverterManager can find and use suitable converters.

FileConverterException — Class in namespace SilverStripe\Assets\Conversion

An exception that represents a failure to convert a file in a FileConverter class.

FileConverterManager — Class in namespace SilverStripe\Assets\Conversion

This class holds a list of available file converters which it uses to convert files from one format to another.

File — Class in namespace SilverStripe\Assets

This class handles the representation of a file on the filesystem within the framework.

$ File#file_types — Property in class File

A list of file extensions and a description of what type of file they represent

$ File#Filename — Property in class File

Full filename of this file

$ File#File — Property in class File

asset stored behind this File record

File::find() — Method in class File

Find a File object by the given filename.

File::format_size() — Method in class File

Formats a file size (eg: (int)42 becomes string '42 bytes')

File::forTemplate() — Method in class File

Return a html5 tag of the appropriate for this file (normally img or a)

File::filterFilename() — Method in class File

Pass name through standard FileNameFilter

File::flushCache() — Method in class File

Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.

FileDefaultPermissions — Class in namespace SilverStripe\Assets

Permissions for root files with Can*Type = Inherit

FileFinder — Class in namespace SilverStripe\Assets

A utility class that finds any files matching a set of rules that are present within a directory tree.

FileFinder::find() — Method in class FileFinder

Finds all files matching the options within a directory. The search is performed depth first.

FileNameFilter — Class in namespace SilverStripe\Assets

Filter certain characters from file name, for nicer (more SEO-friendly) URLs as well as better filesystem compatibility.

FileNameFilter::filter() — Method in class FileNameFilter

Depending on the applied replacement rules, this method might result in an empty string. In this case, getDefaultName() will be used to return a randomly generated file name, while retaining its extension.

FileIDHelper — Class in namespace SilverStripe\Assets\FilenameParsing

Helps build and parse Filename Identifiers (ake: FileIDs) according to a predefined format.

FileIDHelperResolutionStrategy — Class in namespace SilverStripe\Assets\FilenameParsing

File resolution strategy that relies on a list of FileIDHelpers to find files.

FileIDHelperResolutionStrategy::findVariants() — Method in class FileIDHelperResolutionStrategy

Find all the variants of the provided tuple

FileResolutionStrategy — Class in namespace SilverStripe\Assets\FilenameParsing

Represents a strategy for resolving files on a Flysystem Adapter.

FileResolutionStrategy::findVariants() — Method in class FileResolutionStrategy

Find all the variants of the provided tuple

Filesystem — Class in namespace SilverStripe\Assets

A collection of static methods for manipulating the filesystem.

$ Filesystem#file_create_mask — Property in class Filesystem

$ Filesystem#folder_create_mask — Property in class Filesystem

Filesystem::folderModTime() — Method in class Filesystem

Return the most recent modification time of anything in the folder.

$ AssetAdapter#file_permissions — Property in class AssetAdapter

Config compatible permissions configuration

AssetAdapter::findRoot() — Method in class AssetAdapter

Determine the root folder absolute system path

AssetAdapter::flush() — Method in class AssetAdapter

Force flush and regeneration of server files

Filesystem — Class in namespace SilverStripe\Assets\Flysystem

FlysystemAssetStore — Class in namespace SilverStripe\Assets\Flysystem

Asset store based on flysystem Filesystem as a backend

$ FlysystemAssetStore#file_response_headers — Property in class FlysystemAssetStore

Custom headers to add to all custom file responses

FlysystemAssetStore::fileGeneratorFor() — Method in class FlysystemAssetStore

Get an asset renamer for the given filename.

FlysystemAssetStore::flush() — Method in class FlysystemAssetStore

Ensure each adapter re-generates its own server configuration files

ProtectedAssetAdapter::findRoot() — Method in class ProtectedAssetAdapter

Determine the root folder absolute system path

PublicAssetAdapter::findRoot() — Method in class PublicAssetAdapter

Determine the root folder absolute system path

Folder — Class in namespace SilverStripe\Assets

Represents a logical folder, which may be used to organise assets stored in the configured backend.

Folder::find_or_make() — Method in class Folder

Find the given folder or create it as a database record

FolderNameFilter — Class in namespace SilverStripe\Assets

Filter certain characters from file name, for nicer (more SEO-friendly) URLs as well as better filesystem compatibility.

$ ImageManipulation#force_resample — Property in class ImageManipulation

Force all images to resample in all cases Off by default, as this can be resource intensive to apply to multiple images simultaneously.

ImageManipulation::Fit() — Method in class ImageManipulation

Scale image proportionally to fit within the specified bounds

ImageManipulation::FitMax() — Method in class ImageManipulation

Proportionally scale down this image if it is wider or taller than the specified dimensions.

ImageManipulation::FillMax() — Method in class ImageManipulation

Crop this image to the aspect ratio defined by the specified width and height, then scale down the image to those dimensions if it exceeds them.

ImageManipulation::Fill() — Method in class ImageManipulation

Resize and crop image to fill specified dimensions.

$ InterventionBackend#flush_enabled — Property in class InterventionBackend

Is cache flushing enabled?

InterventionBackend::flush() — Method in class InterventionBackend

This function is triggered early in the request if the "flush" query parameter has been set. Each class that implements Flushable implements this function which looks after it's own specific flushing functionality.

FileLink — Class in namespace SilverStripe\Assets\Shortcodes

Represents a link between a dataobject parent and a file shortcode in a HTML content area

FileLinkTracking — Class in namespace SilverStripe\Assets\Shortcodes

Adds tracking of links in any HTMLText fields which reference SiteTree or File items.

$ FileLinkTracking#fileParser — Property in class FileLinkTracking

FileLinkTrackingParser — Class in namespace SilverStripe\Assets\Shortcodes

A helper object for extracting information about links.

FileShortcodeProvider — Class in namespace SilverStripe\Assets\Shortcodes

Provides shortcodes for File dataobject

FileShortcodeProvider::find_shortcode_record() — Method in class FileShortcodeProvider

Find the record to use for a given shortcode.

FileShortcodeProvider::find_error_record() — Method in class FileShortcodeProvider

Given a HTTP Error, find an appropriate substitute File or SiteTree data object instance.

FileShortcodeProvider::flush() — Method in class FileShortcodeProvider

ImageShortcodeProvider::find_error_record() — Method in class ImageShortcodeProvider

$ DBFile#Filename — Property in class DBFile

Name of the file, including directory

$ DefaultAssetNameGenerator#filename — Property in class DefaultAssetNameGenerator

Original filename

$ DefaultAssetNameGenerator#first — Property in class DefaultAssetNameGenerator

First version

FileHashingService — Class in namespace SilverStripe\Assets\Storage

Utility for computing and comparing unique file hash. All $fs parameters can either be:

an AssetStore constant VISIBILITY constant or
an actual Filesystem object.

Sha1FileHashingService::flush() — Method in class Sha1FileHashingService

$ Upload#file — Property in class Upload

A dataobject (typically {File}) which implements {AssetContainer}

$ BlogPost#featured_images_directory — Property in class BlogPost

Sets the upload directory for featured images to help keep your files organised

$ BlogPost#FeaturedImageID — Property in class BlogPost

BlogPost::fieldLabels() — Method in class BlogPost

Sets the label for BlogPost.Title to 'Post Title' (Rather than 'Page name').

BlogPost::FeaturedImage() — Method in class BlogPost

CMSMain::flush() — Method in class CMSMain

Clear the cache on ?flush

CMSMain::flushMemberCache() — Method in class CMSMain

Flush the hints cache for a specific member

LeftAndMainPageIconsExtension::flush() — Method in class LeftAndMainPageIconsExtension

Just broadly clears the cache on flush

OldPageRedirector::find_old_page() — Method in class OldPageRedirector

Attempt to find an old/renamed page from some given the URL as an array

SiteTreeURLSegmentField::Field() — Method in class SiteTreeURLSegmentField

Returns the form field.

$ SiteTree#fields_ignored_by_versioning — Property in class SiteTree

Fields which, if changed on their own, won't cause a new version/live record to be created

$ SiteTree#field_labels — Property in class SiteTree

SiteTree::flushCache() — Method in class SiteTree

Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.

SiteTree::flushMemberCache() — Method in class SiteTree

Flushes the member specific cache for creatable children

SiteTree::fieldLabels() — Method in class SiteTree

SiteTree::flush() — Method in class SiteTree

Clear the creatableChildren cache on flush

AddToCampaignHandler::Form() — Method in class AddToCampaignHandler

Builds a Form that mirrors the parent editForm, but with an extra field to collect the ChangeSet ID

CampaignAdminList::FieldHolder() — Method in class CampaignAdminList

Placeholder for react-only custom form field

$ CachedConfigCollection#flush — Property in class CachedConfigCollection

$ YamlTransformer#files — Property in class YamlTransformer

A list of files. Real, full path.

YamlTransformer::filterByOnlyAndExcept() — Method in class YamlTransformer

This filteres out any yaml documents which don't pass their only or except statement tests.

ContentReviewCMSExtension::findRecord() — Method in class ContentReviewCMSExtension

Find the page this form is updating

ReviewContentHandler::Form() — Method in class ReviewContentHandler

Bootstrap the form fields for the content review modal

$ ContentReviewNotificationJob#first_run_hour — Property in class ContentReviewNotificationJob

The hour that the first job will be created at (for the next day). All other jobs should be triggered around this time too, as the next generation is queued when this job is run.

Cookie::force_expiry() — Method in class Cookie

CookieJar::forceExpiry() — Method in class CookieJar

Force the expiry of a cookie by name

Cookie_Backend::forceExpiry() — Method in class Cookie_Backend

Force the expiry of a cookie by name

Director::fileExists() — Method in class Director

Returns true if the given file exists. Filename should be relative to the site root.

Director::force_redirect() — Method in class Director

Skip any further processing and immediately respond with a redirect to the passed URL.

Director::forceSSL() — Method in class Director

Force the site to run on SSL.

Director::forceWWW() — Method in class Director

Force a redirect to a domain starting with "www."

HTTP::filename2url() — Method in class HTTP

Turns a local system filename into a URL by comparing it to the script filename.

HTTP::findByTagAndAttribute() — Method in class HTTP

Search for all tags with a specific attribute, then return the value of that attribute in a flat array.

$ CanonicalURLMiddleware#forceWWW — Property in class CanonicalURLMiddleware

Set if we should redirect to WWW

$ CanonicalURLMiddleware#forceSSL — Property in class CanonicalURLMiddleware

Set if we should force SSL

$ CanonicalURLMiddleware#forceBasicAuthToSSL — Property in class CanonicalURLMiddleware

Set if we should automatically redirect basic auth requests to HTTPS. A null value (default) will cause this property to return the value of the forceSSL property.

$ CanonicalURLMiddleware#forceSSLPatterns — Property in class CanonicalURLMiddleware

If forceSSL is enabled, this is the list of patterns that the url must match (at least one)

$ CanonicalURLMiddleware#forceSSLDomain — Property in class CanonicalURLMiddleware

SSL Domain to use

FlushMiddleware — Class in namespace SilverStripe\Control\Middleware

Triggers a call to flush() on all implementors of Flushable.

$ HTTPCacheControlMiddleware#forcingLevel — Property in class HTTPCacheControlMiddleware

Forcing level of previous setting; higher number wins Combination of consts below

FlushScheduler — Class in namespace SilverStripe\Control\Middleware\URLSpecialsMiddleware

Schedule flush operation for a following request

$ PjaxResponseNegotiator#fragmentOverride — Property in class PjaxResponseNegotiator

Overridden fragments (if any). Otherwise uses fragments from the request.

$ RSSFeed_Entry#failover — Property in class RSSFeed_Entry

The object that represents the item, it contains all the data.

RequestHandler::findAction() — Method in class RequestHandler

Session::finalize() — Method in class Session

Set user agent key

FilesystemCacheFactory — Class in namespace SilverStripe\Core\Cache

MemberCacheFlusher::flushMemberCache() — Method in class MemberCacheFlusher

ClassInfo::flush() — Method in class ClassInfo

Config::forClass() — Method in class Config

Get an accessor that returns results by class by default.

Config_ForClass::forClass() — Method in class Config_ForClass

CustomMethods::findBuiltInMethods() — Method in class CustomMethods

Get all public built in methods for this class

CustomMethods::findMethodsFrom() — Method in class CustomMethods

Find all methods on the given object.

Flushable — Class in namespace SilverStripe\Core

Provides an interface for classes to implement their own flushing functionality whenever flush=1 is requested.

Flushable::flush() — Method in class Flushable

Factory — Class in namespace SilverStripe\Core\Injector

A factory which is used for creating service instances.

FlushDiscoverer — Class in namespace SilverStripe\Core\Startup

Public interface for startup flush discoverers

Backtrace::filtered_backtrace() — Method in class Backtrace

Return debug_backtrace() results with functions filtered specific to the debugging system, and not the trace.

Backtrace::filter_backtrace() — Method in class Backtrace

Filter a backtrace so that it doesn't show the calls to the debugging system, which is useless information.

Backtrace::full_func_name() — Method in class Backtrace

Return the full function name. If showArgs is set to true, a string representation of the arguments will be shown

CsvBulkLoader::findExistingObject() — Method in class CsvBulkLoader

Find an existing objects based on one or more uniqueness columns specified via CsvBulkLoader::$duplicateChecks.

DebugView::formatCaller() — Method in class DebugView

Formats the caller of a method

Deprecation::fileIsInSupportedModule() — Method in class Deprecation

Check whether a file (path to file) is in a supported module

FixtureBlueprint — Class in namespace SilverStripe\Dev

A blueprint on how to create instances of a certain DataObject subclass.

FixtureFactory — Class in namespace SilverStripe\Dev

Manages a set of database fixtures for DataObject records as well as raw database table rows.

$ FixtureFactory#fixtures — Property in class FixtureFactory

FunctionalTest — Class in namespace SilverStripe\Dev

SilverStripe-specific testing object designed to support functional testing of your web app. It simulates get/post requests, form submission, and can validate resulting HTML, looking up content by CSS selector.

FunctionalTest::findAttribute() — Method in class FunctionalTest

Find an attribute in a SimpleXMLElement object by name.

DatabaseAdapterRegistry::flush() — Method in class DatabaseAdapterRegistry

$ SapphireTest#fixture_file — Property in class SapphireTest

Path to fixture data for this test run.

$ SapphireTest#fixtureFactory — Property in class SapphireTest

SapphireTest::findEmail() — Method in class SapphireTest

Search for an email that was sent.

FixtureTestState — Class in namespace SilverStripe\Dev\State

FlushableTestState — Class in namespace SilverStripe\Dev\State

Clears flushable / resettable objects

$ FlushableTestState#flushed — Property in class FlushableTestState

TestMailer::findEmail() — Method in class TestMailer

Search for an email that was sent.

TestSession::followRedirection() — Method in class TestSession

If the last request was a 3xx response, then follow the redirection

$ YamlFixture#fixtureFile — Property in class YamlFixture

Absolute path to the .yml fixture file

$ YamlFixture#fixtureString — Property in class YamlFixture

String containing fixture

$ ServiceConnector#fileDescriptor — Property in class ServiceConnector

Associative array of:

name: the full name of the file including the extension.

BlockLinkField_Readonly::Field() — Method in class BlockLinkField_Readonly

Returns the form field.

BlockLinkField_Readonly::FieldHolder() — Method in class BlockLinkField_Readonly

Do not render a form field holder for this, just display the toggled composite field

FileBlock — Class in namespace SilverStripe\ElementalFileBlock\Block

FileBlock::File() — Method in class FileBlock

FileAccessibilityAndValidationCheck — Class in namespace SilverStripe\EnvironmentCheck\Checks

Checks for the accessibility and file type validation of one or more files or folders.

$ FileAccessibilityAndValidationCheck#fileTypeValidateFunc — Property in class FileAccessibilityAndValidationCheck

Constant, check for a single file to match age criteria, or all of them.

FileAgeCheck — Class in namespace SilverStripe\EnvironmentCheck\Checks

Checks for the maximum age of one or more files or folders.

FileWriteableCheck — Class in namespace SilverStripe\EnvironmentCheck\Checks

Check that the given file is writable.

$ HasFunctionCheck#functionName — Property in class HasFunctionCheck

$ EnvironmentChecker#from_email_address — Property in class EnvironmentChecker

Fetcher — Class in namespace SilverStripe\EnvironmentCheck\Traits

Simple helper for env checks which require HTTP clients.

ErrorPage::fieldLabels() — Method in class ErrorPage

$ CurlLinkChecker#follow_location — Property in class CurlLinkChecker

If we want to follow redirects a 301 http code for example Set via YAML file

CheckboxSetField::Field() — Method in class CheckboxSetField

CompositeField::FieldList() — Method in class CompositeField

Returns all the sub-fields, suitable for <% loop FieldList %>

CompositeField::fieldByName() — Method in class CompositeField

CompositeField::fieldPosition() — Method in class CompositeField

Find the numerical position of a field within the children collection. Doesn't work recursively.

CompositeValidator::fieldIsRequired() — Method in class CompositeValidator

Returns whether the field in question is required. This will usually display '*' next to the field.

ConfirmedPasswordField::Field() — Method in class ConfirmedPasswordField

CurrencyField_Disabled::Field() — Method in class CurrencyField_Disabled

Overloaded to display the correctly formatted value for this data type

CurrencyField_Readonly::Field() — Method in class CurrencyField_Readonly

Overloaded to display the correctly formatted value for this data type

DatalessField::FieldHolder() — Method in class DatalessField

Returns the field's representation in the form.

DateField::frontendToInternal() — Method in class DateField

Convert frontend date to the internal representation (ISO 8601).

DateField_Disabled::Field() — Method in class DateField_Disabled

Returns the form field.

DatetimeField::frontendToInternal() — Method in class DatetimeField

Convert frontend date to the internal representation (ISO 8601).

DropdownField::Field() — Method in class DropdownField

FieldGroup — Class in namespace SilverStripe\Forms

Lets you include a nested group of fields inside a template.

FieldList — Class in namespace SilverStripe\Forms

A list designed to hold form field instances.

FieldList::flattenFields() — Method in class FieldList

Return a flattened list of all fields

FieldList::fieldNameError() — Method in class FieldList

Trigger an error for duplicate field names

FieldList::flushFieldsCache() — Method in class FieldList

FieldList::findTab() — Method in class FieldList

Returns the specified tab object, if it exists

FieldList::findOrMakeTab() — Method in class FieldList

Returns the specified tab object, creating it if necessary.

FieldList::fieldByName() — Method in class FieldList

Returns a named field.

FieldList::fieldPosition() — Method in class FieldList

Find the numerical position of a field within the children collection. Doesn't work recursively.

FieldList::forTemplate() — Method in class FieldList

Default template rendering of a FieldList will concatenate all FieldHolder values.

FieldsValidator — Class in namespace SilverStripe\Forms

Validates the internal state of all fields in the form.

FileField — Class in namespace SilverStripe\Forms

Represents a file type which can be added to a form.

FileField::Field() — Method in class FileField

FileHandleField — Class in namespace SilverStripe\Forms

FileUploadReceiver — Class in namespace SilverStripe\Forms

Provides operations for reading and writing uploaded files to/from {File} dataobject instances.

Filter — Class in namespace SilverStripe\Forms

Filter::filter() — Method in class Filter

Filters a value.

SlugFilter::filter() — Method in class SlugFilter

Form — Class in namespace SilverStripe\Forms

Base class for all forms.

$ Form#fields — Property in class Form

$ Form#formMethod — Property in class Form

$ Form#formActionPath — Property in class Form

Custom form action path, if not linking to itself.

Form::Fields() — Method in class Form

Return the form's fields - used by the templates

Form::FormAttributes() — Method in class Form

Form::FormHttpMethod() — Method in class Form

Returns the real HTTP method for the form: GET, POST, PUT, DELETE or HEAD.

Form::FormMethod() — Method in class Form

Returns the form method to be used in the

Form::FormAction() — Method in class Form

Return the form's action attribute.

Form::FormName() — Method in class Form

Returns the name of the form.

Form::FieldMap() — Method in class Form

Returns an object where there is a method with the same name as each data field on the form.

Form::forTemplate() — Method in class Form

Return a rendered version of this form.

Form::forAjaxTemplate() — Method in class Form

Return a rendered version of this form, suitable for ajax post-back.

FormAction — Class in namespace SilverStripe\Forms

The action buttons are <input type="submit"> as well as

FormAction::Field() — Method in class FormAction

FormAction::FieldHolder() — Method in class FormAction

FormFactory — Class in namespace SilverStripe\Forms

A service which can generate a form

FormField — Class in namespace SilverStripe\Forms

Represents a field in a form.

$ FormField#form — Property in class FormField

$ FormField#fieldHolderTemplate — Property in class FormField

Name of the template used to render this form field. If not set, then will look up the class ancestry for the first matching template where the template name equals the class name.

FormField::Field() — Method in class FormField

Returns the form field.

FormField::FieldHolder() — Method in class FormField

Returns a "field holder" for this field.

FormField::forTemplate() — Method in class FormField

This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.

FormMessage — Class in namespace SilverStripe\Forms

Form component which contains a castable message

FormMessageBootstrapExtension — Class in namespace SilverStripe\Forms

Will convert a SilverStripe message type into a Bootstrap alert type

FormRequestHandler — Class in namespace SilverStripe\Forms

$ FormRequestHandler#form — Property in class FormRequestHandler

Form model being handled

FormRequestHandler::forTemplate() — Method in class FormRequestHandler

FormScaffolder — Class in namespace SilverStripe\Forms

$ FormScaffolder#fieldClasses — Property in class FormScaffolder

FormTemplateHelper — Class in namespace SilverStripe\Forms

A helper class for managing Form} and {@link FormField HTML template output.

FormTransformation — Class in namespace SilverStripe\Forms

This class represents "transformations" of a form - such as making it printable or making it readonly.

Form_FieldMap — Class in namespace SilverStripe\Forms

$ Form_FieldMap#form — Property in class Form_FieldMap

GridField::FieldHolder() — Method in class GridField

Returns the whole gridfield rendered with all the attached components.

GridField::Field() — Method in class GridField

$ GridFieldDataColumns#fieldCasting — Property in class GridFieldDataColumns

$ GridFieldDataColumns#fieldFormatting — Property in class GridFieldDataColumns

GridFieldDataColumns::formatValue() — Method in class GridFieldDataColumns

$ GridFieldDetailForm#fields — Property in class GridFieldDetailForm

$ GridFieldDetailForm_ItemRequest#formActions — Property in class GridFieldDetailForm_ItemRequest

The default form actions available to this item request

$ GridFieldSortableHeader#fieldSorting — Property in class GridFieldSortableHeader

$ HTMLEditorField#fixed_row_height — Property in class HTMLEditorField

Extra height per row

HTMLEditorField::Field() — Method in class HTMLEditorField

Returns the form field.

$ TinyMCECombinedGenerator#filename_base — Property in class TinyMCECombinedGenerator

Named config

TinyMCECombinedGenerator::flush() — Method in class TinyMCECombinedGenerator

HTMLReadonlyField::Field() — Method in class HTMLReadonlyField

Returns the form field.

HiddenField::FieldHolder() — Method in class HiddenField

ListboxField::Field() — Method in class ListboxField

Returns a select tag containing all the appropriate option tags

LiteralField::FieldHolder() — Method in class LiteralField

LiteralField::Field() — Method in class LiteralField

LookupField::Field() — Method in class LookupField

Returns a readonly span containing the correct value.

$ MoneyField#fieldAmount — Property in class MoneyField

$ MoneyField#fieldCurrency — Property in class MoneyField

NullableField::Field() — Method in class NullableField

OptionsetField::Field() — Method in class OptionsetField

Returns the form field.

PrintableTransformation_TabSet::FieldHolder() — Method in class PrintableTransformation_TabSet

Returns a tab-strip and the associated tabs.

RequiredFields::fieldIsRequired() — Method in class RequiredFields

Returns true if the named field is "required".

FormSchema — Class in namespace SilverStripe\Forms\Schema

Represents a Form as structured data which allows a frontend library to render it.

SearchableDropdownTrait::Field() — Method in class SearchableDropdownTrait

SegmentField::Field() — Method in class SegmentField

$ AbstractSegmentFieldModifier#form — Property in class AbstractSegmentFieldModifier

$ AbstractSegmentFieldModifier#field — Property in class AbstractSegmentFieldModifier

SelectionGroup::FieldSet() — Method in class SelectionGroup

SelectionGroup::FieldList() — Method in class SelectionGroup

Returns all the sub-fields, suitable for <% loop FieldList %>

SelectionGroup::FieldHolder() — Method in class SelectionGroup

Returns a "field holder" for this field.

SingleLookupField::Field() — Method in class SingleLookupField

Returns a readonly span containing the correct value.

Tab::Fields() — Method in class Tab

Get child fields

TabSet::FieldHolder() — Method in class TabSet

Returns a tab-strip and the associated tabs.

TimeField::frontendToInternal() — Method in class TimeField

Convert frontend time to the internal representation (ISO 8601).

ToggleCompositeField::FieldHolder() — Method in class ToggleCompositeField

$ TreeDropdownField#filterCallback — Property in class TreeDropdownField

Callback for filtering records

TreeDropdownField::filterMarking() — Method in class TreeDropdownField

Marking public function for the tree, which combines different filters sensibly.

TreeDropdownField::flattenChildrenArray() — Method in class TreeDropdownField

Flattens a given list of children array items, so the data is no longer structured in a hierarchy

TreeDropdownField_Readonly::Field() — Method in class TreeDropdownField_Readonly

Returns the form field.

TreeMultiselectField::Field() — Method in class TreeMultiselectField

We overwrite the field attribute to add our hidden fields, as this formfield can contain multiple values.

TreeMultiselectField_Readonly::Field() — Method in class TreeMultiselectField_Readonly

We overwrite the field attribute to add our hidden fields, as this formfield can contain multiple values.

$ UploadReceiver#folderName — Property in class UploadReceiver

Partial filesystem path relative to /assets directory.

$ Validator#form — Property in class Validator

Validator::fieldIsRequired() — Method in class Validator

Returns whether the field in question is required. This will usually display '*' next to the field. The base implementation always returns false.

FileProvider — Class in namespace SilverStripe\GraphQL\PersistedQuery

Class FileProvider

QueryHandler::formatError() — Method in class QueryHandler

More verbose error display defaults.

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

Loads classes by fuzzy match (glob), relative to the root e.g. src/*.model.php

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

A utility class that handles an assortment of issues related to field access on DataObjects, particularly with case insensitivity.

$ FieldAccessor#field_formatter — Property in class FieldAccessor

A function that makes an object property a field name

FieldAccessor::formatField() — Method in class FieldAccessor

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

InheritanceBuilder::fillAncestry() — Method in class InheritanceBuilder

InheritanceBuilder::fillDescendants() — Method in class InheritanceBuilder

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

FirstResult::firstResult() — Method in class FirstResult

FieldFilterInterface — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter

Defines the interface used by all read filters for operations

FieldFilterRegistry — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter

$ FieldFilterRegistry#filters — Property in class FieldFilterRegistry

FilterRegistryInterface — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter

Filters for queries are registered as services and retrieved by identifiers.

QueryFilter::filter() — Method in class QueryFilter

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

An abstraction of a field that appears on a Type abstraction

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

A plugin that applies to a Field abstraction

$ AbstractQueryFilterPlugin#field_name — Property in class AbstractQueryFilterPlugin

$ AbstractQuerySortPlugin#field_name — Property in class AbstractQuerySortPlugin

$ SortPlugin#field_name — Property in class SortPlugin

Schema::findOrMakeType() — Method in class Schema

Schema::findOrMakeModel() — Method in class Schema

SchemaTranscribeHandler::fire() — Method in class SchemaTranscribeHandler

AbstractTypeRegistry::fromCache() — Method in class AbstractTypeRegistry

AbstractTypeRegistry::Float() — Method in class AbstractTypeRegistry

$ Type#fields — Property in class Type

$ LDAPAuthenticator#fallback_authenticator — Property in class LDAPAuthenticator

Set to 'yes' to fallback login attempts to $fallback_authenticator.

$ LDAPAuthenticator#fallback_authenticator_class — Property in class LDAPAuthenticator

The class of Authenticator to use as the fallback authenticator.

LDAPAuthenticator::fallbackAuthenticate() — Method in class LDAPAuthenticator

Try to authenticate using the fallback authenticator.

LDAPService::flush() — Method in class LDAPService

Flushes out the LDAP results cache when flush=1 is called.

LDAPMemberSyncTask::findOrCreateMember() — Method in class LDAPMemberSyncTask

Finds or creates a new Member object if the GUID provided by LDAP doesn't exist in the DB

FluentLinkExtension — Class in namespace SilverStripe\LinkField\Extensions

FileLink — Class in namespace SilverStripe\LinkField\Models

A link to a File in the CMS

$ FileLink#FileID — Property in class FileLink

FileLink::File() — Method in class FileLink

Link::forTemplate() — Method in class Link

Return a rendered version of this link.

MigrationTaskTrait::failedTransaction() — Method in class MigrationTaskTrait

Used in a callback if there is an error with the migration that causes a rolled back DB transaction

$ DebugViewFriendlyErrorFormatter#friendlyErrorMessage — Property in class DebugViewFriendlyErrorFormatter

Default friendly error

$ DebugViewFriendlyErrorFormatter#friendlyErrorDetail — Property in class DebugViewFriendlyErrorFormatter

Default error body

DebugViewFriendlyErrorFormatter::format() — Method in class DebugViewFriendlyErrorFormatter

DebugViewFriendlyErrorFormatter::formatBatch() — Method in class DebugViewFriendlyErrorFormatter

DetailedErrorFormatter::format() — Method in class DetailedErrorFormatter

DetailedErrorFormatter::formatBatch() — Method in class DetailedErrorFormatter

DetailedErrorFormatter::findInTrace() — Method in class DetailedErrorFormatter

Find a call on the given file & line in the trace

LoginHandler::finishRegistration() — Method in class LoginHandler

Handles the request to verify and process a new registration

LoginHandler::finishVerification() — Method in class LoginHandler

Handles requests to authenticate from any MFA method, directing verification to the Method supplied.

AdminRegistrationController::finishRegistration() — Method in class AdminRegistrationController

Complete a registration for a method for the currently logged in user

RegisteredMFAMethodListField::Field() — Method in class RegisteredMFAMethodListField

Returns the form field.

$ MimeUploadValidator#filterPattern — Property in class MimeUploadValidator

The preg_replace() pattern to use against MIME types. Used to strip out useless characters so matching of MIME types can be fuzzy.

ArrayLib::filter_keys() — Method in class ArrayLib

Filter an array by keys (useful for only allowing certain form-input to be saved).

ArrayLib::flatten() — Method in class ArrayLib

Takes an multi dimension array and returns the flattened version.

ArrayList::first() — Method in class ArrayList

Returns the first item in the list.

ArrayList::find() — Method in class ArrayList

Find the first item of this list where the given key = value

ArrayList::filter() — Method in class ArrayList

ArrayList::filterAny() — Method in class ArrayList

ArrayList::filterOrExclude() — Method in class ArrayList

ArrayList::filterByCallback() — Method in class ArrayList

$ DBSchemaManager#fix_table_case_on_build — Property in class DBSchemaManager

Check if tables should be renamed in a case-sensitive fashion.

DBSchemaManager::fixTableCase() — Method in class DBSchemaManager

Ensure the given table has the correct case

DBSchemaManager::fieldList() — Method in class DBSchemaManager

Get a list of all the fields for the given table.

DBSchemaManager::float() — Method in class DBSchemaManager

Returns data type for 'float' column

Database::formattedDatetimeClause() — 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 in a certain format

MySQLDatabase::formattedDatetimeClause() — 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 in a certain format

MySQLSchemaManager::fieldList() — Method in class MySQLSchemaManager

Get a list of all the fields for the given table.

MySQLSchemaManager::float() — Method in class MySQLSchemaManager

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

DB::field_list() — Method in class DB

Get a list of all the fields for the given table.

$ DataList#finalisedQuery — Property in class DataList

A cached Query to save repeated database calls. {DataList::getTemplateIteratorCount()}

DataList::filter() — Method in class DataList

DataList::filterAny() — Method in class DataList

DataList::filterByCallback() — Method in class DataList

Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.

DataList::first() — Method in class DataList

Returns the first item in this DataList

DataList::find() — Method in class DataList

Find the first DataObject of this DataList where the given key = value

$ DataObject#fixed_fields — Property in class DataObject

Base fields which are not defined in static $db

$ DataObject#field_labels — Property in class DataObject

User defined labels for searchable_fields, used to override default display in the search form.

DataObject::forceChange() — Method in class DataObject

Forces the record to think that all its data has changed.

DataObject::findCascadeDeletes() — Method in class DataObject

Find all objects that will be cascade deleted if this object is deleted

DataObject::flushCache() — Method in class DataObject

Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.

DataObject::flush_and_destroy_cache() — Method in class DataObject

Flush the get_one global cache and destroy associated objects.

DataObject::fieldLabels() — Method in class DataObject

Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.

DataObject::fieldLabel() — Method in class DataObject

Get a human-readable label for a single field, see fieldLabels() for more details.

DataObject::findRelatedObjects() — Method in class DataObject

Find objects in the given relationships, merging them into the given list

DataObjectSchema::fieldSpecs() — Method in class DataObjectSchema

Get all DB field specifications for a class, including ancestors and composite fields.

DataObjectSchema::fieldSpec() — Method in class DataObjectSchema

Get specifications for a single class field

$ DataQuery#filterByClassName — Property in class DataQuery

DataQuery::firstRow() — Method in class DataQuery

Return the first row that would be returned by this full DataQuery Note that this will issue a separate SELECT ... LIMIT 1 query.

EagerLoadedList::forForeignID() — Method in class EagerLoadedList

Returns a copy of this list with the relationship linked to the given foreign ID

EagerLoadedList::first() — Method in class EagerLoadedList

Returns the first item in the list.

EagerLoadedList::find() — Method in class EagerLoadedList

Returns the first item in the list where the key field is equal to the value.

EagerLoadedList::filter() — Method in class EagerLoadedList

EagerLoadedList::filterAny() — Method in class EagerLoadedList

EagerLoadedList::filterByCallback() — Method in class EagerLoadedList

DBDate::Full() — Method in class DBDate

Returns the date in the localised full format

DBDate::Format() — Method in class DBDate

Return the date using a particular formatting string. Use {o} to include an ordinal representation for the day of the month ("1st", "2nd", "3rd" etc)

DBDate::FormatFromSettings() — Method in class DBDate

Return a date formatted as per a CMS user's settings.

DBDate::fixInputDate() — Method in class DBDate

Fix non-iso dates

DBDatetime::FormatFromSettings() — Method in class DBDatetime

Return a date and time formatted as per a CMS user's settings.

DBEnum::flushCache() — Method in class DBEnum

Clear all cached enum values.

DBEnum::formField() — Method in class DBEnum

Return a dropdown field suitable for editing this field.

DBField::forTemplate() — Method in class DBField

Determine 'default' casting for this field.

$ DBForeignKey#foreignListCache — Property in class DBForeignKey

Cache for multiple subsequent calls to scaffold form fields with the same foreign key object

DBHTMLText::forTemplate() — Method in class DBHTMLText

DBHTMLVarchar::forTemplate() — Method in class DBHTMLVarchar

DBInt::Formatted() — Method in class DBInt

Returns the number, with commas added as appropriate, eg “1,000”.

DBMultiEnum::formField() — Method in class DBMultiEnum

Return a CheckboxSetField suitable for editing this field

DBString::forTemplate() — Method in class DBString

DBText::FirstSentence() — Method in class DBText

Return the first string that finishes with a period (.) in this text.

DBText::FirstParagraph() — Method in class DBText

Get first paragraph

DBTime::Format() — Method in class DBTime

Return the time using a particular formatting string.

DBTime::FormatFromSettings() — Method in class DBTime

Return a time formatted as per a CMS user's settings.

Filterable — Class in namespace SilverStripe\ORM

Additional interface for SS_List classes that are filterable.

Filterable::filter() — Method in class Filterable

Filterable::filterAny() — Method in class Filterable

Filterable::filterByCallback() — Method in class Filterable

Return a new instance of this list that excludes any items with these characteristics Filter this List by a callback function. The function will be passed each record of the List in turn, and must return true for the record to be included. Returns the filtered list.

FulltextFilter — Class in namespace SilverStripe\ORM\Filters

Filters by full-text matching on the given field.

$ SearchFilter#fullName — Property in class SearchFilter

$ HasManyList#foreignKey — Property in class HasManyList

HasManyList::foreignIDFilter() — Method in class HasManyList

Hierarchy::flushCache() — Method in class Hierarchy

Flush all Hierarchy caches:

Children (instance)
NumChildren (instance)

ListDecorator::first() — Method in class ListDecorator

Returns the first item in the list.

ListDecorator::forTemplate() — Method in class ListDecorator

ListDecorator::find() — Method in class ListDecorator

Returns the first item in the list where the key field is equal to the value.

ListDecorator::filter() — Method in class ListDecorator

Filter the list to include items with these characteristics

ListDecorator::filterAny() — Method in class ListDecorator

Return a copy of this list which contains items matching any of these characteristics.

ListDecorator::filterByCallback() — Method in class ListDecorator

Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.

$ ManyManyList#foreignKey — Property in class ManyManyList

ManyManyList::foreignIDFilter() — Method in class ManyManyList

Return a filter expression for when getting the contents of the relationship for some foreign ID

ManyManyList::foreignIDWriteFilter() — Method in class ManyManyList

Return a filter expression for the join table when writing to the join table

ManyManyThroughList::foreignIDFilter() — Method in class ManyManyThroughList

Don't apply foreign ID filter until getFinalisedQuery()

$ ManyManyThroughQueryManipulator#foreignKey — Property in class ManyManyThroughQueryManipulator

Key that joins to the parent class

$ ManyManyThroughQueryManipulator#foreignClass — Property in class ManyManyThroughQueryManipulator

Foreign class 'from' property. Normally not needed unless polymorphic.

$ Map#firstItems — Property in class Map

PaginatedList::FirstPage() — Method in class PaginatedList

PaginatedList::FirstItem() — Method in class PaginatedList

Returns the number of the first item being displayed on the current page. This is useful for things like "displaying 10-20".

PaginatedList::FirstLink() — Method in class PaginatedList

Returns a link to the first page.

$ SQLConditionalExpression#from — Property in class SQLConditionalExpression

An array of tables. The first one is just the table name.

SQLConditionalExpression::filtersOnID() — Method in class SQLConditionalExpression

Checks whether this query is for a specific ID in a table

SQLConditionalExpression::filtersOnFK() — Method in class SQLConditionalExpression

Checks whether this query is filtering on a foreign key, ie finding a has_many relationship

SQLSelect::firstRow() — Method in class SQLSelect

Returns a query that returns only the first row of this query

Relation::forForeignID() — Method in class Relation

RelationList::forForeignID() — Method in class RelationList

RelationList::foreignIDFilter() — Method in class RelationList

Returns a where clause that filters the members of this relationship to just the related items.

SS_List::first() — Method in class SS_List

Returns the first item in the list.

SS_List::find() — Method in class SS_List

Returns the first item in the list where the key field is equal to the value.

FulltextSearchable — Class in namespace SilverStripe\ORM\Search

Provides a simple search engine for your site based on the MySQL FULLTEXT index.

$ SearchContext#fields — Property in class SearchContext

FormFields mapping to DataObject::$db properties which are supposed to be searchable.

$ SearchContext#filters — Property in class SearchContext

Array of SearchFilter subclasses.

UnsavedRelationList::first() — Method in class UnsavedRelationList

Returns the first item in the list.

UnsavedRelationList::forForeignID() — Method in class UnsavedRelationList

Returns a copy of this list with the relationship linked to the given foreign ID.

FederatedIdentity — Class in namespace SilverStripe\RealMe\Model

Class RealMeFederatedIdentity

$ FederatedIdentity#FirstName — Property in class FederatedIdentity

RegistryPage::fieldLabels() — Method in class RegistryPage

SideReportView::forTemplate() — Method in class SideReportView

SideReportView::formatValue() — Method in class SideReportView

DataFormatter::for_extension() — Method in class DataFormatter

Get a DataFormatter object suitable for handling the given file extension.

DataFormatter::for_extensions() — Method in class DataFormatter

Get formatter for the first matching extension.

DataFormatter::for_mimetype() — Method in class DataFormatter

Get a DataFormatter object suitable for handling the given mimetype.

DataFormatter::for_mimetypes() — Method in class DataFormatter

Get formatter for the first matching mimetype.

FormEncodedDataFormatter — Class in namespace SilverStripe\RestfulServer\DataFormatter

Accepts form encoded strings and converts them to a valid PHP array via parse_str().

Form — Class in namespace SilverStripe\Security\Confirmation

Basic confirmation form implementation.

Handler::Form() — Method in class Handler

Returns an instance of Confirmation\Form initialized with the proper storage id taken from URL

DefaultAdminService::findOrCreateDefaultAdmin() — Method in class DefaultAdminService

DefaultAdminService::findOrCreateAdmin() — Method in class DefaultAdminService

Find or create a Member with admin permissions

DefaultAdminService::findOrCreateAdminGroup() — Method in class DefaultAdminService

Ensure a Group exists with admin permission

Group::fieldLabels() — Method in class Group

InheritedPermissionFlusher::flush() — Method in class InheritedPermissionFlusher

Flush all MemberCacheFlusher services

InheritedPermissionFlusher::flushCache() — Method in class InheritedPermissionFlusher

Flushes all registered MemberCacheFlusher services

InheritedPermissions::flushMemberCache() — Method in class InheritedPermissions

Clear the cache for this instance only

LoginAttempt::fieldLabels() — Method in class LoginAttempt

$ Member#FirstName — Property in class Member

$ Member#FailedLoginCount — Property in class Member

Member::fieldLabels() — Method in class Member

LostPasswordHandler::forgotPassword() — Method in class LostPasswordHandler

Forgot password form handler method.

Member_GroupSet::foreignIDFilter() — Method in class Member_GroupSet

Link this group set to a specific member.

Member_GroupSet::foreignIDWriteFilter() — Method in class Member_GroupSet

Return a filter expression for the join table when writing to the join table

$ Member_Validator#forMember — Property in class Member_Validator

Determine what member this validator is meant for

PermissionCheckboxSetField::Field() — Method in class PermissionCheckboxSetField

PermissionRole::fieldLabels() — Method in class PermissionRole

Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.

$ RememberLoginHash#force_single_token — Property in class RememberLoginHash

If true, user can only use auto login on one device. A user can still login from multiple devices, but previous tokens from other devices will become invalid.

$ Security#frame_options — Property in class Security

Value of X-Frame-Options header

$ Security#force_database_is_ready — Property in class Security

Security::force_database_is_ready() — Method in class Security

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

SessionManagerField::Field() — Method in class SessionManagerField

Returns the form field.

LoginSession::find() — Method in class LoginSession

$ EditableSpamProtectionField#formField — Property in class EditableSpamProtectionField

FormSpamProtectionExtension — Class in namespace SilverStripe\SpamProtection\Extension

An extension to the Form class which provides the method enableSpamProtection() helper.

$ FormSpamProtectionExtension#field_name — Property in class FormSpamProtectionExtension

SiteTreePublishingEngine::flushChanges() — Method in class SiteTreePublishingEngine

Execute URL deletions, enqueue URL updates.

FilesystemPublisher — Class in namespace SilverStripe\StaticPublishQueue\Publisher

$ FilesystemPublisher#fileExtension — Property in class FilesystemPublisher

UrlBundleService::formatUrl() — Method in class UrlBundleService

Extensibility function which allows to handle custom formatting / encoding needs for URLs Returning "falsy" value will make the URL to be skipped

FileSubsites — Class in namespace SilverStripe\Subsites\Extensions

Extension for the File object to add subsites support

FolderFormFactoryExtension — Class in namespace SilverStripe\Subsites\Extensions

SubsitesTreeDropdownField::Field() — Method in class SubsitesTreeDropdownField

Returns the form field.

Subsite::fieldLabels() — Method in class Subsite

$ SubsiteDomain#FullProtocol — Property in class SubsiteDomain

Full protocol including ://

SubsiteDomain::fieldLabels() — Method in class SubsiteDomain

SubsitesVirtualPage::fieldLabels() — Method in class SubsitesVirtualPage

ReadonlyTagField::Field() — Method in class ReadonlyTagField

Render the readonly field as HTML.

StringTagField::Field() — Method in class StringTagField

StringTagField::formatOptions() — Method in class StringTagField

TagField::Field() — Method in class TagField

Returns the form field.

FileTextCache — Class in namespace SilverStripe\TextExtraction\Cache

Cache::flush() — Method in class Cache

FileTextExtractable — Class in namespace SilverStripe\TextExtraction\Extension

Decorate File or a File derivative to enable text extraction from the file content. Uses a set of subclasses of FileTextExtractor to do the extraction based on the content type of the file.

$ FileTextExtractable#fileTextCache — Property in class FileTextExtractable

FileTextExtractor — Class in namespace SilverStripe\TextExtraction\Extractor

A decorator for File or a subclass that provides a method for extracting full-text from the file's external contents.

FileTextExtractor::for_file() — Method in class FileTextExtractor

Given a File object, decide which extractor instance to use to handle it

$ UserDefinedFormAdmin#form_submissions_folder — Property in class UserDefinedFormAdmin

$ UserDefinedFormController#finished_anchor — Property in class UserDefinedFormController

$ UserDefinedFormController#form_submissions_folder — Property in class UserDefinedFormController

$ UserDefinedFormController#file_upload_stage — Property in class UserDefinedFormController

UserDefinedFormController::Form() — Method in class UserDefinedFormController

Get the form for the page. Form can be modified by calling updateForm() on a UserDefinedForm extension.

UserDefinedFormController::finished() — Method in class UserDefinedFormController

This action handles rendering the "finished" message, which is customizable by editing the ReceivedFormSubmission template.

UserFormsStepField::FieldHolder() — Method in class UserFormsStepField

Returns a "field holder" for this field.

$ EditableCustomRule#FieldValue — Property in class EditableCustomRule

EditableFormField::formatDisplayRules() — Method in class EditableFormField

Extracts info from DisplayRules into array so UserDefinedForm->buildWatchJS can run through it.

FormField — Class in namespace SilverStripe\UserForms\Model\EditableFormField\EditableDateField

$ EditableFileField#FolderConfirmed — Property in class EditableFileField

$ EditableFileField#FolderID — Property in class EditableFileField

EditableFileField::Folder() — Method in class EditableFileField

$ EmailRecipient#FormID — Property in class EmailRecipient

EmailRecipient::Form() — Method in class EmailRecipient

$ UserForm#fieldsFromTo — Property in class UserForm

Unused property

UserForm::FilteredEmailRecipients() — Method in class UserForm

Allow overriding the EmailRecipients on a DataExtension so you can customise who receives an email.

VersionFeedController::filterContent() — Method in class VersionFeedController

Evaluates the result of the given callback

$ HistoryViewerController#formNames — Property in class HistoryViewerController

An array of supported form names that can be requested through the schema

FileArchiveExtension — Class in namespace SilverStripe\VersionedAdmin\Extensions

Adds a archive view for Files

ChangeSet::fieldLabels() — Method in class ChangeSet

ChangeSetItem::findReferenced() — Method in class ChangeSetItem

Get all implicit objects for this change

$ DataDifferencer#fromRecord — Property in class DataDifferencer

ReadingMode::fromDataQueryParams() — Method in class ReadingMode

Converts dataquery params to original reading mode.

ReadingMode::fromQueryString() — Method in class ReadingMode

Convert querystring arguments to reading mode.

RecursivePublishable::findOwned() — Method in class RecursivePublishable

Find all objects owned by the current object.

RecursivePublishable::findOwners() — Method in class RecursivePublishable

Find objects which own this object.

RecursivePublishable::findOwnersRecursive() — Method in class RecursivePublishable

Find objects which own this object.

RecursiveStagesService::flushCachedData() — Method in class RecursiveStagesService

Versioned::flushCache() — Method in class Versioned

FilterInterface — Class in namespace SilverStripe\View\Parsers

A FilterInterface is given an input string and returns a filtered string. Replacements will be provided and performed (typically in regex format), and transliteration may be used as a separate service to replace characters rather than remove them.

FilterInterface::filter() — Method in class FilterInterface

Performs a set of replacement rules against the input string, applying transliteration if a service is provided, and returns the filtered result.

HTMLValue::forTemplate() — Method in class HTMLValue

SQLFormatter::formatPlain() — Method in class SQLFormatter

SQLFormatter::formatHTML() — Method in class SQLFormatter

ShortcodeParser::findParentsForMarkers() — Method in class ShortcodeParser

URLSegmentFilter::filter() — Method in class URLSegmentFilter

Note: Depending on the applied replacement rules, this method might result in an empty string.

Requirements::flush() — Method in class Requirements

Triggered early in the request when a flush is requested

$ Requirements_Backend#forceJSToBottom — Property in class Requirements_Backend

Force the JavaScript to the bottom of the page, even if there's a script tag in the body already

SSViewer::flush() — Method in class SSViewer

Triggered early in the request when someone requests a flush.

SSViewer::fromString() — Method in class SSViewer

Create a template from a string instead of a .ss file

SSViewer::flush_template_cache() — Method in class SSViewer

Clears all parsed template files in the cache folder.

SSViewer::flush_cacheblock_cache() — Method in class SSViewer

Clears all partial cache blocks.

SSViewer_BasicIteratorSupport::FirstLast() — Method in class SSViewer_BasicIteratorSupport

Returns 'first' or 'last' if this is the first or last object in the set.

SSViewer_BasicIteratorSupport::FromEnd() — Method in class SSViewer_BasicIteratorSupport

Return the position of this item from the last item in the list. The position of the final item is $endIndex, which defaults to 1.

EmbedShortcodeProvider::flushCachedShortcodes() — Method in class EmbedShortcodeProvider

ThemeResourceLoader::findTemplate() — Method in class ThemeResourceLoader

Attempts to find possible candidate templates from a set of template names from modules, current theme directory and finally the application folder.

ThemeResourceLoader::findThemedCSS() — Method in class ThemeResourceLoader

Resolve themed CSS path

ThemeResourceLoader::findThemedJavascript() — Method in class ThemeResourceLoader

Resolve themed javascript path

ThemeResourceLoader::findThemedResource() — Method in class ThemeResourceLoader

Resolve a themed resource or directory

ThemeResourceLoader::flush() — Method in class ThemeResourceLoader

Flush any cached data

$ ViewableData#failover — Property in class ViewableData

A failover object to attempt to get data from if it is not present on this object.

ViewableData_Debugger::forTemplate() — Method in class ViewableData_Debugger

Return debugging information, as XHTML. If a field name is passed, it will show debugging information on that field, otherwise it will show information on all methods and fields.

CredentialRepository::findOneByCredentialId() — Method in class CredentialRepository

CredentialRepository::findAllForUserEntity() — Method in class CredentialRepository

CredentialRepository::fromArray() — Method in class CredentialRepository

Create an instance of a repository from the given credentials

FlushInvalidatedResource — Class in namespace SilverStripe\i18n\Messages\Symfony

Some arbitrary resource which expires when flush is invoked.

FlushInvalidatedResource::flush() — Method in class FlushInvalidatedResource

$ i18nTextCollector#fileExtensions — Property in class i18nTextCollector

List of file extensions to parse

i18nTextCollector::findModuleForClass() — Method in class i18nTextCollector

Given a partial class name, attempt to determine the best module to assign strings to.

AssignUsersToWorkflowAction::fieldLabels() — Method in class AssignUsersToWorkflowAction

Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.

NotifyUsersWorkflowAction::fieldLabels() — Method in class NotifyUsersWorkflowAction

Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.

$ AdvancedWorkflowAdmin#fileEditActions — Property in class AdvancedWorkflowAdmin

$ AdvancedWorkflowAdmin#fieldOverrides — Property in class AdvancedWorkflowAdmin

Defaults are set in getEditForm().

WorkflowDefinitionExporter::format() — Method in class WorkflowDefinitionExporter

Format the exported data as YAML.

FrontEndWorkflowController — Class in namespace Symbiote\AdvancedWorkflow\Controllers

Provides a front end Form view of the defined Workflow Actions and Transitions

FrontEndWorkflowController::Form() — Method in class FrontEndWorkflowController

Create the Form containing:

fields from the Context Object
required fields from the Context Object
Actions from the connected WorkflowTransitions

WorkflowAction::fieldLabels() — Method in class WorkflowAction

Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.

WorkflowActionInstance::fieldLabels() — Method in class WorkflowActionInstance

Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.

WorkflowDefinition::fieldLabels() — Method in class WorkflowDefinition

Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.

WorkflowInstance::fieldLabels() — Method in class WorkflowInstance

Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.

WorkflowTransition::fieldLabels() — Method in class WorkflowTransition

Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.

FileWorkflowApplicable — Class in namespace Symbiote\AdvancedWorkflow\Extensions

WorkflowApplicable extension specifically for File objects, which don't have the same CMS UI structure so need to be handled a little differently. Additionally, it doesn't really work without custom code to handle the triggering of workflow, and in general is not ready for production use just yet.

WorkflowField::FieldHolder() — Method in class WorkflowField

Returns a "field holder" for this field.

WorkflowFieldItemController::Form() — Method in class WorkflowFieldItemController

FrontendWorkflowForm — Class in namespace Symbiote\AdvancedWorkflow\Forms

$ GridFieldAddExistingSearchButton#fragment — Property in class GridFieldAddExistingSearchButton

$ GridFieldEditableColumns#forms — Property in class GridFieldEditableColumns

GridFieldRequestHandler::Form() — Method in class GridFieldRequestHandler

This method should be overloaded to build out the detail form.

KeyValueField::Field() — Method in class KeyValueField

Returns the form field.

MultiValueCheckboxField::Field() — Method in class MultiValueCheckboxField

MultiValueDropdownField::Field() — Method in class MultiValueDropdownField

Returns the form field.

MultiValueListField::Field() — Method in class MultiValueListField

Returns the form field.

MultiValueTextField::Field() — Method in class MultiValueTextField

Returns the form field.

MultiValueField::forTemplate() — Method in class MultiValueField

Determine 'default' casting for this field.

QueuedJobService::finaliseLogging() — Method in class QueuedJobService

FluentTestState — Class in namespace TractorCow\Fluent\Dev

FluentTestState::flushCaches() — Method in class FluentTestState

Flush all caches

FluentCMSMainExtension — Class in namespace TractorCow\Fluent\Extension

Custom handling of save & publish actions this is needed to ensure correct localised version records are created Currently, the default save / publish actions call Versioned::writeWithoutVersion() which breaks the Fluent functionality This extension injects the code which ensures the correct localisation is executed before the default action

FluentChangesExtension — Class in namespace TractorCow\Fluent\Extension

Adds locale-specific extensions to ChangeSet

FluentDateTimeExtension — Class in namespace TractorCow\Fluent\Extension

FluentDirectorExtension — Class in namespace TractorCow\Fluent\Extension

Fluent extension for \SilverStripe\Control\Director to apply routing rules for locales

$ FluentDirectorExtension#force_domain — Property in class FluentDirectorExtension

Whether to force "domain mode"

FluentExtension — Class in namespace TractorCow\Fluent\Extension

Basic fluent extension

$ FluentExtension#field_include — Property in class FluentExtension

Filter whitelist of fields to localise.

$ FluentExtension#field_exclude — Property in class FluentExtension

Filter blacklist of fields to localise.

FluentExtension::findRecordInLocale() — Method in class FluentExtension

Checks whether the given record ID exists in the given locale, in the given table. Skips using the ORM because we don't need it for this call.

FluentFilteredExtension — Class in namespace TractorCow\Fluent\Extension

FluentGridFieldExtension — Class in namespace TractorCow\Fluent\Extension

Supports GridFieldDetailForm_ItemRequest with extra actions

FluentIsolatedExtension — Class in namespace TractorCow\Fluent\Extension

Represents an object that can only exist in a single locale

FluentLeftAndMainExtension — Class in namespace TractorCow\Fluent\Extension

FluentMemberExtension — Class in namespace TractorCow\Fluent\Extension

FluentReadVersionsExtension — Class in namespace TractorCow\Fluent\Extension

Available since SilverStripe 4.3.x

FluentSiteTreeExtension — Class in namespace TractorCow\Fluent\Extension

Fluent extension for SiteTree

FluentVersionedExtension — Class in namespace TractorCow\Fluent\Extension

Extension for versioned localised objects

FluentVersionedExtension::flushCache() — Method in class FluentVersionedExtension

Clear internal static property caches

FluentVersionedExtension::flushVersionsCache() — Method in class FluentVersionedExtension

FluentAdminTrait — Class in namespace TractorCow\Fluent\Extension\Traits

Decorates admin areas for localised items with extra actions.

FluentBadgeTrait — Class in namespace TractorCow\Fluent\Extension\Traits

FluentObjectTrait — Class in namespace TractorCow\Fluent\Extension\Traits

Shared functionality between both FluentExtension and FluentFilteredExtension

FallbackLocale — Class in namespace TractorCow\Fluent\Model

Class FallbackLocale

FluentSearchForm — Class in namespace TractorCow\Fluent\Search

Simple extension to enable SS Core search to work with SS Fluent

FluentSearchVariant — Class in namespace TractorCow\Fluent\Search

Allow FulltextSearch to index content from all configured locales, and support users searching to be restricted to their active locale. Works in a very similar way to SearchVariantVersioned from the FulltextSearch module (where that variant restricts searches to live pages, etc.)

FluentState — Class in namespace TractorCow\Fluent\State

Stores the current fluent state

ConvertTranslatableTask::fluentClasses() — Method in class ConvertTranslatableTask

Gets all classes with FluentExtension

InitialDataObjectLocalisationTask::filterPermittedClassesRecursively() — Method in class InitialDataObjectLocalisationTask

FluentTemplateGlobalProvider — Class in namespace TractorCow\Fluent\View

G

GridFieldDropdownFilter — Class in namespace BringYourOwnIdeas\Maintenance\Forms

GridFieldDropdownFilter provides a dropdown that can be used to filter a GridField arbitrarily

GridFieldDropdownFilter::getActions() — Method in class GridFieldDropdownFilter

Return a list of the actions handled by this action provider.

GridFieldDropdownFilter::getManipulatedData() — Method in class GridFieldDropdownFilter

Manipulate the SS_List as needed by this grid modifier.

GridFieldDropdownFilter::getHTMLFragments() — Method in class GridFieldDropdownFilter

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

GridFieldHtmlFragment — Class in namespace BringYourOwnIdeas\Maintenance\Forms

Facilitates adding arbitrary HTML to grid fields

GridFieldHtmlFragment::getHTMLFragments() — Method in class GridFieldHtmlFragment

GridFieldLinkButton — Class in namespace BringYourOwnIdeas\Maintenance\Forms

A button that contains a link to an URL.

GridFieldLinkButton::getHTMLFragments() — Method in class GridFieldLinkButton

Place the link button in a

tag above the field

GridFieldRefreshButton — Class in namespace BringYourOwnIdeas\Maintenance\Forms

Adds a "Refresh" button to the bottom or top of a GridField.

GridFieldRefreshButton::getHTMLFragments() — Method in class GridFieldRefreshButton

GridFieldRefreshButton::getActions() — Method in class GridFieldRefreshButton

Refresh is an action button.

GridFieldRefreshButton::getURLHandlers() — Method in class GridFieldRefreshButton

Refresh is accessible via the url

GridFieldRefreshButton::getQueuedJobService() — Method in class GridFieldRefreshButton

CheckForUpdatesJob::getTitle() — Method in class CheckForUpdatesJob

Define the title

CheckForUpdatesJob::getJobType() — Method in class CheckForUpdatesJob

Define the type.

Package::getTitle() — Method in class Package

Strips vendor and 'silverstripe-' prefix from Name property

Package::getSummary() — Method in class Package

Returns HTML formatted summary of this object, uses a template to do this.

Package::getBadges() — Method in class Package

Gives the summary template {getSummary()} a list of badges to show against a package

Package::getDataSchema() — Method in class Package

Returns a JSON data schema for the frontend React components to use

SiteSummary::getReportField() — Method in class SiteSummary

Add a button row, including link out to the SilverStripe addons repository, and export button

SiteSummary::getDropdownFilter() — Method in class SiteSummary

Returns a dropdown filter with user configurable options in it

SiteSummary::getInfoLink() — Method in class SiteSummary

Returns a link to more information on this module on the addons site

SiteSummary::getCMSFields() — Method in class SiteSummary

Returns a FieldList with which to create the CMS editing form.

SiteSummary::getAlerts() — Method in class SiteSummary

Return a list of alerts to display in a message box above the report A combination of free text fields - combined alerts as opposed to a message box per alert.

SiteSummary::getLastUpdated() — Method in class SiteSummary

Get the "last updated" date for the report. This is based on the modified date of any of the records, since they are regenerated when the report is generated.

UpdatePackageInfoTask::getComposerLoader() — Method in class UpdatePackageInfoTask

Fetch the composer loader

UpdatePackageInfoTask::getSupportedAddonsLoader() — Method in class UpdatePackageInfoTask

UpdatePackageInfoTask::getModuleHealthLoader() — Method in class UpdatePackageInfoTask

UpdatePackageInfoTask::getTitle() — Method in class UpdatePackageInfoTask

UpdatePackageInfoTask::getDescription() — Method in class UpdatePackageInfoTask

UpdatePackageInfoTask::getPackageInfo() — Method in class UpdatePackageInfoTask

Fetch information about the installed packages.

UpdatePackageInfoTask::getSupportedPackages() — Method in class UpdatePackageInfoTask

Return an array of supported modules as fetched from silverstripe/supported-modules.

UpdatePackageInfoTask::getHealthIndicator() — Method in class UpdatePackageInfoTask

Return an array of module health information as fetched from addons.silverstripe.org.

$ ApiLoader#guzzleClient — Property in class ApiLoader

ApiLoader::getCacheKey() — Method in class ApiLoader

Define a unique cache key for results to be saved for each request (subclass)

ApiLoader::getGuzzleClient() — Method in class ApiLoader

ApiLoader::getClientOptions() — Method in class ApiLoader

Get Guzzle client options

ApiLoader::getFromCache() — Method in class ApiLoader

Attempts to load something from the cache and deserializes from JSON if successful

ApiLoader::getCache() — Method in class ApiLoader

ComposerLoader::getJson() — Method in class ComposerLoader

ComposerLoader::getLock() — Method in class ComposerLoader

ComposerLoader::getBasePath() — Method in class ComposerLoader

ModuleHealthLoader::getModuleHealthInfo() — Method in class ModuleHealthLoader

Return the list of supported addons as provided by addons.silverstripe.org

ModuleHealthLoader::getModuleNames() — Method in class ModuleHealthLoader

ModuleHealthLoader::getCacheKey() — Method in class ModuleHealthLoader

Define a unique cache key for results to be saved for each request (subclass)

SupportedAddonsLoader::getAddonNames() — Method in class SupportedAddonsLoader

Return the list of supported modules

SupportedAddonsLoader::getCacheKey() — Method in class SupportedAddonsLoader

Define a unique cache key for results to be saved for each request (subclass)

CheckComposerUpdatesExtension::getUpdateChecker() — Method in class CheckComposerUpdatesExtension

ComposerLoaderExtension::getComposer() — Method in class ComposerLoaderExtension

ComposerLoaderExtension::getPackages() — Method in class ComposerLoaderExtension

Retrieve an array of primary composer dependencies from composer.json.

ComposerLoaderExtension::getRepository() — Method in class ComposerLoaderExtension

Provides access to the Composer repository

ComposerLoaderExtension::getInstalledConstraint() — Method in class ComposerLoaderExtension

Find all dependency constraints for the given package in the current repository and return the strictest one

ComposerUpdateExtension::getAvailableVersion() — Method in class ComposerUpdateExtension

If the available version is the same as the current version then return nothing, otherwise show the latest available version

UpdateChecker::getVersionSelector() — Method in class UpdateChecker

CWPSiteConfigExtension::getThemeOptionsExcluding() — Method in class CWPSiteConfigExtension

Returns theme_colors used for ColorPickerField.

CarouselPageExtension::getCarouselItems() — Method in class CarouselPageExtension

ColorPickerField::getSchemaDataDefaults() — Method in class ColorPickerField

Gets the defaults for $schemaData.

ColorPickerField::getSourceValues() — Method in class ColorPickerField

Retrieve all values in the source array

FontPickerField::getSchemaDataDefaults() — Method in class FontPickerField

Gets the defaults for $schemaData.

CarouselItem::getCMSFields() — Method in class CarouselItem

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

ArchiveHandler::getI18nLabel() — Method in class ArchiveHandler

Return i18n localized front-end label

DeleteHandler::getI18nLabel() — Method in class DeleteHandler

Return i18n localized front-end label

EditHandler::getI18nLabel() — Method in class EditHandler

Return i18n localized front-end label

EditHandler::getToplevelController() — Method in class EditHandler

Traverse up nested requests until we reach the first that's not a GridFieldDetailForm or GridFieldDetailForm_ItemRequest.

$ Handler#gridField — Property in class Handler

Related GridField instance.

Handler::getConfig() — Method in class Handler

Return front-end configuration

Handler::getDestructive() — Method in class Handler

True if the hanlder performs destructive actions

Handler::getXhr() — Method in class Handler

True if handler is called via XHR

Handler::getButtonClasses() — Method in class Handler

Return front-end buttonClasses

Handler::getIcon() — Method in class Handler

Return front-end icon

Handler::getLabel() — Method in class Handler

Return front-end label

Handler::getI18nLabel() — Method in class Handler

Return i18n localized front-end label

Handler::getRecordIDList() — Method in class Handler

Returns the list of record IDs selected in the front-end.

Handler::getRecords() — Method in class Handler

Returns a DataList of the records selected in the front-end.

PublishHandler::getI18nLabel() — Method in class PublishHandler

Return i18n localized front-end label

UnPublishHandler::getI18nLabel() — Method in class UnPublishHandler

Return i18n localized front-end label

UnlinkHandler::getI18nLabel() — Method in class UnlinkHandler

Return i18n localized front-end label

BulkManager::getConfig() — Method in class BulkManager

Returns one $config parameter of the full $config.

BulkManager::getBulkActions() — Method in class BulkManager

Return the list of bulk actions already provided

BulkManager::getColumnsHandled() — Method in class BulkManager

Which columns are handled by the component.

BulkManager::getColumnContent() — Method in class BulkManager

Sets the column's content.

BulkManager::getColumnAttributes() — Method in class BulkManager

Set the column's HTML attributes.

BulkManager::getColumnMetadata() — Method in class BulkManager

Set the column's meta data.

BulkManager::getHTMLFragments() — Method in class BulkManager

BulkManager::getURLHandlers() — Method in class BulkManager

Returns an action => handler list.

$ HTTPBulkToolsResponse#gridField — Property in class HTTPBulkToolsResponse

GridField instance.

HTTPBulkToolsResponse::getBody() — Method in class HTTPBulkToolsResponse

Makes sure body is created before being returned

HTTPBulkToolsResponse::getSuccessRecords() — Method in class HTTPBulkToolsResponse

Return the list of successful records

HTTPBulkToolsResponse::getFailedRecords() — Method in class HTTPBulkToolsResponse

Return the list of failed records

HTTPBulkToolsResponse::getRecordGridfieldRow() — Method in class HTTPBulkToolsResponse

Creates a gridfield table row for a given record

$ BulkUploadField#gridfield — Property in class BulkUploadField

$ BulkUploadHandler#gridField — Property in class BulkUploadHandler

Gridfield instance.

BulkUploadHandler::getRecordRow() — Method in class BulkUploadHandler

BulkUploader::getAutoPublishDataObject() — Method in class BulkUploader

Get Versioned DataObject auto publish config

BulkUploader::getConfig() — Method in class BulkUploader

Returns one $config reference or the full $config.

BulkUploader::getUfSetup() — Method in class BulkUploader

Returns one $ufSetup reference or the full config.

BulkUploader::getRecordClassName() — Method in class BulkUploader

Returns the class name of container DataObject record.

BulkUploader::getDefaultFileRelationName() — Method in class BulkUploader

Get the first has_one Image/File relation from the GridField managed DataObject i.e. 'MyImage' => 'Image' will return 'MyImage'.

BulkUploader::getFileRelationName() — Method in class BulkUploader

Returns the name of the Image/File field name from the managed record Either as set in the component config or the default one.

BulkUploader::getFileRelationClassName() — Method in class BulkUploader

Return the ClassName of the fileRelation i.e. 'MyImage' => 'Image' will return 'Image' i.e. 'MyImage' => 'File' will return 'File'.

BulkUploader::getHTMLFragments() — Method in class BulkUploader

HTML to be embedded into the GridField.

BulkUploader::getURLHandlers() — Method in class BulkUploader

Component URL handlers.

ElementFormController::getUserFormController() — Method in class ElementFormController

Return the associated UserDefinedFormController

ElementForm::getType() — Method in class ElementForm

Get the type of the current block, for use in GridField summaries, block type dropdowns etc. Examples are "Content", "File", "Media", etc.

ElementController::getElement() — Method in class ElementController

ElementalAreaController::getClientConfig() — Method in class ElementalAreaController

Returns configuration required by the client app.

ElementalAreaController::getElementForm() — Method in class ElementalAreaController

This method is called from LeftAndMain::schema() /admin/linkfield/schema/elementForm/

ElementalAreasExtension::getElementalTypes() — Method in class ElementalAreasExtension

Get the available element types for this page type,

ElementalAreasExtension::getElementalRelations() — Method in class ElementalAreasExtension

Returns an array of the relation names to ElementAreas. Ignores any has_one fields named Parent as that would indicate that this is child of an existing area

ElementalPageExtension::getElementsForSearch() — Method in class ElementalPageExtension

Returns the contents of each ElementalArea has_one's markup for use in Solr or Elastic search indexing

ElementalPageExtension::getContentFromElementsForCmsSearch() — Method in class ElementalPageExtension

Returns the contents of all Elements on the pages ElementalAreas for use in CMS search

GridFieldAddNewMultiClassHandlerExtension — Class in namespace DNADesign\Elemental\Extensions

GridFieldDetailFormItemRequestExtension — Class in namespace DNADesign\Elemental\Extensions

EditFormFactory::getForm() — Method in class EditFormFactory

EditFormFactory::getFormFields() — Method in class EditFormFactory

EditFormFactory::getFormValidator() — Method in class EditFormFactory

ElementalAreaField::getTypes() — Method in class ElementalAreaField

ElementalAreaField::getArea() — Method in class ElementalAreaField

ElementalAreaField::getSchemaDataDefaults() — Method in class ElementalAreaField

Gets the defaults for $schemaData.

ElementalAreaField::getReadOnlyBlockReducer() — Method in class ElementalAreaField

A getter method that seems redundant in that it is a function that returns a function, however the returned closure is used in an array map function to return a complete FieldList representing a read only view of the element passed in (to the closure).

TextCheckboxGroupField::getMessage() — Method in class TextCheckboxGroupField

Returns the field message, used by form validation.

TextCheckboxGroupField::getMessageType() — Method in class TextCheckboxGroupField

Returns the field message type.

TextCheckboxGroupField::getMessageCast() — Method in class TextCheckboxGroupField

Casting type for this message. Will be 'text' or 'html'

BaseElement::getCMSFields() — Method in class BaseElement

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

BaseElement::getType() — Method in class BaseElement

Get the type of the current block, for use in GridField summaries, block type dropdowns etc. Examples are "Content", "File", "Media", etc.

BaseElement::getController() — Method in class BaseElement

BaseElement::getSearchIndexable() — Method in class BaseElement

Determines whether this elemental block is indexable in search.

BaseElement::getContentForSearchIndex() — Method in class BaseElement

Provides content to be indexed in search.

BaseElement::getContentForCmsSearch() — Method in class BaseElement

Provides content for CMS search if ElementSiteTreeFilterSearch.render_elements is false

BaseElement::getRenderTemplates() — Method in class BaseElement

BaseElement::getSimpleClassName() — Method in class BaseElement

BaseElement::getPage() — Method in class BaseElement

Despite the name of the method, getPage can return any type of DataObject

BaseElement::getAnchor() — Method in class BaseElement

Get a unique anchor name

BaseElement::getAnchorsInContent() — Method in class BaseElement

Get anchors in this block's content.

BaseElement::getAreaRelationName() — Method in class BaseElement

Retrieve a elemental area relation for creating cms links

BaseElement::getEditLink() — Method in class BaseElement

BaseElement::getMimeType() — Method in class BaseElement

BaseElement::getSummary() — Method in class BaseElement

This can be overridden on child elements to create a summary for display in GridFields.

BaseElement::getBlockConfig() — Method in class BaseElement

The block config defines a set of data (usually set through config on the element) that will be made available in client side config. Individual element types may choose to add config variable for use in React code

BaseElement::getIcon() — Method in class BaseElement

Generate markup for element type icons suitable for use in GridFields.

BaseElement::getDescription() — Method in class BaseElement

Get a description for this content element, if available

BaseElement::getTypeNice() — Method in class BaseElement

Generate markup for element type, with description suitable for use in GridFields.

BaseElement::getEditorPreview() — Method in class BaseElement

BaseElement::getAuthor() — Method in class BaseElement

BaseElement::getStyleVariant() — Method in class BaseElement

Get a user defined style variant for this element, if available

BaseElement::getPageTitle() — Method in class BaseElement

BaseElement::getGraphQLTypeName() — Method in class BaseElement

ElementContent::getCMSFields() — Method in class ElementContent

Re-title the HTML field to Content

ElementContent::getSummary() — Method in class ElementContent

This can be overridden on child elements to create a summary for display in GridFields.

ElementContent::getType() — Method in class ElementContent

Get the type of the current block, for use in GridField summaries, block type dropdowns etc. Examples are "Content", "File", "Media", etc.

ElementalArea::getOwnerPage() — Method in class ElementalArea

DBObjectType::getGraphQLType() — Method in class DBObjectType

ElementTypeReport::getElementTypes() — Method in class ElementTypeReport

Return an array of all valid classes that extend BaseElement

ElementTypeReport::getReportField() — Method in class ElementTypeReport

Add elemental CSS and a unique class name to the GridField

ElementsInUseReport::getEditLink() — Method in class ElementsInUseReport

Helper method to return the link to edit an element

ElementsInUseReport::getReportField() — Method in class ElementsInUseReport

Add elemental CSS and a unique class name to the GridField

ElementsInUseReport::getBreadcrumbs() — Method in class ElementsInUseReport

When used with silverstripe/reports >= 4.4, this method will automatically be added as breadcrumbs leading up to this report.

ElementTypeRegistry::getDefinitions() — Method in class ElementTypeRegistry

Get the schema of the element types that are registered

ElementTypeRegistry::getDefinition() — Method in class ElementTypeRegistry

Get the element type data for the given instance or class name of an element.

ElementTypeRegistry::generate() — Method in class ElementTypeRegistry

Create a registry and attempt to fill it by resolving element types by introspecting class hierarchy

ReorderElements::getElement() — Method in class ReorderElements

Get the Element reordering will be performed on

MigrateContentToElement::getAreaRelationFromPage() — Method in class MigrateContentToElement

Extracts the relevant ElementalArea from the given page. This can be overloaded for custom page types that might prefer an alternate area to hold the migrated content

DataExtension::getTopPage() — Method in class DataExtension

Finds the top-level SiteTree object for a Block / ElementalArea, using the cached TopPageID reference when possible.

DataExtension::getFixedTopPageID() — Method in class DataExtension

Get the ID of a page which is currently set as the fixed top page

DataExtension::getTopPageFromCachedData() — Method in class DataExtension

Perform a page lookup based on cached data This function allows more extensibility as it can be fully overridden unlike an extension point Various projects may decide to alter this by injecting features like tracking, feature flags and even completely different data lookups This is a performance driven functionality so extension points are not great as they only allow adding features on top of existing ones not replacing them

DataExtension::getTopPageTable() — Method in class DataExtension

Find table name which has the top page fields

SiteTreeExtension::getDuplicationKey() — Method in class SiteTreeExtension

Generates a unique key for the page

SiteTreeExtension::getDuplicatedPageKey() — Method in class SiteTreeExtension

Find currently duplicated page note: this doesn't change any stored data

AdminRootController::get_admin_route() — Method in class AdminRootController

Convenience function to return the admin route config.

AdminRootController::get_template_global_variables() — Method in class AdminRootController

CMSBatchAction::getActionTitle() — Method in class CMSBatchAction

The the text to show in the dropdown for this action

CMSBatchAction::getParameterFields() — Method in class CMSBatchAction

CMSBatchActionHandler::getPages() — Method in class CMSBatchActionHandler

Safely query and return all pages queried

CMSEditLinkExtension::getCMSEditOwner() — Method in class CMSEditLinkExtension

Get the ModelAdmin, LeftAndMain, or DataObject which owns this object for CMS editing purposes.

CMSEditLinkExtension::getCMSEditLinkForManagedDataObject() — Method in class CMSEditLinkExtension

Get the link for editing an object from the CMS edit form of this object.

CMSMenu::get_menu_item() — Method in class CMSMenu

Get a single menu item by its code value.

CMSMenu::get_menu_code() — Method in class CMSMenu

Get menu code for class

CMSMenu::get_menu_items() — Method in class CMSMenu

Get all menu entries.

CMSMenu::get_viewable_menu_items() — Method in class CMSMenu

Get all menu items that the passed member can view.

CMSMenu::get_cms_classes() — Method in class CMSMenu

A utility funciton to retrieve subclasses of a given class that are instantiable (ie, not abstract) and have a valid menu title.

CMSMenu::getIterator() — Method in class CMSMenu

IteratorAggregate Interface Method. Iterates over the menu items.

CMSMenuItem::getAttributesHTML() — Method in class CMSMenuItem

CMSProfileController::getEditForm() — Method in class CMSProfileController

Calls SiteTree->getCMSFields() by default to determine the form fields to display.

EditorEmailLinkFormFactory::getFormFields() — Method in class EditorEmailLinkFormFactory

EditorEmailLinkFormFactory::getValidator() — Method in class EditorEmailLinkFormFactory

EditorExternalLinkFormFactory::getFormFields() — Method in class EditorExternalLinkFormFactory

EditorExternalLinkFormFactory::getValidator() — Method in class EditorExternalLinkFormFactory

GridFieldDetailFormPreviewExtension — Class in namespace SilverStripe\Admin\Forms

GridFieldPrintButtonExtension — Class in namespace SilverStripe\Admin\Forms

LinkFormFactory::getForm() — Method in class LinkFormFactory

LinkFormFactory::getFormFields() — Method in class LinkFormFactory

LinkFormFactory::getFormActions() — Method in class LinkFormFactory

LinkFormFactory::getValidator() — Method in class LinkFormFactory

LinkFormFactory::getRequiredContext() — Method in class LinkFormFactory

Return list of mandatory context keys

UsedOnTable::getSchemaDataDefaults() — Method in class UsedOnTable

UsedOnTable::getState() — Method in class UsedOnTable

UsedOnTable::getRecord() — Method in class UsedOnTable

UsedOnTable::getAttributes() — Method in class UsedOnTable

Attributes to be given for this field type

LeftAndMain::getCombinedClientConfig() — Method in class LeftAndMain

Gets the combined configuration of all LeftAndMain subclasses required by the client app.

LeftAndMain::getClientConfig() — Method in class LeftAndMain

Returns configuration required by the client app.

LeftAndMain::getFormSchema() — Method in class LeftAndMain

Get form schema helper

LeftAndMain::getSchemaRequested() — Method in class LeftAndMain

Check if the current request has a X-Formschema-Request header set.

LeftAndMain::getSchemaResponse() — Method in class LeftAndMain

Generate schema for the given form based on the X-Formschema-Request header value

LeftAndMain::getRequiredPermissions() — Method in class LeftAndMain

Get list of required permissions

LeftAndMain::getResponseNegotiator() — Method in class LeftAndMain

LeftAndMain::getTemplatesWithSuffix() — Method in class LeftAndMain

Return appropriate template(s) for this class, with the given suffix using SSViewer::get_templates_by_class()

LeftAndMain::getRecord() — Method in class LeftAndMain

Get dataobject from the current ID

LeftAndMain::getSearchFilter() — Method in class LeftAndMain

Gets the current search filter for this request, if available

LeftAndMain::getNewItem() — Method in class LeftAndMain

Create new item.

LeftAndMain::getEditForm() — Method in class LeftAndMain

Calls SiteTree->getCMSFields() by default to determine the form fields to display.

LeftAndMain::getSilverStripeNavigator() — Method in class LeftAndMain

Used for preview controls, mainly links which switch between different states of the page.

LeftAndMain::getHelpLinks() — Method in class LeftAndMain

Returns help_links in a format readable by a template

LeftAndMain::getApplicationName() — Method in class LeftAndMain

Get the application name.

LeftAndMain::getVersionProvider() — Method in class LeftAndMain

Get the SilverStripe version provider

LeftAndMain::getHttpErrorMessage() — Method in class LeftAndMain

Get the HTTP error message if one has occurred during HandleRequest.

LeftAndMain_SearchFilter::getChildrenMethod() — Method in class LeftAndMain_SearchFilter

Method on Hierarchy objects which is used to traverse into children relationships.

LeftAndMain_SearchFilter::getNumChildrenMethod() — Method in class LeftAndMain_SearchFilter

Method on Hierarchy objects which is used find the number of children for a parent page

LeftAndMain_SearchFilter::getPageClasses() — Method in class LeftAndMain_SearchFilter

Given a page, determine any additional CSS classes to apply to the tree node

ModalController::getRequest() — Method in class ModalController

Returns the HTTPRequest object that this controller is using.

ModalController::getController() — Method in class ModalController

ModalController::getName() — Method in class ModalController

Get urlsegment

ModelAdmin::getLinkForModelClass() — Method in class ModelAdmin

Get the link for the tab of a DataObject subclass managed by this ModelAdmin.

ModelAdmin::getLinkForModelTab() — Method in class ModelAdmin

Get the link for a specific tab on this ModelAdmin.

ModelAdmin::getCMSEditLinkForManagedDataObject() — Method in class ModelAdmin

Get the link for editing an object inside this ModelAdmin.

ModelAdmin::getEditForm() — Method in class ModelAdmin

Produces an edit form that includes a default \SilverStripe\Forms\GridField\GridField for the currently active \SilverStripe\ORM\DataObject. The GridField will show data from the currently active modelClass only (see ModelAdmin::init()).

ModelAdmin::getGridField() — Method in class ModelAdmin

Generate the GridField field that will be used for this ModelAdmin.

ModelAdmin::getGridFieldConfig() — Method in class ModelAdmin

Generate the GridField Configuration that will use for the ModelAdmin Gridfield.

ModelAdmin::getExportFields() — Method in class ModelAdmin

Define which fields are used in the getEditForm GridField export.

ModelAdmin::getList() — Method in class ModelAdmin

You can override how ModelAdmin returns DataObjects by either overloading this method, or defining an extension to ModelAdmin that implements the updateList method (and takes a \SilverStripe\ORM\DataList as the first argument).

ModelAdmin::getModelClass() — Method in class ModelAdmin

The model managed by this instance.

ModelAdmin::getManagedModelTabs() — Method in class ModelAdmin

ModelAdmin::getManagedModels() — Method in class ModelAdmin

ModelAdmin::getModelTabForModelClass() — Method in class ModelAdmin

Get the model tab name for a given model class

ModelAdmin::getModelImporters() — Method in class ModelAdmin

Returns all importers defined in ModelAdmin::$model_importers.

SilverStripeNavigator::getItems() — Method in class SilverStripeNavigator

SilverStripeNavigator::getRecord() — Method in class SilverStripeNavigator

SilverStripeNavigator::get_for_record() — Method in class SilverStripeNavigator

SilverStripeNavigatorItem::getHTML() — Method in class SilverStripeNavigatorItem

SilverStripeNavigatorItem::getTitle() — Method in class SilverStripeNavigatorItem

SilverStripeNavigatorItem::getName() — Method in class SilverStripeNavigatorItem

Machine-friendly name.

SilverStripeNavigatorItem::getLink() — Method in class SilverStripeNavigatorItem

Optional link to a specific view of this record.

SilverStripeNavigatorItem::getMessage() — Method in class SilverStripeNavigatorItem

SilverStripeNavigatorItem::getRecord() — Method in class SilverStripeNavigatorItem

SilverStripeNavigatorItem::getPriority() — Method in class SilverStripeNavigatorItem

SilverStripeNavigatorItem_Unversioned::getHTML() — Method in class SilverStripeNavigatorItem_Unversioned

SilverStripeNavigatorItem_Unversioned::getLink() — Method in class SilverStripeNavigatorItem_Unversioned

Optional link to a specific view of this record.

SilverStripeNavigatorItem_Unversioned::getTitle() — Method in class SilverStripeNavigatorItem_Unversioned

SecurityAdmin::getManagedModels() — Method in class SecurityAdmin

SecurityAdmin::getGridFieldConfig() — Method in class SecurityAdmin

Generate the GridField Configuration that will use for the ModelAdmin Gridfield.

SudoModeController::getClientConfig() — Method in class SudoModeController

Returns configuration required by the client app.

SudoModeController::getSudoModeService() — Method in class SudoModeController

DeleteAssets::getActionTitle() — Method in class DeleteAssets

The the text to show in the dropdown for this action

AssetAdmin::getClientConfig() — Method in class AssetAdmin

Returns configuration required by the client app.

AssetAdmin::getFileEditLink() — Method in class AssetAdmin

Given a file return the CMS link to edit it

AssetAdmin::getNameGenerator() — Method in class AssetAdmin

Get an asset renamer for the given filename.

AssetAdmin::getFormFactory() — Method in class AssetAdmin

Build a form scaffolder for this model

AssetAdmin::getFileEditForm() — Method in class AssetAdmin

The form is used to generate a form schema, as well as an intermediary object to process data through API endpoints.

AssetAdmin::getFileInsertForm() — Method in class AssetAdmin

The form is used to generate a form schema, as well as an intermediary object to process data through API endpoints.

AssetAdmin::getFileEditorLinkForm() — Method in class AssetAdmin

The form used to generate a form schema, since it's used directly on API endpoints, it does not have any form actions.

AssetAdmin::getAbstractFileForm() — Method in class AssetAdmin

Abstract method for generating a form for a file

AssetAdmin::getMoveForm() — Method in class AssetAdmin

Get form for moving files/folders to a new location

AssetAdmin::getFileSelectForm() — Method in class AssetAdmin

Get form for selecting a file

AssetAdmin::getFileHistoryForm() — Method in class AssetAdmin

AssetAdmin::getObjectFromData() — Method in class AssetAdmin

Build the array containing the all attributes the AssetAdmin client interact with.

AssetAdmin::getMinimalistObjectFromData() — Method in class AssetAdmin

Build the array containing the minimal attributes needed to render an UploadFieldItem.

AssetAdmin::generateThumbnails() — Method in class AssetAdmin

Generate thumbnails and provide links for a given file

AssetAdmin::getAddToCampaignForm() — Method in class AssetAdmin

AssetAdmin::getUpload() — Method in class AssetAdmin

AssetAdmin::getRecordUpdatedResponse() — Method in class AssetAdmin

Get response for successfully updated record

AssetAdmin::getFolderCreateForm() — Method in class AssetAdmin

Returns the form to be used for creating a new folder

AssetAdmin::getFileSearchform() — Method in class AssetAdmin

Allow search form to be accessible to schema

AssetAdmin::getThumbnailGenerator() — Method in class AssetAdmin

AssetAdminFile::getInsertWidth() — Method in class AssetAdminFile

Calculate width to insert into html area

AssetAdminFile::getInsertHeight() — Method in class AssetAdminFile

Calculate width to insert into html area

AssetAdminFile::getInsertDimensions() — Method in class AssetAdminFile

Get dimensions of this image sized within insert_width x insert_height

AssetAdminFile::getFilesInUse() — Method in class AssetAdminFile

Get the list of all nested files in use

AssetAdminFile::getDescendantFileCount() — Method in class AssetAdminFile

RemoteFileModalExtension::getRequest() — Method in class RemoteFileModalExtension

RemoteFileModalExtension::getFormSchema() — Method in class RemoteFileModalExtension

RemoteFileModalExtension::getSchemaResponse() — Method in class RemoteFileModalExtension

Generate schema for the given form based on the X-Formschema-Request header value

AssetFormFactory::getForm() — Method in class AssetFormFactory

AssetFormFactory::getValidator() — Method in class AssetFormFactory

Get the validator for the form to be built

AssetFormFactory::getFormType() — Method in class AssetFormFactory

Get form type from 'type' context

AssetFormFactory::getFormFieldTabs() — Method in class AssetFormFactory

Gets the main tabs for the file edit form

AssetFormFactory::getSaveAction() — Method in class AssetFormFactory

AssetFormFactory::getDeleteAction() — Method in class AssetFormFactory

Get delete action, if this record is deletable

AssetFormFactory::getFormActions() — Method in class AssetFormFactory

AssetFormFactory::getFormFields() — Method in class AssetFormFactory

Get fields for this form

AssetFormFactory::getPopoverMenu() — Method in class AssetFormFactory

Build popup menu

AssetFormFactory::getPopoverActions() — Method in class AssetFormFactory

Get actions that go into the Popover menu

AssetFormFactory::getFormFieldDetailsTab() — Method in class AssetFormFactory

Build "details" formfield tab

AssetFormFactory::getPath() — Method in class AssetFormFactory

Get user-visible "Path" for this record

AssetFormFactory::getFormFieldSecurityTab() — Method in class AssetFormFactory

Build security tab

AssetFormFactory::getRequiredContext() — Method in class AssetFormFactory

Return list of mandatory context keys

FileFormFactory::getFormFieldTabs() — Method in class FileFormFactory

FileFormFactory::getFormFieldDetailsTab() — Method in class FileFormFactory

FileFormFactory::getFormFieldUsageTab() — Method in class FileFormFactory

FileFormFactory::getFormFieldLinkOptionsTab() — Method in class FileFormFactory

FileFormFactory::getFormFieldAttributesTab() — Method in class FileFormFactory

Create tab for file attributes

FileFormFactory::getFormFieldHistoryTab() — Method in class FileFormFactory

FileFormFactory::getFormFields() — Method in class FileFormFactory

Get fields for this form

FileFormFactory::getPublishAction() — Method in class FileFormFactory

Get publish action

FileFormFactory::getFormActions() — Method in class FileFormFactory

FileFormFactory::getSpecsMarkup() — Method in class FileFormFactory

get HTML for status icon

FileFormFactory::getStatusFlagMarkup() — Method in class FileFormFactory

Get published status flag

FileFormFactory::getUnpublishAction() — Method in class FileFormFactory

Get action for publishing

FileFormFactory::getReplaceFileAction() — Method in class FileFormFactory

Get Replace file action

FileFormFactory::getDownloadFileAction() — Method in class FileFormFactory

Get Download file action

FileFormFactory::getPopoverActions() — Method in class FileFormFactory

Get actions that go into the Popover menu

FileFormFactory::getInsertAction() — Method in class FileFormFactory

FileFormFactory::getInsertLinkAction() — Method in class FileFormFactory

FileFormFactory::getRequiredContext() — Method in class FileFormFactory

FileFormFactory::getValidator() — Method in class FileFormFactory

Get the validator for the form to be built

FileHistoryFormFactory::getForm() — Method in class FileHistoryFormFactory

FileHistoryFormFactory::getSpecsMarkup() — Method in class FileHistoryFormFactory

get HTML for status icon

FileHistoryFormFactory::getFormFields() — Method in class FileHistoryFormFactory

Get fields for this form

FileHistoryFormFactory::getFormActions() — Method in class FileHistoryFormFactory

FileHistoryFormFactory::getRequiredContext() — Method in class FileHistoryFormFactory

FileSearchFormFactory::getForm() — Method in class FileSearchFormFactory

Generates the form

FileSearchFormFactory::getFormFields() — Method in class FileSearchFormFactory

FileSearchFormFactory::getRequiredContext() — Method in class FileSearchFormFactory

Return list of mandatory context keys

FolderCreateFormFactory::getRequiredContext() — Method in class FolderCreateFormFactory

Return list of mandatory context keys

FolderCreateFormFactory::getFormFields() — Method in class FolderCreateFormFactory

Get fields for this form

FolderCreateFormFactory::getSaveAction() — Method in class FolderCreateFormFactory

FolderCreateFormFactory::getDeleteAction() — Method in class FolderCreateFormFactory

FolderFormFactory::getFormFields() — Method in class FolderFormFactory

Get fields for this form

HistoryListField::getSchemaStateDefaults() — Method in class HistoryListField

Gets the defaults for $schemaState.

HistoryListField::getRecord() — Method in class HistoryListField

ImageFormFactory::getSpecsMarkup() — Method in class ImageFormFactory

get HTML for status icon

ImageFormFactory::getFormFieldAttributesTab() — Method in class ImageFormFactory

Create tab for file attributes

ImageFormFactory::getForm() — Method in class ImageFormFactory

MoveFormFactory::getForm() — Method in class MoveFormFactory

Generates the form

MoveFormFactory::getRequiredContext() — Method in class MoveFormFactory

Return list of mandatory context keys

PreviewImageField::getSchemaDataDefaults() — Method in class PreviewImageField

Gets the defaults for $schemaData.

PreviewImageField::getSchemaStateDefaults() — Method in class PreviewImageField

Gets the defaults for $schemaState.

PreviewImageField::getRecord() — Method in class PreviewImageField

RemoteFileFormFactory::getForm() — Method in class RemoteFileFormFactory

RemoteFileFormFactory::getRequiredContext() — Method in class RemoteFileFormFactory

Return list of mandatory context keys

RemoteFileFormFactory::getFormFields() — Method in class RemoteFileFormFactory

RemoteFileFormFactory::getFormActions() — Method in class RemoteFileFormFactory

RemoteFileFormFactory::getCreateFormFields() — Method in class RemoteFileFormFactory

Get form fields for create new embed

RemoteFileFormFactory::getEditFormFields() — Method in class RemoteFileFormFactory

Get form fields for edit form

UploadField::getSchemaDataDefaults() — Method in class UploadField

Gets the defaults for $schemaData.

UploadField::getFolderID() — Method in class UploadField

Get ID of target parent folder

UploadField::getSchemaStateDefaults() — Method in class UploadField

Gets the defaults for $schemaState.

UploadField::getEncodedItems() — Method in class UploadField

Encode selected values for react

UploadField::getIsMultiUpload() — Method in class UploadField

Check if allowed to upload more than one file

UploadField::getAllowedMaxFileNumber() — Method in class UploadField

Gets the number of files allowed for this field

UploadField::getAllowedMaxFileSize() — Method in class UploadField

Returns the max allowed filesize

UploadField::getAttributes() — Method in class UploadField

Allows customization through an 'updateAttributes' hook on the base class.

UploadField::getUploadEnabled() — Method in class UploadField

Check if uploading files is enabled

UploadField::getAttachEnabled() — Method in class UploadField

Check if attaching files is enabled

Notice::getNoticeType() — Method in class Notice

Notice::getIDs() — Method in class Notice

Notice::getMessage() — Method in class Notice

FileTypeResolver::getThumbnailGenerator() — Method in class FileTypeResolver

ImageThumbnailHelper::getMaxImageFileSize() — Method in class ImageThumbnailHelper

Get the maximum file size for which thumbnails will be generated. Set to 0 to disable the limit.

ImageThumbnailHelper::generateThumbnails() — Method in class ImageThumbnailHelper

Similar to AssetAdmin->generateThumbnails(), but with the ability to tell if a file actually required to be generated.

$ ThumbnailGenerator#generates — Property in class ThumbnailGenerator

Set to false to not generate

ThumbnailGenerator::generateThumbnailLink() — Method in class ThumbnailGenerator

Generate thumbnail and return the "src" property for this thumbnail

ThumbnailGenerator::generateThumbnail() — Method in class ThumbnailGenerator

Generate thumbnail object

ThumbnailGenerator::generateLink() — Method in class ThumbnailGenerator

Generate "src" property for this thumbnail.

ThumbnailGenerator::getGenerates() — Method in class ThumbnailGenerator

AssetControlExtension::getRecordState() — Method in class AssetControlExtension

Check default state of this record

AssetControlExtension::getAssetStore() — Method in class AssetControlExtension

AssetManipulationList::getAssetKey() — Method in class AssetManipulationList

Get an identifying key for a given filename and hash

AssetManipulationList::getPublicAssets() — Method in class AssetManipulationList

Get all public assets

AssetManipulationList::getProtectedAssets() — Method in class AssetManipulationList

Get protected assets

AssetManipulationList::getDeletedAssets() — Method in class AssetManipulationList

Get deleted assets

TestAssetStore::getLocalPath() — Method in class TestAssetStore

Helper method to get local filesystem path for this file

TestAssetStore::getFileID() — Method in class TestAssetStore

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

TestAssetStore::getOriginalFilename() — Method in class TestAssetStore

TestAssetStore::getFilesystemFor() — Method in class TestAssetStore

TestAssetStore::getDefaultConflictResolution() — Method in class TestAssetStore

Choose a default conflict resolution

File::get_shortcodes() — Method in class File

File::getTreeTitle() — Method in class File

File::getCMSFields() — Method in class File

List of basic content editable file fields.

File::getStatusTitle() — Method in class File

Get title for current file status

File::get_app_category() — Method in class File

Returns a category based on the file extension.

File::get_category_extensions() — Method in class File

For a category or list of categories, get the list of file extensions

File::getNormalisedFileName() — Method in class File

Generate a readable title, dashes and underscores replaced by whitespace, and any file extensions removed.

File::getNameGenerator() — Method in class File

Get an asset renamer for the given filename.

File::getAbsoluteURL() — Method in class File

Gets the URL of this file

File::getURL() — Method in class File

Gets the URL of this file

File::getSourceURL() — Method in class File

Get URL, but without resampling.

File::generateFilename() — Method in class File

Get expected value of Filename tuple value. Will be used to trigger a file move on draft stage.

File::getExtension() — Method in class File

Returns the file extension

File::get_file_extension() — Method in class File

Gets the extension of a filepath or filename, by stripping away everything before the last "dot".

File::get_icon_for_extension() — Method in class File

Given an extension, determine the icon that should be used

File::getFileType() — Method in class File

Return the type of file for the given extension on the current file name.

File::get_file_type() — Method in class File

Get descriptive type of file based on filename

File::getSize() — Method in class File

Returns the size of the file type in an appropriate format.

File::getAbsoluteSize() — Method in class File

Return file size in bytes.

File::get_class_for_file_extension() — Method in class File

Maps a File subclass to a specific extension.

File::getMetaData() — Method in class File

Get metadata for this file

File::getMimeType() — Method in class File

Get mime type

File::getStream() — Method in class File

File::getString() — Method in class File

File::getIsImage() — Method in class File

Determine if a valid non-empty image exists behind this asset

File::getFilename() — Method in class File

Get value of filename

File::getHash() — Method in class File

Get value of hash

File::getVariant() — Method in class File

Get value of variant

File::getTag() — Method in class File

Return a html5 tag of the appropriate for this file (normally img or a)

File::getVisibility() — Method in class File

Determine visibility of the given file

File::grantFile() — Method in class File

Ensures that access to the specified protected file is granted for the current user.

File::getPermissionChecker() — Method in class File

File::getAllowedExtensions() — Method in class File

Get the list of globally allowed file extensions for file uploads.

File::getFilter() — Method in class File

FileFinder::getOption() — Method in class FileFinder

Returns an option value set on this instance.

FileNameFilter::getReplacements() — Method in class FileNameFilter

FileNameFilter::getTransliterator() — Method in class FileNameFilter

FileNameFilter::getDefaultName() — Method in class FileNameFilter

AbstractFileIDHelper::getFileIDBase() — Method in class AbstractFileIDHelper

FileIDHelperResolutionStrategy::generateVariantFileID() — Method in class FileIDHelperResolutionStrategy

Build a file ID for a variant so it follows the pattern of its original file. The variant may not exist on the Filesystem yet, but the original file has to. This is to make sure that variant files always follow the same pattern as the original file they are attached to.

FileIDHelperResolutionStrategy::getDefaultFileIDHelper() — Method in class FileIDHelperResolutionStrategy

FileIDHelperResolutionStrategy::getResolutionFileIDHelpers() — Method in class FileIDHelperResolutionStrategy

FileIDHelperResolutionStrategy::getVersionedStage() — Method in class FileIDHelperResolutionStrategy

FileResolutionStrategy::generateVariantFileID() — Method in class FileResolutionStrategy

HashFileIDHelper::getFileIDBase() — Method in class HashFileIDHelper

NaturalFileIDHelper::getFileIDBase() — Method in class NaturalFileIDHelper

ParsedFileID::getFileID() — Method in class ParsedFileID

The File ID associated with this ParsedFileID if known, or blank if unknown.

ParsedFileID::getFilename() — Method in class ParsedFileID

Filename component.

ParsedFileID::getVariant() — Method in class ParsedFileID

Variant component. Usually a string representing some resized version of an image.

ParsedFileID::getHash() — Method in class ParsedFileID

Hash build from the content of the file. Usually the first 10 characters of sha1 hash.

ParsedFileID::getTuple() — Method in class ParsedFileID

Convert this parsed file ID to an array representation.

Filesystem::getAdapter() — Method in class Filesystem

FlysystemAssetStore::getPublicFilesystem() — Method in class FlysystemAssetStore

Get the currently assigned flysystem backend

FlysystemAssetStore::getProtectedFilesystem() — Method in class FlysystemAssetStore

Get filesystem to use for non-public files

FlysystemAssetStore::getPublicResolutionStrategy() — Method in class FlysystemAssetStore

FlysystemAssetStore::getProtectedResolutionStrategy() — Method in class FlysystemAssetStore

FlysystemAssetStore::getCapabilities() — Method in class FlysystemAssetStore

Return list of feature capabilities of this backend as an array.

FlysystemAssetStore::getVisibility() — Method in class FlysystemAssetStore

Determine visibility of the given file

FlysystemAssetStore::getAsStream() — Method in class FlysystemAssetStore

Get a stream for this file

FlysystemAssetStore::getAsString() — Method in class FlysystemAssetStore

Get contents of a given file

FlysystemAssetStore::getAsURL() — Method in class FlysystemAssetStore

Get the url for the file

FlysystemAssetStore::grant() — Method in class FlysystemAssetStore

Ensures that access to the specified protected file is granted for the current user.

FlysystemAssetStore::getStreamAsFile() — Method in class FlysystemAssetStore

Get stream as a file

FlysystemAssetStore::getDefaultConflictResolution() — Method in class FlysystemAssetStore

Choose a default conflict resolution

FlysystemAssetStore::getMetadata() — Method in class FlysystemAssetStore

Get metadata for this file, if available

FlysystemAssetStore::getMimeType() — Method in class FlysystemAssetStore

Get mime type of this file

FlysystemAssetStore::getFileID() — Method in class FlysystemAssetStore

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

FlysystemAssetStore::getResponseFor() — Method in class FlysystemAssetStore

Generate a custom HTTP response for a request to a given asset, identified by a path.

GeneratedAssets — Class in namespace SilverStripe\Assets\Flysystem

Simple Flysystem implementation of GeneratedAssetHandler for storing generated content

GeneratedAssets::getFilesystem() — Method in class GeneratedAssets

Get the asset backend

GeneratedAssets::getContentURL() — Method in class GeneratedAssets

Returns a URL to a generated asset, if one is available.

GeneratedAssets::getContent() — Method in class GeneratedAssets

Returns the content for a generated asset, if one is available.

ProtectedAdapter::getProtectedUrl() — Method in class ProtectedAdapter

Provide downloadable url that is restricted to granted users

ProtectedAssetAdapter::getProtectedUrl() — Method in class ProtectedAssetAdapter

Provide secure downloadable

PublicAdapter::getPublicUrl() — Method in class PublicAdapter

Provide downloadable url that is open to the public

PublicAssetAdapter::getPublicUrl() — Method in class PublicAssetAdapter

Provide downloadable url

Folder::getIcon() — Method in class Folder

Return the relative URL of an icon for this file type

Folder::getTitle() — Method in class Folder

Get the folder title

Folder::getSize() — Method in class Folder

A folder doesn't have a (meaningful) file size.

Folder::getTreeTitle() — Method in class Folder

Folder::getFilename() — Method in class Folder

Get value of filename

Folder::getURL() — Method in class Folder

Folders do not have public URLs

Folder::getAbsoluteURL() — Method in class Folder

Folders do not have public URLs

Folder::getFilter() — Method in class Folder

Image::getIsImage() — Method in class Image

Determine if a valid non-empty image exists behind this asset

Image::getLazyLoadingEnabled() — Method in class Image

ImageManipulation::getAllowGeneration() — Method in class ImageManipulation

Check if resizes are allowed

ImageManipulation::getString() — Method in class ImageManipulation

ImageManipulation::getStream() — Method in class ImageManipulation

ImageManipulation::getURL() — Method in class ImageManipulation

ImageManipulation::getAbsoluteURL() — Method in class ImageManipulation

ImageManipulation::getMetaData() — Method in class ImageManipulation

Get metadata for this file

ImageManipulation::getMimeType() — Method in class ImageManipulation

Get mime type

ImageManipulation::getAbsoluteSize() — Method in class ImageManipulation

Return file size in bytes.

ImageManipulation::getFilename() — Method in class ImageManipulation

Get value of filename

ImageManipulation::getHash() — Method in class ImageManipulation

Get value of hash

ImageManipulation::getVariant() — Method in class ImageManipulation

Get value of variant

ImageManipulation::getIsImage() — Method in class ImageManipulation

Determine if a valid non-empty image exists behind this asset

ImageManipulation::getIcon() — Method in class ImageManipulation

Return the relative URL of an icon for the file type, based on the appCategory() value.

ImageManipulation::getImageBackend() — Method in class ImageManipulation

Get Image_Backend instance for this image

ImageManipulation::getWidth() — Method in class ImageManipulation

Get the width of this image.

ImageManipulation::getHeight() — Method in class ImageManipulation

Get the height of this image.

ImageManipulation::getOrientation() — Method in class ImageManipulation

Get the orientation of this image.

ImageManipulation::getDefaultAttributes() — Method in class ImageManipulation

ImageManipulation::getAttributes() — Method in class ImageManipulation

Allows customization through an 'updateAttributes' hook on the base class.

Image_Backend::getWidth() — Method in class Image_Backend

Image_Backend::getHeight() — Method in class Image_Backend

Image_Backend::getImageResource() — Method in class Image_Backend

Get the currently assigned image resource

InterventionBackend::getTempPath() — Method in class InterventionBackend

InterventionBackend::getCache() — Method in class InterventionBackend

InterventionBackend::getAssetContainer() — Method in class InterventionBackend

InterventionBackend::getImageManager() — Method in class InterventionBackend

InterventionBackend::getImageResource() — Method in class InterventionBackend

Get the currently assigned image resource, or generates one if not yet assigned.

InterventionBackend::getQuality() — Method in class InterventionBackend

InterventionBackend::getDimensions() — Method in class InterventionBackend

Return dimensions as array with cache enabled

InterventionBackend::getResourceDimensions() — Method in class InterventionBackend

Get dimensions from the given resource

InterventionBackend::getErrorCacheKey() — Method in class InterventionBackend

Cache key for recording errors

InterventionBackend::getDimensionCacheKey() — Method in class InterventionBackend

Cache key for dimensions for given container

InterventionBackend::getWidth() — Method in class InterventionBackend

InterventionBackend::getHeight() — Method in class InterventionBackend

FileLinkTracking::getFileParser() — Method in class FileLinkTracking

FileParser for link tracking

FileShortcodeProvider::get_shortcodes() — Method in class FileShortcodeProvider

Gets the list of shortcodes provided by this handler

FileShortcodeProvider::getCachedMarkup() — Method in class FileShortcodeProvider

FileShortcodeProvider::getGrant() — Method in class FileShortcodeProvider

FileShortcodeProvider::getCacheKey() — Method in class FileShortcodeProvider

Generates a cachekey with the given parameters

FileShortcodeProvider::getCache() — Method in class FileShortcodeProvider

Gets the cache used by this provider

ImageShortcodeProvider::get_shortcodes() — Method in class ImageShortcodeProvider

Gets the list of shortcodes provided by this handler

ImageShortcodeProvider::getCache() — Method in class ImageShortcodeProvider

Gets the cache used by this provider

AssetContainer::getString() — Method in class AssetContainer

AssetContainer::getStream() — Method in class AssetContainer

AssetContainer::getURL() — Method in class AssetContainer

AssetContainer::getAbsoluteURL() — Method in class AssetContainer

AssetContainer::getMetaData() — Method in class AssetContainer

Get metadata for this file

AssetContainer::getMimeType() — Method in class AssetContainer

Get mime type

AssetContainer::getAbsoluteSize() — Method in class AssetContainer

Return file size in bytes.

AssetContainer::getIsImage() — Method in class AssetContainer

Determine if a valid non-empty image exists behind this asset

AssetContainer::getVisibility() — Method in class AssetContainer

Determine visibility of the given file

AssetContainer::getFilename() — Method in class AssetContainer

Get value of filename

AssetContainer::getHash() — Method in class AssetContainer

Get value of hash

AssetContainer::getVariant() — Method in class AssetContainer

Get value of variant

AssetContainer::grantFile() — Method in class AssetContainer

Ensures that access to the specified protected file is granted for the current user.

AssetNameGenerator::getMaxTries() — Method in class AssetNameGenerator

Number of attempts allowed

AssetStore::getCapabilities() — Method in class AssetStore

Return list of feature capabilities of this backend as an array.

AssetStore::getAsString() — Method in class AssetStore

Get contents of a given file

AssetStore::getAsStream() — Method in class AssetStore

Get a stream for this file

AssetStore::getAsURL() — Method in class AssetStore

Get the url for the file

AssetStore::getMetadata() — Method in class AssetStore

Get metadata for this file, if available

AssetStore::getMimeType() — Method in class AssetStore

Get mime type of this file

AssetStore::getVisibility() — Method in class AssetStore

Determine visibility of the given file

AssetStore::grant() — Method in class AssetStore

Ensures that access to the specified protected file is granted for the current user.

AssetStoreRouter::getResponseFor() — Method in class AssetStoreRouter

Generate a custom HTTP response for a request to a given asset, identified by a path.

DBFile::getIsImage() — Method in class DBFile

Determine if a valid non-empty image exists behind this asset, which is a format compatible with image manipulations

DBFile::getStore() — Method in class DBFile

DBFile::getTag() — Method in class DBFile

Return a html5 tag of the appropriate for this file (normally img or a)

DBFile::getFrontendTemplate() — Method in class DBFile

Determine the template to render as on the frontend

DBFile::getBasename() — Method in class DBFile

Get trailing part of filename

DBFile::getExtension() — Method in class DBFile

Get file extension

DBFile::getTitle() — Method in class DBFile

Alt title for this

DBFile::getStream() — Method in class DBFile

DBFile::getString() — Method in class DBFile

DBFile::getURL() — Method in class DBFile

DBFile::getSourceURL() — Method in class DBFile

Get URL, but without resampling.

DBFile::getAbsoluteURL() — Method in class DBFile

Get the absolute URL to this resource

DBFile::getMetaData() — Method in class DBFile

Get metadata for this file

DBFile::getMimeType() — Method in class DBFile

Get mime type

DBFile::getValue() — Method in class DBFile

Returns the value of this field.

DBFile::getVisibility() — Method in class DBFile

Determine visibility of the given file

DBFile::getFilename() — Method in class DBFile

Get value of filename

DBFile::getHash() — Method in class DBFile

Get value of hash

DBFile::getVariant() — Method in class DBFile

Get value of variant

DBFile::getAbsoluteSize() — Method in class DBFile

Return file size in bytes.

DBFile::getAllowedCategories() — Method in class DBFile

Get list of allowed file categories

DBFile::getAllowedExtensions() — Method in class DBFile

Gets the list of extensions (if limited) for this field. Empty list means there is no restriction on allowed types.

DBFile::getSize() — Method in class DBFile

Returns the size of the file type in an appropriate format.

DBFile::grantFile() — Method in class DBFile

Ensures that access to the specified protected file is granted for the current user.

DefaultAssetNameGenerator::getPrefix() — Method in class DefaultAssetNameGenerator

Get numeric prefix

DefaultAssetNameGenerator::getMaxTries() — Method in class DefaultAssetNameGenerator

Number of attempts allowed

FileHashingService::get() — Method in class FileHashingService

Determined if we have an hash for the provided key and return the hash if present

GeneratedAssetHandler — Class in namespace SilverStripe\Assets\Storage

Interface to define a handler for persistent generated files

GeneratedAssetHandler::getContentURL() — Method in class GeneratedAssetHandler

Returns a URL to a generated asset, if one is available.

GeneratedAssetHandler::getContent() — Method in class GeneratedAssetHandler

Returns the content for a generated asset, if one is available.

ProtectedFileController::getRouteHandler() — Method in class ProtectedFileController

Sha1FileHashingService::get() — Method in class Sha1FileHashingService

Determined if we have an hash for the provided key and return the hash if present

Upload::getValidator() — Method in class Upload

Get current validator

Upload::getNameGenerator() — Method in class Upload

Get an asset renamer for the given filename.

Upload::getAssetStore() — Method in class Upload

Upload::getValidFilename() — Method in class Upload

Given a temporary file and upload path, validate the file and determine the value of the 'Filename' tuple that should be used to store this asset.

Upload::getReplaceFile() — Method in class Upload

Upload::getFile() — Method in class Upload

Get file-object, either generated from {load()}, or manually set.

Upload::getErrors() — Method in class Upload

Return all errors that occurred while processing so far (mostly set by {loadUploaded()})

Upload::getDefaultVisibility() — Method in class Upload

Get default visibility for uploaded files. {AssetStore} One of the values of AssetStore::VISIBILITY_* constants

Upload_Validator::getErrors() — Method in class Upload_Validator

Return all errors that occurred while validating the temporary file.

Upload_Validator::getLargestAllowedMaxFileSize() — Method in class Upload_Validator

Returns the largest maximum filesize allowed across all extensions

Upload_Validator::getAllowedMaxFileSize() — Method in class Upload_Validator

Get maximum file size for all or specified file extension.

Upload_Validator::getAllowedExtensions() — Method in class Upload_Validator

Upload_Validator::getFileExtension() — Method in class Upload_Validator

Return the extension of the uploaded file, in lowercase Returns an empty string for files without an extension

AuditHook::getAuditLogger() — Method in class AuditHook

AuditHookMFA::getAuditLogger() — Method in class AuditHookMFA

AuditHookManyManyList::getAuditLogger() — Method in class AuditHookManyManyList

AuditHookMemberGroupSet::getAuditLogger() — Method in class AuditHookMemberGroupSet

AuditHookSessionManager::getAuditLogger() — Method in class AuditHookSessionManager

GridFieldCategorisationConfig — Class in namespace SilverStripe\Blog\Admin

GridFieldFormAction — Class in namespace SilverStripe\Blog\Admin

GridFieldFormAction::getAttributes() — Method in class GridFieldFormAction

GridFieldMergeAction — Class in namespace SilverStripe\Blog\Admin

GridFieldMergeAction::getColumnsHandled() — Method in class GridFieldMergeAction

Names of all columns which are affected by this component.

GridFieldMergeAction::getColumnContent() — Method in class GridFieldMergeAction

HTML for the column, content of the element.

GridFieldMergeAction::getColumnAttributes() — Method in class GridFieldMergeAction

Attributes for the element containing the content returned by getColumnContent().

GridFieldMergeAction::getColumnMetadata() — Method in class GridFieldMergeAction

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

GridFieldMergeAction::getActions() — Method in class GridFieldMergeAction

Return a list of the actions handled by this action provider.

GridFieldAddByDBField — Class in namespace SilverStripe\Blog\Forms\GridField

GridFieldAddByDBField::getActions() — Method in class GridFieldAddByDBField

Provide actions to this component.

GridFieldAddByDBField::getDataObjectField() — Method in class GridFieldAddByDBField

Returns the database field for which we'll add the new data object.

GridFieldAddByDBField::getHTMLFragments() — Method in class GridFieldAddByDBField

Renders the TextField and add button to the GridField.

GridFieldBlogPostState — Class in namespace SilverStripe\Blog\Forms\GridField

Provides a component to the GridField which tells the user whether or not a blog post has been published and when.

GridFieldBlogPostState::getColumnContent() — Method in class GridFieldBlogPostState

HTML for the column, content of the element.

GridFieldBlogPostState::getColumnAttributes() — Method in class GridFieldBlogPostState

Attributes for the element containing the content returned by getColumnContent().

GridFieldConfigBlogPost — Class in namespace SilverStripe\Blog\Forms\GridField

GridField config necessary for managing a SiteTree object.

$ Blog#grant_user_access — Property in class Blog

If true, users assigned as editor, writer, or contributor will be automatically granted CMS_ACCESS_CMSMain permission. If false, only users with this permission already may be assigned.

$ Blog#grant_user_permission — Property in class Blog

Permission to either require, or grant to users assigned to work on this blog.

$ Blog#grant_user_group — Property in class Blog

Group code to assign newly granted users to.

Blog::getCMSFields() — Method in class Blog

{@inheritdoc}

Blog::getMember() — Method in class Blog

Blog::getSettingsFields() — Method in class Blog

{@inheritdoc}

Blog::getCandidateUsers() — Method in class Blog

Gets the list of user candidates to be assigned to assist with this blog.

Blog::getArchivedBlogPosts() — Method in class Blog

Returns BlogPosts for a given date period.

Blog::getBlogPosts() — Method in class Blog

Return blog posts.

Blog::getLumberjackTitle() — Method in class Blog

This sets the title for our gridfield.

Blog::getLumberjackGridFieldConfig() — Method in class Blog

This overwrites lumberjacks default gridfield config.

Blog::getUserGroup() — Method in class Blog

Gets or creates the group used to assign CMS access.

BlogCategory::getListUrlSegment() — Method in class BlogCategory

{@inheritdoc}

BlogCategory::getDuplicateError() — Method in class BlogCategory

{@inheritdoc}

BlogCommentExtension::getExtraClass() — Method in class BlogCommentExtension

Extra CSS classes for styling different comment types.

BlogController::getCurrentProfile() — Method in class BlogController

Get the Member associated with the current URL segment.

BlogController::getCurrentProfilePosts() — Method in class BlogController

Get posts related to the current Member profile.

BlogController::getArchiveYear() — Method in class BlogController

Fetches the archive year from the url.

BlogController::getArchiveMonth() — Method in class BlogController

Fetches the archive money from the url.

BlogController::getArchiveDay() — Method in class BlogController

Fetches the archive day from the url.

BlogController::getCurrentTag() — Method in class BlogController

Tag Getter for use in templates.

BlogController::getCurrentCategory() — Method in class BlogController

Category Getter for use in templates.

BlogController::getMetaTitle() — Method in class BlogController

Get the meta title for the current action.

BlogController::getFilterDescription() — Method in class BlogController

Returns a description of the current filter.

BlogController::getArchiveDate() — Method in class BlogController

Returns the current archive date.

BlogController::getRSSLink() — Method in class BlogController

Returns a link to the RSS feed.

BlogMemberExtension::generateURLSegment() — Method in class BlogMemberExtension

Generate a unique URL segment based on the Member's name.

BlogObject::getCMSFields() — Method in class BlogObject

{@inheritdoc}

BlogObject::getLink() — Method in class BlogObject

Returns a relative link to this category.

BlogObject::generateURLSegment() — Method in class BlogObject

Generates a unique URLSegment from the title.

BlogObject::getDuplicatesByField() — Method in class BlogObject

Looks for objects o the same type and the same value by the given Field

BlogObject::getListUrlSegment() — Method in class BlogObject

This returns the url segment for the listing page.

BlogObject::getDuplicateError() — Method in class BlogObject

Returns an error message for this object when it tries to write a duplicate.

BlogPost::getCMSFields() — Method in class BlogPost

{@inheritdoc}

BlogPost::getCandidateAuthors() — Method in class BlogPost

Gets the list of author candidates to be assigned as authors of this blog post.

BlogPost::getMember() — Method in class BlogPost

BlogPost::getMonthlyArchiveLink() — Method in class BlogPost

Returns a monthly archive link for the current blog post.

BlogPost::getYearlyArchiveLink() — Method in class BlogPost

Returns a yearly archive link for the current blog post.

BlogPost::getCredits() — Method in class BlogPost

Resolves static and dynamic authors linked to this post.

BlogPost::getDynamicCredits() — Method in class BlogPost

Resolves dynamic authors linked to this post.

BlogPost::getStaticCredits() — Method in class BlogPost

Resolves static authors linked to this post.

BlogPost::getProfilesDisabled() — Method in class BlogPost

Checks to see if User Profiles has been disabled via config

BlogPost::getDate() — Method in class BlogPost

Proxy method for displaying the publish date in rss feeds.

BlogTag::getListUrlSegment() — Method in class BlogTag

{@inheritdoc}

BlogTag::getDuplicateError() — Method in class BlogTag

{@inheritdoc}

BlogArchiveWidget::getCMSFields() — Method in class BlogArchiveWidget

{@inheritdoc}

BlogArchiveWidget::getArchive() — Method in class BlogArchiveWidget

Returns a list of months where blog posts are present.

BlogCategoriesWidget::getCMSFields() — Method in class BlogCategoriesWidget

{@inheritdoc}

BlogCategoriesWidget::getCategories() — Method in class BlogCategoriesWidget

BlogFeaturedPostsWidget::getCMSFields() — Method in class BlogFeaturedPostsWidget

{@inheritdoc}

BlogFeaturedPostsWidget::getPosts() — Method in class BlogFeaturedPostsWidget

BlogRecentPostsWidget::getCMSFields() — Method in class BlogRecentPostsWidget

{@inheritdoc}

BlogRecentPostsWidget::getPosts() — Method in class BlogRecentPostsWidget

BlogTagsCloudWidget::getCMSFields() — Method in class BlogTagsCloudWidget

{@inheritdoc}

BlogTagsCloudWidget::getTags() — Method in class BlogTagsCloudWidget

BlogTagsWidget::getCMSFields() — Method in class BlogTagsWidget

{@inheritdoc}

BlogTagsWidget::getTags() — Method in class BlogTagsWidget

CMSBatchAction_Archive::getActionTitle() — Method in class CMSBatchAction_Archive

The the text to show in the dropdown for this action

CMSBatchAction_Publish::getActionTitle() — Method in class CMSBatchAction_Publish

The the text to show in the dropdown for this action

CMSBatchAction_Restore::getActionTitle() — Method in class CMSBatchAction_Restore

The the text to show in the dropdown for this action

CMSBatchAction_Unpublish::getActionTitle() — Method in class CMSBatchAction_Unpublish

The the text to show in the dropdown for this action

CMSMain::getResponseNegotiator() — Method in class CMSMain

CMSMain::getCMSEditLinkForManagedDataObject() — Method in class CMSMain

Get the link for editing a page.

CMSMain::getTabIdentifier() — Method in class CMSMain

Return the active tab identifier for the CMS. Used by templates to decide which tab to give the active state.

CMSMain::getHintsCache() — Method in class CMSMain

CMSMain::getSiteTreeFor() — Method in class CMSMain

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

CMSMain::getTreeFor() — Method in class CMSMain

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

CMSMain::getTreeNodeCustomisations() — Method in class CMSMain

Get callback to determine template customisations for nodes

CMSMain::getTreeNodeClasses() — Method in class CMSMain

Get extra CSS classes for a page's tree node

CMSMain::getsubtree() — Method in class CMSMain

Get a subtree underneath the request param 'ID'.

CMSMain::getSearchContext() — Method in class CMSMain

This provides information required to generate the search form and can be modified on extensions through updateSearchContext

CMSMain::getSearchFieldSchema() — Method in class CMSMain

Returns the search form schema for the current model

CMSMain::getSearchForm() — Method in class CMSMain

Returns a Form for page searching for use in templates.

CMSMain::getPageTypes() — Method in class CMSMain

Returns a sorted array suitable for a dropdown with pagetypes and their translated name

CMSMain::getRecordTypes() — Method in class CMSMain

Returns a sorted array suitable for a dropdown with record types and their translated name

CMSMain::getBreadcrumbsBackLink() — Method in class CMSMain

Get "back" url for breadcrumbs

CMSMain::getRecord() — Method in class CMSMain

Get a database record to be managed by the CMS.

CMSMain::getEditForm() — Method in class CMSMain

CMSMain::getArchiveWarningMessage() — Method in class CMSMain

Build an archive warning message based on the page's children

CMSMain::getQueryFilter() — Method in class CMSMain

Safely reconstruct a selected filter from a given set of query parameters

CMSMain::getList() — Method in class CMSMain

Returns the pages meet a certain criteria as {CMSSiteTreeFilter} or the subpages of a parent page defaulting to no filter and show all pages in first level.

CMSMain::getNewItem() — Method in class CMSMain

CMSMain::getCMSTreeTitle() — Method in class CMSMain

Get title for root CMS node

CMSMain::generateHintsCacheKey() — Method in class CMSMain

Cache key for TreeHints() method

CMSPageEditController::getClientConfig() — Method in class CMSPageEditController

Returns configuration required by the client app.

CMSPageEditController::getAddToCampaignForm() — Method in class CMSPageEditController

CMSPageSettingsController::getEditForm() — Method in class CMSPageSettingsController

CMSPageSettingsController::getTabIdentifier() — Method in class CMSPageSettingsController

Return the active tab identifier for the CMS. Used by templates to decide which tab to give the active state.

CMSSiteTreeFilter::get_all_filters() — Method in class CMSSiteTreeFilter

Returns a sorted array of all implementators of CMSSiteTreeFilter, suitable for use in a dropdown.

CMSSiteTreeFilter::getChildrenMethod() — Method in class CMSSiteTreeFilter

Method on Hierarchy objects which is used to traverse into children relationships.

CMSSiteTreeFilter::getNumChildrenMethod() — Method in class CMSSiteTreeFilter

Method on Hierarchy objects which is used find the number of children for a parent page

CMSSiteTreeFilter::getPageClasses() — Method in class CMSSiteTreeFilter

CMSSiteTreeFilter::getFilteredPages() — Method in class CMSSiteTreeFilter

Gets the list of filtered pages

CMSSiteTreeFilter_ChangedPages::getFilteredPages() — Method in class CMSSiteTreeFilter_ChangedPages

Gets the list of filtered pages

CMSSiteTreeFilter_DeletedPages::getFilteredPages() — Method in class CMSSiteTreeFilter_DeletedPages

Gets the list of filtered pages

CMSSiteTreeFilter_PublishedPages::getFilteredPages() — Method in class CMSSiteTreeFilter_PublishedPages

Filters out all pages who's status who's status that doesn't exist on live

CMSSiteTreeFilter_Search::getFilteredPages() — Method in class CMSSiteTreeFilter_Search

Retun an array of maps containing the keys, 'ID' and 'ParentID' for each page to be displayed in the search.

CMSSiteTreeFilter_StatusDeletedPages::getFilteredPages() — Method in class CMSSiteTreeFilter_StatusDeletedPages

Filters out all pages who's status is set to "Deleted".

CMSSiteTreeFilter_StatusDraftPages::getFilteredPages() — Method in class CMSSiteTreeFilter_StatusDraftPages

Filters out all pages who's status is set to "Draft".

CMSSiteTreeFilter_StatusRemovedFromDraftPages::getFilteredPages() — Method in class CMSSiteTreeFilter_StatusRemovedFromDraftPages

Filters out all pages who's status is set to "Removed from draft".

ContentController::getMenu() — Method in class ContentController

Returns a fixed navigation menu of the given level.

ContentController::getViewer() — Method in class ContentController

Return an SSViewer object to render the template for the current page.

LeftAndMainPageIconsExtension::generatePageIconsCss() — Method in class LeftAndMainPageIconsExtension

Include CSS for page icons. We're not using the JSTree 'types' option because it causes too much performance overhead just to add some icons.

LeftAndMainPageIconsExtension::generateRecordIconsCss() — Method in class LeftAndMainPageIconsExtension

Include CSS for page icons. We're not using the JSTree 'types' option because it causes too much performance overhead just to add some icons.

ModelAsController::getNestedController() — Method in class ModelAsController

RootURLController::get_homepage_link() — Method in class RootURLController

Get the full form (e.g. /home/) relative link to the home page for the current HTTP_HOST value. Note that the link is trimmed of leading and trailing slashes before returning to ensure consistency.

SilverStripeNavigatorItem_CMSLink::getHTML() — Method in class SilverStripeNavigatorItem_CMSLink

SilverStripeNavigatorItem_CMSLink::getTitle() — Method in class SilverStripeNavigatorItem_CMSLink

SilverStripeNavigatorItem_CMSLink::getLink() — Method in class SilverStripeNavigatorItem_CMSLink

Optional link to a specific view of this record.

AnchorLinkFormFactory::getFormFields() — Method in class AnchorLinkFormFactory

AnchorLinkFormFactory::getRequiredContext() — Method in class AnchorLinkFormFactory

Return list of mandatory context keys

AnchorSelectorField::getSchemaDataDefaults() — Method in class AnchorSelectorField

Gets the defaults for $schemaData.

AnchorSelectorField::getAnchorsInPage() — Method in class AnchorSelectorField

Get anchors in the given page ID.

InternalLinkFormFactory::getFormFields() — Method in class InternalLinkFormFactory

InternalLinkFormFactory::getValidator() — Method in class InternalLinkFormFactory

SiteTreeURLSegmentField::getAttributes() — Method in class SiteTreeURLSegmentField

SiteTreeURLSegmentField::getPage() — Method in class SiteTreeURLSegmentField

SiteTreeURLSegmentField::getHelpText() — Method in class SiteTreeURLSegmentField

SiteTreeURLSegmentField::getURLPrefix() — Method in class SiteTreeURLSegmentField

SiteTreeURLSegmentField::getURLSuffix() — Method in class SiteTreeURLSegmentField

SiteTreeURLSegmentField::getDefaultURL() — Method in class SiteTreeURLSegmentField

SiteTreeURLSegmentField::getURL() — Method in class SiteTreeURLSegmentField

LinkablePlugin::getIdentifier() — Method in class LinkablePlugin

RedirectorPage::getCMSFields() — Method in class RedirectorPage

RedirectorPageController::getContent() — Method in class RedirectorPageController

If we ever get this far, it means that the redirection failed.

SiteTree::get_by_link() — Method in class SiteTree

Fetches the SiteTree object that maps to a link.

SiteTree::getMimeType() — Method in class SiteTree

To determine preview mechanism (e.g. embedded / iframe)

SiteTree::getAbsoluteLiveLink() — Method in class SiteTree

Get the absolute URL for this page on the Live site.

SiteTree::getBreadcrumbItems() — Method in class SiteTree

Returns a list of breadcrumbs for the current page.

SiteTree::getParent() — Method in class SiteTree

Get the parent of this page.

SiteTree::getCreatableChildrenCache() — Method in class SiteTree

SiteTree::getSiteConfig() — Method in class SiteTree

Stub method to get the site config, unless the current class can provide an alternate.

SiteTree::getPermissionChecker() — Method in class SiteTree

SiteTree::getVersionProvider() — Method in class SiteTree

SiteTree::generateURLSegment() — Method in class SiteTree

Generate a URL segment based on the title provided.

SiteTree::getStageURLSegment() — Method in class SiteTree

Gets the URL segment for the latest draft version of this page.

SiteTree::getLiveURLSegment() — Method in class SiteTree

Gets the URL segment for the currently published version of this page.

SiteTree::getCMSFields() — Method in class SiteTree

Returns a FieldList with which to create the main editing form.

SiteTree::getSettingsFields() — Method in class SiteTree

Returns fields related to configuration aspects on this record, e.g. access control. See getCMSFields() for content-related fields.

SiteTree::getCMSActions() — Method in class SiteTree

Get the actions available in the CMS for this page - eg Save, Publish.

SiteTree::getClassDropdown() — Method in class SiteTree

Get the class dropdown used in the CMS to change the class of a page. This returns the list of options in the dropdown as a Map from class name to singular name. Filters by SiteTree->canCreate(), as well as SiteTree::$needs_permission.

SiteTree::getMenuTitle() — Method in class SiteTree

Get the title for use in menus for this page. If the MenuTitle field is set it returns that, else it returns the Title field.

SiteTree::getStatusFlags() — Method in class SiteTree

A flag provides the user with additional data about the current page status, for example a "removed from draft" status. Each page can have more than one status flag. Returns a map of a unique key to a (localized) title for the flag. The unique key can be reused as a CSS class. Use the 'updateStatusFlags' extension point to customize the flags.

SiteTree::getIconClass() — Method in class SiteTree

Returns the CSS class used for the page icon in the site tree.

SiteTree::getTreeTitle() — Method in class SiteTree

getTreeTitle will return three html DOM elements, an empty with the class 'jstree-pageicon' in front, following by a wrapping around its MenuTitle, then following by a indicating its publication status.

SiteTree::getPageLevel() — Method in class SiteTree

Gets the depth of this page in the sitetree, where 1 is the root level

SiteTree::getControllerName() — Method in class SiteTree

Find the controller name by our convention of {$ModelClass}Controller Can be overriden by config variable

SiteTree::getPageIconURL() — Method in class SiteTree

Generate link to this page's icon

SiteTree::getParentType() — Method in class SiteTree

Returns 'root' if the current page has no parent, or 'subpage' otherwise

SiteTree::generateChildrenCacheKey() — Method in class SiteTree

Cache key for creatableChildPages() method

SiteTree::getExcludedURLSegments() — Method in class SiteTree

Get the list of excluded root URL segments

SiteTree::getAnchorsOnPage() — Method in class SiteTree

SiteTreeLinkTracking::getParser() — Method in class SiteTreeLinkTracking

Parser for link tracking

VirtualPage::getVirtualFields() — Method in class VirtualPage

Generates the array of fields required for the page type.

VirtualPage::getNonVirtualisedFields() — Method in class VirtualPage

List of fields or properties to never virtualise

VirtualPage::getCMSFields() — Method in class VirtualPage

Generate the CMS fields from the fields from the original page.

VirtualPage::getSettingsFields() — Method in class VirtualPage

VirtualPage::getViewerTemplates() — Method in class VirtualPage

Use the target page's class name for fetching templates - as we need to take on its appearance

VirtualPage::getField() — Method in class VirtualPage

VirtualPage::getControllerName() — Method in class VirtualPage

{@inheritdoc}

BrokenFilesReport::group() — Method in class BrokenFilesReport

BrokenFilesReport::getParameterFields() — Method in class BrokenFilesReport

BrokenRedirectorPagesReport::group() — Method in class BrokenRedirectorPagesReport

BrokenRedirectorPagesReport::getParameterFields() — Method in class BrokenRedirectorPagesReport

BrokenVirtualPagesReport::group() — Method in class BrokenVirtualPagesReport

BrokenVirtualPagesReport::getParameterFields() — Method in class BrokenVirtualPagesReport

EmptyPagesReport::group() — Method in class EmptyPagesReport

RecentlyEditedReport::group() — Method in class RecentlyEditedReport

SearchForm::getClassesToSearch() — Method in class SearchForm

Get the classes to search

SearchForm::getResults() — Method in class SearchForm

Return dataObjectSet of the results using current request to get info from form.

SearchForm::getSearchQuery() — Method in class SearchForm

Get the search query for display in a "You searched for ..." sentence.

SearchForm::getPageLength() — Method in class SearchForm

AddToCampaignHandler::getAvailableChangeSets() — Method in class AddToCampaignHandler

Get what ChangeSets are available for an item to be added to by this user

AddToCampaignHandler::getInChangeSets() — Method in class AddToCampaignHandler

Get changesets that a given object is already in

AddToCampaignHandler::getObject() — Method in class AddToCampaignHandler

Safely get a DataObject from a client-supplied ID and ClassName, checking: argument validity; existence; and canView permissions.

AddToCampaignHandler::getFormAlert() — Method in class AddToCampaignHandler

Get descriptive alert to display at the top of the form

AddToCampaignHandler::getOrCreateCampaign() — Method in class AddToCampaignHandler

Find or build campaign from posted data

CampaignAdmin::getClientConfig() — Method in class CampaignAdmin

Returns configuration required by the client app.

CampaignAdmin::getEditForm() — Method in class CampaignAdmin

Calls SiteTree->getCMSFields() by default to determine the form fields to display.

CampaignAdmin::getPlaceholderGroups() — Method in class CampaignAdmin

CampaignAdmin::getListResource() — Method in class CampaignAdmin

Get list contained as a hal wrapper

CampaignAdmin::getChangeSetResource() — Method in class CampaignAdmin

Build item resource from a changeset

CampaignAdmin::getChangeSetItemResource() — Method in class CampaignAdmin

Build item resource from a changesetitem

CampaignAdmin::getListItems() — Method in class CampaignAdmin

Gets viewable list of campaigns

CampaignAdmin::getCampaignEditForm() — Method in class CampaignAdmin

CampaignAdmin::getCampaignCreateForm() — Method in class CampaignAdmin

Build create form

CampaignAdminList::getSchemaDataDefaults() — Method in class CampaignAdminList

Gets the defaults for $schemaData.

CachedConfigCollection::getNestFactory() — Method in class CachedConfigCollection

Get callback for nesting the inner collection

CachedConfigCollection::get() — Method in class CachedConfigCollection

Fetches value for a class, or a property on that class

CachedConfigCollection::getAll() — Method in class CachedConfigCollection

Get complete config (excludes middleware)

CachedConfigCollection::getMetadata() — Method in class CachedConfigCollection

Returns the entire metadata

CachedConfigCollection::getHistory() — Method in class CachedConfigCollection

CachedConfigCollection::getCollection() — Method in class CachedConfigCollection

Get or build collection

CachedConfigCollection::getCollectionCreator() — Method in class CachedConfigCollection

CachedConfigCollection::getCache() — Method in class CachedConfigCollection

CachedConfigCollection::getFlush() — Method in class CachedConfigCollection

ConfigCollectionInterface::get() — Method in class ConfigCollectionInterface

Fetches value for a class, or a property on that class

ConfigCollectionInterface::getMetadata() — Method in class ConfigCollectionInterface

Returns the entire metadata

ConfigCollectionInterface::getHistory() — Method in class ConfigCollectionInterface

ConfigCollectionInterface::getMiddlewares() — Method in class ConfigCollectionInterface

ConfigCollectionInterface::getAll() — Method in class ConfigCollectionInterface

Get complete config (excludes middleware)

DeltaConfigCollection::getDeltaMiddleware() — Method in class DeltaConfigCollection

Get middleware for handling deltas

DeltaConfigCollection::getMiddlewares() — Method in class DeltaConfigCollection

DeltaConfigCollection::getDeltas() — Method in class DeltaConfigCollection

Get deltas for the given class

MemoryConfigCollection::get() — Method in class MemoryConfigCollection

Fetches value for a class, or a property on that class

MemoryConfigCollection::getClassConfig() — Method in class MemoryConfigCollection

Retrieve config for an entire class

MemoryConfigCollection::getAll() — Method in class MemoryConfigCollection

Get complete config (excludes middleware-applied config)

MemoryConfigCollection::getMetadata() — Method in class MemoryConfigCollection

Returns the entire metadata

MemoryConfigCollection::getHistory() — Method in class MemoryConfigCollection

MemoryConfigCollection::getSerializedMembers() — Method in class MemoryConfigCollection

Get list of serialized properties

DeltaMiddleware::getCollection() — Method in class DeltaMiddleware

DeltaMiddleware::getClassConfig() — Method in class DeltaMiddleware

Get config for a class

Middleware::getClassConfig() — Method in class Middleware

Get config for a class

MiddlewareAware::getMiddlewares() — Method in class MiddlewareAware

MiddlewareCommon::getDisableFlag() — Method in class MiddlewareCommon

Get flag to use to disable this middleware

PrivateStaticTransformer::getClassConfig() — Method in class PrivateStaticTransformer

This is responsible for introspecting a given class and returning an array continaing all of its private statics

PrivateStaticTransformer::getClasses() — Method in class PrivateStaticTransformer

YamlTransformer::getNamedYamlDocuments() — Method in class YamlTransformer

Returns an array of YAML documents keyed by name.

YamlTransformer::getMatchingDocuments() — Method in class YamlTransformer

This returns an array of documents which match the given pattern. The pattern is expected to come from before/after blocks of yaml (eg. framwork/*).

YamlTransformer::getSortedYamlDocuments() — Method in class YamlTransformer

This method gets all headers and all yaml documents and stores them respectively.

ContentReviewCMSExtension::getReviewContentForm() — Method in class ContentReviewCMSExtension

Return a handler for "content due for review" forms, according to the given object ID

ContentReviewCMSExtension::getReviewContentHandler() — Method in class ContentReviewCMSExtension

Return a handler or reviewing content

ContentReviewCMSExtension::getSchemaRequested() — Method in class ContentReviewCMSExtension

Check if the current request has a X-Formschema-Request header set.

ContentReviewCMSExtension::getSchemaResponse() — Method in class ContentReviewCMSExtension

Generate schema for the given form based on the X-Formschema-Request header value

ContentReviewDefaultSettings::getOwnerNames() — Method in class ContentReviewDefaultSettings

ContentReviewDefaultSettings::getReviewBody() — Method in class ContentReviewDefaultSettings

Get the review body, falling back to the default if left blank.

ContentReviewDefaultSettings::getReviewSubject() — Method in class ContentReviewDefaultSettings

Get the review subject line, falling back to the default if left blank.

ContentReviewDefaultSettings::getReviewFrom() — Method in class ContentReviewDefaultSettings

Get the "from" field for review emails.

ContentReviewDefaultSettings::getWithDefault() — Method in class ContentReviewDefaultSettings

Get the value of a user-configured field, falling back to the default if left blank.

SiteTreeContentReview::get_schedule() — Method in class SiteTreeContentReview

SiteTreeContentReview::getReviewDate() — Method in class SiteTreeContentReview

Returns false if the content review have disabled.

SiteTreeContentReview::getOptions() — Method in class SiteTreeContentReview

Get the object that have the information about the content review settings. Either:

SiteTreeContentReview::getOwnerNames() — Method in class SiteTreeContentReview

SiteTreeContentReview::getEditorName() — Method in class SiteTreeContentReview

ContentReviewNotificationJob::getTitle() — Method in class ContentReviewNotificationJob

ContentReviewNotificationJob::getJobType() — Method in class ContentReviewNotificationJob

ContentReviewEmails::getOverduePagesForOwners() — Method in class ContentReviewEmails

ContentReviewEmails::getEmailBody() — Method in class ContentReviewEmails

Get string value of HTML body with all variable evaluated.

ContentReviewEmails::getTemplateVariables() — Method in class ContentReviewEmails

Gets list of safe template variables and their values which can be used in both the static and editable templates.

ContentNegotiator::getEnabled() — Method in class ContentNegotiator

Gets the current enabled status, if it is not set this will fallback to config

Controller::getURLParams() — Method in class Controller

Returns the parameters extracted from the URL by the Director.

Controller::getResponse() — Method in class Controller

Returns the HTTPResponse object that this controller is building up. Can be used to set the status code and headers.

Controller::getAction() — Method in class Controller

Returns the action that is being executed on this controller.

Controller::getViewer() — Method in class Controller

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

Controller::get_template_global_variables() — Method in class Controller

Cookie::get_inst() — Method in class Cookie

Fetch the current instance of the cookie backend.

Cookie::get() — Method in class Cookie

Get the cookie value by name. Returns null if not set.

Cookie::get_all() — Method in class Cookie

Get all the cookies.

CookieJar::get() — Method in class CookieJar

Get the cookie value by name

CookieJar::getAll() — Method in class CookieJar

Get all the cookies

Cookie_Backend::get() — Method in class Cookie_Backend

Get the cookie value by name

Cookie_Backend::getAll() — Method in class Cookie_Backend

Get all the cookies

Director::get_current_page() — Method in class Director

Return the SiteTree object that is currently being viewed. If there is no SiteTree object to return, then this will return the current controller.

Director::getAbsFile() — Method in class Director

Given a filesystem reference relative to the site root, return the full file-system path.

Director::get_environment_type() — Method in class Director

Can also be checked with Director::isDev()}, {@link Director::isTest(), and Director::isLive().

Director::get_template_global_variables() — Method in class Director

Returns an array of strings of the method names of methods on the call that should be exposed as global variables in the templates.

Email::getSendAllEmailsTo() — Method in class Email

Email::getCCAllEmailsTo() — Method in class Email

Email::getBCCAllEmailsTo() — Method in class Email

Email::getSendAllEmailsFrom() — Method in class Email

Email::getData() — Method in class Email

Get data which is exposed to the template

Email::getHTMLTemplate() — Method in class Email

Email::getPlainTemplate() — Method in class Email

Get the template to render the plain part with

MailerSubscriber::getSubscribedEvents() — Method in class MailerSubscriber

HTTP::getLinksIn() — Method in class HTTP

HTTP::getImagesIn() — Method in class HTTP

HTTP::get_mime_type() — Method in class HTTP

Get the MIME type based on a file's extension. If the finfo class exists in PHP, and the file exists relative to the project root, then use that extension, otherwise fallback to a list of commonly known MIME types.

HTTPApplication::getFlushDiscoverer() — Method in class HTTPApplication

Returns the current flush discoverer

HTTPApplication::getEnvironmentType() — Method in class HTTPApplication

Return the current environment type (dev, test or live) Only checks Kernel and Server ENV as we don't have sessions initialized yet

HTTPApplication::getKernel() — Method in class HTTPApplication

Get the kernel for this application

$ HTTPRequest#getVars — Property in class HTTPRequest

Contains all HTTP GET parameters passed into this request.

HTTPRequest::getBody() — Method in class HTTPRequest

HTTPRequest::getVars() — Method in class HTTPRequest

HTTPRequest::getVar() — Method in class HTTPRequest

HTTPRequest::getExtension() — Method in class HTTPRequest

Returns a possible file extension found in parsing the URL as denoted by a "."-character near the end of the URL.

HTTPRequest::getHeaders() — Method in class HTTPRequest

HTTPRequest::getHeader() — Method in class HTTPRequest

Returns a HTTP Header by name if found in the request

HTTPRequest::getURL() — Method in class HTTPRequest

Returns the URL used to generate the page

HTTPRequest::getHost() — Method in class HTTPRequest

HTTPRequest::getIP() — Method in class HTTPRequest

Returns the client IP address which originated this request.

HTTPRequest::getAcceptMimetypes() — Method in class HTTPRequest

Returns all mimetypes from the HTTP "Accept" header as an array.

HTTPRequest::getScheme() — Method in class HTTPRequest

Return the URL scheme (e.g. "http" or "https").

HTTPRequest::getSession() — Method in class HTTPRequest

HTTPResponse::getProtocolVersion() — Method in class HTTPResponse

HTTPResponse::getStatusCode() — Method in class HTTPResponse

HTTPResponse::getStatusDescription() — Method in class HTTPResponse

HTTPResponse::getBody() — Method in class HTTPResponse

HTTPResponse::getHeader() — Method in class HTTPResponse

Return the HTTP header of the given name.

HTTPResponse::getHeaders() — Method in class HTTPResponse

HTTPResponse_Exception::getResponse() — Method in class HTTPResponse_Exception

HTTPStreamResponse::getStream() — Method in class HTTPStreamResponse

HTTPStreamResponse::getSavedBody() — Method in class HTTPStreamResponse

Get body prior to stream traversal

HTTPStreamResponse::getBody() — Method in class HTTPStreamResponse

HasRequestHandler::getRequestHandler() — Method in class HasRequestHandler

AllowedHostsMiddleware::getAllowedHosts() — Method in class AllowedHostsMiddleware

CanonicalURLMiddleware::getEnforceTrailingSlashConfig() — Method in class CanonicalURLMiddleware

CanonicalURLMiddleware::getEnforceTrailingSlashConfigIgnorePaths() — Method in class CanonicalURLMiddleware

CanonicalURLMiddleware::getEnforceTrailingSlashConfigIgnoreUserAgents() — Method in class CanonicalURLMiddleware

CanonicalURLMiddleware::getForceSSLPatterns() — Method in class CanonicalURLMiddleware

CanonicalURLMiddleware::getForceSSLDomain() — Method in class CanonicalURLMiddleware

CanonicalURLMiddleware::getForceWWW() — Method in class CanonicalURLMiddleware

CanonicalURLMiddleware::getForceSSL() — Method in class CanonicalURLMiddleware

CanonicalURLMiddleware::getForceBasicAuthToSSL() — Method in class CanonicalURLMiddleware

CanonicalURLMiddleware::getRedirect() — Method in class CanonicalURLMiddleware

Given request object determine if we should redirect.

CanonicalURLMiddleware::getOrValidateRequest() — Method in class CanonicalURLMiddleware

Return a valid request, if one is available, or null if none is available

CanonicalURLMiddleware::getRedirectType() — Method in class CanonicalURLMiddleware

CanonicalURLMiddleware::getEnabledEnvs() — Method in class CanonicalURLMiddleware

Get enabled flag, or list of environments to enable in.

ChangeDetectionMiddleware::generateETag() — Method in class ChangeDetectionMiddleware

ConfirmationMiddleware::getConfirmationUrl() — Method in class ConfirmationMiddleware

The URL of the confirmation form ("Security/confirm/middleware" by default)

ConfirmationMiddleware::generateDeclineUrlForRequest() — Method in class ConfirmationMiddleware

Returns the URL where the user to be redirected when declining the action (on the confirmation form)

ConfirmationMiddleware::getConfirmationItems() — Method in class ConfirmationMiddleware

Extract the confirmation items from the request and return

EnvironmentBypass::getEnvironments() — Method in class EnvironmentBypass

Returns the list of environments

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

A rule to match a GET parameter within HTTPRequest

GetParameter::getName() — Method in class GetParameter

Return the parameter name

GetParameter::generateToken() — Method in class GetParameter

Generates the unique token depending on the path and the parameter

GetParameter::getRequestConfirmationItem() — Method in class GetParameter

Check the request by the rule and return a confirmation item

HttpMethodBypass::getMethods() — Method in class HttpMethodBypass

Returns the list of methods

PathAware::getPath() — Method in class PathAware

Returns the path

Rule::getRequestConfirmationItem() — Method in class Rule

Check the request by the rule and return a confirmation item

Url::getHttpMethods() — Method in class Url

Returns HTTP methods to be checked

Url::getRequestConfirmationItem() — Method in class Url

Check the request by the rule and return a confirmation item

Url::generateToken() — Method in class Url

Generates the unique token depending on the path

UrlPathStartswith::generateToken() — Method in class UrlPathStartswith

Generates the unique token depending on the path

UrlPathStartswith::getRequestConfirmationItem() — Method in class UrlPathStartswith

Check the request by the rule and return a confirmation item

HTTPCacheControlMiddleware::getVary() — Method in class HTTPCacheControlMiddleware

Get current vary keys

HTTPCacheControlMiddleware::getState() — Method in class HTTPCacheControlMiddleware

Get current state

HTTPCacheControlMiddleware::getStateDirective() — Method in class HTTPCacheControlMiddleware

Low level method to get the value of a directive for a state.

HTTPCacheControlMiddleware::getDirective() — Method in class HTTPCacheControlMiddleware

Get the value of the given directive for the current state

HTTPCacheControlMiddleware::getStateDirectives() — Method in class HTTPCacheControlMiddleware

Get directives for the given state

HTTPCacheControlMiddleware::getDirectives() — Method in class HTTPCacheControlMiddleware

Get all directives for the currently active state

HTTPCacheControlMiddleware::generateCacheHeader() — Method in class HTTPCacheControlMiddleware

Generate the cache header

HTTPCacheControlMiddleware::generateHeadersFor() — Method in class HTTPCacheControlMiddleware

Generate all headers to output

HTTPCacheControlMiddleware::getForcingLevel() — Method in class HTTPCacheControlMiddleware

HTTPCacheControlMiddleware::generateVaryHeader() — Method in class HTTPCacheControlMiddleware

Generate vary http header

HTTPCacheControlMiddleware::generateLastModifiedHeader() — Method in class HTTPCacheControlMiddleware

Generate Last-Modified header

HTTPCacheControlMiddleware::generateExpiresHeader() — Method in class HTTPCacheControlMiddleware

Generate Expires http header

HTTPMiddlewareAware::getMiddlewares() — Method in class HTTPMiddlewareAware

PermissionAwareConfirmationMiddleware::getAffectedPermissions() — Method in class PermissionAwareConfirmationMiddleware

Returns the list of permissions that are affected

PermissionAwareConfirmationMiddleware::getEnforceAuthentication() — Method in class PermissionAwareConfirmationMiddleware

Returns flag whether we want to enforce authentication or not

PermissionAwareConfirmationMiddleware::getAuthenticationRedirect() — Method in class PermissionAwareConfirmationMiddleware

Returns HTTPResponse with a redirect to a login page

RateLimitMiddleware::getKeyFromRequest() — Method in class RateLimitMiddleware

RateLimitMiddleware::getErrorHTTPResponse() — Method in class RateLimitMiddleware

RateLimitMiddleware::getExtraKey() — Method in class RateLimitMiddleware

RateLimitMiddleware::getMaxAttempts() — Method in class RateLimitMiddleware

RateLimitMiddleware::getDecay() — Method in class RateLimitMiddleware

RateLimitMiddleware::getRateLimiter() — Method in class RateLimitMiddleware

RequestHandlerMiddlewareAdapter::getRequestHandler() — Method in class RequestHandlerMiddlewareAdapter

TrustedProxyMiddleware::getTrustedProxyIPs() — Method in class TrustedProxyMiddleware

Return the comma-separated list of IP ranges that are trusted to provide proxy headers Can also be 'none' or '*' (all)

TrustedProxyMiddleware::getProxyHostHeaders() — Method in class TrustedProxyMiddleware

Return the array of headers from which to lookup the hostname

TrustedProxyMiddleware::getProxyIPHeaders() — Method in class TrustedProxyMiddleware

Return the array of headers from which to lookup the client IP

TrustedProxyMiddleware::getProxySchemeHeaders() — Method in class TrustedProxyMiddleware

Return the array of headers from which to lookup the client scheme (http/https)

TrustedProxyMiddleware::getIPFromHeaderValue() — Method in class TrustedProxyMiddleware

Extract an IP address from a header value that has been obtained.

NestedController::getNestedController() — Method in class NestedController

Get overriding controller

PjaxResponseNegotiator::getResponse() — Method in class PjaxResponseNegotiator

PjaxResponseNegotiator::getFragmentOverride() — Method in class PjaxResponseNegotiator

RSSFeed::getTemplate() — Method in class RSSFeed

Returns the name of the template to use.

RSSFeed::getTemplates() — Method in class RSSFeed

Returns the ordered list of preferred templates for rendering this object.

RequestHandler::getRequest() — Method in class RequestHandler

Returns the HTTPRequest object that this controller is using.

RequestHandler::getBackURL() — Method in class RequestHandler

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

RequestHandler::getReferer() — Method in class RequestHandler

Get referer

Session::get() — Method in class Session

Get session value

Session::getAll() — Method in class Session

Get all values

SimpleResourceURLGenerator::getNonceStyle() — Method in class SimpleResourceURLGenerator

Application::getKernel() — Method in class Application

Get the kernel for this application

BaseKernel::getEnvironment() — Method in class BaseKernel

Get the environment type

BaseKernel::getIncludeTests() — Method in class BaseKernel

BaseKernel::getBooted() — Method in class BaseKernel

Check whether the kernel has booted or not

BaseKernel::getNestedFrom() — Method in class BaseKernel

BaseKernel::getContainer() — Method in class BaseKernel

BaseKernel::getInjectorLoader() — Method in class BaseKernel

Get loader for injector instance

BaseKernel::getClassLoader() — Method in class BaseKernel

BaseKernel::getModuleLoader() — Method in class BaseKernel

BaseKernel::getConfigLoader() — Method in class BaseKernel

BaseKernel::getThemeResourceLoader() — Method in class BaseKernel

RateLimiter::getCache() — Method in class RateLimiter

RateLimiter::getIdentifier() — Method in class RateLimiter

RateLimiter::getMaxAttempts() — Method in class RateLimiter

RateLimiter::getDecay() — Method in class RateLimiter

RateLimiter::getNumAttempts() — Method in class RateLimiter

RateLimiter::getNumAttemptsRemaining() — Method in class RateLimiter

RateLimiter::getTimeToReset() — Method in class RateLimiter

ClassInfo::getValidSubClasses() — Method in class ClassInfo

Returns the manifest of all classes which are present in the database.

ConfigLoader::getManifest() — Method in class ConfigLoader

Returns the currently active class manifest instance that is used for loading classes.

Config_ForClass::get() — Method in class Config_ForClass

ExtensionMiddleware::getClassConfig() — Method in class ExtensionMiddleware

Get config for a class

ExtensionMiddleware::getExtraConfig() — Method in class ExtensionMiddleware

Applied config to a class from its extensions

InheritanceMiddleware::getClassConfig() — Method in class InheritanceMiddleware

Get config for a class

CoreKernel::getDatabaseConfig() — Method in class CoreKernel

Load database config from environment

CoreKernel::getDatabasePrefix() — Method in class CoreKernel

CoreKernel::getDatabaseSuffix() — Method in class CoreKernel

CoreKernel::getDatabaseName() — Method in class CoreKernel

Get name of database

CustomMethods::getExtraMethodConfig() — Method in class CustomMethods

Get meta-data details on a named method

Environment::getVariables() — Method in class Environment

Extract env vars prior to modification

Environment::getMemoryLimitMax() — Method in class Environment

Environment::getTimeLimitMax() — Method in class Environment

Environment::getEnv() — Method in class Environment

Get value of environment variable.

Extensible::get_extensions() — Method in class Extensible

Extensible::get_extra_config_sources() — Method in class Extensible

Get extra config sources for this class

Extensible::getExtensionInstance() — Method in class Extensible

Get an extension instance attached to this object by name.

Extensible::getExtensionInstances() — Method in class Extensible

Get all extension instances for this specific object instance.

Extension::getOwner() — Method in class Extension

Returns the owner of this extension.

Extension::get_classname_without_arguments() — Method in class Extension

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

Injector::getObjectCreator() — Method in class Injector

Injector::getConfigLocator() — Method in class Injector

Retrieve the configuration locator

Injector::getServiceName() — Method in class Injector

Does the given service exist, and if so, what's the stored name for it?

Injector::get() — Method in class Injector

Get a named managed object

Injector::getNamedService() — Method in class Injector

Returns the service, or null if it doesnt' exist. See get() for main usage.

Injector::getServiceNamedSpec() — Method in class Injector

Get or build a named service and specification

Injector::getServiceSpec() — Method in class Injector

Search for spec, lazy-loading in from config locator.

InjectorLoader::getManifest() — Method in class InjectorLoader

Returns the currently active class manifest instance that is used for loading classes.

Kernel::getContainer() — Method in class Kernel

Kernel::getClassLoader() — Method in class Kernel

Kernel::getInjectorLoader() — Method in class Kernel

Get loader for injector instance

Kernel::getModuleLoader() — Method in class Kernel

Kernel::getConfigLoader() — Method in class Kernel

Kernel::getThemeResourceLoader() — Method in class Kernel

Kernel::getEnvironment() — Method in class Kernel

One of dev, live, or test

ClassLoader::getManifest() — Method in class ClassLoader

Returns the currently active class manifest instance that is used for loading classes.

ClassLoader::getItemPath() — Method in class ClassLoader

Returns the path for a class or interface in the currently active manifest, or any previous ones if later manifests aren't set to "exclusive".

ClassManifest::getParser() — Method in class ClassManifest

Get or create active parser

ClassManifest::getTraverser() — Method in class ClassManifest

Get node traverser for parsing class files

ClassManifest::getVisitor() — Method in class ClassManifest

Get visitor for parsing class files

ClassManifest::getItemPath() — Method in class ClassManifest

Returns the file path to a class or interface if it exists in the manifest.

ClassManifest::getItemName() — Method in class ClassManifest

Return correct case name

ClassManifest::getClasses() — Method in class ClassManifest

Returns a map of lowercased class names to file paths.

ClassManifest::getClassNames() — Method in class ClassManifest

Returns a map of lowercase class names to proper class names in the manifest

ClassManifest::getTraits() — Method in class ClassManifest

Returns a map of lowercased trait names to file paths.

ClassManifest::getTraitNames() — Method in class ClassManifest

Returns a map of lowercase trait names to proper trait names in the manifest

ClassManifest::getEnums() — Method in class ClassManifest

Returns a map of lowercased enum names to file paths.

ClassManifest::getEnumNames() — Method in class ClassManifest

Returns a map of lowercase enum names to proper enum names in the manifest

ClassManifest::getDescendants() — Method in class ClassManifest

Returns an array of all the descendant data.

ClassManifest::getDescendantsOf() — Method in class ClassManifest

Returns an array containing all the descendants (direct and indirect) of a class.

ClassManifest::getInterfaces() — Method in class ClassManifest

Returns a map of lowercased interface names to file locations.

ClassManifest::getInterfaceNames() — Method in class ClassManifest

Return map of lowercase interface names to proper case names in the manifest

ClassManifest::getImplementors() — Method in class ClassManifest

Returns a map of lowercased interface names to the classes the implement them.

ClassManifest::getImplementorsOf() — Method in class ClassManifest

Returns an array containing the class names that implement a certain interface.

ClassManifest::getOwnerModule() — Method in class ClassManifest

Get module that owns this class

ClassManifest::getState() — Method in class ClassManifest

Load current state into an array of data

ClassManifestVisitor::getClasses() — Method in class ClassManifestVisitor

ClassManifestVisitor::getTraits() — Method in class ClassManifestVisitor

ClassManifestVisitor::getEnums() — Method in class ClassManifestVisitor

ClassManifestVisitor::getInterfaces() — Method in class ClassManifestVisitor

ManifestFileFinder::getIgnoredDirs() — Method in class ManifestFileFinder

Get all ignored directories

Module::getName() — Method in class Module

Gets name of this module. Used as unique key and identifier for this module.

Module::getComposerName() — Method in class Module

Get full composer name. Will be null if no composer.json is available

Module::getExposedFolders() — Method in class Module

Get list of folders that need to be made available

Module::getShortName() — Method in class Module

Gets "short" name of this module. This is the base directory this module is installed in.

Module::getResourcesDir() — Method in class Module

Name of the resource directory where vendor resources should be exposed as defined by the extra.resources-dir key in the composer file. A blank string will be returned if the key is undefined.

Module::getPath() — Method in class Module

Get base path for this module

Module::getRelativePath() — Method in class Module

Get path relative to base dir.

Module::getResource() — Method in class Module

Get resource for this module

ModuleLoader::getModule() — Method in class ModuleLoader

Get module by name from the current manifest.

ModuleLoader::getManifest() — Method in class ModuleLoader

Returns the currently active class manifest instance that is used for loading classes.

ModuleManifest::getModule() — Method in class ModuleManifest

Get module by name

ModuleManifest::getModules() — Method in class ModuleManifest

Get modules found

ModuleManifest::getModuleByPath() — Method in class ModuleManifest

Get module that contains the given path

ModuleResource::getPath() — Method in class ModuleResource

Return the full filesystem path to this resource.

ModuleResource::getRelativePath() — Method in class ModuleResource

Get the path of this resource relative to the base path.

ModuleResource::getURL() — Method in class ModuleResource

Public URL to this resource.

ModuleResource::getModule() — Method in class ModuleResource

ModuleResource::getRelativeResource() — Method in class ModuleResource

Get nested resource relative to this.

ModuleResourceLoader::get_template_global_variables() — Method in class ModuleResourceLoader

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

PrioritySorter::getSortedList() — Method in class PrioritySorter

Sorts the items and returns a new version of $this->items

VersionProvider::getVersion() — Method in class VersionProvider

Gets a comma delimited string of package titles and versions

VersionProvider::getModuleVersion() — Method in class VersionProvider

Get the version of a specific module

VersionProvider::getModules() — Method in class VersionProvider

Gets the configured core modules to use for the SilverStripe application version

VersionProvider::getModuleVersionFromComposer() — Method in class VersionProvider

Tries to obtain version number from composer.lock if it exists

VersionProvider::getComposerLock() — Method in class VersionProvider

Load composer.lock's contents and return it

VersionProvider::getComposerLockPath() — Method in class VersionProvider

DeployFlushDiscoverer::getCacheTimestamp() — Method in class DeployFlushDiscoverer

Returns the timestamp of the manifest generation or null if no cache has been found (or couldn't read the cache)

DeployFlushDiscoverer::getDeployResource() — Method in class DeployFlushDiscoverer

Returns the resource to be checked for deployment

DeployFlushDiscoverer::getDeployTimestamp() — Method in class DeployFlushDiscoverer

Returns the resource modification timestamp

ScheduledFlushDiscoverer::getFlush() — Method in class ScheduledFlushDiscoverer

Returns the flag whether the manifest flush has been scheduled in previous requests

TempFolder::getTempFolder() — Method in class TempFolder

Returns the temporary folder path that silverstripe should use for its cache files.

TempFolder::getTempFolderUsername() — Method in class TempFolder

Returns as best a representation of the current username as we can glean.

TempFolder::getTempParentFolder() — Method in class TempFolder

Return the parent folder of the temp folder.

CronTaskStatus::get_status() — Method in class CronTaskStatus

Get the status

CronTask::getSchedule() — Method in class CronTask

Return a string for a CRON expression. If a "falsy" value is returned, the CronTaskController will assume the CronTask is disabled.

Backtrace::get_rendered_backtrace() — Method in class Backtrace

Render a backtrace array into an appropriate plain-text or HTML string.

BuildTask::getTitle() — Method in class BuildTask

BuildTask::getDescription() — Method in class BuildTask

BulkLoader::getCheckPermissions() — Method in class BulkLoader

If true, this bulk loader will respect create/edit/delete permissions.

BulkLoader::getOptionFields() — Method in class BulkLoader

Return a FieldList containing all the options for this form; this doesn't include the actual upload field itself

BulkLoader::getImportSpec() — Method in class BulkLoader

Get a specification of all available columns and relations on the used model.

CSSContentParser::getBySelector() — Method in class CSSContentParser

Returns a number of SimpleXML elements that match the given CSS selector.

CSSContentParser::getByXpath() — Method in class CSSContentParser

Allows querying the content through XPATH selectors.

SSListContains::getStubForToString() — Method in class SSListContains

SSListContainsOnly::getStubForToString() — Method in class SSListContainsOnly

CsvBulkLoader::getNormalisedColumnMap() — Method in class CsvBulkLoader

Deprecation::get_called_method_from_trace() — Method in class Deprecation

Given a backtrace, get the method name from the immediate parent caller (the caller of #notice)

Deprecation::getShowNoticesCalledFromSupportedCode() — Method in class Deprecation

If true, deprecation warnings will be shown for deprecated code which is called by core Silverstripe modules.

DevelopmentAdmin::get_links() — Method in class DevelopmentAdmin

DevelopmentAdmin::getLinks() — Method in class DevelopmentAdmin

DevelopmentAdmin::getRegisteredController() — Method in class DevelopmentAdmin

DevelopmentAdmin::generatesecuretoken() — Method in class DevelopmentAdmin

Generate a secure token which can be used as a crypto key.

FixtureBlueprint::getFactory() — Method in class FixtureBlueprint

FixtureBlueprint::getDefaults() — Method in class FixtureBlueprint

FixtureBlueprint::getClass() — Method in class FixtureBlueprint

FixtureFactory::getId() — Method in class FixtureFactory

Get the ID of an object from the fixture.

FixtureFactory::getIds() — Method in class FixtureFactory

Return all of the IDs in the fixture of a particular class name.

FixtureFactory::get() — Method in class FixtureFactory

Get an object from the fixture.

FixtureFactory::getFixtures() — Method in class FixtureFactory

FixtureFactory::getBlueprints() — Method in class FixtureFactory

FixtureFactory::getBlueprint() — Method in class FixtureFactory

FunctionalTest::get() — Method in class FunctionalTest

Submit a get request

FunctionalTest::get_disable_themes() — Method in class FunctionalTest

DatabaseAdapterRegistry::getConfigureDatabasePaths() — Method in class DatabaseAdapterRegistry

Including _configure_database.php is a legacy method of configuring a database It's still used by https://github.com/silverstripe/silverstripe-sqlite3

DatabaseAdapterRegistry::getCache() — Method in class DatabaseAdapterRegistry

DatabaseAdapterRegistry::get_adapters() — Method in class DatabaseAdapterRegistry

Return all registered adapters

DatabaseAdapterRegistry::get_adapter() — Method in class DatabaseAdapterRegistry

Returns registry data for a class

DatabaseAdapterRegistry::get_default_fields() — Method in class DatabaseAdapterRegistry

Retrieves default field configuration

DatabaseAdapterRegistry::getDatabaseConfigurationHelper() — Method in class DatabaseAdapterRegistry

Build configuration helper for a given class

DatabaseConfigurationHelper::getDatabaseVersion() — Method in class DatabaseConfigurationHelper

Determines the version of the database server

MySQLDatabaseConfigurationHelper::getDatabaseVersion() — Method in class MySQLDatabaseConfigurationHelper

Determines the version of the database server

SapphireTest::getIllegalExtensions() — Method in class SapphireTest

Gets illegal extensions for this class

SapphireTest::getRequiredExtensions() — Method in class SapphireTest

Gets required extensions for this class

SapphireTest::get_fixture_file() — Method in class SapphireTest

SapphireTest::getUsesDatabase() — Method in class SapphireTest

SapphireTest::getUsesTransactions() — Method in class SapphireTest

SapphireTest::getRequireDefaultRecordsFrom() — Method in class SapphireTest

SapphireTest::getCurrentAbsolutePath() — Method in class SapphireTest

Useful for writing unit tests without hardcoding folder structures.

SapphireTest::getCurrentRelativePath() — Method in class SapphireTest

SapphireTest::getFixturePaths() — Method in class SapphireTest

Get fixture paths for this test

SapphireTest::getExtraDataObjects() — Method in class SapphireTest

Return all extra objects to scaffold for this test

SapphireTest::getExtraControllers() — Method in class SapphireTest

Get additional controller classes to register routes for

SapphireTest::getExtraRoutes() — Method in class SapphireTest

Get extra routes to merge into Director.rules

SapphireTest::getAnnotations() — Method in class SapphireTest

Returns the annotations for this test.

FixtureTestState::getFixtureFactory() — Method in class FixtureTestState

FixtureTestState::getFixturePaths() — Method in class FixtureTestState

FixtureTestState::getTestAbsolutePath() — Method in class FixtureTestState

Useful for writing unit tests without hardcoding folder structures.

FixtureTestState::getIsLoaded() — Method in class FixtureTestState

Check if fixtures need to be loaded for this class

GlobalsTestState — Class in namespace SilverStripe\Dev\State

Cleans up and reset global env vars between tests

SapphireTestState::getStates() — Method in class SapphireTestState

SapphireTestState::getStateByName() — Method in class SapphireTestState

SapphireTestState::getStateByClass() — Method in class SapphireTestState

TaskRunner::getTasks() — Method in class TaskRunner

TaskRunner::getTaskList() — Method in class TaskRunner

i18nTextCollectorTask::getIsMerge() — Method in class i18nTextCollectorTask

Check if we should merge

TestKernel::getIncludeTests() — Method in class TestKernel

TestSession::get() — Method in class TestSession

Submit a get request

YamlFixture::getFixtureFile() — Method in class YamlFixture

YamlFixture::getFixtureString() — Method in class YamlFixture

ImportField::getBodyText() — Method in class ImportField

ServiceConnector::getDetail() — Method in class ServiceConnector

Retrieves detail in priority order from

local instance field
Config
Environment

ServiceConnector::getUsername() — Method in class ServiceConnector

ServiceConnector::getPassword() — Method in class ServiceConnector

ServiceConnector::getUrl() — Method in class ServiceConnector

SettingsField::getInnerField() — Method in class SettingsField

DynamoDbSession::getHandler() — Method in class DynamoDbSession

DynamoDbSession::getClient() — Method in class DynamoDbSession

DynamoDbSession::get() — Method in class DynamoDbSession

Get an instance of DynamoDbSession configured from the environment if available.

DynamoDbSession::getSessionLifetime() — Method in class DynamoDbSession

Check the AWS constant or refer to the Session class to find the session timeout value (if it exists) in terms of DynamoDB, session_lifetime is the time to mark the inactive session to be garbage collected.

BannerBlock::getType() — Method in class BannerBlock

Get the type of the current block, for use in GridField summaries, block type dropdowns etc. Examples are "Content", "File", "Media", etc.

BannerBlock::getCMSFields() — Method in class BannerBlock

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

BannerBlock::getCallToActionLink() — Method in class BannerBlock

Accessor for CallToActionLink i.e. $block->CallToActionLink

BannerBlock::getSummary() — Method in class BannerBlock

Add the banner content instead of the image title

BlockLinkField::getParsedValue() — Method in class BlockLinkField

Return a parsed ArrayData object from the contents of the JSON value. Will be cached for future use, and the cache will be reset via setValue each time.

BlockLinkField::getLinkPage() — Method in class BlockLinkField

Get the linked SiteTree object, if available

BlockLinkField::getLinkText() — Method in class BlockLinkField

Get the link text/title

BlockLinkField::getLinkDescription() — Method in class BlockLinkField

Get the link "description", used for titles or alt text

BlockLinkField::getLinkTargetBlank() — Method in class BlockLinkField

Get whether to open the link in a new window

BlockLinkField::getLinkRelativeUrl() — Method in class BlockLinkField

Get the relative URL for the linked SiteTree object, with a leading slash

BlockLinkField::getShowLinkText() — Method in class BlockLinkField

Get whether to display the link text field

BlockLinkField::getAttributes() — Method in class BlockLinkField

When not used in a React form factory context, this adds the schema and state data to SilverStripe template rendered attributes lists

BlockLinkField::getSchemaDataDefaults() — Method in class BlockLinkField

Add some extra props for the React component to work with

FileBlock::getCMSFields() — Method in class FileBlock

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

FileBlock::getType() — Method in class FileBlock

Get the type of the current block, for use in GridField summaries, block type dropdowns etc. Examples are "Content", "File", "Media", etc.

FileBlock::getSummary() — Method in class FileBlock

This can be overridden on child elements to create a summary for display in GridFields.

FileBlock::getSummaryThumbnail() — Method in class FileBlock

Return a thumbnail of the file, if it's an image. Used in GridField preview summaries.

ExternalURLCheck::getCurlOpts() — Method in class ExternalURLCheck

ExternalURLCheck::getURLs() — Method in class ExternalURLCheck

FileAccessibilityAndValidationCheck::getFiles() — Method in class FileAccessibilityAndValidationCheck

Gets a list of absolute file paths.

FileAgeCheck::getFiles() — Method in class FileAgeCheck

Gets a list of absolute file paths.

SessionCheck::getCookie() — Method in class SessionCheck

Get PHPSESSID or SECSESSID cookie set from the response if it exists.

ClientFactory::getConfig() — Method in class ClientFactory

Merge config provided from yaml with default config

Fetcher::getURL() — Method in class Fetcher

Getter for URL

ErrorPage::getDefaultRecords() — Method in class ErrorPage

Returns an array of arrays, each of which defines properties for a new ErrorPage record.

ErrorPage::getCMSFields() — Method in class ErrorPage

ErrorPage::get_content_for_errorcode() — Method in class ErrorPage

Returns statically cached content for a given error code

ErrorPage::getCodes() — Method in class ErrorPage

ErrorPage::get_error_filename() — Method in class ErrorPage

Gets the filename identifier for the given error code.

ErrorPage::getErrorFilename() — Method in class ErrorPage

Get filename identifier for this record.

ErrorPage::get_asset_handler() — Method in class ErrorPage

ErrorPageFileExtension::getErrorRecordFor() — Method in class ErrorPageFileExtension

Used by {File::handle_shortcode}

CMSExternalLinksController::getJobStatus() — Method in class CMSExternalLinksController

Respond to Ajax requests for info on a running job

CheckExternalLinksJob::getTitle() — Method in class CheckExternalLinksJob

CheckExternalLinksJob::getJobType() — Method in class CheckExternalLinksJob

By default jobs should just go into the default processing queue

CheckExternalLinksJob::getSignature() — Method in class CheckExternalLinksJob

Return a signature for this queued job

BrokenExternalLink::getHTTPCodeDescription() — Method in class BrokenExternalLink

Retrieve a human readable description of a response code

BrokenExternalPageTrackStatus::get_latest() — Method in class BrokenExternalPageTrackStatus

Get the latest track status

BrokenExternalPageTrackStatus::getIncompletePageList() — Method in class BrokenExternalPageTrackStatus

Gets the list of Pages yet to be checked

BrokenExternalPageTrackStatus::getIncompleteTracks() — Method in class BrokenExternalPageTrackStatus

Get the list of incomplete BrokenExternalPageTrack

BrokenExternalPageTrackStatus::getTotalPages() — Method in class BrokenExternalPageTrackStatus

Get total pages count

BrokenExternalPageTrackStatus::getCompletedPages() — Method in class BrokenExternalPageTrackStatus

Get completed pages count

BrokenExternalPageTrackStatus::get_or_create() — Method in class BrokenExternalPageTrackStatus

Returns the latest run, or otherwise creates a new one

BrokenExternalLinksReport::getColumns() — Method in class BrokenExternalLinksReport

Alias of columns(), to support the export to csv action in GridFieldExportButton generateExportFileData method.

BrokenExternalLinksReport::getCMSFields() — Method in class BrokenExternalLinksReport

Returns a FieldList with which to create the CMS editing form.

CheckExternalLinksTask::getLinkChecker() — Method in class CheckExternalLinksTask

CurlLinkChecker::getCache() — Method in class CurlLinkChecker

Return cache

CheckboxField::getAttributes() — Method in class CheckboxField

Allows customization through an 'updateAttributes' hook on the base class.

CheckboxField_Readonly::getValueCast() — Method in class CheckboxField_Readonly

Get custom cating helper for Value() field

CheckboxSetField::getOptions() — Method in class CheckboxSetField

Gets the list of options to render in this formfield

CheckboxSetField::getAttributes() — Method in class CheckboxSetField

Allows customization through an 'updateAttributes' hook on the base class.

CompositeField::getSchemaDataDefaults() — Method in class CompositeField

Merge child field data into this form

CompositeField::getChildren() — Method in class CompositeField

Accessor method for $this->children

CompositeField::getName() — Method in class CompositeField

Returns the name (ID) for the element.

CompositeField::getTag() — Method in class CompositeField

CompositeField::getLegend() — Method in class CompositeField

CompositeField::getAttributes() — Method in class CompositeField

Allows customization through an 'updateAttributes' hook on the base class.

CompositeField::getColumnCount() — Method in class CompositeField

CompositeValidator::getValidators() — Method in class CompositeValidator

CompositeValidator::getValidatorsByType() — Method in class CompositeValidator

Return all Validators that match a certain class name. EG: RequiredFields::class

ConfirmedPasswordField::getChildren() — Method in class ConfirmedPasswordField

Returns the children of this field for use in templating.

ConfirmedPasswordField::getRandomPasswordCallback() — Method in class ConfirmedPasswordField

Gets the callback used to generate a random password

ConfirmedPasswordField::getShowOnClickTitle() — Method in class ConfirmedPasswordField

ConfirmedPasswordField::getRequireExistingPassword() — Method in class ConfirmedPasswordField

Check if existing password is required

ConfirmedPasswordField::getPasswordField() — Method in class ConfirmedPasswordField

ConfirmedPasswordField::getConfirmPasswordField() — Method in class ConfirmedPasswordField

ConfirmedPasswordField::getMinLength() — Method in class ConfirmedPasswordField

ConfirmedPasswordField::getMaxLength() — Method in class ConfirmedPasswordField

ConfirmedPasswordField::getRequireStrongPassword() — Method in class ConfirmedPasswordField

CurrencyField::getSchemaValidation() — Method in class CurrencyField

Return list of validation rules. Each rule is a key value pair.

DatalessField::getAttributes() — Method in class DatalessField

Allows customization through an 'updateAttributes' hook on the base class.

DatalessField::getAllowHTML() — Method in class DatalessField

DateField::getHTML5() — Method in class DateField

DateField::getDateLength() — Method in class DateField

Get length of the date format to use. One of:

DateField::getDateFormat() — Method in class DateField

Get date format in CLDR standard format

DateField::getFrontendFormatter() — Method in class DateField

Get date formatter with the standard locale / date format

DateField::getInternalFormatter() — Method in class DateField

Get a date formatter for the ISO 8601 format

DateField::getAttributes() — Method in class DateField

DateField::getSchemaDataDefaults() — Method in class DateField

Gets the defaults for $schemaData.

DateField::getLocale() — Method in class DateField

Get locale to use for this field

DateField::getSchemaValidation() — Method in class DateField

Return list of validation rules. Each rule is a key value pair.

DateField::getMinDate() — Method in class DateField

DateField::getMaxDate() — Method in class DateField

DateField_Disabled::getHTML5() — Method in class DateField_Disabled

DatetimeField::getAttributes() — Method in class DatetimeField

DatetimeField::getSchemaDataDefaults() — Method in class DatetimeField

DatetimeField::getHTML5() — Method in class DatetimeField

DatetimeField::getFrontendFormatter() — Method in class DatetimeField

Get date formatter with the standard locale / date format

DatetimeField::getDatetimeFormat() — Method in class DatetimeField

Get date format in CLDR standard format

DatetimeField::getInternalFormatter() — Method in class DatetimeField

Get a date formatter for the ISO 8601 format

DatetimeField::getDateLength() — Method in class DatetimeField

Get length of the date format to use. One of:

DatetimeField::getTimeLength() — Method in class DatetimeField

Get length of the date format to use. One of:

DatetimeField::getLocale() — Method in class DatetimeField

Get locale for this field

DatetimeField::getMinDatetime() — Method in class DatetimeField

DatetimeField::getMaxDatetime() — Method in class DatetimeField

DatetimeField::getTimezone() — Method in class DatetimeField

DropdownField::getFieldOption() — Method in class DropdownField

Build a field option for template rendering

DropdownField::getHasEmptyDefault() — Method in class DropdownField

A required DropdownField must have a user selected attribute, so require an empty default for a required field

EmailField::getSchemaValidation() — Method in class EmailField

Return list of validation rules. Each rule is a key value pair.

FieldGroup::getName() — Method in class FieldGroup

Returns the name (ID) for the element.

FieldGroup::getZebra() — Method in class FieldGroup

FieldGroup::getMessage() — Method in class FieldGroup

FieldGroup::getMessageType() — Method in class FieldGroup

FieldGroup::getMessageCast() — Method in class FieldGroup

Casting type for this message. Will be 'text' or 'html'

FieldList::getContainerField() — Method in class FieldList

FileField::getAttributes() — Method in class FileField

Allows customization through an 'updateAttributes' hook on the base class.

FileField::getAcceptFileTypes() — Method in class FileField

Returns a list of file extensions (and corresponding mime types) that will be accepted

FileField::getRelationAutoSetting() — Method in class FileField

Check if relation can be automatically assigned to the underlying dataobject

FileHandleField::getAttributes() — Method in class FileHandleField

FileHandleField::getFolderName() — Method in class FileHandleField

FileHandleField::getAllowedExtensions() — Method in class FileHandleField

FileUploadReceiver::getRecord() — Method in class FileUploadReceiver

Get the record to use as "Parent" for uploaded Files (eg a Page with a has_one to File) If none is set, it will use Form->getRecord() or Form->Controller()->data()

FileUploadReceiver::getItems() — Method in class FileUploadReceiver

Retrieves the current list of files

FileUploadReceiver::getItemIDs() — Method in class FileUploadReceiver

Retrieves the list of selected file IDs

FileUploadReceiver::getRelationAutosetClass() — Method in class FileUploadReceiver

Gets the foreign class that needs to be created, or 'File' as default if there is no relationship, or it cannot be determined.

FileUploadReceiver::getRelationAutoSetting() — Method in class FileUploadReceiver

Check if relation can be automatically assigned to the underlying dataobject

Form::getNotifyUnsavedChanges() — Method in class Form

Form::getRequest() — Method in class Form

Helper to get current request for this form

Form::getSession() — Method in class Form

Get session for this form

Form::getSessionData() — Method in class Form

Return any form data stored in the session

Form::getSessionValidationResult() — Method in class Form

Return any ValidationResult instance stored for this object

Form::getValidationResponseCallback() — Method in class Form

Form::getRedirectToFormOnValidationError() — Method in class Form

Get whether the user should be redirected back down to the form on the page upon validation errors

Form::getValidator() — Method in class Form

Get the Validator attached to this form.

Form::getValidationExemptActions() — Method in class Form

Get a list of actions that are exempt from validation

Form::getExtraFields() — Method in class Form

Generate extra special fields - namely the security token field (if required).

Form::getDefaultAttributes() — Method in class Form

Form::getTemplateHelper() — Method in class Form

Return a FormTemplateHelper for this form. If one has not been set, return the default helper.

Form::getTemplate() — Method in class Form

Return the template to render this form with.

Form::getTemplates() — Method in class Form

Returns the ordered list of preferred templates for rendering this form If the template isn't set, then default to the form class name e.g "Form".

Form::getEncType() — Method in class Form

Returns the encoding type for the form.

Form::getStrictFormMethodCheck() — Method in class Form

Form::getHTMLID() — Method in class Form

Form::getController() — Method in class Form

Get the controller or parent request handler.

Form::getName() — Method in class Form

Get the name of the form.

Form::getRecord() — Method in class Form

Returns the record that has given this form its data through loadDataFrom().

Form::getLegend() — Method in class Form

Get the legend value to be inserted into the

element in Form.ss

Form::getData() — Method in class Form

Get the submitted data from this form through FieldList->dataFields(), which filters out any form-specific data like form-actions.

Form::getSecurityToken() — Method in class Form

Returns the security token for this form (if any exists).

Form::getRequestHandler() — Method in class Form

Get request handler for this form

FormAction::getSchemaDataDefaults() — Method in class FormAction

Add extra options to data

FormAction::getIcon() — Method in class FormAction

Get button icon, if supported

FormAction::getInputType() — Method in class FormAction

Returns the field input name.

FormAction::getAttributes() — Method in class FormAction

Allows customization through an 'updateAttributes' hook on the base class.

FormAction::getButtonContent() — Method in class FormAction

Gets the content inside the button field. This is raw HTML, and should be used sparingly.

FormAction::getUseButtonTag() — Method in class FormAction

Determine if this action is rendered as a

FormAction::getValidationExempt() — Method in class FormAction

Get whether this action can be performed without validating the data

FormFactory::getForm() — Method in class FormFactory

Generates the form

FormFactory::getRequiredContext() — Method in class FormFactory

Return list of mandatory context keys

FormField::getTemplateHelper() — Method in class FormField

Returns the current FormTemplateHelper on either the parent Form or the global helper set through the Injector layout.

FormField::getName() — Method in class FormField

Returns the field name.

FormField::getInputType() — Method in class FormField

Returns the field input name.

FormField::getDefaultAttributes() — Method in class FormField

FormField::getForm() — Method in class FormField

Get the currently used form.

FormField::getCustomValidationMessage() — Method in class FormField

Get the custom error message for this form field. If a custom message has not been defined then just return blank. The default error is defined on Validator.

FormField::getTemplate() — Method in class FormField

FormField::getFieldHolderTemplate() — Method in class FormField

FormField::getSmallFieldHolderTemplate() — Method in class FormField

FormField::getTemplates() — Method in class FormField

Returns an array of templates to use for rendering FieldHolder.

FormField::getFieldHolderTemplates() — Method in class FormField

Returns an array of templates to use for rendering FieldHolder.

FormField::getSmallFieldHolderTemplates() — Method in class FormField

Returns an array of templates to use for rendering SmallFieldHolder.

FormField::getDescription() — Method in class FormField

FormField::getContainerFieldList() — Method in class FormField

Get the FieldList that contains this field.

FormField::getSchemaComponent() — Method in class FormField

Gets the type of front-end component the FormField will be rendered as.

FormField::getSchemaData() — Method in class FormField

Gets the schema data used to render the FormField on the front-end.

FormField::getSchemaDataType() — Method in class FormField

FormField::getSchemaDataDefaults() — Method in class FormField

Gets the defaults for $schemaData.

FormField::getSchemaState() — Method in class FormField

Gets the schema state used to render the FormField on the front-end.

FormField::getSchemaStateDefaults() — Method in class FormField

Gets the defaults for $schemaState.

FormField::getSchemaValidation() — Method in class FormField

Return list of validation rules. Each rule is a key value pair.

FormField::getTitleTip() — Method in class FormField

FormMessage::getMessage() — Method in class FormMessage

Returns the field message, used by form validation.

FormMessage::getMessageType() — Method in class FormMessage

Returns the field message type.

FormMessage::getMessageCast() — Method in class FormMessage

Casting type for this message. Will be 'text' or 'html'

FormMessage::getMessageCastingHelper() — Method in class FormMessage

Get casting helper for message cast, or null if not known

FormMessage::getSchemaMessage() — Method in class FormMessage

Get form schema encoded message

FormMessageBootstrapExtension::getAlertType() — Method in class FormMessageBootstrapExtension

Maps a SilverStripe message type to a Bootstrap alert type

FormRequestHandler::getValidationErrorResponse() — Method in class FormRequestHandler

Returns the appropriate response up the controller chain if validate() fails (which is checked prior to executing any form actions).

FormRequestHandler::getAllActions() — Method in class FormRequestHandler

Get a list of all actions, including those in the main "fields" FieldList

FormScaffolder::getFieldList() — Method in class FormScaffolder

Gets the form fields as defined through the metadata on $obj and the custom parameters passed to FormScaffolder.

FormScaffolder::getParamsArray() — Method in class FormScaffolder

Return an array suitable for passing on to DBField->scaffoldFormField() without tying this call to a FormScaffolder interface.

FormTemplateHelper::generateFormID() — Method in class FormTemplateHelper

FormTemplateHelper::generateFieldHolderID() — Method in class FormTemplateHelper

FormTemplateHelper::generateFieldID() — Method in class FormTemplateHelper

Generate the field ID value

AbstractRequestAwareStore::getRequest() — Method in class AbstractRequestAwareStore

GridField — Class in namespace SilverStripe\Forms\GridField

Displays a SS_List in a grid format.

GridField::getModelClass() — Method in class GridField

Returns the class name of the record type that this GridField should contain.

GridField::getReadonlyComponents() — Method in class GridField

Return the readonly components

GridField::getConfig() — Method in class GridField

GridField::getComponents() — Method in class GridField

GridField::getCastedValue() — Method in class GridField

Cast an arbitrary value with the help of a $castingDefinition.

GridField::getList() — Method in class GridField

Get the data source.

GridField::getManipulatedList() — Method in class GridField

Get the data source after applying every GridField_DataManipulator to it.

GridField::getState() — Method in class GridField

Get the current GridState_Data or the GridState.

GridField::getRowAttributes() — Method in class GridField

GridField::getAttributes() — Method in class GridField

Allows customization through an 'updateAttributes' hook on the base class.

GridField::getColumns() — Method in class GridField

Get the columns of this GridField, they are provided by attached GridField_ColumnProvider.

GridField::getColumnContent() — Method in class GridField

Get the value from a column.

GridField::getDataFieldValue() — Method in class GridField

Get the value of a named field on the given record.

GridField::getColumnAttributes() — Method in class GridField

Get extra columns attributes used as HTML attributes.

GridField::getColumnMetadata() — Method in class GridField

Get metadata for a column.

GridField::getColumnCount() — Method in class GridField

Return how many columns the grid will have.

GridField::gridFieldAlterAction() — Method in class GridField

This is the action that gets executed when a GridField_AlterAction gets clicked.

GridField::getOptionalTableHeader() — Method in class GridField

GridField::getOptionalTableBody() — Method in class GridField

GridField::getOptionalTableFooter() — Method in class GridField

GridFieldAddExistingAutocompleter — Class in namespace SilverStripe\Forms\GridField

This class is is responsible for adding objects to another object's has_many and many_many relation, as defined by the RelationList passed to the GridField constructor.

GridFieldAddExistingAutocompleter::getHTMLFragments() — Method in class GridFieldAddExistingAutocompleter

GridFieldAddExistingAutocompleter::getActions() — Method in class GridFieldAddExistingAutocompleter

GridFieldAddExistingAutocompleter::getManipulatedData() — Method in class GridFieldAddExistingAutocompleter

If an object ID is set, add the object to the list

GridFieldAddExistingAutocompleter::getURLHandlers() — Method in class GridFieldAddExistingAutocompleter

GridFieldAddExistingAutocompleter::getResultsFormat() — Method in class GridFieldAddExistingAutocompleter

GridFieldAddExistingAutocompleter::getSearchFields() — Method in class GridFieldAddExistingAutocompleter

GridFieldAddExistingAutocompleter::getPlaceholderText() — Method in class GridFieldAddExistingAutocompleter

GridFieldAddExistingAutocompleter::getResultsLimit() — Method in class GridFieldAddExistingAutocompleter

Gets the maximum number of autocomplete results to display.

GridFieldAddNewButton — Class in namespace SilverStripe\Forms\GridField

This component provides a button for opening the add new form provided by GridFieldDetailForm.

GridFieldAddNewButton::getHTMLFragments() — Method in class GridFieldAddNewButton

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

GridFieldButtonRow — Class in namespace SilverStripe\Forms\GridField

Adding this class to a GridFieldConfig} of a {@link GridField adds a button row to that field.

GridFieldButtonRow::getHTMLFragments() — Method in class GridFieldButtonRow

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

GridFieldComponent — Class in namespace SilverStripe\Forms\GridField

Base interface for all components that can be added to GridField.

GridFieldConfig — Class in namespace SilverStripe\Forms\GridField

Encapsulates a collection of components following the GridFieldComponent} interface. While the {@link GridField itself has some configuration in the form of setters, most of the details are dealt with through components.

GridFieldConfig::getComponents() — Method in class GridFieldConfig

GridFieldConfig::getComponentsByType() — Method in class GridFieldConfig

Returns all components extending a certain class, or implementing a certain interface.

GridFieldConfig::getComponentByType() — Method in class GridFieldConfig

Returns the first available component with the given class or interface.

GridFieldConfig_Base — Class in namespace SilverStripe\Forms\GridField

A simple readonly, paginated view of records, with sortable and searchable headers.

GridFieldConfig_RecordEditor — Class in namespace SilverStripe\Forms\GridField

Allows editing of records contained within the GridField, instead of only allowing the ability to view records in the GridField.

GridFieldConfig_RecordViewer — Class in namespace SilverStripe\Forms\GridField

Allows viewing readonly details of individual records.

GridFieldConfig_RelationEditor — Class in namespace SilverStripe\Forms\GridField

Similar to GridFieldConfig_RecordEditor, but adds features to work on has-many or many-many relationships.

GridFieldDataColumns — Class in namespace SilverStripe\Forms\GridField

GridFieldDataColumns::getColumnsHandled() — Method in class GridFieldDataColumns

Names of all columns which are affected by this component.

GridFieldDataColumns::getDisplayFields() — Method in class GridFieldDataColumns

Get the DisplayFields

GridFieldDataColumns::getFieldCasting() — Method in class GridFieldDataColumns

GridFieldDataColumns::getFieldFormatting() — Method in class GridFieldDataColumns

GridFieldDataColumns::getColumnContent() — Method in class GridFieldDataColumns

HTML for the column, content of the element.

GridFieldDataColumns::getColumnAttributes() — Method in class GridFieldDataColumns

Attributes for the element containing the content returned by getColumnContent().

GridFieldDataColumns::getColumnMetadata() — Method in class GridFieldDataColumns

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

GridFieldDataColumns::getValueFromRelation() — Method in class GridFieldDataColumns

Translate a Object.RelationName.ColumnName $columnName into the value that ColumnName returns

GridFieldDeleteAction — Class in namespace SilverStripe\Forms\GridField

This class is a GridField component that adds a delete action for objects.

GridFieldDeleteAction::getTitle() — Method in class GridFieldDeleteAction

GridFieldDeleteAction::getGroup() — Method in class GridFieldDeleteAction

GridFieldDeleteAction::getExtraData() — Method in class GridFieldDeleteAction

GridFieldDeleteAction::getColumnAttributes() — Method in class GridFieldDeleteAction

Return any special attributes that will be used for FormField::create_tag()

GridFieldDeleteAction::getColumnMetadata() — Method in class GridFieldDeleteAction

Add the title

GridFieldDeleteAction::getColumnsHandled() — Method in class GridFieldDeleteAction

Which columns are handled by this component

GridFieldDeleteAction::getActions() — Method in class GridFieldDeleteAction

Which GridField actions are this component handling

GridFieldDeleteAction::getColumnContent() — Method in class GridFieldDeleteAction

GridFieldDeleteAction::getRemoveAction() — Method in class GridFieldDeleteAction

GridFieldDeleteAction::getRemoveRelation() — Method in class GridFieldDeleteAction

Get whether to remove or delete the relation

GridFieldDetailForm — Class in namespace SilverStripe\Forms\GridField

Provides view and edit forms at GridField-specific URLs.

GridFieldDetailForm::getURLHandlers() — Method in class GridFieldDetailForm

Return URLs to be handled by this grid field, in an array the same form as $url_handlers.

GridFieldDetailForm::getRecordFromRequest() — Method in class GridFieldDetailForm

GridFieldDetailForm::getLostRecordRedirection() — Method in class GridFieldDetailForm

Try and find another URL at which the given record can be edited.

GridFieldDetailForm::getItemRequestHandler() — Method in class GridFieldDetailForm

Build a request handler for the given record

GridFieldDetailForm::getTemplate() — Method in class GridFieldDetailForm

GridFieldDetailForm::getName() — Method in class GridFieldDetailForm

GridFieldDetailForm::getRedirectMissingRecords() — Method in class GridFieldDetailForm

Return the status of redirection to missing records.

GridFieldDetailForm::getDefaultShowPagination() — Method in class GridFieldDetailForm

GridFieldDetailForm::getShowPagination() — Method in class GridFieldDetailForm

GridFieldDetailForm::getDefaultShowAdd() — Method in class GridFieldDetailForm

GridFieldDetailForm::getShowAdd() — Method in class GridFieldDetailForm

GridFieldDetailForm::getValidator() — Method in class GridFieldDetailForm

GridFieldDetailForm::getFields() — Method in class GridFieldDetailForm

GridFieldDetailForm::getItemRequestClass() — Method in class GridFieldDetailForm

GridFieldDetailForm::getItemEditFormCallback() — Method in class GridFieldDetailForm

GridFieldDetailForm_ItemRequest — Class in namespace SilverStripe\Forms\GridField

$ GridFieldDetailForm_ItemRequest#gridField — Property in class GridFieldDetailForm_ItemRequest

GridFieldDetailForm_ItemRequest::getCreateContext() — Method in class GridFieldDetailForm_ItemRequest

Build context for verifying canCreate

GridFieldDetailForm_ItemRequest::getRightGroupField() — Method in class GridFieldDetailForm_ItemRequest

GridFieldDetailForm_ItemRequest::getFormActions() — Method in class GridFieldDetailForm_ItemRequest

Build the set of form field actions for the record being handled

GridFieldDetailForm_ItemRequest::getToplevelController() — Method in class GridFieldDetailForm_ItemRequest

Traverse the nested RequestHandlers until we reach something that's not GridFieldDetailForm_ItemRequest.

GridFieldDetailForm_ItemRequest::getBackLink() — Method in class GridFieldDetailForm_ItemRequest

GridFieldDetailForm_ItemRequest::getExtraSavedData() — Method in class GridFieldDetailForm_ItemRequest

Get the list of extra data from the $record as saved into it by {Form::saveInto()}

GridFieldDetailForm_ItemRequest::getEditLink() — Method in class GridFieldDetailForm_ItemRequest

Gets the edit link for a record

GridFieldDetailForm_ItemRequest::getPreviousRecordID() — Method in class GridFieldDetailForm_ItemRequest

Gets the ID of the previous record in the list.

GridFieldDetailForm_ItemRequest::getNextRecordID() — Method in class GridFieldDetailForm_ItemRequest

Gets the ID of the next record in the list.

GridFieldDetailForm_ItemRequest::getTemplate() — Method in class GridFieldDetailForm_ItemRequest

GridFieldDetailForm_ItemRequest::getTemplates() — Method in class GridFieldDetailForm_ItemRequest

Get list of templates to use

GridFieldDetailForm_ItemRequest::getController() — Method in class GridFieldDetailForm_ItemRequest

GridFieldDetailForm_ItemRequest::getGridField() — Method in class GridFieldDetailForm_ItemRequest

GridFieldDetailForm_ItemRequest::getRecord() — Method in class GridFieldDetailForm_ItemRequest

GridFieldEditButton — Class in namespace SilverStripe\Forms\GridField

Provides the entry point to editing a single record presented by the GridField.

GridFieldEditButton::getTitle() — Method in class GridFieldEditButton

GridFieldEditButton::getGroup() — Method in class GridFieldEditButton

GridFieldEditButton::getExtraData() — Method in class GridFieldEditButton

GridFieldEditButton::getUrl() — Method in class GridFieldEditButton

GridFieldEditButton::getColumnAttributes() — Method in class GridFieldEditButton

Return any special attributes that will be used for FormField::create_tag()

GridFieldEditButton::getColumnMetadata() — Method in class GridFieldEditButton

Add the title

GridFieldEditButton::getColumnsHandled() — Method in class GridFieldEditButton

Which columns are handled by this component

GridFieldEditButton::getActions() — Method in class GridFieldEditButton

Which GridField actions are this component handling.

GridFieldEditButton::getColumnContent() — Method in class GridFieldEditButton

GridFieldEditButton::getExtraClass() — Method in class GridFieldEditButton

Get the extra HTML classes to add for edit buttons

GridFieldExportButton — Class in namespace SilverStripe\Forms\GridField

Adds an "Export list" button to the bottom of a GridField.

GridFieldExportButton::getHTMLFragments() — Method in class GridFieldExportButton

Place the export button in a

tag below the field

GridFieldExportButton::getActions() — Method in class GridFieldExportButton

export is an action button

GridFieldExportButton::getURLHandlers() — Method in class GridFieldExportButton

it is also a URL

GridFieldExportButton::getExportColumnsForGridField() — Method in class GridFieldExportButton

Return the columns to export

GridFieldExportButton::generateExportFileData() — Method in class GridFieldExportButton

Generate export fields for CSV.

GridFieldExportButton::getExportColumns() — Method in class GridFieldExportButton

GridFieldExportButton::getCsvSeparator() — Method in class GridFieldExportButton

GridFieldExportButton::getCsvEnclosure() — Method in class GridFieldExportButton

GridFieldExportButton::getCsvHasHeader() — Method in class GridFieldExportButton

GridFieldFilterHeader — Class in namespace SilverStripe\Forms\GridField

GridFieldFilterHeader alters the GridField with some filtering fields in the header of each column.

GridFieldFilterHeader::getURLHandlers() — Method in class GridFieldFilterHeader

GridFieldFilterHeader::getThrowExceptionOnBadDataType() — Method in class GridFieldFilterHeader

See setThrowExceptionOnBadDataType()

GridFieldFilterHeader::getSearchField() — Method in class GridFieldFilterHeader

GridFieldFilterHeader::getActions() — Method in class GridFieldFilterHeader

If the GridField has a filterable datalist, return an array of actions

GridFieldFilterHeader::getManipulatedData() — Method in class GridFieldFilterHeader

GridFieldFilterHeader::getPlaceHolderText() — Method in class GridFieldFilterHeader

Get the text to be used as a placeholder in the search field.

GridFieldFilterHeader::getSearchContext() — Method in class GridFieldFilterHeader

Generate a search context based on the model class of the of the GridField

GridFieldFilterHeader::getSearchFieldSchema() — Method in class GridFieldFilterHeader

Returns the search field schema for the component

GridFieldFilterHeader::getSearchForm() — Method in class GridFieldFilterHeader

Returns the search form for the component

GridFieldFilterHeader::getSearchFormSchema() — Method in class GridFieldFilterHeader

Returns the search form schema for the component

GridFieldFilterHeader::getHTMLFragments() — Method in class GridFieldFilterHeader

Either returns the legacy filter header or the search button and field

GridFieldFooter — Class in namespace SilverStripe\Forms\GridField

Adding this class to a GridFieldConfig} of a {@link GridField adds a footer bar to that field.

GridFieldFooter::getHTMLFragments() — Method in class GridFieldFooter

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

GridFieldGroupDeleteAction — Class in namespace SilverStripe\Forms\GridField

Adds a delete action for the gridfield to remove a relationship from group.

$ GridFieldGroupDeleteAction#groupID — Property in class GridFieldGroupDeleteAction

GridFieldGroupDeleteAction::getColumnContent() — Method in class GridFieldGroupDeleteAction

GridFieldGroupDeleteAction::getGroup() — Method in class GridFieldGroupDeleteAction

Get the ActionMenu group (not related to Member group)

GridFieldImportButton — Class in namespace SilverStripe\Forms\GridField

GridFieldImportButton::getHTMLFragments() — Method in class GridFieldImportButton

Place the export button in a

tag below the field

GridFieldImportButton::getActions() — Method in class GridFieldImportButton

export is an action button

GridFieldImportButton::getModalTitle() — Method in class GridFieldImportButton

GridFieldImportButton::getImportForm() — Method in class GridFieldImportButton

GridFieldImportButton::getImportIframe() — Method in class GridFieldImportButton

GridFieldLazyLoader — Class in namespace SilverStripe\Forms\GridField

GridFieldLazyLoader alters the GridField behavior to delay rendering of rows until the tab containing the GridField is selected by the user.

GridFieldLazyLoader::getManipulatedData() — Method in class GridFieldLazyLoader

Empty $datalist if the current request should be lazy loadable.

GridFieldLazyLoader::getHTMLFragments() — Method in class GridFieldLazyLoader

Apply an appropriate CSS class to $gridField based on whatever the current request is lazy loadable or not.

GridFieldLevelup — Class in namespace SilverStripe\Forms\GridField

Adds a "level up" link to a GridField table, which is useful when viewing hierarchical data. Requires the managed record to have a "getParent()" method or has_one relationship called "Parent".

GridFieldLevelup::getHTMLFragments() — Method in class GridFieldLevelup

GridFieldLevelup::getAttributes() — Method in class GridFieldLevelup

GridFieldLevelup::getLinkSpec() — Method in class GridFieldLevelup

GridFieldPageCount — Class in namespace SilverStripe\Forms\GridField

GridFieldPage displays a simple current page count summary.

GridFieldPageCount::getPaginator() — Method in class GridFieldPageCount

Retrieves an instance of a GridFieldPaginator attached to the same control

GridFieldPageCount::getHTMLFragments() — Method in class GridFieldPageCount

GridFieldPaginator — Class in namespace SilverStripe\Forms\GridField

GridFieldPaginator paginates the GridField list and adds controls to the bottom of the GridField.

GridFieldPaginator::getThrowExceptionOnBadDataType() — Method in class GridFieldPaginator

See setThrowExceptionOnBadDataType()

GridFieldPaginator::getActions() — Method in class GridFieldPaginator

GridFieldPaginator::getGridPagerState() — Method in class GridFieldPaginator

Retrieves/Sets up the state object used to store and retrieve information about the current paging details of this GridField

GridFieldPaginator::getManipulatedData() — Method in class GridFieldPaginator

GridFieldPaginator::getTemplateParameters() — Method in class GridFieldPaginator

Determines arguments to be passed to the template for building this field

GridFieldPaginator::getHTMLFragments() — Method in class GridFieldPaginator

GridFieldPaginator::getItemsPerPage() — Method in class GridFieldPaginator

GridFieldPrintButton — Class in namespace SilverStripe\Forms\GridField

Adds an "Print" button to the bottom or top of a GridField.

GridFieldPrintButton::getHTMLFragments() — Method in class GridFieldPrintButton

Place the print button in a

tag below the field

GridFieldPrintButton::getActions() — Method in class GridFieldPrintButton

Print is an action button.

GridFieldPrintButton::getURLHandlers() — Method in class GridFieldPrintButton

Print is accessible via the url

GridFieldPrintButton::getPrintColumnsForGridField() — Method in class GridFieldPrintButton

Return the columns to print

GridFieldPrintButton::getTitle() — Method in class GridFieldPrintButton

Return the title of the printed page

GridFieldPrintButton::generatePrintData() — Method in class GridFieldPrintButton

Export core.

GridFieldPrintButton::getPrintColumns() — Method in class GridFieldPrintButton

GridFieldPrintButton::getPrintHasHeader() — Method in class GridFieldPrintButton

GridFieldSortableHeader — Class in namespace SilverStripe\Forms\GridField

GridFieldSortableHeader adds column headers to a GridField that can also sort the columns.

GridFieldSortableHeader::getThrowExceptionOnBadDataType() — Method in class GridFieldSortableHeader

See setThrowExceptionOnBadDataType()

GridFieldSortableHeader::getFieldSorting() — Method in class GridFieldSortableHeader

GridFieldSortableHeader::getHTMLFragments() — Method in class GridFieldSortableHeader

Returns the header row providing titles with sort buttons

GridFieldSortableHeader::getActions() — Method in class GridFieldSortableHeader

GridFieldSortableHeader::getManipulatedData() — Method in class GridFieldSortableHeader

Returns the manipulated (sorted) DataList. Field names will simply add an 'ORDER BY' clause, relation names will add appropriate joins to the DataQuery first.

GridFieldStateAware — Class in namespace SilverStripe\Forms\GridField

A trait that makes a class able to consume and use a GridFieldStateManagerInterface implementation

GridFieldStateAware::getStateManager() — Method in class GridFieldStateAware

Fallback on the direct Injector access, but allow a custom implementation to be applied

GridFieldStateManager — Class in namespace SilverStripe\Forms\GridField

Creates a unique key for the gridfield, and uses that to write to and retrieve its state from the request

GridFieldStateManager::getStateKey() — Method in class GridFieldStateManager

GridFieldStateManager::getStateFromRequest() — Method in class GridFieldStateManager

GridFieldStateManagerInterface — Class in namespace SilverStripe\Forms\GridField

Defines a class that can create a key for a gridfield and apply its state to a request, and consume state from the request

GridFieldStateManagerInterface::getStateKey() — Method in class GridFieldStateManagerInterface

GridFieldStateManagerInterface::getStateFromRequest() — Method in class GridFieldStateManagerInterface

GridFieldToolbarHeader — Class in namespace SilverStripe\Forms\GridField

Adding this class to a GridFieldConfig} of a {@link GridField adds a header title to that field.

GridFieldToolbarHeader::getHTMLFragments() — Method in class GridFieldToolbarHeader

GridFieldViewButton — Class in namespace SilverStripe\Forms\GridField

A button that allows a user to view readonly details of a record. This is disabled by default and intended for use in readonly GridField instances.

GridFieldViewButton::getTitle() — Method in class GridFieldViewButton

GridFieldViewButton::getGroup() — Method in class GridFieldViewButton

GridFieldViewButton::getExtraData() — Method in class GridFieldViewButton

GridFieldViewButton::getUrl() — Method in class GridFieldViewButton

GridFieldViewButton::getColumnsHandled() — Method in class GridFieldViewButton

Names of all columns which are affected by this component.

GridFieldViewButton::getColumnContent() — Method in class GridFieldViewButton

HTML for the column, content of the element.

GridFieldViewButton::getColumnAttributes() — Method in class GridFieldViewButton

Attributes for the element containing the content returned by getColumnContent().

GridFieldViewButton::getColumnMetadata() — Method in class GridFieldViewButton

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

GridField_ActionMenu — Class in namespace SilverStripe\Forms\GridField

Groups exiting actions in the Actions column in to a menu

GridField_ActionMenu::getColumnsHandled() — Method in class GridField_ActionMenu

Names of all columns which are affected by this component.

GridField_ActionMenu::getColumnContent() — Method in class GridField_ActionMenu

HTML for the column, content of the element.

GridField_ActionMenu::getColumnAttributes() — Method in class GridField_ActionMenu

Attributes for the element containing the content returned by getColumnContent().

GridField_ActionMenu::getColumnMetadata() — Method in class GridField_ActionMenu

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

GridField_ActionMenu::getActions() — Method in class GridField_ActionMenu

Return a list of the actions handled by this action provider.

GridField_ActionMenu::getItems() — Method in class GridField_ActionMenu

Gets the list of items setup

GridField_ActionMenuItem — Class in namespace SilverStripe\Forms\GridField

GridField action menu item interface, this provides data so the action will be included if there is a {GridField_ActionMenu}

GridField_ActionMenuItem::getTitle() — Method in class GridField_ActionMenuItem

Gets the title for this menu item

GridField_ActionMenuItem::getExtraData() — Method in class GridField_ActionMenuItem

Gets any extra data that could go in to the schema that the menu generates

GridField_ActionMenuItem::getGroup() — Method in class GridField_ActionMenuItem

Gets the group this menu item will belong to. A null value should indicate the button should not display.

GridField_ActionMenuLink — Class in namespace SilverStripe\Forms\GridField

Allows GridField_ActionMenuItem to act as a link

GridField_ActionMenuLink::getUrl() — Method in class GridField_ActionMenuLink

Gets the action url for this menu item

GridField_ActionProvider — Class in namespace SilverStripe\Forms\GridField

An action is defined by two things: an action name, and zero or more named arguments.

GridField_ActionProvider::getActions() — Method in class GridField_ActionProvider

Return a list of the actions handled by this action provider.

GridField_ColumnProvider — Class in namespace SilverStripe\Forms\GridField

Add a new column to the table display body, or modify existing columns.

GridField_ColumnProvider::getColumnsHandled() — Method in class GridField_ColumnProvider

Names of all columns which are affected by this component.

GridField_ColumnProvider::getColumnContent() — Method in class GridField_ColumnProvider

HTML for the column, content of the element.

GridField_ColumnProvider::getColumnAttributes() — Method in class GridField_ColumnProvider

Attributes for the element containing the content returned by getColumnContent().

GridField_ColumnProvider::getColumnMetadata() — Method in class GridField_ColumnProvider

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

GridField_DataManipulator — Class in namespace SilverStripe\Forms\GridField

Can modify the data list.

GridField_DataManipulator::getManipulatedData() — Method in class GridField_DataManipulator

Manipulate the SS_List as needed by this grid modifier.

GridField_FormAction — Class in namespace SilverStripe\Forms\GridField

This class is the base class when you want to have an action that alters the state of the GridField, rendered as a button element.

$ GridField_FormAction#gridField — Property in class GridField_FormAction

GridField_FormAction::getAttributes() — Method in class GridField_FormAction

GridField_FormAction::getNameFromParent() — Method in class GridField_FormAction

Calculate the name of the gridfield relative to the form.

GridField_HTMLProvider — Class in namespace SilverStripe\Forms\GridField

A GridField manipulator that provides HTML for the header/footer rows, or f or before/after the template.

GridField_HTMLProvider::getHTMLFragments() — Method in class GridField_HTMLProvider

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

GridField_SaveHandler — Class in namespace SilverStripe\Forms\GridField

A component which is used to handle when a GridField is saved into a record.

GridField_StateProvider — Class in namespace SilverStripe\Forms\GridField

A GridField component that provides state, notably default state.

GridField_URLHandler — Class in namespace SilverStripe\Forms\GridField

Sometimes an action isn't enough: you need to provide additional support URLs for the GridField.

GridField_URLHandler::getURLHandlers() — Method in class GridField_URLHandler

Return URLs to be handled by this grid field, in an array the same form as $url_handlers.

GridState — Class in namespace SilverStripe\Forms\GridField

This class is a snapshot of the current status of a GridField.

$ GridState#grid — Property in class GridState

GridState::getData() — Method in class GridState

GridState::getList() — Method in class GridState

GridState_Component — Class in namespace SilverStripe\Forms\GridField

GridState_Component::getHTMLFragments() — Method in class GridState_Component

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

GridState_Data — Class in namespace SilverStripe\Forms\GridField

Simple set of data, similar to stdClass, but without the notice-level errors.

GridState_Data::getData() — Method in class GridState_Data

Retrieve the value for the given key

GridState_Data::getChangesArray() — Method in class GridState_Data

Convert the state to an array including only value that differ from the default state defined by initDefaults()

GroupedDropdownField — Class in namespace SilverStripe\Forms

Grouped dropdown, using optgroup tags.

GroupedDropdownField::getFieldOption() — Method in class GroupedDropdownField

Build a potentially nested fieldgroup

GroupedDropdownField::getSourceValues() — Method in class GroupedDropdownField

Retrieve all values in the source array

HTMLEditorConfig::get() — Method in class HTMLEditorConfig

Get the HTMLEditorConfig object for the given identifier. This is a correct way to get an HTMLEditorConfig instance - do not call 'new'

HTMLEditorConfig::getThemes() — Method in class HTMLEditorConfig

Gets the current themes, if it is not set this will fallback to config

HTMLEditorConfig::get_active_identifier() — Method in class HTMLEditorConfig

Get the currently active configuration identifier. Will fall back to default_config if unassigned.

HTMLEditorConfig::get_active() — Method in class HTMLEditorConfig

Get the currently active configuration object

HTMLEditorConfig::get_available_configs_map() — Method in class HTMLEditorConfig

Get the available configurations as a map of friendly_name to configuration name.

HTMLEditorConfig::getOption() — Method in class HTMLEditorConfig

Get the current value of an option

HTMLEditorConfig::getAttributes() — Method in class HTMLEditorConfig

Associative array of data-attributes to apply to the underlying text-area

HTMLEditorConfig::getConfigSchemaData() — Method in class HTMLEditorConfig

Provide additional schema data for the field this object configures

HTMLEditorField::getEditorConfig() — Method in class HTMLEditorField

Gets the HTMLEditorConfig instance

HTMLEditorField::getAttributes() — Method in class HTMLEditorField

Allows customization through an 'updateAttributes' hook on the base class.

HTMLEditorField::getSchemaStateDefaults() — Method in class HTMLEditorField

Gets the defaults for $schemaState.

$ HTMLEditorSanitiser#globalAttributes — Property in class HTMLEditorSanitiser

HTMLEditorSanitiser::getRuleForElement() — Method in class HTMLEditorSanitiser

Given an element tag, return the rule structure for that element

HTMLEditorSanitiser::getRuleForAttribute() — Method in class HTMLEditorSanitiser

Given an attribute name, return the rule structure for that attribute

TinyMCECombinedGenerator::getAssetHandler() — Method in class TinyMCECombinedGenerator

Get backend for assets

TinyMCECombinedGenerator::getScriptURL() — Method in class TinyMCECombinedGenerator

Generate a script URL for the given config

TinyMCECombinedGenerator::generateContent() — Method in class TinyMCECombinedGenerator

Build raw config for tinymce

TinyMCECombinedGenerator::getFileContents() — Method in class TinyMCECombinedGenerator

Returns the contents of the script file if it exists and removes the UTF-8 BOM header if it exists.

TinyMCECombinedGenerator::generateFilename() — Method in class TinyMCECombinedGenerator

Get filename to use for this config

TinyMCEConfig::getTheme() — Method in class TinyMCEConfig

Get the theme

TinyMCEConfig::getOption() — Method in class TinyMCEConfig

Get the current value of an option

TinyMCEConfig::getSettings() — Method in class TinyMCEConfig

Get all settings

TinyMCEConfig::getAttributes() — Method in class TinyMCEConfig

Associative array of data-attributes to apply to the underlying text-area

TinyMCEConfig::getPlugins() — Method in class TinyMCEConfig

Gets the list of all enabled plugins as an associative array.

TinyMCEConfig::getInternalPlugins() — Method in class TinyMCEConfig

Get list of plugins without custom locations, which is the set of plugins which can be loaded via the standard plugin path, and could potentially be minified

TinyMCEConfig::getButtons() — Method in class TinyMCEConfig

Get all button rows, skipping empty rows

TinyMCEConfig::getConfig() — Method in class TinyMCEConfig

Generate the JavaScript that will set TinyMCE's configuration:

Parse all configurations into JSON objects to be used in JavaScript
Includes TinyMCE and configurations using the Requirements system

TinyMCEConfig::getEditorCSS() — Method in class TinyMCEConfig

Get location of all editor.css files.

TinyMCEConfig::getContentCSS() — Method in class TinyMCEConfig

Get list of resource paths to css files.

TinyMCEConfig::getScriptURL() — Method in class TinyMCEConfig

Generate gzipped TinyMCE configuration including plugins and languages.

TinyMCEConfig::getConfigSchemaData() — Method in class TinyMCEConfig

Provide additional schema data for the field this object configures

TinyMCEConfig::get_tinymce_lang() — Method in class TinyMCEConfig

Get the current tinyMCE language

TinyMCEConfig::get_tinymce_lang_url() — Method in class TinyMCEConfig

Get the URL for the language pack of the current language

TinyMCEConfig::getTinyMCEResourcePath() — Method in class TinyMCEConfig

Returns the full filesystem path to TinyMCE resources (which could be different from the original tinymce location in the module).

TinyMCEConfig::getTinyMCEResourceURL() — Method in class TinyMCEConfig

Get front-end url to tinymce resources

TinyMCEConfig::getTinyMCEResource() — Method in class TinyMCEConfig

Get resource root for TinyMCE, either as a string or ModuleResource instance Path will be relative to BASE_PATH if string.

TinyMCEScriptGenerator::getScriptURL() — Method in class TinyMCEScriptGenerator

Generate a script URL for the given config

HeaderField::getHeadingLevel() — Method in class HeaderField

HeaderField::getAttributes() — Method in class HeaderField

Allows customization through an 'updateAttributes' hook on the base class.

HeaderField::getSchemaStateDefaults() — Method in class HeaderField

Header fields support dynamic titles via schema state

HeaderField::getSchemaDataDefaults() — Method in class HeaderField

Header fields heading level to be set

ListboxField::getOptions() — Method in class ListboxField

Gets the list of options to render in this formfield

ListboxField::getAttributes() — Method in class ListboxField

Allows customization through an 'updateAttributes' hook on the base class.

ListboxField::getSize() — Method in class ListboxField

Get the size of this dropdown in rows.

ListboxField::getDisabledItems() — Method in class ListboxField

ListboxField::getSchemaDataDefaults() — Method in class ListboxField

Provide ListboxField data to the JSON schema for the frontend component

ListboxField::getSchemaStateDefaults() — Method in class ListboxField

Gets the defaults for $schemaState.

ListboxField::getOptionsArray() — Method in class ListboxField

Returns array of arrays representing tags.

ListboxField::getValueArray() — Method in class ListboxField

Extracts the value of this field, normalised as an array.

LiteralField::getContent() — Method in class LiteralField

LiteralField::getSchemaStateDefaults() — Method in class LiteralField

Header fields support dynamic titles via schema state

LookupField::getHasEmptyDefault() — Method in class LookupField

MoneyField::getCurrencyField() — Method in class MoneyField

Gets field for the currency selector

MoneyField::getAmountField() — Method in class MoneyField

Gets field for the amount input

MoneyField::getDBMoney() — Method in class MoneyField

Get value as DBMoney object useful for formatting the number

MoneyField::getAllowedCurrencies() — Method in class MoneyField

MoneyField::getLocale() — Method in class MoneyField

Get locale to format this currency in.

MultiSelectField::getValueArray() — Method in class MultiSelectField

Extracts the value of this field, normalised as an array.

MultiSelectField::getDefaultItems() — Method in class MultiSelectField

Default selections, regardless of the setValue() settings.

NullableField::getIsNullLabel() — Method in class NullableField

Get the label used for the Is Null checkbox.

NullableField::getIsNullId() — Method in class NullableField

Get the id used for the Is Null check box.

NumericField::getFormatter() — Method in class NumericField

Get number formatter for localising this field

NumericField::getNumberType() — Method in class NumericField

Get type argument for parse / format calls. one of TYPE_INT32, TYPE_INT64 or TYPE_DOUBLE

NumericField::getAttributes() — Method in class NumericField

NumericField::getSchemaValidation() — Method in class NumericField

Return list of validation rules. Each rule is a key value pair.

NumericField::getLocale() — Method in class NumericField

Gets the current locale this field is set to.

NumericField::getHTML5() — Method in class NumericField

Determine if we should use html5 number input

NumericField::getStep() — Method in class NumericField

Step attribute for html5. E.g. '0.01' to enable two decimal places.

NumericField::getScale() — Method in class NumericField

Get number of digits to show to the right of the decimal point.

OptionsetField::getFieldOption() — Method in class OptionsetField

Build a field option for template rendering

OptionsetField::getOptionID() — Method in class OptionsetField

Generate an ID property for a single option

OptionsetField::getOptionName() — Method in class OptionsetField

Get the "name" property for each item in the list

OptionsetField::getOptionClass() — Method in class OptionsetField

Get extra classes for each item in the list

OptionsetField::getAttributes() — Method in class OptionsetField

Allows customization through an 'updateAttributes' hook on the base class.

PasswordField::getAllowValuePostback() — Method in class PasswordField

PasswordField::getAttributes() — Method in class PasswordField

PopoverField::getPopoverTitle() — Method in class PopoverField

Get popup title

PopoverField::getButtonTooltip() — Method in class PopoverField

PopoverField::getPlacement() — Method in class PopoverField

Get popup placement

PopoverField::getSchemaDataDefaults() — Method in class PopoverField

Merge child field data into this form

ReadonlyField::getIncludeHiddenField() — Method in class ReadonlyField

ReadonlyField::getSchemaStateDefaults() — Method in class ReadonlyField

Gets the defaults for $schemaState.

ReadonlyField::getValueCast() — Method in class ReadonlyField

Get custom cating helper for Value() field

RequiredFields::getAllowWhitespaceOnly() — Method in class RequiredFields

Get whether to allow whitespace only as a valid value for a required field

RequiredFields::getRequired() — Method in class RequiredFields

Return the required fields

FormSchema::getMultipartSchema() — Method in class FormSchema

Returns a representation of the provided Form as structured data, based on the request data.

FormSchema::getSchema() — Method in class FormSchema

Gets the schema for this form as a nested array.

FormSchema::getState() — Method in class FormSchema

Gets the current state of this form as a nested array.

FormSchema::getErrors() — Method in class FormSchema

FormSchema::getSchemaForMessage() — Method in class FormSchema

Return form schema for encoded validation message

FormSchema::getFieldStates() — Method in class FormSchema

SearchableDropdownTrait::getIsClearable() — Method in class SearchableDropdownTrait

Get whether the currently selected value(s) can be cleared

SearchableDropdownTrait::getIsLazyLoaded() — Method in class SearchableDropdownTrait

Get whether values are lazy loading via AJAX

SearchableDropdownTrait::getLazyLoadLimit() — Method in class SearchableDropdownTrait

Get the limit of items to lazy load

SearchableDropdownTrait::getPlaceholder() — Method in class SearchableDropdownTrait

Get the placeholder text

SearchableDropdownTrait::getSearchContext() — Method in class SearchableDropdownTrait

Get the search context to use If a search context has been set via setSearchContext() that will be used Will fallback to using the dataobjects default search context if a sourceList has been set Otherwise will return null

SearchableDropdownTrait::getUseDynamicPlaceholder() — Method in class SearchableDropdownTrait

Get whether to use a dynamic placeholder if a normal placeholder is not set

SearchableDropdownTrait::getUseSearchContext() — Method in class SearchableDropdownTrait

Get whether to use a search context instead searching on labelField

SearchableDropdownTrait::getIsSearchable() — Method in class SearchableDropdownTrait

Get whether the field allows searching by typing characters into field

SearchableDropdownTrait::getSource() — Method in class SearchableDropdownTrait

This returns an array rather than a DataList purely to retain compatibility with ancestor getSource()

SearchableDropdownTrait::getLabelField() — Method in class SearchableDropdownTrait

Get the field to use for the label of the option

SearchableDropdownTrait::getAttributes() — Method in class SearchableDropdownTrait

SearchableDropdownTrait::getValueArray() — Method in class SearchableDropdownTrait

Get a list of selected ID's

SearchableDropdownTrait::getSchemaDataType() — Method in class SearchableDropdownTrait

SearchableDropdownTrait::getSchemaDataDefaults() — Method in class SearchableDropdownTrait

Provide data to the JSON schema for the frontend component

SearchableDropdownTrait::getSchemaStateDefaults() — Method in class SearchableDropdownTrait

SearchableLookupField::getSource() — Method in class SearchableLookupField

To retain compatibility with ancestor getSource() this returns an array of only the selected values

SegmentField::getModifiers() — Method in class SegmentField

SegmentField::getHelpText() — Method in class SegmentField

SegmentFieldModifier::getForm() — Method in class SegmentFieldModifier

SegmentFieldModifier::getField() — Method in class SegmentFieldModifier

SegmentFieldModifier::getRequest() — Method in class SegmentFieldModifier

SegmentFieldModifier::getSuggestion() — Method in class SegmentFieldModifier

Modifies the previous suggestion value.

SegmentFieldModifier::getPreview() — Method in class SegmentFieldModifier

Modifies the previous preview value.

AbstractSegmentFieldModifier::getForm() — Method in class AbstractSegmentFieldModifier

AbstractSegmentFieldModifier::getField() — Method in class AbstractSegmentFieldModifier

AbstractSegmentFieldModifier::getRequest() — Method in class AbstractSegmentFieldModifier

IDSegmentFieldModifier::getPreview() — Method in class IDSegmentFieldModifier

IDSegmentFieldModifier::getSuggestion() — Method in class IDSegmentFieldModifier

SlugSegmentFieldModifier::getPreview() — Method in class SlugSegmentFieldModifier

SlugSegmentFieldModifier::getSuggestion() — Method in class SlugSegmentFieldModifier

SlugSegmentFieldModifier::getValue() — Method in class SlugSegmentFieldModifier

SelectField::getSchemaStateDefaults() — Method in class SelectField

Gets the defaults for $schemaState.

SelectField::getDisabledItems() — Method in class SelectField

Non-associative list of disabled item values

SelectField::getAttributes() — Method in class SelectField

Allows customization through an 'updateAttributes' hook on the base class.

SelectField::getSourceValues() — Method in class SelectField

Retrieve all values in the source array

SelectField::getValidValues() — Method in class SelectField

Gets all valid values for this field.

SelectField::getSource() — Method in class SelectField

Gets the source array not including any empty default values.

SelectField::getListMap() — Method in class SelectField

Given a list of values, extract the associative map of id => title

SelectField::getListValues() — Method in class SelectField

Given a non-array collection, extract the non-associative list of ids If passing as array, treat the array values (not the keys) as the ids

SelectionGroup_Item::getTitle() — Method in class SelectionGroup_Item

SelectionGroup_Item::getValue() — Method in class SelectionGroup_Item

SingleLookupField::getHasEmptyDefault() — Method in class SingleLookupField

SingleLookupField::getTemplate() — Method in class SingleLookupField

SingleSelectField::getSchemaStateDefaults() — Method in class SingleSelectField

Gets the defaults for $schemaState.

SingleSelectField::getSchemaDataDefaults() — Method in class SingleSelectField

Gets the defaults for $schemaData.

SingleSelectField::getDefaultValue() — Method in class SingleSelectField

SingleSelectField::getHasEmptyDefault() — Method in class SingleSelectField

SingleSelectField::getEmptyString() — Method in class SingleSelectField

SingleSelectField::getSourceEmpty() — Method in class SingleSelectField

Gets the source array, including the empty string, if present

Tab::getTabSet() — Method in class Tab

Get parent tabset

Tab::getAttributes() — Method in class Tab

Allows customization through an 'updateAttributes' hook on the base class.

TabSet::getTabSet() — Method in class TabSet

Get parent tabset

TabSet::getAttributes() — Method in class TabSet

Allows customization through an 'updateAttributes' hook on the base class.

TabSet::getSchemaStateDefaults() — Method in class TabSet

Sets an additional default for $schemaData.

TextField::getMaxLength() — Method in class TextField

TextField::getTip() — Method in class TextField

TextField::getAttributes() — Method in class TextField

TextField::getSchemaDataDefaults() — Method in class TextField

Gets the defaults for $schemaData.

TextField::getSchemaValidation() — Method in class TextField

Return list of validation rules. Each rule is a key value pair.

TextareaField::getSchemaDataDefaults() — Method in class TextareaField

Set textarea specific schema data

TextareaField::getRows() — Method in class TextareaField

Gets number of rows

TextareaField::getColumns() — Method in class TextareaField

Gets the number of columns in this textarea

TextareaField::getMaxLength() — Method in class TextareaField

TextareaField::getAttributes() — Method in class TextareaField

Allows customization through an 'updateAttributes' hook on the base class.

TextareaField::getSchemaValidation() — Method in class TextareaField

Return list of validation rules. Each rule is a key value pair.

TimeField::getHTML5() — Method in class TimeField

TimeField::getTimeFormat() — Method in class TimeField

Get time format in CLDR standard format

TimeField::getTimeLength() — Method in class TimeField

Get length of the time format to use. One of:

TimeField::getFrontendFormatter() — Method in class TimeField

Get time formatter with the standard locale / date format

TimeField::getInternalFormatter() — Method in class TimeField

Get a time formatter for the ISO 8601 format

TimeField::getAttributes() — Method in class TimeField

TimeField::getSchemaDataDefaults() — Method in class TimeField

Gets the defaults for $schemaData.

TimeField::getMidnight() — Method in class TimeField

Show midnight in current format (adjusts for timezone)

TimeField::getLocale() — Method in class TimeField

TimeField::getTimezone() — Method in class TimeField

Tip::getTipSchema() — Method in class Tip

Outputs props to be passed to the front-end Tip component.

Tip::getImportanceLevel() — Method in class Tip

Tip::getIcon() — Method in class Tip

Tip::getMessage() — Method in class Tip

TippableFieldInterface::getTip() — Method in class TippableFieldInterface

ToggleCompositeField::getAttributes() — Method in class ToggleCompositeField

ToggleCompositeField::getStartClosed() — Method in class ToggleCompositeField

ToggleCompositeField::getHeadingLevel() — Method in class ToggleCompositeField

TreeDropdownField::getTreeBaseID() — Method in class TreeDropdownField

Set the ID of the root node of the tree. This defaults to 0 - i.e.

TreeDropdownField::getFilterFunction() — Method in class TreeDropdownField

Get a callback used to filter the values of the tree before displaying to the user.

TreeDropdownField::getDisableFunction() — Method in class TreeDropdownField

Get the callback used to disable checkboxes for some items in the tree

TreeDropdownField::getSearchFunction() — Method in class TreeDropdownField

Set a callback used to search the hierarchy globally, even before applying the filter.

TreeDropdownField::getShowSearch() — Method in class TreeDropdownField

Check if search is shown

TreeDropdownField::getChildrenMethod() — Method in class TreeDropdownField

Get method to invoke on each node to get the child collection

TreeDropdownField::getNumChildrenMethod() — Method in class TreeDropdownField

Get method to invoke on nodes to count children

TreeDropdownField::getAttributes() — Method in class TreeDropdownField

Attributes to be given for this field type

TreeDropdownField::getLabelField() — Method in class TreeDropdownField

HTML-encoded label for this node, including css classes and other markup.

TreeDropdownField::getTitleField() — Method in class TreeDropdownField

Field to use for plain text item titles.

TreeDropdownField::getKeyField() — Method in class TreeDropdownField

TreeDropdownField::getSourceObject() — Method in class TreeDropdownField

Get class of source object

TreeDropdownField::getSearchResults() — Method in class TreeDropdownField

Get the DataObjects that matches the searched parameter.

TreeDropdownField::getSchemaStateDefaults() — Method in class TreeDropdownField

Gets the defaults for $schemaState.

TreeDropdownField::getCacheKey() — Method in class TreeDropdownField

Ensure cache is keyed by last modified datetime of the underlying list.

TreeDropdownField::getSchemaDataDefaults() — Method in class TreeDropdownField

Gets the defaults for $schemaData.

TreeDropdownField::getHasEmptyDefault() — Method in class TreeDropdownField

TreeDropdownField::getEmptyString() — Method in class TreeDropdownField

TreeDropdownField::getShowSelectedPath() — Method in class TreeDropdownField

TreeDropdownField::getSchemaValidation() — Method in class TreeDropdownField

TreeMultiselectField::getSchemaDataDefaults() — Method in class TreeMultiselectField

Gets the defaults for $schemaData.

TreeMultiselectField::getSchemaStateDefaults() — Method in class TreeMultiselectField

Gets the defaults for $schemaState.

TreeMultiselectField::getItems() — Method in class TreeMultiselectField

Return this field's linked items

UploadReceiver::getUpload() — Method in class UploadReceiver

Retrieves the Upload handler

UploadReceiver::getAllowedExtensions() — Method in class UploadReceiver

Returns list of extensions allowed by this field, or an empty array if there is no restriction

UploadReceiver::getValidator() — Method in class UploadReceiver

Get custom validator for this field

UploadReceiver::getFolderName() — Method in class UploadReceiver

Gets the upload folder name

Validator::getErrors() — Method in class Validator

Returns all errors found by a previous call to validate(). The returned array has a structure resembling:

Validator::getResult() — Method in class Validator

Get last validation result

Validator::getEnabled() — Method in class Validator

Handler::getAuthenticator() — Method in class Handler

Returns the first configured authenticator by highest priority, or null if none are configured

Configuration::get() — Method in class Configuration

Return a setting by dot.separated.syntax

ModelConfiguration::getTypeFormatter() — Method in class ModelConfiguration

ModelConfiguration::getTypePrefix() — Method in class ModelConfiguration

ModelConfiguration::getNestedQueryPlugins() — Method in class ModelConfiguration

ModelConfiguration::getOperationConfig() — Method in class ModelConfiguration

ModelConfiguration::getTypeName() — Method in class ModelConfiguration

ModelConfiguration::getDefaultFields() — Method in class ModelConfiguration

Fields that are added to the model by default. Can be opted out per type

ModelConfiguration::getBaseFields() — Method in class ModelConfiguration

Fields that will appear on all models. Cannot be opted out on any type.

Controller::getAuthHandler() — Method in class Controller

Get an instance of the authorization Handler to manage any authentication requirements

Controller::getToken() — Method in class Controller

Controller::getCorsConfig() — Method in class Controller

Controller::getMergedCorsConfig() — Method in class Controller

Controller::getRequestOrigin() — Method in class Controller

Get (or infer) value of Origin header

Controller::getRequestQueryVariables() — Method in class Controller

Parse query and variables from the given request

Controller::getRequestUser() — Method in class Controller

Get user and validate for this request

Controller::getSchemaKey() — Method in class Controller

Controller::getQueryHandler() — Method in class Controller

DevelopmentAdmin::get_links() — Method in class DevelopmentAdmin

MemberAware::getMemberContext() — Method in class MemberAware

Get the Member for the current context either from a previously set value or the current user

FileProvider::getQueryMapping() — Method in class FileProvider

return a map from to

FileProvider::getByID() — Method in class FileProvider

return a query given an ID

FileProvider::getSchemaMapping() — Method in class FileProvider

GuzzleHTTPClient — Class in namespace SilverStripe\GraphQL\PersistedQuery

GuzzleHTTPClient::getURL() — Method in class GuzzleHTTPClient

HTTPClient::getURL() — Method in class HTTPClient

HTTPProvider::getQueryMapping() — Method in class HTTPProvider

return a map from to

HTTPProvider::getByID() — Method in class HTTPProvider

return a query given an ID

HTTPProvider::getSchemaMapping() — Method in class HTTPProvider

HTTPProvider::getClient() — Method in class HTTPProvider

JSONStringProvider::getQueryMapping() — Method in class JSONStringProvider

return a map from to

JSONStringProvider::getByID() — Method in class JSONStringProvider

return a query given an ID

JSONStringProvider::getSchemaMapping() — Method in class JSONStringProvider

PersistedQueryMappingProvider::getQueryMapping() — Method in class PersistedQueryMappingProvider

return a map from to

PersistedQueryMappingProvider::getByID() — Method in class PersistedQueryMappingProvider

return a query given an ID

PersistedQueryMappingProvider::getSchemaMapping() — Method in class PersistedQueryMappingProvider

PersistedQueryProvider::getQueryFromPersistedID() — Method in class PersistedQueryProvider

RequestIDProcessor::getRequestQueryVariables() — Method in class RequestIDProcessor

Parse query and variables from the given request

RequestProcessor::getRequestQueryVariables() — Method in class RequestProcessor

Parse query and variables from the given request

QueryHandler::getQueryFromPersistedID() — Method in class QueryHandler

get query from persisted id, return null if not found

QueryHandler::getContext() — Method in class QueryHandler

Get global context to pass to $context for all queries

QueryHandler::getMiddlewares() — Method in class QueryHandler

QueryHandler::getOperationName() — Method in class QueryHandler

QueryStateProvider::get() — Method in class QueryStateProvider

Get the value out of the graphql context array

RequestContextProvider::get() — Method in class RequestContextProvider

SchemaConfigProvider::get() — Method in class SchemaConfigProvider

TokenContextProvider::get() — Method in class TokenContextProvider

UserContextProvider::get() — Method in class UserContextProvider

Get the value out of the graphql context array

AbstractBulkLoader::getIdentifier() — Method in class AbstractBulkLoader

BulkLoaderSet::getLoaders() — Method in class BulkLoaderSet

Collection::getClasses() — Method in class Collection

Collection::getFiles() — Method in class Collection

Collection::getManifest() — Method in class Collection

ExtensionLoader::getIdentifier() — Method in class ExtensionLoader

FilepathLoader::getIdentifier() — Method in class FilepathLoader

InheritanceLoader::getIdentifier() — Method in class InheritanceLoader

NamespaceLoader::getIdentifier() — Method in class NamespaceLoader

RegistryBackend::getByID() — Method in class RegistryBackend

CreateCreator::getFieldAccessor() — Method in class CreateCreator

DataObjectModel::getIdentifier() — Method in class DataObjectModel

DataObjectModel::getField() — Method in class DataObjectModel

DataObjectModel::getDefaultFields() — Method in class DataObjectModel

DataObjectModel::getBaseFields() — Method in class DataObjectModel

DataObjectModel::getBlacklistedFields() — Method in class DataObjectModel

DataObjectModel::getAllFields() — Method in class DataObjectModel

DataObjectModel::getUninheritedFields() — Method in class DataObjectModel

DataObjectModel::getDefaultResolver() — Method in class DataObjectModel

DataObjectModel::getSourceClass() — Method in class DataObjectModel

DataObjectModel::getFieldAccessor() — Method in class DataObjectModel

DataObjectModel::getOperationCreatorByIdentifier() — Method in class DataObjectModel

DataObjectModel::getAllOperationIdentifiers() — Method in class DataObjectModel

DataObjectModel::getModelTypeForField() — Method in class DataObjectModel

Gets a field that resolves to another model, (e.g. an ObjectType from a has_one).

DataObjectModel::getPropertyForField() — Method in class DataObjectModel

DataObjectModel::getDataObject() — Method in class DataObjectModel

DataObjectModel::getTypeName() — Method in class DataObjectModel

DataObjectModel::getSchemaConfig() — Method in class DataObjectModel

DataObjectModel::getModelConfiguration() — Method in class DataObjectModel

FieldAccessor::getAllFields() — Method in class FieldAccessor

InheritanceBuilder::getSchema() — Method in class InheritanceBuilder

InheritanceChain::getAncestralModels() — Method in class InheritanceChain

InheritanceChain::getDescendantModels() — Method in class InheritanceChain

InheritanceChain::getDirectDescendants() — Method in class InheritanceChain

InheritanceChain::getInheritance() — Method in class InheritanceChain

InheritanceChain::getBaseClass() — Method in class InheritanceChain

InheritanceUnionBuilder::getSchema() — Method in class InheritanceUnionBuilder

InterfaceBuilder::getSchema() — Method in class InterfaceBuilder

AbstractCanViewPermission::getPermissionResolver() — Method in class AbstractCanViewPermission

CanViewPermission::getIdentifier() — Method in class CanViewPermission

CanViewPermission::getPermissionResolver() — Method in class CanViewPermission

DBDateArgs::getEnum() — Method in class DBDateArgs

DBDateArgs::getResolver() — Method in class DBDateArgs

DBDateArgs::getValues() — Method in class DBDateArgs

DBDatetimeArgs::getEnum() — Method in class DBDatetimeArgs

DBDatetimeArgs::getValues() — Method in class DBDatetimeArgs

DBDecimalArgs::getEnum() — Method in class DBDecimalArgs

DBDecimalArgs::getResolver() — Method in class DBDecimalArgs

DBDecimalArgs::getValues() — Method in class DBDecimalArgs

DBFieldArgs::getEnum() — Method in class DBFieldArgs

DBFieldArgsPlugin::getIdentifier() — Method in class DBFieldArgsPlugin

DBFloatArgs::getEnum() — Method in class DBFloatArgs

DBFloatArgs::getResolver() — Method in class DBFloatArgs

DBFloatArgs::getValues() — Method in class DBFloatArgs

DBTextArgs::getEnum() — Method in class DBTextArgs

DBTextArgs::getValues() — Method in class DBTextArgs

DBTextArgs::getResolver() — Method in class DBTextArgs

DBTimeArgs::getEnum() — Method in class DBTimeArgs

DBTimeArgs::getResolver() — Method in class DBTimeArgs

DBTimeArgs::getValues() — Method in class DBTimeArgs

DBFieldTypes::getIdentifier() — Method in class DBFieldTypes

FirstResult::getIdentifier() — Method in class FirstResult

Inheritance::getIdentifier() — Method in class Inheritance

InheritedPlugins::getIdentifier() — Method in class InheritedPlugins

Paginator::getIdentifier() — Method in class Paginator

FieldFilterInterface::getIdentifier() — Method in class FieldFilterInterface

FieldFilterRegistry::getFilterByIdentifier() — Method in class FieldFilterRegistry

FieldFilterRegistry::getAll() — Method in class FieldFilterRegistry

FilterRegistryInterface::getFilterByIdentifier() — Method in class FilterRegistryInterface

FilterRegistryInterface::getAll() — Method in class FilterRegistryInterface

ContainsFilter::getIdentifier() — Method in class ContainsFilter

EndsWithFilter::getIdentifier() — Method in class EndsWithFilter

EqualToFilter::getIdentifier() — Method in class EqualToFilter

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

A query filter that filters records by greater than comparison

GreaterThanFilter::getIdentifier() — Method in class GreaterThanFilter

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

A query filter that filters records by greater than or equal comparison

GreaterThanOrEqualFilter::getIdentifier() — Method in class GreaterThanOrEqualFilter

InFilter::getIdentifier() — Method in class InFilter

LessThanFilter::getIdentifier() — Method in class LessThanFilter

LessThanOrEqualFilter::getIdentifier() — Method in class LessThanOrEqualFilter

NotEqualFilter::getIdentifier() — Method in class NotEqualFilter

StartsWithFilter::getIdentifier() — Method in class StartsWithFilter

QueryFilter::getIdentifier() — Method in class QueryFilter

QueryFilter::getResolver() — Method in class QueryFilter

QuerySort::getIdentifier() — Method in class QuerySort

QuerySort::getResolver() — Method in class QuerySort

ScalarDBField::getIdentifier() — Method in class ScalarDBField

Resolver::getResolvedField() — Method in class Resolver

UpdateCreator::getFieldAccessor() — Method in class UpdateCreator

Argument::getType() — Method in class Argument

Argument::getName() — Method in class Argument

Argument::getEncodedType() — Method in class Argument

Argument::getDefaultValue() — Method in class Argument

Argument::getDescription() — Method in class Argument

Argument::getSignature() — Method in class Argument

Field::getTypeAsModel() — Method in class Field

Field::getName() — Method in class Field

Field::getType() — Method in class Field

Field::getArgs() — Method in class Field

Field::getEncodedType() — Method in class Field

Field::getNamedType() — Method in class Field

Gets the name of the type, ignoring any nonNull/listOf wrappers

Field::getEncodedResolver() — Method in class Field

Field::getDescription() — Method in class Field

Field::getResolver() — Method in class Field

Field::getResolverContext() — Method in class Field

Field::getResolverMiddlewares() — Method in class Field

Field::getResolverAfterwares() — Method in class Field

Field::getSignature() — Method in class Field

ModelAware::getModel() — Method in class ModelAware

ModelField::getModelType() — Method in class ModelField

For nested field definitions Blog: fields: Comments: fields: Author: fields: Name: String

ModelField::getProperty() — Method in class ModelField

ModelField::getPropertyName() — Method in class ModelField

ModelField::getMetadata() — Method in class ModelField

ModelField::getSignature() — Method in class ModelField

BaseFieldsProvider::getBaseFields() — Method in class BaseFieldsProvider

Fields that must appear on all implementations

ContextProvider::get() — Method in class ContextProvider

Get the value out of the graphql context array

DefaultFieldsProvider::getDefaultFields() — Method in class DefaultFieldsProvider

ExtraTypeProvider::getExtraTypes() — Method in class ExtraTypeProvider

Identifiable::getIdentifier() — Method in class Identifiable

ModelBlacklist::getBlacklistedFields() — Method in class ModelBlacklist

ModelOperation::getModel() — Method in class ModelOperation

OperationProvider::getOperationCreatorByIdentifier() — Method in class OperationProvider

OperationProvider::getAllOperationIdentifiers() — Method in class OperationProvider

PluginInterface::getIdentifier() — Method in class PluginInterface

SchemaComponent::getName() — Method in class SchemaComponent

SchemaModelInterface::getIdentifier() — Method in class SchemaModelInterface

SchemaModelInterface::getField() — Method in class SchemaModelInterface

SchemaModelInterface::getTypeName() — Method in class SchemaModelInterface

SchemaModelInterface::getDefaultResolver() — Method in class SchemaModelInterface

SchemaModelInterface::getSourceClass() — Method in class SchemaModelInterface

SchemaModelInterface::getAllFields() — Method in class SchemaModelInterface

SchemaModelInterface::getModelTypeForField() — Method in class SchemaModelInterface

SchemaModelInterface::getSchemaConfig() — Method in class SchemaModelInterface

SchemaModelInterface::getModelConfiguration() — Method in class SchemaModelInterface

SchemaModelInterface::getPropertyForField() — Method in class SchemaModelInterface

SchemaStorageInterface::getSchema() — Method in class SchemaStorageInterface

SchemaStorageInterface::getConfig() — Method in class SchemaStorageInterface

SignatureProvider::getSignature() — Method in class SignatureProvider

AbstractQueryFilterPlugin::getFieldName() — Method in class AbstractQueryFilterPlugin

AbstractQueryFilterPlugin::getTypeName() — Method in class AbstractQueryFilterPlugin

AbstractQueryFilterPlugin::getLeafNodeType() — Method in class AbstractQueryFilterPlugin

AbstractQueryFilterPlugin::getResolver() — Method in class AbstractQueryFilterPlugin

AbstractQuerySortPlugin::getFieldName() — Method in class AbstractQuerySortPlugin

AbstractQuerySortPlugin::getTypeName() — Method in class AbstractQuerySortPlugin

AbstractQuerySortPlugin::getLeafNodeType() — Method in class AbstractQuerySortPlugin

AbstractQuerySortPlugin::getResolver() — Method in class AbstractQuerySortPlugin

PaginationPlugin::getIdentifier() — Method in class PaginationPlugin

PaginationPlugin::getPaginationResolver() — Method in class PaginationPlugin

PluginConsumer::getPlugins() — Method in class PluginConsumer

PluginConsumer::getDefaultPlugins() — Method in class PluginConsumer

PluginConsumer::getPluginRegistry() — Method in class PluginConsumer

PluginConsumer::getSortedPlugins() — Method in class PluginConsumer

Sorts the before/after of plugins using topological sort

SortPlugin::getIdentifier() — Method in class SortPlugin

SortPlugin::getResolver() — Method in class SortPlugin

PluginRegistry::getPluginByID() — Method in class PluginRegistry

DefaultResolverStrategy::getResolverMethod() — Method in class DefaultResolverStrategy

EncodedResolver::getStack() — Method in class EncodedResolver

EncodedResolver::getExpression() — Method in class EncodedResolver

EncodedResolver::getInnerExpression() — Method in class EncodedResolver

EncodedResolver::getContextArgs() — Method in class EncodedResolver

EncodedResolver::getContext() — Method in class EncodedResolver

EncodedResolver::getRef() — Method in class EncodedResolver

EncodedResolver::getResolverMiddlewares() — Method in class EncodedResolver

EncodedResolver::getResolverAfterwares() — Method in class EncodedResolver

ResolverReference::getClass() — Method in class ResolverReference

ResolverReference::getMethod() — Method in class ResolverReference

Schema::getSchemaKey() — Method in class Schema

Schema::getConfig() — Method in class Schema

Schema::getState() — Method in class Schema

Schema::getType() — Method in class Schema

Schema::getCanonicalType() — Method in class Schema

Given a type name, try to resolve it to any model-implementing component

Schema::getModelTypesFromClass() — Method in class Schema

Gets all the models that were generated from a given ancestor, e.g. DataObject

Schema::getTypes() — Method in class Schema

Schema::getQueryType() — Method in class Schema

Schema::getMutationType() — Method in class Schema

Schema::getTypeOrModel() — Method in class Schema

Schema::getEnums() — Method in class Schema

Schema::getEnum() — Method in class Schema

Schema::getScalars() — Method in class Schema

Schema::getScalar() — Method in class Schema

Schema::getModel() — Method in class Schema

Schema::getModelByClassName() — Method in class Schema

Schema::getModels() — Method in class Schema

Schema::getInterface() — Method in class Schema

Schema::getInterfaces() — Method in class Schema

Schema::getImplementorsOf() — Method in class Schema

Schema::getUnion() — Method in class Schema

Schema::getUnions() — Method in class Schema

Schema::getInternalTypes() — Method in class Schema

SchemaBuilder::getConfig() — Method in class SchemaBuilder

Retrieves the context for an already stored schema which does not require booting. Useful for getting data from a saved schema at request time.

SchemaBuilder::getSchema() — Method in class SchemaBuilder

Gets a graphql-php Schema instance that can be queried

SchemaBuilder::getStoreCreator() — Method in class SchemaBuilder

SchemaConfig::getModelConfiguration() — Method in class SchemaConfig

SchemaConfig::getResolvers() — Method in class SchemaConfig

SchemaConfig::getDefaultResolver() — Method in class SchemaConfig

SchemaConfig::getPluraliser() — Method in class SchemaConfig

SchemaConfig::getTypeMapping() — Method in class SchemaConfig

SchemaConfig::getTypeNameForClass() — Method in class SchemaConfig

NestedInputBuilder::getRootType() — Method in class NestedInputBuilder

NestedInputBuilder::getResolveConfig() — Method in class NestedInputBuilder

NestedInputBuilder::getResolver() — Method in class NestedInputBuilder

NestedInputBuilder::getResolveType() — Method in class NestedInputBuilder

NestedInputBuilder::getResolvers() — Method in class NestedInputBuilder

SchemaTranscriber::getRootDir() — Method in class SchemaTranscriber

StorableSchema::getTypes() — Method in class StorableSchema

StorableSchema::getEnums() — Method in class StorableSchema

StorableSchema::getInterfaces() — Method in class StorableSchema

StorableSchema::getUnions() — Method in class StorableSchema

StorableSchema::getScalars() — Method in class StorableSchema

StorableSchema::getConfig() — Method in class StorableSchema

AbstractTypeRegistry::get() — Method in class AbstractTypeRegistry

AbstractTypeRegistry::getSourceDirectory() — Method in class AbstractTypeRegistry

AbstractTypeRegistry::getSourceNamespace() — Method in class AbstractTypeRegistry

CodeGenerationStore::getSchema() — Method in class CodeGenerationStore

CodeGenerationStore::getConfig() — Method in class CodeGenerationStore

CodeGenerationStore::getCache() — Method in class CodeGenerationStore

CodeGenerationStore::getRootDir() — Method in class CodeGenerationStore

CodeGenerationStore::getObfuscator() — Method in class CodeGenerationStore

CodeGenerationStore::getTemplateDir() — Method in class CodeGenerationStore

CanonicalModelAware::getCanonicalModel() — Method in class CanonicalModelAware

Enum::getValueList() — Method in class Enum

Enum::getValues() — Method in class Enum

Enum::getSignature() — Method in class Enum

A deterministic representation of everything that gets encoded into the template.

InputType::getIsInput() — Method in class InputType

InterfaceType::getEncodedTypeResolver() — Method in class InterfaceType

InterfaceType::getSignature() — Method in class InterfaceType

ModelType::getFieldByName() — Method in class ModelType

ModelType::getOperations() — Method in class ModelType

ModelType::getOperationCreators() — Method in class ModelType

ModelType::getExtraTypes() — Method in class ModelType

Scalar::getName() — Method in class Scalar

Scalar::getSerialiser() — Method in class Scalar

Scalar::getEncodedSerialiser() — Method in class Scalar

Scalar::getValueParser() — Method in class Scalar

Scalar::getEncodedValueParser() — Method in class Scalar

Scalar::getLiteralParser() — Method in class Scalar

Scalar::getEncodedLiteralParser() — Method in class Scalar

Scalar::getSignature() — Method in class Scalar

Type::getName() — Method in class Type

Type::getFields() — Method in class Type

Type::getFieldByName() — Method in class Type

Type::getDescription() — Method in class Type

Type::getInterfaces() — Method in class Type

Type::getEncodedInterfaces() — Method in class Type

Type::getIsInput() — Method in class Type

Type::getFieldResolver() — Method in class Type

Type::getSignature() — Method in class Type

A deterministic representation of everything that gets encoded into the template.

TypeReference::getDefaultValue() — Method in class TypeReference

TypeReference::getTypeName() — Method in class TypeReference

TypeReference::getNamedType() — Method in class TypeReference

TypeReference::getRawType() — Method in class TypeReference

UnionType::getName() — Method in class UnionType

UnionType::getTypes() — Method in class UnionType

UnionType::getEncodedTypes() — Method in class UnionType

UnionType::getTypeResolver() — Method in class UnionType

UnionType::getEncodedTypeResolver() — Method in class UnionType

UnionType::getDescription() — Method in class UnionType

UnionType::getSignature() — Method in class UnionType

GridFieldQueuedExportButton — Class in namespace SilverStripe\GridfieldQueuedExport\Forms

A button you can add to a GridField to export that GridField as a CSV. Should work with any sized GridField, as the export is done using a queuedjob in the background.

GridFieldQueuedExportButton::getHTMLFragments() — Method in class GridFieldQueuedExportButton

Place the export button in a

tag below the field

GridFieldQueuedExportButton::getActions() — Method in class GridFieldQueuedExportButton

This class is an action button

GridFieldQueuedExportButton::getURLHandlers() — Method in class GridFieldQueuedExportButton

This class is also a URL handler

GridFieldQueuedExportButton::getExportPath() — Method in class GridFieldQueuedExportButton

GridFieldQueuedExportButton::getExportColumns() — Method in class GridFieldQueuedExportButton

GridFieldQueuedExportButton::getCsvSeparator() — Method in class GridFieldQueuedExportButton

GridFieldQueuedExportButton::getCsvHasHeader() — Method in class GridFieldQueuedExportButton

GridFieldQueuedExportButtonResponse — Class in namespace SilverStripe\GridfieldQueuedExport\Forms

A special type of SS_HTTPResponse that GridFieldQueuedExportButton returns in response to the "findgridfield" action, which includes a reference to the gridfield

$ GridFieldQueuedExportButtonResponse#gridField — Property in class GridFieldQueuedExportButtonResponse

GridFieldQueuedExportButtonResponse::getGridField() — Method in class GridFieldQueuedExportButtonResponse

GenerateCSVJob — Class in namespace SilverStripe\GridfieldQueuedExport\Jobs

Iteratively exports GridField data to a CSV file on disk, in order to support large exports.

GenerateCSVJob::getJobType() — Method in class GenerateCSVJob

GenerateCSVJob::getTitle() — Method in class GenerateCSVJob

GenerateCSVJob::getSignature() — Method in class GenerateCSVJob

GenerateCSVJob::getOutputPath() — Method in class GenerateCSVJob

GenerateCSVJob::getCSVWriter() — Method in class GenerateCSVJob

GenerateCSVJob::getGridField() — Method in class GenerateCSVJob

CryptoHandler::getKey() — Method in class CryptoHandler

CryptoHandler::getSalt() — Method in class CryptoHandler

OpenSSLCrypto::getKey() — Method in class OpenSSLCrypto

OpenSSLCrypto::getSalt() — Method in class OpenSSLCrypto

HybridSession::getHandlers() — Method in class HybridSession

HybridSession::gc() — Method in class HybridSession

BaseStore::getKey() — Method in class BaseStore

Get the session secret key

BaseStore::getLifetime() — Method in class BaseStore

Get lifetime in number of seconds

BaseStore::getNow() — Method in class BaseStore

Gets the current unix timestamp

CookieStore::getCrypto() — Method in class CookieStore

Get the cryptography store for the specified session

CookieStore::gc() — Method in class CookieStore

DatabaseStore::gc() — Method in class DatabaseStore

IFramePage::getCMSFields() — Method in class IFramePage

IFramePage::getClass() — Method in class IFramePage

Compute class from the size parameters.

IFramePage::getStyle() — Method in class IFramePage

Compute style from the size parameters.

LDAPAuthenticator::get_name() — Method in class LDAPAuthenticator

LDAPAuthenticator::get_login_form() — Method in class LDAPAuthenticator

LDAPAuthenticator::getLoginHandler() — Method in class LDAPAuthenticator

LDAPAuthenticator::getLostPasswordHandler() — Method in class LDAPAuthenticator

LDAPAuthenticator::getChangePasswordHandler() — Method in class LDAPAuthenticator

LDAPLostPasswordHandler::getMemberFromData() — Method in class LDAPLostPasswordHandler

Load an existing Member from the provided data

LDAPLostPasswordHandler::getService() — Method in class LDAPLostPasswordHandler

Get the LDAP service

LDAPDebugController::GroupsSearchLocations() — Method in class LDAPDebugController

LDAPDebugController::Groups() — Method in class LDAPDebugController

LDAPLoginForm::getAuthenticatorName() — Method in class LDAPLoginForm

The name of this login form, to display in the frontend Replaces Authenticator::get_name()

LDAPAllSyncJob::getJobType() — Method in class LDAPAllSyncJob

LDAPAllSyncJob::getTitle() — Method in class LDAPAllSyncJob

LDAPAllSyncJob::getSignature() — Method in class LDAPAllSyncJob

LDAPMemberSyncJob::getJobType() — Method in class LDAPMemberSyncJob

LDAPMemberSyncJob::getTitle() — Method in class LDAPMemberSyncJob

LDAPMemberSyncJob::getSignature() — Method in class LDAPMemberSyncJob

LDAPGateway::getLdap() — Method in class LDAPGateway

LDAPGateway::getNodes() — Method in class LDAPGateway

Query for LDAP nodes (organizational units, containers, and domains).

LDAPGateway::getGroups() — Method in class LDAPGateway

Query for LDAP groups.

LDAPGateway::getNestedGroups() — Method in class LDAPGateway

Return all nested AD groups underneath a specific DN

LDAPGateway::getGroupByGUID() — Method in class LDAPGateway

Return a particular LDAP group by objectGUID value.

LDAPGateway::getGroupByDN() — Method in class LDAPGateway

Return a particular LDAP group by DN value.

LDAPGateway::getUsers() — Method in class LDAPGateway

Query for LDAP users, but don't include built-in user accounts.

LDAPGateway::getUsersWithIterator() — Method in class LDAPGateway

Query for LDAP users, but don't include built-in user accounts. Iterate over all users, regardless of the paging size control built into the LDAP server.

LDAPGateway::getUserByGUID() — Method in class LDAPGateway

Return a particular LDAP user by objectGUID value.

LDAPGateway::getUserByDN() — Method in class LDAPGateway

Return a particular LDAP user by DN value.

LDAPGateway::getUserByEmail() — Method in class LDAPGateway

Return a particular LDAP user by mail value.

LDAPGateway::getUserByUsername() — Method in class LDAPGateway

Get a specific user's data from LDAP

LDAPGateway::getCanonicalUsername() — Method in class LDAPGateway

Get a canonical username from the record based on the connection settings.

LDAPGroupMapping::getCMSFields() — Method in class LDAPGroupMapping

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

LDAPGroupMapping::Group() — Method in class LDAPGroupMapping

$ LDAPService#groups_search_locations — Property in class LDAPService

If configured, only group objects within these locations will be exposed to this service.

$ LDAPService#gateway — Property in class LDAPService

LDAPService::get_cache() — Method in class LDAPService

Get the cache object used for LDAP results. Note that the default lifetime set here is 8 hours, but you can change that by adding configuration:

LDAPService::getGateway() — Method in class LDAPService

Return the LDAP gateway currently in use. Can be strung together to access the underlying Laminas\Ldap instance, or the PHP ldap resource itself. For example:

Get the Laminas\Ldap object: $service->getGateway()->getLdap() // Laminas\Ldap\Ldap object
Get the underlying PHP ldap resource: $service->getGateway()->getLdap()->getResource() // php resource

LDAPService::getNodes() — Method in class LDAPService

Return all nodes (organizational units, containers, and domains) within the current base DN.

LDAPService::getGroups() — Method in class LDAPService

Return all AD groups in configured search locations, including all nested groups.

LDAPService::getNestedGroups() — Method in class LDAPService

Return all member groups (and members of those, recursively) underneath a specific group DN.

LDAPService::getGroupByGUID() — Method in class LDAPService

Get a particular AD group's data given a GUID.

LDAPService::getGroupByDN() — Method in class LDAPService

Get a particular AD group's data given a DN.

LDAPService::getUsers() — Method in class LDAPService

Return all AD users in configured search locations, including all users in nested groups.

LDAPService::getUserByGUID() — Method in class LDAPService

Get a specific AD user's data given a GUID.

LDAPService::getUserByDN() — Method in class LDAPService

Get a specific AD user's data given a DN.

LDAPService::getUserByEmail() — Method in class LDAPService

Get a specific user's data given an email.

LDAPService::getUserByUsername() — Method in class LDAPService

Get a specific user's data given a username.

LDAPService::getUsernameByEmail() — Method in class LDAPService

Get a username for an email.

LDAPService::getLDAPGroupMembers() — Method in class LDAPService

Given a group DN, get the group membership data in LDAP.

LDAPService::getLogger() — Method in class LDAPService

Get a logger

LDAPGroupSyncTask::getTitle() — Method in class LDAPGroupSyncTask

LDAPMemberSyncOneTask::getTitle() — Method in class LDAPMemberSyncOneTask

LDAPMemberSyncTask::getTitle() — Method in class LDAPMemberSyncTask

LDAPMigrateExistingMembersTask::getTitle() — Method in class LDAPMigrateExistingMembersTask

LinkFieldController::getClientConfig() — Method in class LinkFieldController

Returns configuration required by the client app.

LinkFieldController::getLinkForm() — Method in class LinkFieldController

This method is called from LeftAndMain::schema() /admin/linkfield/schema/linkForm/

AbstractLinkField::getExcludeLinkTextField() — Method in class AbstractLinkField

AbstractLinkField::getAllowedTypes() — Method in class AbstractLinkField

Get the types of link which are allowed for this field.

AbstractLinkField::getTypesProp() — Method in class AbstractLinkField

The method returns a stringified JSON object of available link types with additional parameters necessary for work on the client side.

AbstractLinkField::getSchemaDataDefaults() — Method in class AbstractLinkField

Gets the defaults for $schemaData.

AbstractLinkField::getSchemaStateDefaults() — Method in class AbstractLinkField

Gets the defaults for $schemaState.

AbstractLinkField::getDefaultAttributes() — Method in class AbstractLinkField

AbstractLinkField::getOwner() — Method in class AbstractLinkField

AbstractLinkField::getOwnerFields() — Method in class AbstractLinkField

MultiLinkField::getSchemaDataDefaults() — Method in class MultiLinkField

Gets the defaults for $schemaData.

MultiLinkField::getSchemaStateDefaults() — Method in class MultiLinkField

Gets the defaults for $schemaState.

MultiLinkField::getDefaultAttributes() — Method in class MultiLinkField

EmailLink::getCMSFields() — Method in class EmailLink

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

EmailLink::getCMSCompositeValidator() — Method in class EmailLink

When extending this class and overriding this method, you will need to instantiate the CompositeValidator by calling parent::getCMSCompositeValidator(). This will ensure that the appropriate extension point is also invoked.

EmailLink::getDescription() — Method in class EmailLink

Get a short description of the link. This is displayed in LinkField as an indication of what the link is pointing at.

EmailLink::getURL() — Method in class EmailLink

Get the URL this Link links to.

EmailLink::getMenuTitle() — Method in class EmailLink

The title that will be displayed in the dropdown for selecting the link type to create.

ExternalLink::getCMSFields() — Method in class ExternalLink

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

ExternalLink::getCMSCompositeValidator() — Method in class ExternalLink

ExternalLink::getDescription() — Method in class ExternalLink

Get a short description of the link. This is displayed in LinkField as an indication of what the link is pointing at.

ExternalLink::getURL() — Method in class ExternalLink

Get the URL this Link links to.

ExternalLink::getMenuTitle() — Method in class ExternalLink

The title that will be displayed in the dropdown for selecting the link type to create.

FileLink::getCMSFields() — Method in class FileLink

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

FileLink::getCMSCompositeValidator() — Method in class FileLink

FileLink::getDescription() — Method in class FileLink

Get a short description of the link. This is displayed in LinkField as an indication of what the link is pointing at.

FileLink::getURL() — Method in class FileLink

Get the URL this Link links to.

FileLink::getMenuTitle() — Method in class FileLink

The title that will be displayed in the dropdown for selecting the link type to create.

FileLink::getDefaultTitle() — Method in class FileLink

Get the title that will be displayed if there is no LinkText.

Link::getCMSFields() — Method in class Link

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

Link::getDescription() — Method in class Link

Get a short description of the link. This is displayed in LinkField as an indication of what the link is pointing at.

Link::getURL() — Method in class Link

Get the URL this Link links to.

Link::getLinkTypeHandlerName() — Method in class Link

Get the react component used to render the modal form.

Link::getMenuTitle() — Method in class Link

The title that will be displayed in the dropdown for selecting the link type to create.

Link::getTitle() — Method in class Link

Standard implementation of a title/label for a specific record. Tries to find properties 'Title' or 'Name', and falls back to the 'ID'. Useful to provide user-friendly identification of a record, e.g. in errormessages or UI-selections.

Link::getShortCode() — Method in class Link

This method process the defined singular_name of Link class to get the short code of the Link class name.

Link::getVersionedState() — Method in class Link

Get a string representing the versioned state of the link.

Link::getData() — Method in class Link

Get data for this link type which is required for displaying this link in the react component.

Link::getDefaultTitle() — Method in class Link

Get the title that will be displayed if there is no LinkText.

PhoneLink::getCMSFields() — Method in class PhoneLink

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

PhoneLink::getCMSCompositeValidator() — Method in class PhoneLink

PhoneLink::getDescription() — Method in class PhoneLink

Get a short description of the link. This is displayed in LinkField as an indication of what the link is pointing at.

PhoneLink::getURL() — Method in class PhoneLink

Get the URL this Link links to.

PhoneLink::getMenuTitle() — Method in class PhoneLink

The title that will be displayed in the dropdown for selecting the link type to create.

SiteTreeLink::getCMSFields() — Method in class SiteTreeLink

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

SiteTreeLink::getCMSCompositeValidator() — Method in class SiteTreeLink

SiteTreeLink::getDescription() — Method in class SiteTreeLink

Get a short description of the link. This is displayed in LinkField as an indication of what the link is pointing at.

SiteTreeLink::getURL() — Method in class SiteTreeLink

Get the URL this Link links to.

SiteTreeLink::getMenuTitle() — Method in class SiteTreeLink

The title that will be displayed in the dropdown for selecting the link type to create.

SiteTreeLink::getDefaultTitle() — Method in class SiteTreeLink

Get the title that will be displayed if there is no LinkText.

LinkTypeService::generateAllLinkTypes() — Method in class LinkTypeService

Generate all link types that are subclasses of Link::class

GorriecoeMigrationTask — Class in namespace SilverStripe\LinkField\Tasks

DebugViewFriendlyErrorFormatter::getStatusCode() — Method in class DebugViewFriendlyErrorFormatter

Get default status code

DebugViewFriendlyErrorFormatter::getTitle() — Method in class DebugViewFriendlyErrorFormatter

Get friendly title

DebugViewFriendlyErrorFormatter::getBody() — Method in class DebugViewFriendlyErrorFormatter

Get default error body

HTTPOutputHandler::getContentType() — Method in class HTTPOutputHandler

Get the mime type to use when displaying this error.

HTTPOutputHandler::getStatusCode() — Method in class HTTPOutputHandler

Get the HTTP status code to use when displaying this error.

HTTPOutputHandler::getCLIFormatter() — Method in class HTTPOutputHandler

Return the formatter use if Director::is_cli() is true If none has been set, null is returned, and the getFormatter() result will be used instead

HTTPOutputHandler::getFormatter() — Method in class HTTPOutputHandler

Return the formatter to use in this case.

HTTPOutputHandler::getDefaultFormatter() — Method in class HTTPOutputHandler

Check default formatter to use

MonologErrorHandler::getLoggers() — Method in class MonologErrorHandler

Returns the stack of PSR-3 loggers

GridFieldConfig_Lumberjack — Class in namespace SilverStripe\Lumberjack\Forms

GridField config necessary for managing a SiteTree object.

GridFieldSiteTreeAddNewButton — Class in namespace SilverStripe\Lumberjack\Forms

This component creates a dropdown of possible page types and a button to create a new page.

GridFieldSiteTreeAddNewButton::getAllowedChildren() — Method in class GridFieldSiteTreeAddNewButton

Determine the list of classnames and titles allowed for a given parent object

GridFieldSiteTreeAddNewButton::getHTMLFragments() — Method in class GridFieldSiteTreeAddNewButton

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

GridFieldSiteTreeAddNewButton::getActions() — Method in class GridFieldSiteTreeAddNewButton

Provide actions to this component.

GridFieldSiteTreeEditButton — Class in namespace SilverStripe\Lumberjack\Forms

Swaps the GridField Link out for the SiteTree edit link using SiteTree::CMSEditLink().

GridFieldSiteTreeEditButton::getColumnContent() — Method in class GridFieldSiteTreeEditButton

GridFieldSiteTreeState — Class in namespace SilverStripe\Lumberjack\Forms

Provides a component to the GridField which shows the publish status of a page.

GridFieldSiteTreeState::getColumnsHandled() — Method in class GridFieldSiteTreeState

Names of all columns which are affected by this component.

GridFieldSiteTreeState::getColumnContent() — Method in class GridFieldSiteTreeState

HTML for the column, content of the element.

GridFieldSiteTreeState::getColumnAttributes() — Method in class GridFieldSiteTreeState

Attributes for the element containing the content returned by getColumnContent().

GridFieldSiteTreeState::getColumnMetaData() — Method in class GridFieldSiteTreeState

GridFieldSiteTreeViewButton — Class in namespace SilverStripe\Lumberjack\Forms

GridFieldSiteTreeViewButton::getColumnContent() — Method in class GridFieldSiteTreeViewButton

HTML for the column, content of the element.

Lumberjack::getExcludedSiteTreeClassNames() — Method in class Lumberjack

Loops through subclasses of the owner (intended to be SiteTree) and checks if they've been hidden.

Lumberjack::getLumberjackTitle() — Method in class Lumberjack

This returns the title for the tab and GridField. This can be overwritten in the owner class.

Lumberjack::getLumberjackGridFieldConfig() — Method in class Lumberjack

This returns the gird field config for the lumberjack gridfield.

Lumberjack::getLumberjackPagesForGridfield() — Method in class Lumberjack

Returns list of pages for the CMS gridfield

ChangePasswordHandler::getSchema() — Method in class ChangePasswordHandler

Supply JavaScript application configuration details, required for an MFA check

LoginHandler::getSchema() — Method in class LoginHandler

Provides information about the current Member's MFA state

LoginHandler::getMember() — Method in class LoginHandler

LoginHandler::getLogger() — Method in class LoginHandler

LoginHandler::getBackURL() — Method in class LoginHandler

Adds more options for the back URL - to be returned from a current MFA session store

LoginHandler::getMethodRegistry() — Method in class LoginHandler

MemberAuthenticator::getLoginHandler() — Method in class MemberAuthenticator

MemberAuthenticator::getChangePasswordHandler() — Method in class MemberAuthenticator

Method::getName() — Method in class Method

Provide a localised name for this MFA Method.

Method::getURLSegment() — Method in class Method

Get a URL segment for this method. This will be used in URL paths for performing authentication by this method

Method::getVerifyHandler() — Method in class Method

Return the VerifyHandler that is used to start and check verification attempts with this method

Method::getRegisterHandler() — Method in class Method

Return the RegisterHandler that is used to perform registrations with this method

Method::getThumbnail() — Method in class Method

Return a URL to an image to be used as a thumbnail in the MFA login/registration grid for all MFA methods

Method::getUnavailableMessage() — Method in class Method

If not available to be used, provide a message to display on the frontend to explain why.

RegisterHandler::getDescription() — Method in class RegisterHandler

Provide a localised description of this MFA Method.

RegisterHandler::getSupportLink() — Method in class RegisterHandler

Provide a localised URL to a support article about the registration process for this MFA Method.

RegisterHandler::getSupportText() — Method in class RegisterHandler

Provide a localised string to describe the support link {getSupportLink} about this MFA Method.

RegisterHandler::getComponent() — Method in class RegisterHandler

Get the key that a React UI component is registered under (with @silverstripe/react-injector on the front-end)

VerifyHandler::getComponent() — Method in class VerifyHandler

Get the key that a React UI component is registered under (with @silverstripe/react-injector on the front-end)

MemberExtension::generateAccountResetTokenAndStoreHash() — Method in class MemberExtension

Mirrors the implementation in Member::generateAutologinTokenAndStoreHash(), but against the AccountReset fields.

SecurityAdminExtension::getAccountResetLink() — Method in class SecurityAdminExtension

Generates a link to the Account Reset Handler endpoint to be sent to a Member.

MemberExtension::getDefaultRegisteredMethod() — Method in class MemberExtension

Accessor for the DefaultRegisteredMethod property.

MemberExtension::getDefaultRegisteredMethodName() — Method in class MemberExtension

MemberExtension::getRegisteredMethodNames() — Method in class MemberExtension

SiteConfigExtension::getHelpLink() — Method in class SiteConfigExtension

Gets an anchor tag for CMS users to click to find out more about MFA in the SilverStripe CMS

RegisteredMFAMethodListField::getSchemaDataDefaults() — Method in class RegisteredMFAMethodListField

RegisteredMFAMethodListField::getBackupMethod() — Method in class RegisteredMFAMethodListField

Get the registered backup method (if any) from the currently logged in user.

RegisterHandlerInterface::getDescription() — Method in class RegisterHandlerInterface

Provide a localised description of this MFA Method.

RegisterHandlerInterface::getSupportLink() — Method in class RegisterHandlerInterface

Provide a localised URL to a support article about the registration process for this MFA Method.

RegisterHandlerInterface::getSupportText() — Method in class RegisterHandlerInterface

Provide a localised string to describe the support link {getSupportLink} about this MFA Method.

RegisterHandlerInterface::getComponent() — Method in class RegisterHandlerInterface

Get the key that a React UI component is registered under (with @silverstripe/react-injector on the front-end)

VerifyHandlerInterface::getComponent() — Method in class VerifyHandlerInterface

Get the key that a React UI component is registered under (with @silverstripe/react-injector on the front-end)

MethodInterface::getName() — Method in class MethodInterface

Provide a localised name for this MFA Method.

MethodInterface::getURLSegment() — Method in class MethodInterface

Get a URL segment for this method. This will be used in URL paths for performing authentication by this method

MethodInterface::getVerifyHandler() — Method in class MethodInterface

Return the VerifyHandler that is used to start and check verification attempts with this method

MethodInterface::getRegisterHandler() — Method in class MethodInterface

Return the RegisterHandler that is used to perform registrations with this method

MethodInterface::getThumbnail() — Method in class MethodInterface

Return a URL to an image to be used as a thumbnail in the MFA login/registration grid for all MFA methods

MethodInterface::getUnavailableMessage() — Method in class MethodInterface

If not available to be used, provide a message to display on the frontend to explain why.

RegisteredMethod::getMethod() — Method in class RegisteredMethod

RegisteredMethod::getVerifyHandler() — Method in class RegisteredMethod

RegisteredMethod::getRegisterHandler() — Method in class RegisteredMethod

EnabledMembers::getMethodClassToTitleMapping() — Method in class EnabledMembers

Create an array mapping authentication method Class Names to Readable Names

EnabledMembers::getRegisteredMethodsForRecords() — Method in class EnabledMembers

BaseHandlerTrait::getStore() — Method in class BaseHandlerTrait

BaseHandlerTrait::getSudoModeService() — Method in class BaseHandlerTrait

Returns a sudo mode service instance

BackupCodeGenerator::generate() — Method in class BackupCodeGenerator

Generates a list of backup codes

BackupCodeGenerator::getCharacterSet() — Method in class BackupCodeGenerator

Returns a list of possible characters to use in backup codes.

BackupCodeGenerator::generateCode() — Method in class BackupCodeGenerator

Generates a backup code at the specified string length, using a mixture of digits and mixed case letters

BackupCodeGeneratorInterface::generate() — Method in class BackupCodeGeneratorInterface

Generate a list of backup codes and return them in an array of state objects.

BackupCodeGeneratorInterface::getCharacterSet() — Method in class BackupCodeGeneratorInterface

Returns a list of possible characters to use in backup codes.

MethodRegistry::getMethods() — Method in class MethodRegistry

Get implementations of all configured methods

MethodRegistry::getBackupMethod() — Method in class MethodRegistry

Get the configured backup method

MethodRegistry::getMethodByURLSegment() — Method in class MethodRegistry

Fetches a Method by its URL Segment

RegisteredMethodManager::getFromMember() — Method in class RegisteredMethodManager

Get an authentication method object matching the given method from the given member. Returns null if the given method could not be found attached to the Member

SchemaGenerator::getSchema() — Method in class SchemaGenerator

Provides the full schema for the multi-factor authentication app, using the current Member as context

SchemaGenerator::getAvailableMethods() — Method in class SchemaGenerator

Get details in a list for all available methods, optionally excluding those with urlSegments provided in $exclude

SchemaGenerator::getRegisteredMethods() — Method in class SchemaGenerator

Get a list of methods registered to the user

SchemaGenerator::getDefaultMethod() — Method in class SchemaGenerator

Get the URL Segment for the configured default method on the current member, or null if none is configured

SchemaGenerator::getBackupMethod() — Method in class SchemaGenerator

Get the "details" of the configured back-up method (if set)

SchemaGenerator::getResources() — Method in class SchemaGenerator

Provide URLs for resources such as images and help articles

BackupCode::getCode() — Method in class BackupCode

BackupCode::getHash() — Method in class BackupCode

BackupCode::getAlgorithm() — Method in class BackupCode

BackupCode::getSalt() — Method in class BackupCode

Result::getMessage() — Method in class Result

Result::getContext() — Method in class Result

SessionStore::getMember() — Method in class SessionStore

SessionStore::getMethod() — Method in class SessionStore

SessionStore::getState() — Method in class SessionStore

Get the state from the store

SessionStore::getVerifiedMethods() — Method in class SessionStore

Get the list of methods that have been verified

StoreInterface::getState() — Method in class StoreInterface

Get the state from the store

StoreInterface::getMember() — Method in class StoreInterface

StoreInterface::getMethod() — Method in class StoreInterface

StoreInterface::getVerifiedMethods() — Method in class StoreInterface

Get the list of methods that have been verified

MimeUploadValidator::getFilterPattern() — Method in class MimeUploadValidator

MimeUploadValidator::getExpectedMimeTypes() — Method in class MimeUploadValidator

Fetches an array of valid mimetypes.

ArrayList::getIterator() — Method in class ArrayList

Returns an Iterator for this ArrayList.

CMSPreviewable::getMimeType() — Method in class CMSPreviewable

To determine preview mechanism (e.g. embedded / iframe)

DBConnector::getVersion() — Method in class DBConnector

Query for the version of the currently connected database

DBConnector::getSelectedDatabase() — Method in class DBConnector

Retrieves the name of the currently selected database

DBConnector::getLastError() — Method in class DBConnector

Retrieves the last error generated from the database connection

DBConnector::getGeneratedID() — Method in class DBConnector

Determines the last ID generated from the specified table.

DBQueryBuilder::getSeparator() — Method in class DBQueryBuilder

Determines the line separator to use.

Database::getConnector() — Method in class Database

Get the current connector

Database::getSchemaManager() — Method in class Database

Returns the current schema manager

Database::getQueryBuilder() — Method in class Database

Returns the current query builder

Database::getWhitelistQueryArray() — Method in class Database

Get the sql queries that need to be partially or fully matched

Database::getGeneratedID() — Method in class Database

Get the autogenerated ID from the previous INSERT query.

Database::getVersion() — Method in class Database

Query for the version of the currently connected database

Database::getDatabaseServer() — Method in class Database

Get the database server type (e.g. mysql, postgresql).

Database::getLock() — Method in class Database

Sets an application-level lock so that no two processes can run at the same time, also called a "cooperative advisory lock".

Database::getSelectedDatabase() — Method in class Database

Returns the name of the currently selected database

DatabaseException::getSQL() — Method in class DatabaseException

Returns the SQL that generated this error

DatabaseException::getParameters() — Method in class DatabaseException

The parameters given for this query, if any

MySQLDatabase::getDatabaseServer() — Method in class MySQLDatabase

Get the database server type (e.g. mysql, postgresql).

MySQLDatabase::getTransactionManager() — Method in class MySQLDatabase

Returns the TransactionManager to handle transactions for this database.

MySQLDatabase::getLock() — Method in class MySQLDatabase

Sets an application-level lock so that no two processes can run at the same time, also called a "cooperative advisory lock".

MySQLDatabase::getLockIdentifier() — Method in class MySQLDatabase

MySQLQuery::getIterator() — Method in class MySQLQuery

Return the next record in the query result.

MySQLSchemaManager::getIndexSqlDefinition() — Method in class MySQLSchemaManager

Generate SQL suitable for creating this index

MySQLStatement::getIterator() — Method in class MySQLStatement

Return the next record in the query result.

MySQLiConnector::getVersion() — Method in class MySQLiConnector

Query for the version of the currently connected database

MySQLiConnector::getSelectedDatabase() — Method in class MySQLiConnector

Retrieves the name of the currently selected database

MySQLiConnector::getGeneratedID() — Method in class MySQLiConnector

Determines the last ID generated from the specified table.

MySQLiConnector::getLastError() — Method in class MySQLiConnector

Retrieves the last error generated from the database connection

Query::getIterator() — Method in class Query

Return the next record in the query result.

TempDatabase::getConn() — Method in class TempDatabase

DB::get_conn() — Method in class DB

Get the global database connection.

DB::get_schema() — Method in class DB

Retrieves the schema manager for the current database

DB::get_connector() — Method in class DB

Retrieves the connector object for the current database

DB::get_alternative_database_name() — Method in class DB

Get the name of the database in use

DB::getConfig() — Method in class DB

Get the named connection config

DB::get_generated_id() — Method in class DB

Get the autogenerated ID from the previous INSERT query.

DataList::getQueryParams() — Method in class DataList

Get query parameters for this list.

DataList::getIterator() — Method in class DataList

Returns an Iterator for this DataList.

DataList::getIDList() — Method in class DataList

Returns an array with both the keys and values set to the IDs of the records in this list.

$ DataObject#general_search_field_name — Property in class DataObject

Name of the field which is used as a stand-in for searching across all searchable fields.

$ DataObject#general_search_field_filter — Property in class DataObject

The search filter to use when searching with the general search field.

$ DataObject#general_search_split_terms — Property in class DataObject

If true, the search phrase is split into individual terms, and checks all searchable fields for each search term.

DataObject::getSchema() — Method in class DataObject

Get schema object

DataObject::getObsoleteClassName() — Method in class DataObject

Return obsolete class name, if this is no longer a valid class

DataObject::getClassName() — Method in class DataObject

Gets name of this class

DataObject::getTitle() — Method in class DataObject

DataObject::getQueriedDatabaseFields() — Method in class DataObject

Return all currently fetched database fields.

DataObject::getClassAncestry() — Method in class DataObject

Get the class ancestry, including the current class name.

DataObject::getComponent() — Method in class DataObject

Return a unary component object from a one to one relationship, as a DataObject.

DataObject::getComponents() — Method in class DataObject

Returns a one-to-many relation as a HasManyList

DataObject::getRelationClass() — Method in class DataObject

Find the foreign class of a relation on this DataObject, regardless of the relation type.

DataObject::getRelationType() — Method in class DataObject

Given a relation name, determine the relation type

DataObject::getManyManyComponents() — Method in class DataObject

Returns a many-to-many component, as a ManyManyList.

DataObject::getDefaultSearchContext() — Method in class DataObject

Generates a SearchContext to be used for building and processing a generic search form for properties on this object.

DataObject::getGeneralSearchFieldName() — Method in class DataObject

Name of the field which is used as a stand-in for searching across all searchable fields.

DataObject::getCMSFields() — Method in class DataObject

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

DataObject::getCMSActions() — Method in class DataObject

need to be overload by solid dataobject, so that the customised actions of that dataobject, including that dataobject's extensions customised actions could be added to the EditForm.

DataObject::getCMSCompositeValidator() — Method in class DataObject

DataObject::getFrontEndFields() — Method in class DataObject

Used for simple frontend forms without relation editing or TabSet} behaviour. Uses {@link scaffoldFormFields() by default. To customize, either overload this method in your subclass, or extend it by DataExtension->updateFrontEndFields().

DataObject::getViewerTemplates() — Method in class DataObject

Find appropriate templates for SSViewer to use to render this object

DataObject::getField() — Method in class DataObject

Gets the value of a field.

DataObject::getChangedFields() — Method in class DataObject

Return the fields that have changed since the last write.

DataObject::getReverseAssociation() — Method in class DataObject

Temporary hack to return an association name, based on class, to get around the mangle of having to deal with reverse lookup of relationships to determine autogenerated foreign keys.

DataObject::get() — Method in class DataObject

Return all objects matching the filter sub-classes are automatically selected and included

DataObject::get_one() — Method in class DataObject

Return the first item matching the given query.

DataObject::get_by_id() — Method in class DataObject

Return the given element, searching by ID.

DataObject::getSourceQueryParams() — Method in class DataObject

DataObject::getInheritableQueryParams() — Method in class DataObject

Get list of parameters that should be inherited to relations on this object

DataObject::getSourceQueryParam() — Method in class DataObject

DataObject::getJoin() — Method in class DataObject

If selected through a many_many through relation, this is the instance of the joined record

DataObject::getUniqueKey() — Method in class DataObject

Generate a unique key for data object the unique key uses the DataObject::getUniqueKeyComponents() extension point so unique key modifiers such as versioned or fluent are covered i.e. same data object in different stages or different locales will produce different unique key

DataObjectSchema::getTableNames() — Method in class DataObjectSchema

Get all table names

DataObjectSchema::getManyManyInverseRelationship() — Method in class DataObjectSchema

Find a many_many on the child class that points back to this many_many

DataObjectSchema::getRemoteJoinField() — Method in class DataObjectSchema

Tries to find the database key on another object that is used to store a relationship to this class. If no join field can be found it defaults to 'ParentID'.

DataObjectSchema::getHasManyComponentDetails() — Method in class DataObjectSchema

DataQuery::getFinalisedQuery() — Method in class DataQuery

Ensure that the query is ready to execute.

DataQuery::groupby() — Method in class DataQuery

Append a GROUP BY clause to this query.

DataQuery::getQueryParam() — Method in class DataQuery

Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query.

DataQuery::getQueryParams() — Method in class DataQuery

Returns all query parameters

DataQuery::getDataQueryManipulators() — Method in class DataQuery

Get query manipulators

DataQuery::getAllowCollidingFieldStatements() — Method in class DataQuery

Get whether field statements aliased as columns are allowed when that column is already being selected

DatabaseAdmin::groupedDataClasses() — Method in class DatabaseAdmin

Get the data classes, grouped by their root class

DatabaseAdmin::getReturnURL() — Method in class DatabaseAdmin

Gets the url to return to after build

DatabaseAdmin::getClassTables() — Method in class DatabaseAdmin

Get tables to update for this class

DatabaseAdmin::getClassNameRemappingFields() — Method in class DatabaseAdmin

Find all DBClassName fields on valid subclasses of DataObject that should be remapped. This includes ClassName fields as well as polymorphic class name fields.

EagerLoadedList::getIDList() — Method in class EagerLoadedList

Returns an array with both the keys and values set to the IDs of the records in this list.

EagerLoadedList::getIterator() — Method in class EagerLoadedList

EagerLoadedList::getRows() — Method in class EagerLoadedList

Get the raw data rows for the records in this list.

EagerLoadedList::getExtraData() — Method in class EagerLoadedList

Find the extra field data for a single row of the relationship join table for many_many relations, given the known child ID.

EagerLoadedList::getExtraFields() — Method in class EagerLoadedList

Gets the extra fields included in the relationship.

DBClassName::getDefault() — Method in class DBClassName

Get default vwalue

DBClassNameTrait::getBaseClass() — Method in class DBClassNameTrait

Get the base dataclass for the list of subclasses

DBClassNameTrait::getShortName() — Method in class DBClassNameTrait

Get the base name of the current class Useful as a non-fully qualified CSS Class name in templates.

DBClassNameTrait::getEnum() — Method in class DBClassNameTrait

Get list of classnames that should be selectable

DBComposite::getField() — Method in class DBComposite

get value of a single composite field

DBComposite::getIndexSpecs() — Method in class DBComposite

Returns the index specifications for the field instance, for example:

DBDate::getFormatter() — Method in class DBDate

Get date formatter

DBDate::getCustomFormatter() — Method in class DBDate

Return formatter in a given locale. Useful if localising in a format other than the current locale.

DBDate::getISOFormat() — Method in class DBDate

Get standard ISO date format string

DBDate::getTimestamp() — Method in class DBDate

Get unix timestamp for this date

DBDatetime::getTimeBetween() — Method in class DBDatetime

Get the amount of time inbetween two datetimes.

DBDatetime::get_template_global_variables() — Method in class DBDatetime

DBDatetime::getFormatter() — Method in class DBDatetime

Get date / time formatter for the current locale

DBDatetime::getCustomFormatter() — Method in class DBDatetime

Return formatter in a given locale. Useful if localising in a format other than the current locale.

DBDatetime::getISOFormat() — Method in class DBDatetime

Get standard ISO date format string

DBEnum::getEnum() — Method in class DBEnum

Get list of enum values

DBEnum::getEnumObsolete() — Method in class DBEnum

Get the list of enum values, including obsolete values still present in the database

DBEnum::getDefault() — Method in class DBEnum

Get default vwalue

DBField::getName() — Method in class DBField

Returns the name of this field.

DBField::getValue() — Method in class DBField

Returns the value of this field.

DBField::getDefaultValue() — Method in class DBField

Get default value assigned at the DB level

DBField::getOptions() — Method in class DBField

Get optional parameters for this field

DBField::getIndexType() — Method in class DBField

Return the desired index type to use. Will return false if the field instance should not be indexed.

DBField::getTable() — Method in class DBField

Get the table this field belongs to, if assigned

DBField::getArrayValue() — Method in class DBField

DBField::getSchemaValue() — Method in class DBField

Get formfield schema value

DBField::getIndexSpecs() — Method in class DBField

Returns the index specifications for the field instance, for example:

DBHTMLText::getProcessShortcodes() — Method in class DBHTMLText

Check if shortcodes are enabled

DBHTMLText::getWhitelist() — Method in class DBHTMLText

List of html properties to whitelist

DBHTMLText::getSchemaValue() — Method in class DBHTMLText

Get formfield schema value

DBHTMLVarchar::getProcessShortcodes() — Method in class DBHTMLVarchar

Check if shortcodes are enabled

DBHTMLVarchar::getSchemaValue() — Method in class DBHTMLVarchar

Get formfield schema value

DBIndexable::getIndexType() — Method in class DBIndexable

Return the desired index type to use. Will return false if the field instance should not be indexed.

DBIndexable::getIndexSpecs() — Method in class DBIndexable

Returns the index specifications for the field instance, for example:

DBInt::getValue() — Method in class DBInt

Ensure int values are always returned.

DBLocale::getShortName() — Method in class DBLocale

Resolves the locale to a common english-language name through i18n::get_common_locales().

DBLocale::getLongName() — Method in class DBLocale

DBLocale::getNativeName() — Method in class DBLocale

Returns the localized name based on the field's value.

DBMoney::getFormatter() — Method in class DBMoney

Get currency formatter

DBMoney::getValue() — Method in class DBMoney

Standard '0.00 CUR' format (non-localised)

DBMoney::getCurrency() — Method in class DBMoney

DBMoney::getAmount() — Method in class DBMoney

DBMoney::getLocale() — Method in class DBMoney

DBMoney::getSymbol() — Method in class DBMoney

Get currency symbol

DBPolymorphicForeignKey::getClassValue() — Method in class DBPolymorphicForeignKey

Get the value of the "Class" this key points to

DBPolymorphicForeignKey::getIDValue() — Method in class DBPolymorphicForeignKey

Gets the value of the "ID" this key points to

DBPolymorphicForeignKey::getValue() — Method in class DBPolymorphicForeignKey

Returns the value of this field.

DBPolymorphicRelationAwareForeignKey::getRelationValue() — Method in class DBPolymorphicRelationAwareForeignKey

Get the value of the "Relation" this key points to

DBPrimaryKey::getAutoIncrement() — Method in class DBPrimaryKey

DBString::getNullifyEmpty() — Method in class DBString

Get whether this field stores empty strings rather than converting them to null

DBTime::getFormatter() — Method in class DBTime

Get date / time formatter for the current locale

DBTime::getISOFormat() — Method in class DBTime

Get standard ISO time format string

DBTime::getTimestamp() — Method in class DBTime

Get unix timestamp for this time

DBVarchar::getSize() — Method in class DBVarchar

Allow the ability to access the size of the field programmatically. This can be useful if you want to have text fields with a length limit that is dictated by the DB field.

ComparisonFilter::getOperator() — Method in class ComparisonFilter

Should return an operator to be used for comparisons

ComparisonFilter::getInverseOperator() — Method in class ComparisonFilter

Should return an inverse operator to be used for comparisons

EndsWithFilter::getMatchPattern() — Method in class EndsWithFilter

Apply the match filter to the given variable value

ExactMatchFilter::getSupportedModifiers() — Method in class ExactMatchFilter

Gets supported modifiers for this filter

FulltextFilter::getDbName() — Method in class FulltextFilter

This implementation allows for a list of columns to be passed into MATCH() instead of just one.

GreaterThanFilter — Class in namespace SilverStripe\ORM\Filters

Selects numerical/date content greater than the input

GreaterThanFilter::getOperator() — Method in class GreaterThanFilter

Should return an operator to be used for comparisons

GreaterThanFilter::getInverseOperator() — Method in class GreaterThanFilter

Should return an inverse operator to be used for comparisons

GreaterThanOrEqualFilter — Class in namespace SilverStripe\ORM\Filters

Selects numerical/date content greater than or equal to the input

GreaterThanOrEqualFilter::getOperator() — Method in class GreaterThanOrEqualFilter

Should return an operator to be used for comparisons

GreaterThanOrEqualFilter::getInverseOperator() — Method in class GreaterThanOrEqualFilter

Should return an inverse operator to be used for comparisons

LessThanFilter::getOperator() — Method in class LessThanFilter

Should return an operator to be used for comparisons

LessThanFilter::getInverseOperator() — Method in class LessThanFilter

Should return an inverse operator to be used for comparisons

LessThanOrEqualFilter::getOperator() — Method in class LessThanOrEqualFilter

Should return an operator to be used for comparisons

LessThanOrEqualFilter::getInverseOperator() — Method in class LessThanOrEqualFilter

Should return an inverse operator to be used for comparisons

PartialMatchFilter::getSupportedModifiers() — Method in class PartialMatchFilter

Gets supported modifiers for this filter

PartialMatchFilter::getMatchPattern() — Method in class PartialMatchFilter

Apply the match filter to the given variable value

SearchFilter::getValue() — Method in class SearchFilter

Accessor for the current value to be filtered on.

SearchFilter::getSupportedModifiers() — Method in class SearchFilter

Gets supported modifiers for this filter

SearchFilter::getModifiers() — Method in class SearchFilter

Accessor for the current modifiers to apply to the filter.

SearchFilter::getName() — Method in class SearchFilter

The original name of the field.

SearchFilter::getFullName() — Method in class SearchFilter

The full name passed to the constructor, including any (optional) relations in dot notation.

SearchFilter::getDbName() — Method in class SearchFilter

Normalizes the field name to table mapping.

SearchFilter::getDbFormattedValue() — Method in class SearchFilter

Return the value of the field as processed by the DBField class

SearchFilter::getCaseSensitive() — Method in class SearchFilter

Determines case sensitivity based on getModifiers().

SearchFilter::getCaseSensitiveByCollation() — Method in class SearchFilter

Find out whether the database is set to use case sensitive comparisons or not by default.

StartsWithFilter::getMatchPattern() — Method in class StartsWithFilter

Apply the match filter to the given variable value

GroupedList — Class in namespace SilverStripe\ORM

A list decorator that allows a list to be grouped into sub-lists by common values of a field.

GroupedList::groupBy() — Method in class GroupedList

GroupedList::GroupedBy() — Method in class GroupedList

Similar to groupBy(), but returns the data in a format which is suitable for usage in templates.

HasManyList::getForeignKey() — Method in class HasManyList

Gets the field name which holds the related object ID.

Hierarchy::get_extra_config() — Method in class Hierarchy

Hierarchy::getDescendantIDList() — Method in class Hierarchy

Get a list of this DataObject's and all it's descendants IDs.

Hierarchy::getParent() — Method in class Hierarchy

Get this object's parent, optionally filtered by an SQL clause. If the clause doesn't match the parent, nothing is returned.

Hierarchy::getAncestors() — Method in class Hierarchy

Return all the parents of this class in a set ordered from the closest to furtherest parent.

Hierarchy::getBreadcrumbs() — Method in class Hierarchy

Returns a human-readable, flattened representation of the path to the object, using its Title attribute.

MarkedSet::getNodeCountThreshold() — Method in class MarkedSet

Get total number of nodes to get. This acts as a soft lower-bounds for number of nodes to search until found.

MarkedSet::getMaxChildNodes() — Method in class MarkedSet

Max number of nodes that can be physically rendered at any level.

MarkedSet::getChildrenMethod() — Method in class MarkedSet

Get method to use for getting children

MarkedSet::getChildren() — Method in class MarkedSet

Get children from this node

MarkedSet::getNumChildrenMethod() — Method in class MarkedSet

Get method name for num children

MarkedSet::getNumChildren() — Method in class MarkedSet

Count children

MarkedSet::getChildrenAsArray() — Method in class MarkedSet

Get child data formatted as JSON

MarkedSet::getSubtreeAsArray() — Method in class MarkedSet

Return sub-tree as json array

MarkedSet::getSubtree() — Method in class MarkedSet

Get tree data for node

MarkedSet::getLimitingEnabled() — Method in class MarkedSet

Check if limiting is enabled

ListDecorator::getList() — Method in class ListDecorator

ListDecorator::getIterator() — Method in class ListDecorator

ManyManyList::getExtraData() — Method in class ManyManyList

Find the extra field data for a single row of the relationship join table, given the known child ID.

ManyManyList::getJoinTable() — Method in class ManyManyList

Gets the join table used for the relationship.

ManyManyList::getLocalKey() — Method in class ManyManyList

Gets the key used to store the ID of the local/parent object.

ManyManyList::getForeignKey() — Method in class ManyManyList

Gets the key used to store the ID of the foreign/child object.

ManyManyList::getExtraFields() — Method in class ManyManyList

Gets the extra fields included in the relationship.

ManyManyThroughList::getExtraFields() — Method in class ManyManyThroughList

Get extra fields used by this list

ManyManyThroughList::getJoinTable() — Method in class ManyManyThroughList

ManyManyThroughQueryManipulator::getJoinClass() — Method in class ManyManyThroughQueryManipulator

ManyManyThroughQueryManipulator::getLocalKey() — Method in class ManyManyThroughQueryManipulator

ManyManyThroughQueryManipulator::getForeignKey() — Method in class ManyManyThroughQueryManipulator

ManyManyThroughQueryManipulator::getForeignIDKey() — Method in class ManyManyThroughQueryManipulator

Gets ID key name for foreign key component

ManyManyThroughQueryManipulator::getForeignClassKey() — Method in class ManyManyThroughQueryManipulator

Gets Class key name for foreign key component (or null if none)

ManyManyThroughQueryManipulator::getParentRelationship() — Method in class ManyManyThroughQueryManipulator

Get has_many relationship between parent and join table (for a given DataQuery)

ManyManyThroughQueryManipulator::getJoinAlias() — Method in class ManyManyThroughQueryManipulator

Get name of join table alias for use in queries.

ManyManyThroughQueryManipulator::getForeignClass() — Method in class ManyManyThroughQueryManipulator

ManyManyThroughQueryManipulator::getParentClass() — Method in class ManyManyThroughQueryManipulator

Map::getIterator() — Method in class Map

Returns an Map_Iterator instance for iterating over the complete set of items in the map.

$ PaginatedList#getVar — Property in class PaginatedList

PaginatedList::getPaginationGetVar() — Method in class PaginatedList

Returns the GET var that is used to set the page start. This defaults to "start".

PaginatedList::getPageLength() — Method in class PaginatedList

Returns the number of items displayed per page. This defaults to 10.

PaginatedList::getPageStart() — Method in class PaginatedList

Returns the offset of the item the current page starts at.

PaginatedList::getTotalItems() — Method in class PaginatedList

Returns the total number of items in the unpaginated list.

PaginatedList::getLimitItems() — Method in class PaginatedList

Returns whether or not the underlying list is limited to the current pagination range when iterating.

PaginatedList::getIterator() — Method in class PaginatedList

PaginatedList::getRequest() — Method in class PaginatedList

Get the request object for this list

PolymorphicHasManyList::getForeignClass() — Method in class PolymorphicHasManyList

Retrieve the name of the class this (has_many) relation is filtered by

PolymorphicHasManyList::getForeignRelation() — Method in class PolymorphicHasManyList

Retrieve the name of the has_many relation this list is filtered by

PolymorphicHasManyList::getForeignClassKey() — Method in class PolymorphicHasManyList

Gets the field name which holds the related (has_many) object class.

PolymorphicHasManyList::getForeignRelationKey() — Method in class PolymorphicHasManyList

Gets the field name which holds the has_many relation name.

SQLAssignmentRow::getAssignments() — Method in class SQLAssignmentRow

Retrieves the list of assignments in parameterised format

SQLAssignmentRow::getColumns() — Method in class SQLAssignmentRow

Retrieves the list of columns updated

SQLConditionalExpression::getConnective() — Method in class SQLConditionalExpression

Get the connective property.

SQLConditionalExpression::getFrom() — Method in class SQLConditionalExpression

Return a list of tables queried

SQLConditionalExpression::getJoins() — Method in class SQLConditionalExpression

Retrieves the finalized list of joins

SQLConditionalExpression::getOrderedJoins() — Method in class SQLConditionalExpression

Ensure that framework "auto-generated" table JOINs are first in the finalised SQL query.

SQLConditionalExpression::getWhere() — Method in class SQLConditionalExpression

Return a list of WHERE clauses used internally.

SQLConditionalExpression::getWhereParameterised() — Method in class SQLConditionalExpression

Return a list of WHERE clauses used internally.

SQLConditionalExpression::getJoinRegex() — Method in class SQLConditionalExpression

Get the regular expression pattern used to identify JOIN statements

SQLDelete::getDelete() — Method in class SQLDelete

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

SQLInsert::getInto() — Method in class SQLInsert

Gets the table name to insert into

SQLInsert::getRows() — Method in class SQLInsert

Returns the current list of rows

SQLInsert::getColumns() — Method in class SQLInsert

Returns the list of distinct column names used in this insert

SQLInsert::getAssignments() — Method in class SQLInsert

Retrieves the list of assignments in parameterised format

$ SQLSelect#groupby — Property in class SQLSelect

An array of GROUP BY clauses.

SQLSelect::getDistinct() — Method in class SQLSelect

Get the distinct property.

SQLSelect::getLimit() — Method in class SQLSelect

Get the limit property.

SQLSelect::getOrderBy() — Method in class SQLSelect

Returns the current order by as array if not already. To handle legacy statements which are stored as strings. Without clauses and directions, convert the orderby clause to something readable.

SQLSelect::getHaving() — Method in class SQLSelect

Return a list of HAVING clauses used internally.

SQLSelect::getHavingParameterised() — Method in class SQLSelect

Return a list of HAVING clauses used internally.

SQLSelect::getUnions() — Method in class SQLSelect

Get all of the queries that will be UNIONed with this one.

SQLSelect::getWith() — Method in class SQLSelect

Get the data which will be used to generate the WITH clause of the query

SQLSelect::getGroupBy() — Method in class SQLSelect

Return a list of GROUP BY clauses used internally.

SQLSelect::getSelect() — Method in class SQLSelect

Return an itemised select list as a map, where keys are the aliases, and values are the column sources.

SQLUpdate::getTable() — Method in class SQLUpdate

Gets the table name to update

SQLUpdate::getAssignments() — Method in class SQLUpdate

Retrieves the list of assignments in parameterised format

SQLWriteExpression::getAssignments() — Method in class SQLWriteExpression

Retrieves the list of assignments in parameterised format

Relation::getIDList() — Method in class Relation

Returns an array with both the keys and values set to the IDs of the records in this list.

RelationList::getForeignID() — Method in class RelationList

Any number of foreign keys to apply to this list

RelationList::getQueryParams() — Method in class RelationList

Get query parameters for this list.

$ BasicSearchContext#general_search_field_name — Property in class BasicSearchContext

Name of the field which, if included in search forms passed to this object, will be used to search across all searchable fields.

BasicSearchContext::getQuery() — Method in class BasicSearchContext

Returns a list which has been limited, sorted, and filtered by the given parameters.

FulltextSearchable::get_extra_config() — Method in class FulltextSearchable

FulltextSearchable::get_searchable_classes() — Method in class FulltextSearchable

Shows all classes that had the FulltextSearchable} extension applied through {@link enable().

SearchContext::getSearchFields() — Method in class SearchContext

Returns scaffolded search fields for UI.

SearchContext::getQuery() — Method in class SearchContext

Returns a SQL object representing the search context for the given list of query parameters.

SearchContext::getResults() — Method in class SearchContext

Returns a result set from the given search parameters.

SearchContext::getFilter() — Method in class SearchContext

Accessor for the filter attached to a named field.

SearchContext::getFilters() — Method in class SearchContext

Get the map of filters in the current search context.

SearchContext::getFields() — Method in class SearchContext

Get the list of searchable fields in the current search context.

SearchContext::getSearchParams() — Method in class SearchContext

SearchContext::getSummary() — Method in class SearchContext

Gets a list of what fields were searched and the values provided for each field. Returns an ArrayList of ArrayData, suitable for rendering on a template.

UniqueKeyInterface::generateKey() — Method in class UniqueKeyInterface

Generate a unique key for data object

UniqueKeyService::generateKey() — Method in class UniqueKeyService

UnsavedRelationList::getIterator() — Method in class UnsavedRelationList

Returns an Iterator for this relation.

UnsavedRelationList::getIDList() — Method in class UnsavedRelationList

Returns an array with both the keys and values set to the IDs of the records in this list.

ValidationException::getResult() — Method in class ValidationException

Retrieves the ValidationResult related to this error

ValidationResult::getMessages() — Method in class ValidationResult

Return the full error meta-data, suitable for combining with another ValidationResult.

Authenticator::getLoginHandler() — Method in class Authenticator

Return RequestHandler to manage the log-in process.

Authenticator::getLogOutHandler() — Method in class Authenticator

Return the RequestHandler to manage the log-out process.

Authenticator::getChangePasswordHandler() — Method in class Authenticator

Return RequestHandler to manage the change-password process.

Authenticator::getLostPasswordHandler() — Method in class Authenticator

Authenticator::getService() — Method in class Authenticator

LoginForm::getRealMeWidgetTheme() — Method in class LoginForm

Example function exposing a RealMe config option to the login form template

LoginForm::getServiceName1() — Method in class LoginForm

LoginForm::getServiceName2() — Method in class LoginForm

LoginForm::getServiceName3() — Method in class LoginForm

LoginForm::getAuthenticatorName() — Method in class LoginForm

Return the title of the form for use in the frontend For tabs with multiple login methods, for example.

LoginForm::getFormFields() — Method in class LoginForm

Required FieldList creation on a LoginForm

LoginForm::getFormActions() — Method in class LoginForm

Required FieldList creation for the login actions on this LoginForm

MiniLoginForm::getRealMeMiniLoginLink() — Method in class MiniLoginForm

MiniLoginForm::getMiniLoginFormPopupPosition() — Method in class MiniLoginForm

$ FederatedIdentity#Gender — Property in class FederatedIdentity

FederatedIdentity::getDateOfBirth() — Method in class FederatedIdentity

User::getMember() — Method in class User

User::getFederatedIdentity() — Method in class User

RealMeService::get_template_global_variables() — Method in class RealMeService

RealMeService::getRequest() — Method in class RealMeService

RealMeService::getUserData() — Method in class RealMeService

RealMeService::getAuthData() — Method in class RealMeService

Returns a RealMeUser object if one can be built from the RealMe session data.

RealMeService::getLastError() — Method in class RealMeService

RealMeService::getBackURL() — Method in class RealMeService

RealMeService::getErrorBackURL() — Method in class RealMeService

RealMeService::getCertDir() — Method in class RealMeService

RealMeService::getAuthnContextForEnvironment() — Method in class RealMeService

Returns the appropriate AuthN Context, given the environment passed in. The AuthNContext may be different per environment, and should be one of the strings as defined in the static RealMeService::$authn_contexts at the top of this class.

RealMeService::getSigningCertPath() — Method in class RealMeService

Returns the full path to the SAML signing certificate file, used by SimpleSAMLphp to sign all messages sent to RealMe.

RealMeService::getIdPCertPath() — Method in class RealMeService

RealMeService::getSPCertContent() — Method in class RealMeService

RealMeService::getIdPCertContent() — Method in class RealMeService

RealMeService::getCertificateContents() — Method in class RealMeService

Returns the content of the SAML signing certificate. This is used by getAuth() and by RealMeSetupTask to produce metadata XML files.

RealMeService::getAssertionConsumerServiceUrlForEnvironment() — Method in class RealMeService

RealMeService::getMetadataOrganisationName() — Method in class RealMeService

RealMeService::getMetadataOrganisationDisplayName() — Method in class RealMeService

RealMeService::getMetadataOrganisationUrl() — Method in class RealMeService

RealMeService::getMetadataContactSupport() — Method in class RealMeService

RealMeService::getAllowedRealMeEnvironments() — Method in class RealMeService

The list of RealMe environments that can be used. By default, we allow mts, ite and production.

RealMeService::getAllowedAuthNContextList() — Method in class RealMeService

The list of valid realme AuthNContexts

RealMeService::getSPEntityID() — Method in class RealMeService

Returns the appropriate entity ID for RealMe, given the environment passed in. The entity ID may be different per environment, and should be a full URL, including privacy realm and application name. For example, this may be: https://www.agency.govt.nz/privacy-realm-name/application-name

RealMeService::getAuth() — Method in class RealMeService

Returns the internal Auth object against which visitors are authenticated.

RealMeService::getNameIdFormat() — Method in class RealMeService

RegistryAdmin::getManagedModels() — Method in class RegistryAdmin

RegistryAdmin::getExportFields() — Method in class RegistryAdmin

Define which fields are used in the getEditForm GridField export.

RegistryAdmin::getCsvImportFilename() — Method in class RegistryAdmin

Gets a unique filename to use for importing the uploaded CSV data

RegistryDataInterface::getSearchFields() — Method in class RegistryDataInterface

A FieldList containing FormField objects that represent the fields in the data search form.

RegistryImportFeed::getLatest() — Method in class RegistryImportFeed

RegistryImportFeed::getAssetHandler() — Method in class RegistryImportFeed

Get the handler used to manipulate the filesystem

RegistryImportFeed::getStoragePath() — Method in class RegistryImportFeed

Get the path that import files will be stored for this model

RegistryImportFeed::getImportFiles() — Method in class RegistryImportFeed

Loop import files in the storage path and push them into an ArrayList

RegistryImportFeed::getImportFilename() — Method in class RegistryImportFeed

Returns a relatively unique filename to storage imported data feeds as

RegistryImportFeed::getAssetsDir() — Method in class RegistryImportFeed

Get the assets directory name

RegistryPage::getDataClasses() — Method in class RegistryPage

RegistryPage::getDataClass() — Method in class RegistryPage

RegistryPage::getDataSingleton() — Method in class RegistryPage

RegistryPage::getPageLength() — Method in class RegistryPage

RegistryPage::getCMSFields() — Method in class RegistryPage

RegistryPageController::getTemplateList() — Method in class RegistryPageController

RegistryPageController::getClassNameForUrl() — Method in class RegistryPageController

Sanitise a PHP class name for display in URLs etc

Report::getTitle() — Method in class Report

Allows access to title as a property

Report::getLink() — Method in class Report

Report::getCount() — Method in class Report

counts the number of objects returned

Report::getCountForOverview() — Method in class Report

Counts the number of objects returned up to a configurable limit.

Report::get_excluded_reports() — Method in class Report

Return an array of excluded reports. That is, reports that will not be included in the list of reports in report admin in the CMS.

Report::get_reports() — Method in class Report

Return the SS_Report objects making up the given list.

Report::getCMSFields() — Method in class Report

Returns a FieldList with which to create the CMS editing form.

Report::getCMSActions() — Method in class Report

Report::getReportField() — Method in class Report

Return a field, such as a GridField that is used to show and manipulate data relating to this report.

Report::getBreadcrumbs() — Method in class Report

Return additional breadcrumbs for this report. Useful when this report is a child of another.

Report::getSourceParams() — Method in class Report

Get source params for the report to filter by

ReportAdmin::getEditForm() — Method in class ReportAdmin

Calls SiteTree->getCMSFields() by default to determine the form fields to display.

ReportWrapper::group() — Method in class ReportWrapper

SideReportView::group() — Method in class SideReportView

DataFormatter::getCustomFields() — Method in class DataFormatter

DataFormatter::getCustomRelations() — Method in class DataFormatter

DataFormatter::getCustomAddFields() — Method in class DataFormatter

DataFormatter::getRemoveFields() — Method in class DataFormatter

DataFormatter::getOutputContentType() — Method in class DataFormatter

DataFormatter::getTotalSize() — Method in class DataFormatter

DataFormatter::getFieldsForObj() — Method in class DataFormatter

Returns all fields on the object which should be shown in the output. Can be customised through DataFormatter::setCustomFields().

DataFormatter::getRealFields() — Method in class DataFormatter

Convert an array of aliased field names to their Dataobject field name

DataFormatter::getRealFieldName() — Method in class DataFormatter

Get the DataObject field name from its alias

DataFormatter::getFieldAlias() — Method in class DataFormatter

Get a DataObject Field's Alias defaults to the fieldname

DataFormatter::getApiMapping() — Method in class DataFormatter

Get the 'api_field_mapping' config value for a class or return an empty array

DataFormatter::getMappedKey() — Method in class DataFormatter

Helper function to get mapped field names

RestfulServer::getHandler() — Method in class RestfulServer

Handler for object read.

RestfulServer::getSearchQuery() — Method in class RestfulServer

Uses the default SearchContext specified through DataObject::getDefaultSearchContext() to augument an existing query object (mostly a component query from DataObject) with search clauses.

RestfulServer::getDataFormatter() — Method in class RestfulServer

Returns a dataformatter instance based on the request extension or mimetype. Falls back to RestfulServer::$default_extension.

RestfulServer::getRequestDataFormatter() — Method in class RestfulServer

RestfulServer::getResponseDataFormatter() — Method in class RestfulServer

RestfulServer::getObjectQuery() — Method in class RestfulServer

Gets a single DataObject by ID, through a request like /api/v1//

RestfulServer::getObjectsQuery() — Method in class RestfulServer

RestfulServer::getObjectRelationQuery() — Method in class RestfulServer

RestfulServer::getAllowedRelations() — Method in class RestfulServer

Return only relations which have $api_access enabled.

RestfulServer::getMember() — Method in class RestfulServer

Get the current Member, if available

GridFieldExportReportButton — Class in namespace SilverStripe\SecurityReport\Forms

An extension to GridFieldExportButton to support downloading a custom Report as a CSV file

GridFieldExportReportButton::generateExportFileData() — Method in class GridFieldExportReportButton

Generate export fields for CSV.

GridFieldPrintReportButton — Class in namespace SilverStripe\SecurityReport\Forms

An extension to GridFieldPrintButton to support printing custom Reports

GridFieldPrintReportButton::generatePrintData() — Method in class GridFieldPrintReportButton

Export core

MemberReportExtension::getLastLoggedIn() — Method in class MemberReportExtension

Retrieves the most recent successful LoginAttempt

MemberReportExtension::getGroupsDescription() — Method in class MemberReportExtension

Builds a comma separated list of member group names for a given Member.

MemberReportExtension::getPermissionsDescription() — Method in class MemberReportExtension

Builds a comma separated list of human-readbale permissions for a given Member.

SubsiteMemberReportExtension::getSubsiteDescription() — Method in class SubsiteMemberReportExtension

Describes the subsites this user has SITETREE_EDIT_ALL access to

UserSecurityReport::getColumns() — Method in class UserSecurityReport

Alias of columns(), to support the export to csv action in GridFieldExportButton generateExportFileData method.

UserSecurityReport::getReportField() — Method in class UserSecurityReport

Return a field, such as a GridField that is used to show and manipulate data relating to this report.

AuthenticationMiddleware::getAuthenticationHandler() — Method in class AuthenticationMiddleware

Authenticator::getLoginHandler() — Method in class Authenticator

Return RequestHandler to manage the log-in process.

Authenticator::getLogOutHandler() — Method in class Authenticator

Return the RequestHandler to manage the log-out process.

Authenticator::getChangePasswordHandler() — Method in class Authenticator

Return RequestHandler to manage the change-password process.

Authenticator::getLostPasswordHandler() — Method in class Authenticator

BasicAuthMiddleware::getURLPatterns() — Method in class BasicAuthMiddleware

Get list of url patterns

CMSSecurity::getAuthenticator() — Method in class CMSSecurity

Get the selected authenticator for this request

CMSSecurity::getApplicableAuthenticators() — Method in class CMSSecurity

Get all registered authenticators

CMSSecurity::getTargetMember() — Method in class CMSSecurity

Get known logged out member

CMSSecurity::getResponseController() — Method in class CMSSecurity

Prepare the controller for handling the response to this request

CMSSecurity::getSessionMessage() — Method in class CMSSecurity

Get the HTML Content for the $Content area during login

CMSSecurity::getIsloggedIn() — Method in class CMSSecurity

Check if there is a logged in member

Item::getToken() — Method in class Item

Returns the token of the item

Item::getName() — Method in class Item

Returns the item name (human readable)

Item::getDescription() — Method in class Item

Returns the human readable description of the item

Storage::getHashedItems() — Method in class Storage

Returns the dictionary with the item hashes

Storage::getTokenHash() — Method in class Storage

Returns salted and hashed version of the item token

Storage::getCookieKey() — Method in class Storage

Returns the unique cookie key generated from the session salt

Storage::getCsrfToken() — Method in class Storage

Returns a unique token to use as a CSRF token

Storage::getSessionSalt() — Method in class Storage

Returns the salt generated for the current session

Storage::generateSalt() — Method in class Storage

Returns randomly generated salt

Storage::getItems() — Method in class Storage

Returns the list of registered confirmation items

Storage::getItem() — Method in class Storage

Look up an item by its token key

Storage::getHttpMethod() — Method in class Storage

Returns HTTP method of the success request

Storage::getSuccessPostVars() — Method in class Storage

Returns the list of success request post parameters

Storage::getSuccessUrl() — Method in class Storage

Returns the URL registered by {Storage::setSuccessUrl} as a success redirect target

Storage::getFailureUrl() — Method in class Storage

Returns the URL registered by {Storage::setFailureUrl} as a success redirect target

Storage::getNamespace() — Method in class Storage

Returns the namespace of the storage in the session

DefaultAdminService::getDefaultAdminUsername() — Method in class DefaultAdminService

DefaultAdminService::getDefaultAdminPassword() — Method in class DefaultAdminService

Group — Class in namespace SilverStripe\Security

A security group.

Group::getAllChildren() — Method in class Group

Group::getCMSFields() — Method in class Group

Caution: Only call on instances, not through a singleton.

Group::getTreeTitle() — Method in class Group

Group::getCMSCompositeValidator() — Method in class Group

GroupCsvBulkLoader — Class in namespace SilverStripe\Security

InheritedPermissionFlusher::getServices() — Method in class InheritedPermissionFlusher

InheritedPermissionFlusher::getMemberIDList() — Method in class InheritedPermissionFlusher

Get a list of member IDs that need their permissions flushed

$ InheritedPermissions#globalEditPermissions — Property in class InheritedPermissions

Global permissions required to edit.

InheritedPermissions::getGlobalEditPermissions() — Method in class InheritedPermissions

InheritedPermissions::getDefaultPermissions() — Method in class InheritedPermissions

Get root permissions handler, or null if no handler

InheritedPermissions::getBaseClass() — Method in class InheritedPermissions

Get base class

InheritedPermissions::getPermissionField() — Method in class InheritedPermissions

Get field to check for permission type for the given check.

InheritedPermissions::getJoinTable() — Method in class InheritedPermissions

Get join table for type Defaults to those provided by {InheritedPermissionsExtension)

InheritedPermissions::getGroupJoinTable() — Method in class InheritedPermissions

Get group join table for type Defaults to those provided by {InheritedPermissionsExtension)

InheritedPermissions::getMemberJoinTable() — Method in class InheritedPermissions

Get member join table for type Defaults to those provided by {InheritedPermissionsExtension)

InheritedPermissions::getEditorGroupsTable() — Method in class InheritedPermissions

Get table to use for editor groups relation

InheritedPermissions::getViewerGroupsTable() — Method in class InheritedPermissions

Get table to use for viewer groups relation

InheritedPermissions::getEditorMembersTable() — Method in class InheritedPermissions

Get table to use for editor members relation

InheritedPermissions::getViewerMembersTable() — Method in class InheritedPermissions

Get table to use for viewer members relation

InheritedPermissions::getCachePermissions() — Method in class InheritedPermissions

Gets the permission from cache

InheritedPermissions::generateCacheKey() — Method in class InheritedPermissions

Creates a cache key for a member and type

LoginAttempt::getByEmail() — Method in class LoginAttempt

Get all login attempts for the given email address

LoginForm::getAuthenticatorClass() — Method in class LoginForm

Returns the authenticator class name to use

LoginForm::getAuthenticatorName() — Method in class LoginForm

Return the title of the form for use in the frontend For tabs with multiple login methods, for example.

LoginForm::getFormFields() — Method in class LoginForm

Required FieldList creation on a LoginForm

LoginForm::getFormActions() — Method in class LoginForm

Required FieldList creation for the login actions on this LoginForm

LogoutForm::getFormFields() — Method in class LogoutForm

Build the FieldList for the logout form

LogoutForm::getFormActions() — Method in class LogoutForm

Build default logout form action FieldList

Member::getRequiresPasswordChangeOnNextLogin() — Method in class Member

Used to get the value for the reset password on next login checkbox

Member::generateAutologinTokenAndStoreHash() — Method in class Member

Generate an auto login token which can be used to reset the password, at the same time hashing it and storing in the database.

Member::getMemberFormFields() — Method in class Member

Returns the fields for the member form - used in the registration/profile module.

Member::getMemberPasswordField() — Method in class Member

Builds "Change / Create Password" field for this member

Member::getValidator() — Method in class Member

Returns the RequiredFields instance for the Member object. This Validator is used when saving a CMSProfileController or added to any form responsible for saving a users data.

Member::getCMSCompositeValidator() — Method in class Member

Member::getLastName() — Method in class Member

Simple proxy method to get the Surname property of the member

Member::getTitle() — Method in class Member

Get the complete name of the member, by default in the format ", ".

Member::get_title_sql() — Method in class Member

Return a SQL CONCAT() fragment suitable for a SELECT statement.

Member::getName() — Method in class Member

Get the complete name of the member

Member::getDateFormat() — Method in class Member

Return the date format based on the user's chosen locale, falling back to the default format defined by the i18n::config()->get('default_locale') config setting.

Member::getLocale() — Method in class Member

Get user locale, falling back to the configured default locale

Member::getTimeFormat() — Method in class Member

Return the time format based on the user's chosen locale, falling back to the default format defined by the i18n::config()->get('default_locale') config setting.

Member::Groups() — Method in class Member

Get a "many-to-many" map that holds for all members their group memberships, including any parent groups where membership is implied.

Member::getCMSFields() — Method in class Member

Return a FieldList of fields that would appropriate for editing this member.

Member::getHtmlEditorConfigForCMS() — Method in class Member

Get the HtmlEditorConfig for this user to be used in the CMS.

Member::generateRandomPassword() — Method in class Member

Generate a random password and validate it against the current password validator if one is set

CMSLoginHandler::getReturnReferer() — Method in class CMSLoginHandler

CMSMemberAuthenticator::getLoginHandler() — Method in class CMSMemberAuthenticator

CMSMemberLoginForm::getFormFields() — Method in class CMSMemberLoginForm

CMSMemberLoginForm::getFormActions() — Method in class CMSMemberLoginForm

CMSMemberLoginForm::getExternalLink() — Method in class CMSMemberLoginForm

Get link to use for external security actions

CMSMemberLoginForm::getAuthenticatorName() — Method in class CMSMemberLoginForm

ChangePasswordForm::getFormFields() — Method in class ChangePasswordForm

ChangePasswordForm::getFormActions() — Method in class ChangePasswordForm

CookieAuthenticationHandler::getDeviceCookieName() — Method in class CookieAuthenticationHandler

Get the name of the cookie used to track this device

CookieAuthenticationHandler::getTokenCookieName() — Method in class CookieAuthenticationHandler

Get the name of the cookie used to store an login token

CookieAuthenticationHandler::getTokenCookieSecure() — Method in class CookieAuthenticationHandler

Get the name of the cookie used to store an login token

CookieAuthenticationHandler::getCascadeInTo() — Method in class CookieAuthenticationHandler

Once a member is found by authenticateRequest() pass it to this identity store

LoginHandler::getReturnReferer() — Method in class LoginHandler

LostPasswordForm::getFormFields() — Method in class LostPasswordForm

Create a single EmailField form that has the capability of using the MemberLoginForm Authenticator

LostPasswordForm::getFormActions() — Method in class LostPasswordForm

Give the member a friendly button to push

LostPasswordHandler::getMemberFromData() — Method in class LostPasswordHandler

Load an existing Member from the provided data

MemberAuthenticator::getLostPasswordHandler() — Method in class MemberAuthenticator

MemberAuthenticator::getChangePasswordHandler() — Method in class MemberAuthenticator

MemberAuthenticator::getLoginHandler() — Method in class MemberAuthenticator

MemberAuthenticator::getLogoutHandler() — Method in class MemberAuthenticator

MemberLoginForm::getFormFields() — Method in class MemberLoginForm

Build the FieldList for the login form

MemberLoginForm::getFormActions() — Method in class MemberLoginForm

Build default login form action FieldList

MemberLoginForm::getAuthenticatorName() — Method in class MemberLoginForm

The name of this login form, to display in the frontend Replaces Authenticator::get_name()

SessionAuthenticationHandler::getSessionVariable() — Method in class SessionAuthenticationHandler

Get the session variable name used to track member ID

$ MemberCsvBulkLoader#groups — Property in class MemberCsvBulkLoader

MemberCsvBulkLoader::getGroups() — Method in class MemberCsvBulkLoader

Member_GroupSet::getMember() — Method in class Member_GroupSet

Get foreign member record for this relation

Member_Validator::getForMember() — Method in class Member_Validator

Get the member this validator applies to.

NullSecurityToken::getValue() — Method in class NullSecurityToken

NullSecurityToken::generate() — Method in class NullSecurityToken

PasswordEncryptor::get_encryptors() — Method in class PasswordEncryptor

PasswordEncryptor_Blowfish::get_cost() — Method in class PasswordEncryptor_Blowfish

Gets the cost that is set for the blowfish algorithm

PasswordEncryptor_PHPHash::getAlgorithm() — Method in class PasswordEncryptor_PHPHash

PasswordValidator::getMinLength() — Method in class PasswordValidator

PasswordValidator::getMinTestScore() — Method in class PasswordValidator

PasswordValidator::getTestNames() — Method in class PasswordValidator

Gets the list of tests to use for this validator

PasswordValidator::getHistoricCount() — Method in class PasswordValidator

PasswordValidator::getTests() — Method in class PasswordValidator

Gets all possible tests

Permission::groupList() — Method in class Permission

Get the list of groups that the given member belongs to.

Permission::grant() — Method in class Permission

Grant the given permission code/arg to the given group

Permission::get_members_by_permission() — Method in class Permission

Returns all members for a specific permission.

Permission::get_groups_by_permission() — Method in class Permission

Return all of the groups that have one of the given permission codes

Permission::get_codes() — Method in class Permission

Get a list of all available permission codes, both defined through the PermissionProvider interface, and all not explicitly defined codes existing as a Permission database record. By default, the results are grouped as denoted by Permission_Group.

Permission::get_template_global_variables() — Method in class Permission

Permission::Group() — Method in class Permission

PermissionCheckboxSetField::getHiddenPermissions() — Method in class PermissionCheckboxSetField

PermissionRole::getCMSFields() — Method in class PermissionRole

Centerpiece of every data administration interface in Silverstripe, which returns a FieldList} suitable for a {@link Form object.

Permission_Group::getName() — Method in class Permission_Group

Get the name of the permission group

Permission_Group::getPermissions() — Method in class Permission_Group

Get permissions

RememberLoginHash::getToken() — Method in class RememberLoginHash

RememberLoginHash::getNewDeviceID() — Method in class RememberLoginHash

Randomly generates a new ID used for the device

RememberLoginHash::getNewHash() — Method in class RememberLoginHash

Creates a new random token and hashes it using the member information

RememberLoginHash::generate() — Method in class RememberLoginHash

Generates a new login hash associated with a device The device is assigned a globally unique device ID The returned login hash stores the hashed token in the database, for this device and this member

RequestAuthenticationHandler::getHandlers() — Method in class RequestAuthenticationHandler

This method currently uses a fallback as loading the handlers via YML has proven unstable

Security::getAuthenticators() — Method in class Security

Security::getAuthenticator() — Method in class Security

Get the selected authenticator for this request

Security::getApplicableAuthenticators() — Method in class Security

Get all registered authenticators

Security::getCurrentUser() — Method in class Security

Security::getRequest() — Method in class Security

Returns the HTTPRequest object that this controller is using.

Security::getResponseController() — Method in class Security

Prepare the controller for handling the response to this request

Security::generateTabbedFormSet() — Method in class Security

Combine the given forms into a formset with a tabbed interface

Security::getSessionMessage() — Method in class Security

Get the HTML Content for the $Content area during login

Security::getServiceAuthenticatorsFromRequest() — Method in class Security

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

Security::getPasswordResetLink() — Method in class Security

Create a link to the password reset form.

Security::getTemplatesFor() — Method in class Security

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

Security::get_template_global_variables() — Method in class Security

Defines global accessible templates variables.

SecurityToken::get_default_name() — Method in class SecurityToken

SecurityToken::getSecurityID() — Method in class SecurityToken

Returns the value of an the global SecurityToken in the current session

SecurityToken::getName() — Method in class SecurityToken

SecurityToken::getValue() — Method in class SecurityToken

SecurityToken::getSession() — Method in class SecurityToken

Returns the current session instance from the injector

SecurityToken::getRequestToken() — Method in class SecurityToken

Get security token from request

SecurityToken::generate() — Method in class SecurityToken

SecurityToken::get_template_global_variables() — Method in class SecurityToken

SudoModeService::getLifetime() — Method in class SudoModeService

How long the sudo mode activation lasts for in minutes.

SudoModeServiceInterface::getLifetime() — Method in class SudoModeServiceInterface

How long the sudo mode activation lasts for in minutes.

SessionManagerField::getTitleLinkText() — Method in class SessionManagerField

Returns the field titleLinkText.

SessionManagerField::getTitleLinkHref() — Method in class SessionManagerField

Returns the field titleLinkHref.

SessionManagerField::getSchemaDataDefaults() — Method in class SessionManagerField

SessionManagerField::getLoginSessions() — Method in class SessionManagerField

GarbageCollectionJob — Class in namespace SilverStripe\SessionManager\Jobs

GarbageCollectionJob::getTitle() — Method in class GarbageCollectionJob

LoginSession::generate() — Method in class LoginSession

LoginSession::getFriendlyUserAgent() — Method in class LoginSession

LoginSession::getCurrentLoginSession() — Method in class LoginSession

Retrieve the Login session for the current request.

LoginSession::getCurrentSessions() — Method in class LoginSession

LoginSession::getMaxAge() — Method in class LoginSession

Get the max age for all valid sessions

LoginSession::getSessionLifetime() — Method in class LoginSession

LogInAuthenticationHandler::getSessionVariable() — Method in class LogInAuthenticationHandler

LogInAuthenticationHandler::getRememberLoginHash() — Method in class LogInAuthenticationHandler

GarbageCollectionService — Class in namespace SilverStripe\SessionManager\Services

ShareDraftController::getIsViewingPreview() — Method in class ShareDraftController

ShareDraftController::getIsDraftSecured() — Method in class ShareDraftController

Check if the draft site is secured

ShareDraftContentControllerExtension::getShareDraftLinkAction() — Method in class ShareDraftContentControllerExtension

ShareDraftContentSiteTreeExtension::getNewShareToken() — Method in class ShareDraftContentSiteTreeExtension

ShareDraftContentSiteTreeExtension::getNewToken() — Method in class ShareDraftContentSiteTreeExtension

ShareDraftContentSiteTreeExtension::generateKey() — Method in class ShareDraftContentSiteTreeExtension

ShareDraftContentSiteTreeExtension::getShareDraftLinkAction() — Method in class ShareDraftContentSiteTreeExtension

SiteConfig::getCMSFields() — Method in class SiteConfig

Get the fields that are sent to the CMS.

SiteConfig::getCMSActions() — Method in class SiteConfig

Get the actions that are sent to the CMS.

SiteConfig::get_template_global_variables() — Method in class SiteConfig

Add $SiteConfig to all SSViewers

SiteConfigLeftAndMain::getEditForm() — Method in class SiteConfigLeftAndMain

GridFieldBasicContentReport — Class in namespace SilverStripe\SiteWideContentReport\Form

Class GridFieldBasicContentReport

GridFieldBasicContentReport::getRowAttributes() — Method in class GridFieldBasicContentReport

SitewideContentReport::getCount() — Method in class SitewideContentReport

counts the number of objects returned

SitewideContentReport::getCMSFields() — Method in class SitewideContentReport

SitewideContentReport::getReportField() — Method in class SitewideContentReport

Creates a GridField for pages and another one for files with different columns.

SitewideContentReport::getPrintExportColumns() — Method in class SitewideContentReport

Returns the columns for the export and print functionality.

SitewideContentReport::getExportButton() — Method in class SitewideContentReport

EditableSpamProtectionField::getFormField() — Method in class EditableSpamProtectionField

Return a FormField to appear on the front end. Implement on your subclass.

EditableSpamProtectionField::getCandidateFields() — Method in class EditableSpamProtectionField

Gets the list of all candidate spam detectable fields on this field's form

EditableSpamProtectionField::getCMSFields() — Method in class EditableSpamProtectionField

Used in userforms 3.x and above

EditableSpamProtectionField::getFieldValidationOptions() — Method in class EditableSpamProtectionField

Append custom validation fields to the default 'Validation' section in the editable options view

EditableSpamProtectionField::getRequired() — Method in class EditableSpamProtectionField

EditableSpamProtectionField::getIcon() — Method in class EditableSpamProtectionField

Get the path to the icon for this field type, relative to the site root.

FormSpamProtectionExtension::get_protector() — Method in class FormSpamProtectionExtension

Instantiate a SpamProtector instance

SpamProtector::getFormField() — Method in class SpamProtector

Return the FormField associated with this protector.

StaticPublisher::getPublishedURLs() — Method in class StaticPublisher

SiteTreePublishingEngine::getToUpdate() — Method in class SiteTreePublishingEngine

SiteTreePublishingEngine::getToDelete() — Method in class SiteTreePublishingEngine

PublishableSiteTree::getMyVirtualPages() — Method in class PublishableSiteTree

Job::getRunAsMemberID() — Method in class Job

Static cache manipulation jobs need to run without a user this is because we don't want any session related data to become part of URLs For example stage GET param is injected into URLs when user is logged in This is problematic as stage param must not be present in statically published URLs as they always refer to live content Including stage param in visiting URL is meant to bypass static cache and redirect to admin login this is something we definitely don't want for statically cached pages

Job::getSignature() — Method in class Job

Return a signature for this queued job

Job::getUrlsPerJob() — Method in class Job

Job::getChunkSize() — Method in class Job

DeleteStaticCacheJob::getTitle() — Method in class DeleteStaticCacheJob

DeleteWholeCache::getTitle() — Method in class DeleteWholeCache

GenerateStaticCacheJob — Class in namespace SilverStripe\StaticPublishQueue\Job

Add pages to static cache based on list of URLs

GenerateStaticCacheJob::getTitle() — Method in class GenerateStaticCacheJob

StaticCacheFullBuildJob::getTitle() — Method in class StaticCacheFullBuildJob

StaticCacheFullBuildJob::getSignature() — Method in class StaticCacheFullBuildJob

Return a signature for this queued job

StaticCacheFullBuildJob::getAllLivePageURLs() — Method in class StaticCacheFullBuildJob

Publisher::generatePageResponse() — Method in class Publisher

Publisher::getHTTPApplication() — Method in class Publisher

Publisher::generatePHPCacheFile() — Method in class Publisher

Generate the templated content for a PHP script that can serve up the given piece of content with the given age and expiry.

Publisher::generateHTMLCacheRedirection() — Method in class Publisher

FilesystemPublisher::getDestPath() — Method in class FilesystemPublisher

FilesystemPublisher::getDestFolder() — Method in class FilesystemPublisher

FilesystemPublisher::getFileExtension() — Method in class FilesystemPublisher

FilesystemPublisher::getPublishedURLs() — Method in class FilesystemPublisher

UrlBundleInterface::getJobsForUrls() — Method in class UrlBundleInterface

Package URLs into jobs

UrlBundleService::getJobsForUrls() — Method in class UrlBundleService

Package URLs into jobs

UrlBundleService::getUrls() — Method in class UrlBundleService

Get URLs for further processing

SubsiteAdmin::getEditForm() — Method in class SubsiteAdmin

SubsiteXHRController::getResponseNegotiator() — Method in class SubsiteXHRController

GroupSubsites — Class in namespace SilverStripe\Subsites\Extensions

Extension for the Group object to add subsites support

LeftAndMainSubsites::get_template_global_variables() — Method in class LeftAndMainSubsites

LeftAndMainSubsites::getCMSTreeTitle() — Method in class LeftAndMainSubsites

Set the title of the CMS tree

GridFieldSubsiteDetailForm — Class in namespace SilverStripe\Subsites\Forms

GridFieldSubsiteDetailFormItemRequest — Class in namespace SilverStripe\Subsites\Forms

SubsitesTreeDropdownField::getSubsiteId() — Method in class SubsitesTreeDropdownField

Get the subsite ID to use when generating the tree

InitStateMiddleware::getIsAdmin() — Method in class InitStateMiddleware

Determine whether the website is being viewed from an admin protected area or not

Subsite::getSubsiteIDForDomain() — Method in class Subsite

Get a matching subsite for the given host, or for the current HTTP_HOST.

Subsite::get_from_all_subsites() — Method in class Subsite

Subsite::getCMSFields() — Method in class Subsite

Show the configuration fields for each subsite

Subsite::getPageTypeMap() — Method in class Subsite

Return a list of the different page types available to the CMS

Subsite::getLanguage() — Method in class Subsite

Subsite::getPrimarySubsiteDomain() — Method in class Subsite

Finds the primary {SubsiteDomain} object for this subsite

Subsite::getPrimaryDomain() — Method in class Subsite

Subsite::getMembersByPermission() — Method in class Subsite

SubsiteDomain::getTitle() — Method in class SubsiteDomain

Get the descriptive title for this domain

SubsiteDomain::getCMSFields() — Method in class SubsiteDomain

SubsiteDomain::getFullProtocol() — Method in class SubsiteDomain

Gets the full protocol (including ://) for this domain

SubsiteDomain::getSubstitutedDomain() — Method in class SubsiteDomain

Retrieves domain name with wildcards substituted with actual values

SubsiteDomain::getAbsoluteLink() — Method in class SubsiteDomain

Get absolute link for this domain

SubsitesVirtualPage::getCMSFields() — Method in class SubsitesVirtualPage

Generate the CMS fields from the fields from the original page.

SubsitesVirtualPage::getCopyContentFromID_SubsiteID() — Method in class SubsitesVirtualPage

SubsitesVirtualPage::getVirtualFields() — Method in class SubsitesVirtualPage

Generates the array of fields required for the page type.

ThemeResolver::getThemeList() — Method in class ThemeResolver

Get the list of themes for the given sub site that can be given to SSViewer::set_themes

ThemeResolver::getCustomThemeOptions() — Method in class ThemeResolver

Get a list of custom cascading theme definitions if available

SubsiteState::getSubsiteId() — Method in class SubsiteState

Get the current subsite ID

SubsiteState::getUseSessions() — Method in class SubsiteState

Get whether to use sessions for storing the subsite ID

SubsiteState::getSubsiteIdWasChanged() — Method in class SubsiteState

Get whether the subsite ID has been changed during a request, based on the original and current IDs

Method::getName() — Method in class Method

Provide a localised name for this MFA Method.

Method::getURLSegment() — Method in class Method

Get a URL segment for this method. This will be used in URL paths for performing authentication by this method

Method::getVerifyHandler() — Method in class Method

Return the VerifyHandler that is used to start and check verification attempts with this method

Method::getRegisterHandler() — Method in class Method

Return the RegisterHandler that is used to perform registrations with this method

Method::getThumbnail() — Method in class Method

Return a URL to an image to be used as a thumbnail in the MFA login/registration grid for all MFA methods

Method::getUnavailableMessage() — Method in class Method

If not available to be used, provide a message to display on the frontend to explain why.

Method::getCodeLength() — Method in class Method

Get the length of the TOTP code

RegisterHandler::generateSecret() — Method in class RegisterHandler

Generates a TOTP secret to the configured maximum length

RegisterHandler::getDescription() — Method in class RegisterHandler

Provide a localised description of this MFA Method.

RegisterHandler::getSupportLink() — Method in class RegisterHandler

Provide a localised URL to a support article about the registration process for this MFA Method.

RegisterHandler::getSupportText() — Method in class RegisterHandler

Provide a localised string to describe the support link {getSupportLink} about this MFA Method.

RegisterHandler::getComponent() — Method in class RegisterHandler

Get the key that a React UI component is registered under (with @silverstripe/react-injector on the front-end)

TOTPAware::getEncryptionKey() — Method in class TOTPAware

Gets the encryption key to use from environment variables. This is generated by default on the Common Web Platform, but can be defined as a custom value if required.

TOTPAware::getTotp() — Method in class TOTPAware