A

GridFieldDropdownFilter::addFilterOption() — Method in class GridFieldDropdownFilter

Add an option to the dropdown that provides a filter

$ GridFieldRefreshButton#allowed_actionsProperty in class GridFieldRefreshButton
CheckForUpdatesJob::afterComplete() — Method in class CheckForUpdatesJob
Package::addBadge() — Method in class Package

Adds a badge to the list of badges {see $badges}

$ UpdatePackageInfoTask#allowed_typesProperty in class UpdatePackageInfoTask

The "types" of composer libraries that will be processed. Anything without these types will be ignored.

ApiLoaderClass in namespace BringYourOwnIdeas\Maintenance\Util

Handles fetching supported addon details from addons.silverstripe.org

CwpCommentingExtension::alterCommentForm() — Method in class CwpCommentingExtension
DatedUpdateHolder::AllUpdates() — Method in class DatedUpdateHolder

Find all site's updates, based on some filters.

DatedUpdateHolderController::AllTagsLink() — Method in class DatedUpdateHolderController

Build the link - keep the date range, reset the rest.

DatedUpdateHolderController::AvailableMonths() — Method in class DatedUpdateHolderController

Extract the available months based on the current query.

DatedUpdateHolderController::atom() — Method in class DatedUpdateHolderController
EventHolder::AllUpdates() — Method in class EventHolder

Find all site's news items, based on some filters.

NewsHolder::AllUpdates() — Method in class NewsHolder

Find all site's news items, based on some filters.

NewsHolderController::atom() — Method in class NewsHolderController
ArchiveHandlerClass in namespace Colymba\BulkManager\BulkAction

Bulk action handler for recursive archiving records.

ArchiveHandler::archive() — Method in class ArchiveHandler

Archive the selected records passed from the archive bulk action.

BulkManager::addBulkAction() — Method in class BulkManager

Lets you add custom bulk actions to the bulk manager interface.

BulkManager::augmentColumns() — Method in class BulkManager

Add bulk select column.

HTTPBulkToolsResponse::addHeader() — Method in class HTTPBulkToolsResponse

Overridden here so content-type cannot be changed Add a HTTP header to the response, replacing any header of the same name.

HTTPBulkToolsResponse::addSuccessRecord() — Method in class HTTPBulkToolsResponse

Add a record to the successfully modified list

HTTPBulkToolsResponse::addSuccessRecords() — Method in class HTTPBulkToolsResponse

Add a list of records to the successfully modified list

HTTPBulkToolsResponse::addFailedRecord() — Method in class HTTPBulkToolsResponse

Add a record to the failed to modified list with its error message

HTTPBulkToolsResponse::addFailedRecords() — Method in class HTTPBulkToolsResponse

Add a list of records to the failed to modified list with a common error message

BulkUploadHandler::attach() — Method in class BulkUploadHandler

Retrieve File to be attached and generated DataObject.

ElementalSubsiteExtension::augmentSQL() — Method in class ElementalSubsiteExtension

Update any requests for elements to limit the results to the current site

ElementalAreaController::apiSaveForm() — Method in class ElementalAreaController

Save an inline edit form for a block

AddElementToAreaMutationClass in namespace DNADesign\Elemental\GraphQL
AddElementToAreaMutation::attributes() — Method in class AddElementToAreaMutation
AddElementToAreaMutation::args() — Method in class AddElementToAreaMutation
DeleteBlocksMutation::attributes() — Method in class DeleteBlocksMutation
DeleteBlocksMutation::args() — Method in class DeleteBlocksMutation
DuplicateElementMutation::attributes() — Method in class DuplicateElementMutation
DuplicateElementMutation::args() — Method in class DuplicateElementMutation
SortBlockMutationCreator::attributes() — Method in class SortBlockMutationCreator
SortBlockMutationCreator::args() — Method in class SortBlockMutationCreator
BaseElement::AbsoluteLink() — Method in class BaseElement
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.

CacheAfterCallAspect::afterCall() — Method in class CacheAfterCallAspect

Logs all hits/misses after a CacheInterface::get call is made.

PartialCacheCollector::addTemplateCache() — Method in class PartialCacheCollector

Adds an item to the templateCache array

DebugBar::allowAllEnvironments() — Method in class DebugBar
ControllerExtension::afterCallActionHandler() — Method in class ControllerExtension
LeftAndMainExtension::accessedCMS() — Method in class LeftAndMainExtension
PhockitoClassManifestUpdater::addDouble() — Method in class PhockitoClassManifestUpdater
AdminErrorExtensionClass in namespace SilverStripe\Admin
AdminRootControllerClass in namespace SilverStripe\Admin
AdminRootController::admin_url() — Method in class AdminRootController

Returns the root admin URL for the site with trailing slash

CMSBatchAction::applicablePagesHelper() — Method in class CMSBatchAction

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

CMSBatchAction::applicablePages() — Method in class CMSBatchAction

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

CMSMenu::add_controller() — Method in class CMSMenu

Add a LeftAndMain controller to the CMS menu.

CMSMenu::add_link() — Method in class CMSMenu

Add an arbitrary URL to the CMS menu.

CMSMenu::add_menu_item() — Method in class CMSMenu

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

$ UsedOnTable#allowed_actionsProperty in class UsedOnTable
$ LeftAndMain#admin_themesProperty in class LeftAndMain

Themes to use within the CMS

$ LeftAndMain#application_linkProperty in class LeftAndMain

The href for the anchor on the Silverstripe logo

$ LeftAndMain#application_nameProperty in class LeftAndMain

The application name

LeftAndMain::afterHandleRequest() — Method in class LeftAndMain
LeftAndMain::ApplicationLink() — Method in class LeftAndMain
LeftAndMainExtension::accessedCMS() — Method in class LeftAndMainExtension
LeftAndMainExtension::augmentNewSiteTreeItem() — Method in class LeftAndMainExtension
AkismetFieldClass in namespace SilverStripe\Akismet

Form field to handle akismet error display and handling

AkismetSpamProtectorClass in namespace SilverStripe\Akismet

Spam protector for Akismet

$ AkismetSpamProtector#api_keyProperty in class AkismetSpamProtector

Set this to your API key

AkismetConfigClass in namespace SilverStripe\Akismet\Config

Extends {see SiteConfig} to allow akismet key to be set via the CMS

AkismetMiddlewareClass in namespace SilverStripe\Akismet\Config

Allows akismet to be configured via siteconfig instead of hard-coded configuration

AkismetServiceClass in namespace SilverStripe\Akismet\Service

Describes TijsVerkoyen\Akismet\Akismet

AkismetServiceBackendClass in namespace SilverStripe\Akismet\Service

Applies AkismetService to TijsVerkoyen\Akismet\Akismet

AssetAdminClass in namespace SilverStripe\AssetAdmin\Controller

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

AssetAdmin::apiCreateFile() — Method in class AssetAdmin

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

AssetAdmin::apiUploadFile() — Method in class AssetAdmin

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

AssetAdmin::apiHistory() — Method in class AssetAdmin

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

AssetAdmin::addtocampaign() — Method in class AssetAdmin

Action handler for adding pages to a campaign

AssetAdmin::addToCampaignForm() — Method in class AssetAdmin

Url handler for add to campaign form

AssetAdminFieldsExtensionClass in namespace SilverStripe\AssetAdmin\Controller
AssetAdminFileClass in namespace SilverStripe\AssetAdmin\Controller

Update File dataobjects to be editable in this asset admin

AssetFormFactoryClass in namespace SilverStripe\AssetAdmin\Forms
$ UploadField#allowed_actionsProperty in class UploadField
CreateFileMutationCreator::attributes() — Method in class CreateFileMutationCreator
CreateFileMutationCreator::args() — Method in class CreateFileMutationCreator
CreateFolderMutationCreator::attributes() — Method in class CreateFolderMutationCreator
CreateFolderMutationCreator::args() — Method in class CreateFolderMutationCreator
DeleteFileMutationCreator::attributes() — Method in class DeleteFileMutationCreator
DeleteFileMutationCreator::args() — Method in class DeleteFileMutationCreator
DescendantFileCountType::attributes() — Method in class DescendantFileCountType
FileFilterInputTypeCreator::attributes() — Method in class FileFilterInputTypeCreator
FileInputTypeCreator::attributes() — Method in class FileInputTypeCreator
FileInterfaceTypeCreator::attributes() — Method in class FileInterfaceTypeCreator
FileTypeCreator::attributes() — Method in class FileTypeCreator
FileUsageType::attributes() — Method in class FileUsageType
FolderInputTypeCreator::attributes() — Method in class FolderInputTypeCreator
FolderTypeCreator::attributes() — Method in class FolderTypeCreator
MoveFilesMutationCreator::attributes() — Method in class MoveFilesMutationCreator
MoveFilesMutationCreator::args() — Method in class MoveFilesMutationCreator
PublicationMutationCreator::attributes() — Method in class PublicationMutationCreator
PublicationMutationCreator::args() — Method in class PublicationMutationCreator
PublicationNoticeType::attributes() — Method in class PublicationNoticeType
ReadDescendantFileCountsQueryCreator::attributes() — Method in class ReadDescendantFileCountsQueryCreator
ReadDescendantFileCountsQueryCreator::args() — Method in class ReadDescendantFileCountsQueryCreator
ReadFileQueryCreator::attributes() — Method in class ReadFileQueryCreator
ReadFileUsageQueryCreator::attributes() — Method in class ReadFileUsageQueryCreator
ReadFileUsageQueryCreator::args() — Method in class ReadFileUsageQueryCreator
AssetAdminResolverClass in namespace SilverStripe\AssetAdmin\GraphQL\Resolvers
UpdateFileMutationCreator::attributes() — Method in class UpdateFileMutationCreator
UpdateFileMutationCreator::args() — Method in class UpdateFileMutationCreator
AssetControlExtensionClass 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.

AssetManipulationListClass 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_extensionsProperty in class File
$ File#app_categoriesProperty in class File
$ File#apply_restrictions_to_adminProperty 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.

AssetAdapterClass in namespace SilverStripe\Assets\Flysystem

Adapter for local filesystem based on assets directory

$ ImageManipulation#asset_preview_widthProperty in class ImageManipulation

The width of an image preview in the Asset section

$ ImageManipulation#asset_preview_heightProperty in class ImageManipulation

The height of an image preview in the Asset section

FileLinkTracking::augmentSyncLinkTracking() — Method in class FileLinkTracking

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

$ FileShortcodeProvider#allow_session_grantProperty in class FileShortcodeProvider

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

$ ImageShortcodeProvider#attribute_whitelistProperty in class ImageShortcodeProvider

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

AssetContainerClass in namespace SilverStripe\Assets\Storage

Represents a container for a specific asset.

AssetNameGeneratorClass in namespace SilverStripe\Assets\Storage

Provides a mechanism for suggesting filename alterations to a file

AssetStoreClass in namespace SilverStripe\Assets\Storage

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

AssetStoreRouterClass in namespace SilverStripe\Assets\Storage

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

DBFile::AbsoluteLink() — Method in class DBFile

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

$ Upload_Validator#allowedMaxFileSizeProperty 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#allowedExtensionsProperty in class Upload_Validator
AuditFactoryClass in namespace SilverStripe\Auditor

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

AuditHookClass in namespace SilverStripe\Auditor

Provides logging hooks that are inserted into Framework objects.

AuditHook::afterMemberLoggedIn() — Method in class AuditHook

Log successful login attempts.

AuditHook::authenticationFailed() — Method in class AuditHook

Log failed login attempts.

AuditHook::afterMemberLoggedOut() — Method in class AuditHook

Log successful logout.

AuditHookMFAClass in namespace SilverStripe\Auditor

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

AuditHookManyManyListClass in namespace SilverStripe\Auditor
AuditHookMemberGroupSetClass in namespace SilverStripe\Auditor
AuditHookSessionManagerClass in namespace SilverStripe\Auditor

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

BasicContext::appendErrorHandlerBeforeStep() — Method in class BasicContext
FixtureContext::afterResetDatabase() — Method in class FixtureContext
FixtureContext::afterResetAssets() — Method in class FixtureContext
FixtureContext::aRecordWasLastEditedRelative() — Method in class FixtureContext
FixtureContext::afterResetConfig() — Method in class FixtureContext

Clean up all config files after scenario

GridFieldMergeAction::augmentColumns() — Method in class GridFieldMergeAction

Modify the list of columns displayed in the table.

BlogController::archive() — Method in class BlogController

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

$ BlogPost#AuthorNamesProperty in class BlogPost
BlogPost::Authors() — Method in class BlogPost
BlogPostFilter::augmentSQL() — Method in class BlogPostFilter

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

BlogPostFilter::augmentLoadLazyFields() — Method in class BlogPostFilter

{@inheritDoc}

$ BlogArchiveWidget#ArchiveTypeProperty in class BlogArchiveWidget
APIClientClass in namespace SilverStripe\CKANRegistry\Service
APIClientInterfaceClass in namespace SilverStripe\CKANRegistry\Service

A service responsible for communicating with a CKAN API endpoint

CMSBatchAction_Archive::applicablePages() — Method in class CMSBatchAction_Archive

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

CMSBatchAction_Publish::applicablePages() — Method in class CMSBatchAction_Publish

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

CMSBatchAction_Restore::applicablePages() — Method in class CMSBatchAction_Restore

{see SiteTree::canEdit()}

CMSBatchAction_Unpublish::applicablePages() — Method in class CMSBatchAction_Unpublish

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

CMSMain::archive() — Method in class CMSMain

Delete this page from both live and stage

CMSPageAddController::AddForm() — Method in class CMSPageAddController
CMSPageEditController::addtocampaign() — Method in class CMSPageEditController

Action handler for adding pages to a campaign

CMSPageEditController::AddToCampaignForm() — Method in class CMSPageEditController

Url handler for add to campaign form

AnchorLinkFormFactoryClass in namespace SilverStripe\CMS\Forms
AnchorSelectorFieldClass in namespace SilverStripe\CMS\Forms

Assists with selecting anchors on a given page

AnchorSelectorField::anchors() — Method in class AnchorSelectorField

Find all anchors available on the given page.

LinkablePlugin::apply() — Method in class LinkablePlugin
LinkablePlugin::applyLinkFilter() — Method in class LinkablePlugin
$ SiteTree#allowed_childrenProperty in class SiteTree

Indicates what kind of children this page type can have.

SiteTree::AbsoluteLink() — Method in class SiteTree

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

SiteTree::allowedChildren() — Method in class SiteTree

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

SiteTreeLinkTracking::augmentSyncLinkTracking() — Method in class SiteTreeLinkTracking

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

VirtualPage::allowedChildren() — Method in class VirtualPage
VirtualPage::allMethodNames() — Method in class VirtualPage

{@inheritdoc}

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

AddToCampaignValidatorClass in namespace SilverStripe\CampaignAdmin
CommentsGridFieldAction::augmentColumns() — Method in class CommentsGridFieldAction

Modify the list of columns displayed in the table.

CommentsGridFieldApproveAction::augmentColumns() — Method in class CommentsGridFieldApproveAction

Modify the list of columns displayed in the table.

ApproveHandlerClass in namespace SilverStripe\Comments\Admin\CommentsGridFieldBulkAction

A {@link Handler} for bulk approving comments

Handler::approve() — Method in class Handler
CommentsGridFieldSpamAction::augmentColumns() — Method in class CommentsGridFieldSpamAction

Modify the list of columns displayed in the table.

CommentingController::approve() — Method in class CommentingController

Marks a given {@link Comment} as approved.

CommentsExtension::AllComments() — Method in class CommentsExtension

Returns the RelationList of all comments against this object. Can be used as a data source for a gridfield with write access.

CommentsExtension::AllVisibleComments() — Method in class CommentsExtension

Returns all comments against this object, with with spam and unmoderated items excluded, for use in the frontend

CommentsExtension::attachedToSiteTree() — Method in class CommentsExtension

Returns whether this extension instance is attached to a {@link SiteTree} object

$ Comment#AllowHtmlProperty in class Comment

If true, treat $Comment as HTML instead of plain text

Comment::ApproveLink() — Method in class Comment

Link to approve this comment

Comment::AllReplies() — Method in class Comment

Returns the list of all replies

Comment::Author() — Method in class Comment

Member object who created this comment

SecurityToken::addToUrl() — Method in class SecurityToken
ConfigCollectionInterface::addMiddleware() — Method in class ConfigCollectionInterface
MiddlewareAware::addMiddleware() — Method in class MiddlewareAware
YamlTransformer::addRule() — Method in class YamlTransformer

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

SiteTreeContentReview::addReviewNote() — Method in class SiteTreeContentReview

Creates a ContentReviewLog and connects it to this Page.

SiteTreeContentReview::advanceReviewDate() — Method in class SiteTreeContentReview

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

$ Director#alternate_base_folderProperty in class Director
$ Director#alternate_public_dirProperty in class Director

Override PUBLIC_DIR. Set to a non-null value to override.

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_emailProperty in class Email

This will be set in the config on a site-by-site basis

Email::addFrom() — Method in class Email
Email::addTo() — Method in class Email
Email::addCC() — Method in class Email
Email::addBCC() — Method in class Email
Email::addReplyTo() — Method in class Email
Email::addAttachment() — Method in class Email
Email::addAttachmentFromData() — Method in class Email
Email::addData() — Method in class Email
HTTP::absoluteURLs() — Method in class HTTP

Turn all relative URLs in the content to absolute URLs.

HTTP::add_cache_headers() — Method in class HTTP

Add the appropriate caching headers to the response, including If-Modified-Since / 304 handling.

HTTP::augmentState() — Method in class HTTP

Ensure that all deprecated HTTP cache settings are respected

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.

AllowedHostsMiddlewareClass in namespace SilverStripe\Control\Middleware

Secures requests by only allowing a whitelist of Host values

AjaxBypassClass 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_directivesProperty in class HTTPCacheControlMiddleware

A list of allowed cache directives for HTTPResponses

HTTPCacheControlMiddleware::addVary() — Method in class HTTPCacheControlMiddleware

Add a vary

HTTPCacheControlMiddleware::applyToResponse() — Method in class HTTPCacheControlMiddleware

Generate all headers to add to this object

HTTPMiddlewareAware::addMiddleware() — Method in class HTTPMiddlewareAware
RSSFeed_Entry::Author() — Method in class RSSFeed_Entry

Get the author of this entry

RSSFeed_Entry::AbsoluteLink() — Method in class RSSFeed_Entry

Get a link to this entry

$ RequestHandler#allowed_actionsProperty in class RequestHandler

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

RequestHandler::allowedActions() — Method in class RequestHandler

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

Session::addToArray() — Method in class Session

Merge value with array

ApplicationClass 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

ApcuCacheFactoryClass in namespace SilverStripe\Core\Cache
ClassInfo::allClasses() — Method in class ClassInfo

Wrapper for classes getter.

ClassInfo::ancestry() — Method in class ClassInfo

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

ConfigLoader::activate() — Method in class ConfigLoader

Mark this instance as the current instance

Convert::array2json() — Method in class Convert

Encode an array as a JSON encoded string.

CustomMethods::allMethodNames() — Method in class CustomMethods

Return the names of all the methods available on this object

Extensible::add_extension() — Method in class Extensible

Add an extension to a specific class.

Extension::add_to_class() — Method in class Extension

Called when this extension is added to a particular class

AfterCallAspectClass 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

AopProxyServiceClass in namespace SilverStripe\Core\Injector

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

$ AopProxyService#afterCallProperty in class AopProxyService
Injector::addAutoProperty() — Method in class Injector

Add an object that should be automatically set on managed objects

InjectorLoader::activate() — Method in class InjectorLoader

Mark this instance as the current instance

Kernel::activate() — Method in class Kernel

Ensures this kernel is the active kernel after or during nesting

ManifestFileFinder::acceptDir() — Method in class ManifestFileFinder
Module::activate() — Method in class Module

Activate _config.php for this module, if one exists

ModuleManifest::addModule() — Method in class ModuleManifest

Adds a path as a module

ModuleManifest::activateConfig() — Method in class ModuleManifest

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

BulkLoader_Result::addCreated() — Method in class BulkLoader_Result
BulkLoader_Result::addUpdated() — Method in class BulkLoader_Result
BulkLoader_Result::addDeleted() — Method in class BulkLoader_Result
DevConfigController::audit() — Method in class DevConfigController

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

$ DevelopmentAdmin#allow_all_cliProperty in class DevelopmentAdmin

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

FixtureBlueprint::addCallback() — Method in class FixtureBlueprint

See class documentation.

FunctionalTest::assertPartialMatchBySelector() — Method in class FunctionalTest

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

FunctionalTest::assertExactMatchBySelector() — Method in class FunctionalTest

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

FunctionalTest::assertPartialHTMLMatchBySelector() — Method in class FunctionalTest

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

FunctionalTest::assertExactHTMLMatchBySelector() — Method in class FunctionalTest

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

DatabaseAdapterRegistry::autodiscover() — Method in class DatabaseAdapterRegistry

Detects all _register_database.php files and invokes them.

DatabaseAdapterRegistry::autoconfigure() — Method in class DatabaseAdapterRegistry

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

SapphireTest::assertContains() — Method in class SapphireTest
SapphireTest::assertNotContains() — Method in class SapphireTest
SapphireTest::assertEmailSent() — Method in class SapphireTest

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

SapphireTest::assertListContains() — Method in class SapphireTest

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

SapphireTest::assertDOSContains() — Method in class SapphireTest
SapphireTest::assertListNotContains() — Method in class SapphireTest

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

SapphireTest::assertNotDOSContains() — Method in class SapphireTest
SapphireTest::assertListEquals() — Method in class SapphireTest

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

SapphireTest::assertDOSEquals() — Method in class SapphireTest
SapphireTest::assertListAllMatch() — Method in class SapphireTest

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

SapphireTest::assertDOSAllMatch() — Method in class SapphireTest
SapphireTest::assertSQLEquals() — Method in class SapphireTest

Asserts that two SQL queries are equivalent

SapphireTest::assertSQLContains() — Method in class SapphireTest

Asserts that a SQL query contains a SQL fragment

SapphireTest::assertSQLNotContains() — Method in class SapphireTest

Asserts that a SQL query contains a SQL fragment

SapphireTest::actWithPermission() — Method in class SapphireTest

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

EnvironmentCheckSuiteResult::addResult() — Method in class EnvironmentCheckSuiteResult
CompositeValidator::addValidator() — Method in class CompositeValidator
FieldList::addFieldToTab() — Method in class FieldList

Add an extra field to a tab within this FieldList.

FieldList::addFieldsToTab() — Method in class FieldList

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

Form::actionIsValidationExempt() — Method in class Form

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

Form::Actions() — Method in class Form

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

Form::addExtraClass() — Method in class Form

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

FormAction::actionName() — Method in class FormAction

Get the action name

FormField::addExtraClass() — Method in class FormField

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

FormField::attrTitle() — Method in class FormField

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

FormField::attrValue() — Method in class FormField

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

$ FormRequestHandler#allowed_actionsProperty in class FormRequestHandler
$ FormScaffolder#ajaxSafeProperty in class FormScaffolder
FormScaffolder::addManyManyRelationshipFields() — Method in class FormScaffolder

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

AbstractGridFieldComponentClass in namespace SilverStripe\Forms\GridField
AbstractRequestAwareStoreClass in namespace SilverStripe\Forms\GridField\FormAction
AttributeStoreClass in namespace SilverStripe\Forms\GridField\FormAction

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

GridField::addAllStateToUrl() — Method in class GridField

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

GridField::addDataFields() — Method in class GridField

Add additional calculated data fields to be used on this GridField

GridFieldConfig::addComponent() — Method in class GridFieldConfig
GridFieldConfig::addComponents() — Method in class GridFieldConfig
GridFieldDataColumns::augmentColumns() — Method in class GridFieldDataColumns

Modify the list of columns displayed in the table.

GridFieldDeleteAction::augmentColumns() — Method in class GridFieldDeleteAction

Add a column 'Delete'

GridFieldEditButton::augmentColumns() — Method in class GridFieldEditButton

Add a column 'Delete'

GridFieldEditButton::addExtraClass() — Method in class GridFieldEditButton

Add an extra HTML class

GridFieldStateManager::addStateToURL() — Method in class GridFieldStateManager
GridFieldStateManagerInterface::addStateToURL() — Method in class GridFieldStateManagerInterface
GridFieldViewButton::augmentColumns() — Method in class GridFieldViewButton

Modify the list of columns displayed in the table.

GridField_ActionMenu::augmentColumns() — Method in class GridField_ActionMenu

Modify the list of columns displayed in the table.

GridField_ColumnProvider::augmentColumns() — Method in class GridField_ColumnProvider

Modify the list of columns displayed in the table.

GridState::array_to_object() — Method in class GridState
GridState::attrValue() — Method in class GridState
TinyMCEConfig::addButtonsToLine() — Method in class TinyMCEConfig

Add buttons to the end of a line

RequiredFields::addRequiredField() — Method in class RequiredFields

Adds a single required field to required fields stack.

RequiredFields::appendRequiredFields() — Method in class RequiredFields

Add {@link RequiredField} objects together

AbstractSegmentFieldModifierClass in namespace SilverStripe\Forms\SegmentFieldModifier
SearchCriteria::appendPreparedStatementTo() — Method in class SearchCriteria
SearchCriteria::addAnd() — Method in class SearchCriteria
SearchCriteria::addOr() — Method in class SearchCriteria
SearchCriteriaInterface::appendPreparedStatementTo() — Method in class SearchCriteriaInterface

The method used in all SearchCriterion to generate and append their filter query statements.

SearchCriterion::appendPreparedStatementTo() — Method in class SearchCriterion
SearchIndex::addClass() — Method in class SearchIndex

Add a DataObject subclass whose instances should be included in this index

SearchIndex::addFulltextField() — Method in class SearchIndex

Add a field that should be fulltext searchable

SearchIndex::addFilterField() — Method in class SearchIndex

Add a field that should be filterable

SearchIndex::addSortField() — Method in class SearchIndex

Add a field that should be sortable

SearchIndex::addAllFulltextFields() — Method in class SearchIndex

Add all database-backed text fields as fulltext searchable fields.

SearchIndex::add() — Method in class SearchIndex

!! These should be implemented by the full text search engine

SearchIndex_Null::add() — Method in class SearchIndex_Null

!! These should be implemented by the full text search engine

$ SearchIndex_Recording#addedProperty in class SearchIndex_Recording
SearchIndex_Recording::add() — Method in class SearchIndex_Recording

!! These should be implemented by the full text search engine

SearchUpdateCommitJobProcessor::afterComplete() — Method in class SearchUpdateCommitJobProcessor
SearchUpdateCommitJobProcessor::addMessage() — Method in class SearchUpdateCommitJobProcessor

Add an arbitrary text message into a job

SearchUpdateProcessor::addDirtyIDs() — Method in class SearchUpdateProcessor
SearchUpdateQueuedJobProcessor::afterComplete() — Method in class SearchUpdateQueuedJobProcessor
SearchUpdateQueuedJobProcessor::addMessage() — Method in class SearchUpdateQueuedJobProcessor

Add an arbitrary text message into a job

AbstractSearchQueryWriterClass in namespace SilverStripe\FullTextSearch\Search\Queries

Class AbstractSearchQueryWriter

SearchQuery::addSearchTerm() — Method in class SearchQuery
SearchQuery::addFuzzySearchTerm() — Method in class SearchQuery

Similar to {@link addSearchTerm()}, but uses stemming and other similarity algorithms to find the searched terms. For example, a term "fishing" would also likely find results containing "fish" or "fisher". Depends on search implementation.

SearchQuery::addClassFilter() — Method in class SearchQuery
SearchQuery::addFilter() — Method in class SearchQuery

Similar to {@link addSearchTerm()}, but typically used to further narrow down based on other facets which don't influence the field relevancy.

SearchQuery::addExclude() — Method in class SearchQuery

Excludes results which match these criteria, inverse of {@link addFilter()}.

SearchQuery::addCriteria() — Method in class SearchQuery
SearchIntrospection::add_unique_by_ancestor() — Method in class SearchIntrospection

Add classes to list, keeping only the parent when parent & child are both in list after add

SearchVariant::appliesToEnvironment() — Method in class SearchVariant

Return false if there is something missing from the environment (probably a not installed module) that means this variant can't apply to any class

SearchVariant::appliesTo() — Method in class SearchVariant

Return true if this variant applies to the passed class & subclass

SearchVariant::activateState() — Method in class SearchVariant

Activate the passed state

SearchVariant::alterQuery() — Method in class SearchVariant

Apply this variant to a search query

SearchVariant::activate_state() — Method in class SearchVariant

Activate all the states in the passed argument

SearchVariantSubsites::appliesToEnvironment() — Method in class SearchVariantSubsites

Return false if there is something missing from the environment (probably a not installed module) that means this variant can't apply to any class

SearchVariantSubsites::appliesTo() — Method in class SearchVariantSubsites

Return true if this variant applies to the passed class & subclass

SearchVariantSubsites::activateState() — Method in class SearchVariantSubsites

Activate the passed state

SearchVariantSubsites::alterDefinition() — Method in class SearchVariantSubsites
SearchVariantSubsites::alterQuery() — Method in class SearchVariantSubsites

This field has been altered to allow a user to obtain search results for a particular subsite When attempting to do this in project code, SearchVariantSubsites kicks and overwrites any filter you've applied This fix prevents the module from doing this if a filter is applied on the index or the query, or if a field is being excluded specifically before being executed.

SearchVariantVersioned::appliesTo() — Method in class SearchVariantVersioned

Return true if this variant applies to the passed class & subclass

SearchVariantVersioned::activateState() — Method in class SearchVariantVersioned

Activate the passed state

SearchVariantVersioned::alterDefinition() — Method in class SearchVariantVersioned
SearchVariantVersioned::alterQuery() — Method in class SearchVariantVersioned

Apply this variant to a search query

SolrReindexQueuedJobBase::afterComplete() — Method in class SolrReindexQueuedJobBase
SolrReindexQueuedJobBase::addMessage() — Method in class SolrReindexQueuedJobBase

Add an arbitrary text message into a job

Solr4Service_Core::addDocument() — Method in class Solr4Service_Core
Solr4Service_Core::addDocuments() — Method in class Solr4Service_Core

Solr 4.0 compat http://wiki.apache.org/solr/UpdateXmlMessages#Optional_attributes_for_.22add.22 Remove allowDups, overwritePending and overwriteComitted

SolrIndex::addAnalyzer() — Method in class SolrIndex

Index-time analyzer which is applied to a specific field.

SolrIndex::addStoredField() — Method in class SolrIndex

Add a field that should be stored

SolrIndex::addBoostedField() — Method in class SolrIndex

Add a fulltext field with a boosted value

SolrIndex::addCopyField() — Method in class SolrIndex
SolrIndex::add() — Method in class SolrIndex

!! These should be implemented by the full text search engine

AuthenticatorInterfaceClass in namespace SilverStripe\GraphQL\Auth

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

AuthenticatorInterface::authenticate() — Method in class AuthenticatorInterface

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

BasicAuthAuthenticator::authenticate() — Method in class BasicAuthAuthenticator

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

Configuration::apply() — Method in class Configuration
Controller::autobuildEnabled() — Method in class Controller
Controller::addCorsHeaders() — Method in class Controller

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

QueryRecorderExtension::augmentDataQueryCreation() — Method in class QueryRecorderExtension

Record query against a given class.

QueryHandler::addContextProvider() — Method in class QueryHandler
QueryHandler::addMiddleware() — Method in class QueryHandler
QueryHandlerInterface::addContextProvider() — Method in class QueryHandlerInterface
ApplyVersionFiltersClass in namespace SilverStripe\GraphQL\Resolvers
ApplyVersionFilters::applyToReadingState() — Method in class ApplyVersionFilters
ApplyVersionFilters::applyToList() — Method in class ApplyVersionFilters
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
AbstractBulkLoaderClass 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
AbstractTypeResolverClass in namespace SilverStripe\GraphQL\Schema\DataObject

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

$ FieldAccessor#allowed_aggregatesProperty 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
AbstractCanViewPermissionClass 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
ArgumentClass 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
AbstractQueryFilterPluginClass in namespace SilverStripe\GraphQL\Schema\Plugin

Generic plugin that can be used for filter inputs

AbstractQueryFilterPlugin::apply() — Method in class AbstractQueryFilterPlugin
AbstractQuerySortPluginClass 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
AbstractTypeRegistryClass in namespace SilverStripe\GraphQL\Schema\Storage
Enum::addValue() — Method in class Enum
InterfaceType::applyConfig() — Method in class InterfaceType
ModelType::applyConfig() — Method in class ModelType
ModelType::addField() — Method in class ModelType
ModelType::addFields() — Method in class ModelType
ModelType::addAllFields() — Method in class ModelType
ModelType::addAllOperations() — Method in class ModelType
ModelType::applyOperationsConfig() — Method in class ModelType
ModelType::addOperation() — Method in class ModelType
Scalar::applyConfig() — Method in class Scalar
Type::applyConfig() — Method in class Type
Type::addField() — Method in class Type
Type::addInterface() — Method in class Type
UnionType::applyConfig() — Method in class UnionType
LDAPAuthenticator::authenticate() — Method in class LDAPAuthenticator

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

$ LDAPLoginHandler#allowed_actionsProperty in class LDAPLoginHandler
$ LDAPLostPasswordHandler#allowed_actionsProperty in class LDAPLostPasswordHandler

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

$ LDAPMemberExtension#allow_update_failure_during_loginProperty in class LDAPMemberExtension

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

LDAPMemberExtension::afterMemberLoggedIn() — Method in class LDAPMemberExtension

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

LDAPGateway::authenticate() — Method in class LDAPGateway

Authenticate the given username and password with LDAP.

LDAPGateway::add() — Method in class LDAPGateway

Add an LDAP object.

LDAPService::authenticate() — Method in class LDAPService

Authenticate the given username and password with LDAP.

LDAPService::addLDAPUserToGroup() — Method in class LDAPService

Add LDAP user by DN to LDAP group.

LDAPService::add() — Method in class LDAPService

A simple proxy to LDAP add operation.

EnablerExtension::afterCallActionHandler() — Method in class EnablerExtension
GridFieldSiteTreeState::augmentColumns() — Method in class GridFieldSiteTreeState

Modify the list of columns displayed in the table.

Method::applyRequirements() — Method in class Method

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

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

AuthenticationFailedExceptionClass in namespace SilverStripe\MFA\Exception
$ MemberExtension#AccountResetHashProperty in class MemberExtension
$ MemberExtension#AccountResetExpiredProperty in class MemberExtension
MemberExtension::afterMemberLoggedIn() — Method in class MemberExtension

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

MethodInterface::applyRequirements() — Method in class MethodInterface

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

AvailableMethodDetailsClass in namespace SilverStripe\MFA\State
AvailableMethodDetailsInterfaceClass in namespace SilverStripe\MFA\State

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

SessionStore::addState() — Method in class SessionStore

Add to the state in the store

SessionStore::addVerifiedMethod() — Method in class SessionStore

Add and keep track of methods that have been verified

StoreInterface::addState() — Method in class StoreInterface

Add to the state in the store

StoreInterface::addVerifiedMethod() — Method in class StoreInterface

Add and keep track of methods that have been verified

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

ArrayListClass 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

PDOConnector::affectedRows() — Method in class PDOConnector

Determines the number of affected rows from the last SQL query

$ DB#alternative_database_enabledProperty in class DB

Allow alternative DB to be disabled.

DB::affected_rows() — Method in class DB

Return the number of rows affected by the previous operation.

DB::alteration_message() — Method in class DB

Show a message about database alteration

DataExtension::augmentSQL() — Method in class DataExtension

Edit the given query object to support queries for this extension

DataExtension::augmentDatabase() — Method in class DataExtension

Update the database schema as required by this extension.

DataExtension::augmentWrite() — Method in class DataExtension

Augment a write-record request.

DataList::alterDataQuery() — Method in class DataList

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

DataList::addFilter() — Method in class DataList

Return a new instance of the list with an added filter

DataList::applyRelation() — Method in class DataList

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

DataList::avg() — Method in class DataList

Return the average value of the given field in this DataList

DataList::addMany() — Method in class DataList

Add a number of items to the component set.

DataList::add() — Method in class DataList

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

$ DataObject#api_accessProperty in class DataObject

Allow API access to this object?

DataQuery::avg() — Method in class DataQuery

Return the average value of the given field in this DataList

DataQuery::aggregate() — Method in class DataQuery

Runs a raw aggregate expression. Please handle escaping yourself

DataQuery::applyRelationPrefix() — Method in class DataQuery

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

DataQuery::applyRelation() — Method in class DataQuery

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

DataQuery::addSelectFromTable() — Method in class DataQuery

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

DataQueryManipulator::afterGetFinalisedQuery() — Method in class DataQueryManipulator

Invoked after getFinalisedQuery()

DBComposite::addToQuery() — Method in class DBComposite

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

DBDate::Ago() — Method in class DBDate

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

DBField::addToQuery() — Method in class DBField

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

DBField::ATT() — Method in class DBField

Gets the value appropriate for a HTML attribute string

DBHTMLText::AbsoluteLinks() — Method in class DBHTMLText

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

PartialMatchFilter::apply() — Method in class PartialMatchFilter

Apply filter criteria to a SQL query.

SearchFilter::applyAggregate() — Method in class SearchFilter

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

SearchFilter::apply() — Method in class SearchFilter

Apply filter criteria to a SQL query.

HasManyList::add() — Method in class HasManyList

Adds the item to this relation.

Hierarchy::AllChildren() — Method in class Hierarchy

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

Hierarchy::AllChildrenIncludingDeleted() — Method in class Hierarchy

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

Hierarchy::AllHistoricalChildren() — Method in class Hierarchy

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

ListDecorator::add() — Method in class ListDecorator

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

ManyManyList::add() — Method in class ManyManyList

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

ManyManyThroughList::add() — Method in class ManyManyThroughList
ManyManyThroughQueryManipulator::afterGetFinalisedQuery() — Method in class ManyManyThroughQueryManipulator

Invoked after getFinalisedQuery()

PolymorphicHasManyList::add() — Method in class PolymorphicHasManyList

Adds the item to this relation.

SQLAssignmentRow::addAssignments() — Method in class SQLAssignmentRow

Adds assignments for a list of several fields

SQLAssignmentRow::assign() — Method in class SQLAssignmentRow

Set the value for a single field

SQLAssignmentRow::assignSQL() — Method in class SQLAssignmentRow

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

SQLConditionalExpression::addFrom() — Method in class SQLConditionalExpression

Add a table to include in the query or update

SQLConditionalExpression::addLeftJoin() — Method in class SQLConditionalExpression

Add a LEFT JOIN criteria to the tables list.

SQLConditionalExpression::addInnerJoin() — Method in class SQLConditionalExpression

Add an INNER JOIN criteria

SQLConditionalExpression::addFilterToJoin() — Method in class SQLConditionalExpression

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

SQLConditionalExpression::addWhere() — Method in class SQLConditionalExpression

Adds a WHERE clause.

SQLConditionalExpression::addWhereAny() — Method in class SQLConditionalExpression
SQLDelete::addDelete() — Method in class SQLDelete

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

SQLInsert::addRow() — Method in class SQLInsert

Appends a new row to insert

SQLInsert::addRows() — Method in class SQLInsert

Adds the list of rows to the array

SQLInsert::addAssignments() — Method in class SQLInsert

Adds assignments for a list of several fields.

SQLInsert::assign() — Method in class SQLInsert

Set the value for a single field

SQLInsert::assignSQL() — Method in class SQLInsert

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

SQLSelect::addSelect() — Method in class SQLSelect

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

SQLSelect::addOrderBy() — Method in class SQLSelect

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

SQLSelect::addGroupBy() — Method in class SQLSelect

Add a GROUP BY clause.

SQLSelect::addHaving() — Method in class SQLSelect

Add a HAVING clause

SQLSelect::aggregate() — Method in class SQLSelect

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

SQLUpdate::addAssignments() — Method in class SQLUpdate

Adds assignments for a list of several fields.

SQLUpdate::assign() — Method in class SQLUpdate

Set the value for a single field

SQLUpdate::assignSQL() — Method in class SQLUpdate

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

SQLWriteExpression::addAssignments() — Method in class SQLWriteExpression

Adds assignments for a list of several fields.

SQLWriteExpression::assign() — Method in class SQLWriteExpression

Set the value for a single field

SQLWriteExpression::assignSQL() — Method in class SQLWriteExpression

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

RelationList::addCallbacks() — Method in class RelationList

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

SS_List::add() — Method in class SS_List

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

SearchContext::addFilter() — Method in class SearchContext

Adds a instance of {@link SearchFilter}.

SearchContext::addField() — Method in class SearchContext

Adds a new {@link FormField} instance.

UnsavedRelationList::add() — Method in class UnsavedRelationList

Add an item to this relationship

UnsavedRelationList::addMany() — Method in class UnsavedRelationList

Add a number of items to the relation.

ValidationResult::addError() — Method in class ValidationResult

Record an error against this validation result,

ValidationResult::addFieldError() — Method in class ValidationResult

Record an error against this validation result,

ValidationResult::addMessage() — Method in class ValidationResult

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

ValidationResult::addFieldMessage() — Method in class ValidationResult

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

PostgreSQLConnector::affectedRows() — Method in class PostgreSQLConnector

Determines the number of affected rows from the last SQL query

$ PostgreSQLDatabase#allow_query_master_postgresProperty in class PostgreSQLDatabase

Determines whether to check a database exists on the host by querying the 'postgres' database and running createDatabase.

PostgreSQLDatabase::allow_query_master_postgres() — Method in class PostgreSQLDatabase

Determines whether to check a database exists on the host by querying the 'postgres' database and running createDatabase.

PostgreSQLSchemaManager::alterTable() — Method in class PostgreSQLSchemaManager

Alter a table's schema.

PostgreSQLSchemaManager::alterField() — Method in class PostgreSQLSchemaManager

Change the database type of the given field.

PostgreSQLSchemaManager::alterIndex() — Method in class PostgreSQLSchemaManager

Alter an index on a table.

AuthenticatorClass in namespace SilverStripe\RealMe

Class RealMeAuthenticator

Authenticator::authenticate() — Method in class Authenticator

Method to authenticate an user.

$ LoginHandler#allowed_actionsProperty in class LoginHandler
LoginHandler::acs() — Method in class LoginHandler
$ RealMeService#authn_contextsProperty in class RealMeService
$ RealMeService#allowed_authn_context_listProperty in class RealMeService
RegistryPageController::AllQueryVars() — Method in class RegistryPageController

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

ReportWrapper::afterQuery() — Method in class ReportWrapper

Override this method to perform some actions after querying.

BasicRestfulAuthenticator::authenticate() — Method in class BasicRestfulAuthenticator

The authenticate function

$ JSONDataFormatter#api_baseProperty in class JSONDataFormatter
$ XMLDataFormatter#api_baseProperty in class XMLDataFormatter
$ RestfulServer#api_baseProperty in class RestfulServer
$ RestfulServer#authenticatorProperty in class RestfulServer
SQLite3Connector::affectedRows() — Method in class SQLite3Connector

Determines the number of affected rows from the last SQL query

SQLite3SchemaManager::alterTable() — Method in class SQLite3SchemaManager

Alter a table's schema.

SQLite3SchemaManager::alterField() — Method in class SQLite3SchemaManager

Change the database type of the given field.

SQLite3SchemaManager::alterIndex() — Method in class SQLite3SchemaManager

Alter an index on a table.

SudoModeController::activate() — Method in class SudoModeController

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

SudoModeOnLoginExtension::afterLogin() — Method in class SudoModeOnLoginExtension

Activates sudo mode on a successful log in

SudoModeService::activate() — Method in class SudoModeService

Register activated sudo mode permission in the provided session, which lasts for the configured lifetime.

SudoModeServiceInterface::activate() — Method in class SudoModeServiceInterface

Register activated sudo mode permission in the provided session, which lasts for the configured lifetime.

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

AuthenticationMiddlewareClass in namespace SilverStripe\Security
AuthenticatorClass in namespace SilverStripe\Security

Abstract base class for an authentication method

Authenticator::authenticate() — Method in class Authenticator

Method to authenticate an user.

Group::AllChildrenIncludingDeleted() — Method in class Group

Returns all of the children for the CMS Tree.

$ Member#auto_login_token_lifetimeProperty in class Member

Default lifetime of auto login token.

$ Member#AutoLoginHashProperty in class Member
$ Member#AutoLoginExpiredProperty in class Member
Member::afterMemberLoggedIn() — Method in class Member

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

Member::afterMemberLoggedOut() — Method in class Member

Audit logging hook, called after a member is logged out

Member::actAs() — Method in class Member

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

Member::addToGroupByCode() — Method in class Member

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

CookieAuthenticationHandler::authenticateRequest() — Method in class CookieAuthenticationHandler
$ LoginHandler#allowed_actionsProperty in class LoginHandler
$ LostPasswordHandler#allowed_actionsProperty in class LostPasswordHandler

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

MemberAuthenticator::authenticate() — Method in class MemberAuthenticator

Method to authenticate an user.

SessionAuthenticationHandler::authenticateRequest() — Method in class SessionAuthenticationHandler
Member_GroupSet::add() — Method in class Member_GroupSet

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

NullSecurityToken::addToUrl() — Method in class NullSecurityToken
PasswordExpirationMiddleware::allowCurrentRequest() — Method in class PasswordExpirationMiddleware

Allow the current request to be finished without password expiration check

$ Permission#admin_implies_allProperty in class Permission

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

RequestAuthenticationHandler::authenticateRequest() — Method in class RequestAuthenticationHandler

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

$ Security#autologin_enabledProperty in class Security

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

SecurityToken::addToUrl() — Method in class SecurityToken
LogInAuthenticationHandler::authenticateRequest() — Method in class LogInAuthenticationHandler
LogOutAuthenticationHandler::authenticateRequest() — Method in class LogOutAuthenticationHandler
CommentSpamProtection::alterCommentForm() — Method in class CommentSpamProtection
$ Publisher#add_timestampProperty in class Publisher
UrlBundleInterface::addUrls() — Method in class UrlBundleInterface

Add URLs to this bundle

UrlBundleService::addUrls() — Method in class UrlBundleService
FileSubsites::alternateTreeTitle() — Method in class FileSubsites

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

FileSubsites::augmentSQL() — Method in class FileSubsites

Update any requests to limit the results to the current site

GroupSubsites::augmentSQL() — Method in class GroupSubsites

Update any requests to limit the results to the current site

GroupSubsites::alternateCanEdit() — Method in class GroupSubsites
LeftAndMainSubsites::alternateMenuDisplayCheck() — Method in class LeftAndMainSubsites
LeftAndMainSubsites::alternateAccessCheck() — Method in class LeftAndMainSubsites

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

LeftAndMainSubsites::augmentNewSiteTreeItem() — Method in class LeftAndMainSubsites
SiteConfigSubsites::augmentSQL() — Method in class SiteConfigSubsites

Update any requests to limit the results to the current site

SiteTreeSubsites::augmentSQL() — Method in class SiteTreeSubsites

Update any requests to limit the results to the current site

SiteTreeSubsites::alternateSiteConfig() — Method in class SiteTreeSubsites
SiteTreeSubsites::alternateAbsoluteLink() — Method in class SiteTreeSubsites
SiteTreeSubsites::alternatePreviewLink() — Method in class SiteTreeSubsites

This function is marked as deprecated for removal in 5.0.0 in silverstripe/cms so now simply passes execution to where the functionality exists for backwards compatiblity.

SiteTreeSubsites::augmentSyncLinkTracking() — Method in class SiteTreeSubsites
SiteTreeSubsites::augmentValidURLSegment() — Method in class SiteTreeSubsites

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

$ InitStateMiddleware#admin_url_pathsProperty in class InitStateMiddleware

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

Subsite::all_sites() — Method in class Subsite

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

Subsite::all_accessible_sites() — Method in class Subsite
Subsite::accessible_sites() — Method in class Subsite

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

Subsite::allowedThemes() — Method in class Subsite

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

Subsite::absoluteBaseURL() — Method in class Subsite

Get the absolute URL for this subsite

Subsite::adminDuplicate() — Method in class Subsite

Javascript admin action to duplicate this subsite

Subsite::activate() — Method in class Subsite

Make this subsite the current one

SubsiteDomain::absoluteBaseURL() — Method in class SubsiteDomain

Get absolute baseURL for this domain

SubsiteReportWrapper::afterQuery() — Method in class SubsiteReportWrapper
Method::applyRequirements() — Method in class Method

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

$ EditableFormField#abstractProperty in class EditableFormField

Define this field as abstract (not inherited)

$ EditableFormField#allowed_cssProperty in class EditableFormField

A list of CSS classes that can be added

$ EditableFileField#allowed_extensions_blacklistProperty in class EditableFileField

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

$ EditableMultipleOptionField#abstractProperty in class EditableMultipleOptionField

Define this field as abstract (not inherited)

EditableOption::allow_empty_values() — Method in class EditableOption

Returns whether to allow empty values or not.

$ EditableTextField#AutocompleteProperty in class EditableTextField
$ EmailRecipient#allow_unbound_recipient_fieldsProperty in class EmailRecipient

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

$ VersionFeed#allchanges_enabledProperty in class VersionFeed

Enable the allchanges feed

$ VersionFeed#allchanges_limitProperty in class VersionFeed

Allchanges feed limit of items.

VersionFeedController::allchanges() — Method in class VersionFeedController

Get all changes from the site in a RSS feed.

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

ArchiveRestoreActionClass in namespace SilverStripe\VersionedAdmin\Extensions

Adds a restore action to the item edit form of ArchiveAdmin

ArchiveViewProviderClass 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#AddedProperty in class ChangeSetItem
DeleteExtension::augmentMutation() — Method in class DeleteExtension
AbstractPublishOperationCreatorClass 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
CopyToStageInputType::attributes() — Method in class CopyToStageInputType
VersionSortType::attributes() — Method in class VersionSortType
VersionedInputType::attributes() — Method in class VersionedInputType
GridFieldArchiveAction::augmentColumns() — Method in class GridFieldArchiveAction

Add a column 'Actions'

GridFieldRestoreAction::augmentColumns() — Method in class GridFieldRestoreAction

Add a column 'Delete'

Versioned::augmentDataQueryCreation() — Method in class Versioned

Amend freshly created DataQuery objects with versioned-specific information.

Versioned::augmentSQL() — Method in class Versioned

Augment the the SQLSelect that is created by the DataQuery

Versioned::augmentLoadLazyFields() — Method in class Versioned

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

Versioned::augmentDatabase() — Method in class Versioned

Update the database schema as required by this extension.

Versioned::augmentWrite() — Method in class Versioned

Augment a write-record request.

Versioned::allVersions() — Method in class Versioned

Return a list of all the versions available.

Versioned::Author() — Method in class Versioned

Get author of this record.

VersionedGridFieldState::augmentColumns() — Method in class VersionedGridFieldState

Modify the list of columns displayed in the table.

Versioned_Version::Author() — Method in class Versioned_Version

Author of this DataObject

ArrayDataClass in namespace SilverStripe\View

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

ArrayData::array_to_object() — Method in class ArrayData

Converts an associative array to a simple object

AttributesHTMLClass in namespace SilverStripe\View

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

Requirements::add_i18n_javascript() — Method in class Requirements

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

Requirements_Backend::add_i18n_javascript() — Method in class Requirements_Backend

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

SSTemplateParser::addClosedBlock() — Method in class SSTemplateParser

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

SSTemplateParser::addOpenBlock() — Method in class SSTemplateParser

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

SSTemplateParser::Argument_DollarMarkedLookup() — Method in class SSTemplateParser

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

SSTemplateParser::Argument_QuotedString() — Method in class SSTemplateParser
SSTemplateParser::Argument_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

$ EmbedShortcodeProvider#attribute_whitelistProperty in class EmbedShortcodeProvider

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

ThemeResourceLoader::addSet() — Method in class ThemeResourceLoader

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

Method::applyRequirements() — Method in class Method

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

$ RegisterHandler#authenticator_attachmentProperty in class RegisterHandler

The default attachment mode to use for Authentication Selection Criteria.

WidgetAreaEditor::AvailableWidgets() — Method in class WidgetAreaEditor
AssignUsersToWorkflowActionClass 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.

AdvancedWorkflowAdminClass in namespace Symbiote\AdvancedWorkflow\Admin
AdvancedWorkflowActionControllerClass 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
AdvancedWorkflowExtensionClass in namespace Symbiote\AdvancedWorkflow\Extensions

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

WorkflowApplicable::AbsoluteEditLink() — Method in class WorkflowApplicable

Included in CMS-generated email templates for a NotifyUsersWorkflowAction.

WorkflowField::action() — Method in class WorkflowField
WorkflowField::ActionLink() — Method in class WorkflowField
AWRequiredFieldsClass in namespace Symbiote\AdvancedWorkflow\Forms

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

GridFieldExportAction::augmentColumns() — Method in class GridFieldExportAction

Add a column 'Delete'

GridFieldWorkflowRestrictedEditButton::augmentColumns() — Method in class GridFieldWorkflowRestrictedEditButton

Add a column

GridFieldAddExistingSearchHandler::add() — Method in class GridFieldAddExistingSearchHandler
GridFieldExternalLink::augmentColumns() — Method in class GridFieldExternalLink

Add a column for the actions

GridFieldOrderableRows::augmentColumns() — Method in class GridFieldOrderableRows

Modify the list of columns displayed in the table.

QueuedJobDescriptor::activateOnQueue() — Method in class QueuedJobDescriptor

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

GridFieldQueuedJobExecute::augmentColumns() — Method in class GridFieldQueuedJobExecute

Add a column 'Delete'

QJUtils::ajaxResponse() — Method in class QJUtils
AbstractQueuedJobClass in namespace Symbiote\QueuedJobs\Services

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

AbstractQueuedJob::afterComplete() — Method in class AbstractQueuedJob

Called when the job is determined to be 'complete'

AbstractQueuedJob::addMessage() — Method in class AbstractQueuedJob
QueuedJob::addMessage() — Method in class QueuedJob

Add an arbitrary text message into a job

FluentExtension::augmentDatabase() — Method in class FluentExtension

Update the database schema as required by this extension.

FluentExtension::augmentSQL() — Method in class FluentExtension

Edit the given query object to support queries for this extension

FluentExtension::augmentWrite() — Method in class FluentExtension

Augment a write-record request.

FluentExtension::augmentDataQueryCreation() — Method in class FluentExtension

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

FluentFilteredExtension::augmentSQL() — Method in class FluentFilteredExtension
FluentVersionedExtension::augmentSQL() — Method in class FluentVersionedExtension

Edit the given query object to support queries for this extension

FluentVersionedExtension::augmentWrite() — Method in class FluentVersionedExtension

Apply versioning to write

$ InitStateMiddleware#admin_url_pathsProperty in class InitStateMiddleware

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

FluentSearchVariant::appliesTo() — Method in class FluentSearchVariant

Return true if this variant applies to the passed class & subclass

FluentSearchVariant::activateState() — Method in class FluentSearchVariant

Activate the passed state

FluentSearchVariant::alterQuery() — Method in class FluentSearchVariant

Apply this variant to a search query

FluentSearchVariant::alterDefinition() — Method in class FluentSearchVariant

B

ComposerLoader::build() — Method in class ComposerLoader

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

CwpSiteTreeFileExtension::BackLinkHTMLList() — Method in class CwpSiteTreeFileExtension

Generate an HTML list which provides links to where a file is used.

BaseHomePageClass in namespace CWP\CWP\PageTypes

BaseHomePage is the basic home page.

BaseHomePageControllerClass in namespace CWP\CWP\PageTypes
BasePageClass in namespace CWP\CWP\PageTypes

BasePage is a foundation page class which can be used for constructing your own page types. By default it is hidden from the CMS - we rely on developers creating their own Page class in mysite/code which will extend from BasePage.

BasePageControllerClass in namespace CWP\CWP\PageTypes
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.

BulkManagerClass in namespace Colymba\BulkManager

GridField component for editing attached models in bulk.

BulkUploadFieldClass in namespace Colymba\BulkUpload

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

BulkUploadHandlerClass in namespace Colymba\BulkUpload

Handles request from the GridFieldBulkUpload component.

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

BaseElementClass in namespace DNADesign\Elemental\Models

Class BaseElement

ElementalArea::Breadcrumbs() — Method in class ElementalArea

Necessary to display results in CMS site search.

$ DebugBar#bufferingEnabledProperty in class DebugBar
ControllerExtension::beforeCallActionHandler() — Method in class ControllerExtension
CMSBatchAction::batchaction() — Method in class CMSBatchAction

Helper method for processing batch actions.

$ CMSBatchActionHandler#batch_actionsProperty in class CMSBatchActionHandler
CMSBatchActionHandler::batchActionList() — Method in class CMSBatchActionHandler

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

  • Link
  • Title
CMSBatchActionHandler::batchActions() — Method in class CMSBatchActionHandler

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

CMSProfileController::Breadcrumbs() — Method in class CMSProfileController

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

LeftAndMain::Breadcrumbs() — Method in class LeftAndMain
LeftAndMain::batchactions() — Method in class LeftAndMain

Batch Actions Handler

LeftAndMain::BatchActionsForm() — Method in class LeftAndMain
LeftAndMain::BaseCSSClasses() — Method in class LeftAndMain

Same as {@link ViewableData->CSSClasses()}, but with a changed name to avoid problems when using {@link ViewableData->customise()} (which always returns "ArrayData" from the $original object).

ModelAdmin::Breadcrumbs() — Method in class ModelAdmin
SecurityAdmin::Backlink() — Method in class SecurityAdmin

Disable GridFieldDetailForm backlinks for this view, as its

SecurityAdmin::Breadcrumbs() — Method in class SecurityAdmin
$ AkismetSpamProtector#bypass_permissionProperty in class AkismetSpamProtector

Permission required to bypass check

$ AkismetSpamProtector#bypass_membersProperty in class AkismetSpamProtector

Set to try to bypass check for all logged in users

$ AssetAdmin#bust_cacheProperty 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

BuilderClass in namespace SilverStripe\AssetAdmin\GraphQL\Schema
$ TestAssetStore#basedirProperty in class TestAssetStore

Base dir of current file

TestAssetStore::base_path() — Method in class TestAssetStore

Get absolute path to basedir

File::BackLinkTracking() — Method in class File

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

File::BackLinkTrackingCount() — Method in class File

Count of backlinks Note: Doesn't filter broken records

File::BackLinks() — Method in class File

List of SiteTreeLink objects attached to this page

FileIDHelper::buildFileID() — Method in class FileIDHelper

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

FileIDHelperResolutionStrategy::buildFileID() — Method in class FileIDHelperResolutionStrategy

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

FileResolutionStrategy::buildFileID() — Method in class FileResolutionStrategy

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

HashFileIDHelper::buildFileID() — Method in class HashFileIDHelper

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

LegacyFileIDHelper::buildFileID() — Method in class LegacyFileIDHelper

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

NaturalFileIDHelper::buildFileID() — Method in class NaturalFileIDHelper

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

AuditHook::bind_manipulation_capture() — Method in class AuditHook

This will bind a new class dynamically so we can hook into manipulation and capture it. It creates a new PHP file in the temp folder, then loads it and sets it as the active DB class.

BasicContextClass in namespace SilverStripe\BehatExtension\Context

BasicContext

EmailContext::before() — Method in class EmailContext
FixtureContext::beforeDatabaseDefaults() — Method in class FixtureContext
SilverStripeContext::before() — Method in class SilverStripeContext
BlogAdminSidebarClass in namespace SilverStripe\Blog\Forms
BlogClass in namespace SilverStripe\Blog\Model

Blog Holder

BlogCategoryClass in namespace SilverStripe\Blog\Model

A blog category for generalising blog posts.

$ BlogCategory#BlogIDProperty in class BlogCategory
BlogCategory::Blog() — Method in class BlogCategory
BlogCommentExtensionClass in namespace SilverStripe\Blog\Model

Adds Blog specific behaviour to Comment.

BlogControllerClass in namespace SilverStripe\Blog\Model
BlogFilterClass in namespace SilverStripe\Blog\Model

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

BlogFilterGridFieldClass in namespace SilverStripe\Blog\Model\BlogFilter

Enables children of non-editable pages to be edited.

BlogMemberExtensionClass in namespace SilverStripe\Blog\Model

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

BlogObjectClass in namespace SilverStripe\Blog\Model

An object shared by BlogTag and BlogCategory.

BlogObject::BlogPosts() — Method in class BlogObject
BlogPostClass in namespace SilverStripe\Blog\Model

An individual blog post.

BlogPostControllerClass in namespace SilverStripe\Blog\Model
BlogPostFeaturedExtensionClass in namespace SilverStripe\Blog\Model

Adds a checkbox field for featured blog posts widget.

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

BlogPostNotificationsClass in namespace SilverStripe\Blog\Model

Customise blog post to support comment notifications.

BlogTagClass in namespace SilverStripe\Blog\Model

A blog tag for keyword descriptions of a blog post.

$ BlogTag#BlogIDProperty in class BlogTag
BlogTag::Blog() — Method in class BlogTag
CategorisationObject::BlogPosts() — Method in class CategorisationObject
BlogArchiveWidgetClass in namespace SilverStripe\Blog\Widgets
BlogArchiveWidget::Blog() — Method in class BlogArchiveWidget
BlogArchiveWidgetControllerClass in namespace SilverStripe\Blog\Widgets
BlogCategoriesWidgetClass in namespace SilverStripe\Blog\Widgets
BlogCategoriesWidget::Blog() — Method in class BlogCategoriesWidget
BlogCategoriesWidgetControllerClass in namespace SilverStripe\Blog\Widgets
BlogFeaturedPostsWidgetClass in namespace SilverStripe\Blog\Widgets
BlogFeaturedPostsWidget::Blog() — Method in class BlogFeaturedPostsWidget
BlogRecentPostsWidgetClass in namespace SilverStripe\Blog\Widgets
BlogRecentPostsWidget::Blog() — Method in class BlogRecentPostsWidget
BlogRecentPostsWidgetControllerClass in namespace SilverStripe\Blog\Widgets
BlogTagsCloudWidgetClass in namespace SilverStripe\Blog\Widgets
BlogTagsCloudWidget::Blog() — Method in class BlogTagsCloudWidget
BlogTagsCloudWidgetControllerClass in namespace SilverStripe\Blog\Widgets
BlogTagsWidgetClass in namespace SilverStripe\Blog\Widgets
BlogTagsWidget::Blog() — Method in class BlogTagsWidget
BlogTagsWidgetControllerClass in namespace SilverStripe\Blog\Widgets
CMSMain::Breadcrumbs() — Method in class CMSMain
CMSMain::batchactions() — Method in class CMSMain

Batch Actions Handler

CMSMain::BatchActionParameters() — Method in class CMSMain

Returns a LiteralField containing parameter field HTML for batch actions

CMSMain::BatchActionList() — Method in class CMSMain

Returns a list of batch actions

CMSPagesController::Breadcrumbs() — Method in class CMSPagesController
$ SiteTree#base_plural_nameProperty in class SiteTree

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

$ SiteTree#base_singular_nameProperty in class SiteTree

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

$ SiteTree#base_descriptionProperty in class SiteTree

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

SiteTree::Breadcrumbs() — Method in class SiteTree

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

SiteTree::BackLinkTracking() — Method in class SiteTree

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

SiteTree::BackLinks() — Method in class SiteTree

List of SiteTreeLink objects attached to this page

SiteTreeFileExtension::BackLinkHTMLList() — Method in class SiteTreeFileExtension
BrokenFilesReportClass in namespace SilverStripe\CMS\Reports
BrokenLinksReportClass in namespace SilverStripe\CMS\Reports

Content side-report listing pages with broken links

BrokenRedirectorPagesReportClass in namespace SilverStripe\CMS\Reports
BrokenVirtualPagesReportClass in namespace SilverStripe\CMS\Reports
$ Comment#BaseClassProperty in class Comment
Director::baseURL() — Method in class Director

Return the root-relative url for the baseurl

Director::baseFolder() — Method in class Director

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

$ Email#bcc_all_emails_toProperty in class Email
Email::BaseURL() — Method in class Email
SwiftPlugin::beforeSendPerformed() — Method in class SwiftPlugin

Before sending a message make sure all our overrides are taken into account

BypassClass in namespace SilverStripe\Control\Middleware\ConfirmationMiddleware

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

URLSpecialsMiddleware::buildImpactRedirect() — Method in class URLSpecialsMiddleware

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

BaseKernelClass in namespace SilverStripe\Core

Simple Kernel container

BaseKernel::boot() — Method in class BaseKernel
ClassInfo::baseDataClass() — Method in class ClassInfo
CoreConfigFactory::buildStaticTransformer() — Method in class CoreConfigFactory
CoreConfigFactory::buildYamlTransformerForPath() — Method in class CoreConfigFactory
Convert::base64url_encode() — Method in class Convert

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

Convert::base64url_decode() — Method in class Convert

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

Convert::bytes2memstring() — Method in class Convert
CoreKernel::boot() — Method in class CoreKernel
$ AopProxyService#beforeCallProperty in class AopProxyService
BeforeCallAspectClass in namespace SilverStripe\Core\Injector

A BeforeCallAspect is run before a method is executed.

BeforeCallAspect::beforeCall() — Method in class BeforeCallAspect

Call this aspect before a method is executed

Kernel::boot() — Method in class Kernel
ClassManifestVisitor::beforeTraverse() — Method in class ClassManifestVisitor
BacktraceClass in namespace SilverStripe\Dev

Backtrace helper

Backtrace::backtrace() — Method in class Backtrace

Render or return a backtrace from the given scope.

BehatFixtureFactoryClass in namespace SilverStripe\Dev
BuildTaskClass in namespace SilverStripe\Dev

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

BulkLoaderClass in namespace SilverStripe\Dev

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

BulkLoader_ResultClass in namespace SilverStripe\Dev

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

DebugView::Breadcrumbs() — Method in class DebugView

Generate breadcrumb links to the URL path being displayed

DevBuildController::build() — Method in class DevBuildController
DevelopmentAdmin::buildDefaults() — Method in class DevelopmentAdmin

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

SapphireInfo::BaseURL() — Method in class SapphireInfo
BannerBlockClass in namespace SilverStripe\ElementalBannerBlock\Block
BlockLinkFieldClass in namespace SilverStripe\ElementalBannerBlock\Form
BlockLinkField_ReadonlyClass in namespace SilverStripe\ElementalBannerBlock\Form

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

BrokenExternalLinkClass in namespace SilverStripe\ExternalLinks\Model

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

BrokenExternalPageTrackClass in namespace SilverStripe\ExternalLinks\Model

Represents a track for a single page

BrokenExternalPageTrackStatusClass in namespace SilverStripe\ExternalLinks\Model

Represents the status of a track run

BrokenExternalPageTrackStatus::BrokenLinks() — Method in class BrokenExternalPageTrackStatus
BrokenExternalLinksReportClass in namespace SilverStripe\ExternalLinks\Reports

Content side-report listing pages with external broken links

$ CurlLinkChecker#bypass_cacheProperty in class CurlLinkChecker

If we want to bypass the cache Set via YAML file

FormRequestHandler::buttonClicked() — Method in class FormRequestHandler

Get instance of button which was clicked for this request

GridFieldDetailForm_ItemRequest::Breadcrumbs() — Method in class GridFieldDetailForm_ItemRequest

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

$ TinyMCEConfig#base_dirProperty in class TinyMCEConfig

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

  • plugins
  • themes
  • skins
SearchIndex::buildDependancyList() — Method in class SearchIndex
$ SearchUpdateBatchedProcessor#batch_sizeProperty in class SearchUpdateBatchedProcessor

Maximum number of record-states to process in one batch.

$ SearchUpdateBatchedProcessor#batch_soft_capProperty in class SearchUpdateBatchedProcessor

Up to this number of additional ids can be added to any batch in order to reduce the number of batches

SearchUpdateBatchedProcessor::batchData() — Method in class SearchUpdateBatchedProcessor
BasicAuthAuthenticatorClass in namespace SilverStripe\GraphQL\Auth

An authenticator using SilverStripe's BasicAuth

BuildClass in namespace SilverStripe\GraphQL\Dev
Build::build() — Method in class Build
Build::buildSchema() — Method in class Build
BulkLoaderSetClass in namespace SilverStripe\GraphQL\Schema\BulkLoader

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

DBFieldArgs::baseFormatResolver() — Method in class DBFieldArgs
Resolver::baseResolve() — Method in class Resolver

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

BaseFieldsProviderClass in namespace SilverStripe\GraphQL\Schema\Interfaces

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

SchemaBuilder::build() — Method in class SchemaBuilder

Stores a schema and fetches the graphql-php instance

SchemaBuilder::buildByName() — Method in class SchemaBuilder

Boots a schema, persists it, and fetches it

SchemaBuilder::boot() — Method in class SchemaBuilder

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

NestedInputBuilder::buildPathsFromArgs() — Method in class NestedInputBuilder

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

AbstractTypeRegistry::Boolean() — Method in class AbstractTypeRegistry
ModelType::buildOperations() — Method in class ModelType
BaseStoreClass in namespace SilverStripe\HybridSessions\Store
DatabaseStore::binaryDataJsonEncode() — Method in class DatabaseStore

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

DatabaseStore::binaryDataJsonDecode() — Method in class DatabaseStore

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

LDAPUtil::bin_to_str_guid() — Method in class LDAPUtil
LDAPUtil::bin_to_str_sid() — Method in class LDAPUtil
EnablerExtension::beforeCallActionHandler() — Method in class EnablerExtension
BaseHandlerTraitClass in namespace SilverStripe\MFA\RequestHandler
BackupCodeGeneratorClass in namespace SilverStripe\MFA\Service
$ BackupCodeGenerator#backup_code_countProperty 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_lengthProperty in class BackupCodeGenerator

The length of each individual backup code.

BackupCodeGeneratorInterfaceClass in namespace SilverStripe\MFA\Service

A service class implementation for generating and hashing backup codes.

BackupCodeClass in namespace SilverStripe\MFA\State

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

ArrayList::byIDs() — Method in class ArrayList

Filter this list to only contain the given Primary IDs

ArrayList::byID() — Method in class ArrayList

Return the first item with the given ID

DBQueryBuilder::buildSQL() — Method in class DBQueryBuilder

Builds a sql query with the specified connection

DBQueryBuilder::buildDeleteFragment() — Method in class DBQueryBuilder

Return the DELETE clause ready for inserting into a query.

DBQueryBuilder::buildUpdateFragment() — Method in class DBQueryBuilder

Return the UPDATE clause ready for inserting into a query.

DBQueryBuilder::buildFromFragment() — Method in class DBQueryBuilder

Return the FROM clause ready for inserting into a query.

DBQueryBuilder::buildWhereFragment() — Method in class DBQueryBuilder

Returns the WHERE clauses ready for inserting into a query.

DBQueryBuilder::buildOrderByFragment() — Method in class DBQueryBuilder

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

DBQueryBuilder::buildGroupByFragment() — Method in class DBQueryBuilder

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

DBQueryBuilder::buildHavingFragment() — Method in class DBQueryBuilder

Returns the HAVING clauses ready for inserting into a query.

DBQueryBuilder::buildLimitFragment() — Method in class DBQueryBuilder

Return the LIMIT clause ready for inserting into a query.

DBSchemaManager::boolean() — Method in class DBSchemaManager

Returns data type for 'boolean' column

MySQLQueryBuilder::buildLimitFragment() — Method in class MySQLQueryBuilder

Return the LIMIT clause ready for inserting into a query.

MySQLSchemaManager::boolean() — Method in class MySQLSchemaManager

Return a boolean type-formatted string

MySQLSchemaManager::bigint() — Method in class MySQLSchemaManager

Return a bigint type-formatted string

MySQLiConnector::bindParameters() — Method in class MySQLiConnector

Binds a list of parameters to a statement

PDOConnector::bindParameters() — Method in class PDOConnector

Bind all parameters to a PDOStatement

TableBuilder::buildTables() — Method in class TableBuilder
TempDatabase::build() — Method in class TempDatabase

Create temp DB without creating extra objects

DB::build_sql() — Method in class DB

Builds a sql query with the specified connection

DataList::byIDs() — Method in class DataList

Filter this list to only contain the given Primary IDs

DataList::byID() — Method in class DataList

Return the first DataObject with the given ID

$ DataObject#belongs_toProperty in class DataObject

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

$ DataObject#belongs_many_manyProperty in class DataObject

The inverse side of a many-many relationship.

DataObject::belongsTo() — Method in class DataObject

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

DataObject::baseTable() — Method in class DataObject

Get the name of the base table for this object

DataObject::baseClass() — Method in class DataObject

Get the base class for this object

DataObjectSchema::baseDataClass() — Method in class DataObjectSchema

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

DataObjectSchema::baseDataTable() — Method in class DataObjectSchema

Get the base table

DataObjectSchema::belongsToComponent() — Method in class DataObjectSchema

Return data for a specific belongs_to component.

DataQueryManipulator::beforeGetFinalisedQuery() — Method in class DataQueryManipulator

Invoked prior to getFinalisedQuery()

DatabaseAdmin::build() — Method in class DatabaseAdmin

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

DatabaseAdmin::buildDefaults() — Method in class DatabaseAdmin

Build the default data, calling requireDefaultRecords on all DataObject classes

DBComposite::bindTo() — Method in class DBComposite

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

Filterable::byID() — Method in class Filterable

Return the first item with the given ID

Filterable::byIDs() — Method in class Filterable

Filter this list to only contain the given Primary IDs

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

PostgreSQLQueryBuilder::buildLimitFragment() — Method in class PostgreSQLQueryBuilder

Return the LIMIT clause ready for inserting into a query.

PostgreSQLQueryBuilder::buildSQL() — Method in class PostgreSQLQueryBuilder

Builds a sql query with the specified connection

PostgreSQLSchemaManager::buildPostgresTriggerName() — Method in class PostgreSQLSchemaManager

Builds the internal Postgres trigger name given the silverstripe table and trigger name

PostgreSQLSchemaManager::boolean() — Method in class PostgreSQLSchemaManager

Return a boolean type-formatted string

PostgreSQLSchemaManager::bigint() — Method in class PostgreSQLSchemaManager

Return a bigint type-formatted string

$ FederatedIdentity#BirthInfoQualityProperty in class FederatedIdentity
$ FederatedIdentity#BirthYearProperty in class FederatedIdentity
$ FederatedIdentity#BirthMonthProperty in class FederatedIdentity
$ FederatedIdentity#BirthDayProperty in class FederatedIdentity
$ FederatedIdentity#BirthPlaceQualityProperty in class FederatedIdentity
$ FederatedIdentity#BirthPlaceCountryProperty in class FederatedIdentity
$ FederatedIdentity#BirthPlaceLocalityProperty in class FederatedIdentity
RegistryPage::Breadcrumbs() — Method in class RegistryPage

Modified version of Breadcrumbs, to cater for viewing items.

ReportAdmin::Breadcrumbs() — Method in class ReportAdmin

Returns the Breadcrumbs for the ReportAdmin

ReportWrapper::beforeQuery() — Method in class ReportWrapper

Override this method to perform some actions prior to querying.

BasicRestfulAuthenticatorClass in namespace SilverStripe\RestfulServer

A simple authenticator for the Restful server.

SQLite3QueryBuilder::buildLimitFragment() — Method in class SQLite3QueryBuilder

Return the LIMIT clause ready for inserting into a query.

SQLite3SchemaManager::boolean() — Method in class SQLite3SchemaManager

Return a boolean type-formatted string

SQLite3SchemaManager::bigint() — Method in class SQLite3SchemaManager

Return a bigint type-formatted string

BasicAuthClass in namespace SilverStripe\Security

Provides an interface to HTTP basic authentication.

BasicAuthMiddlewareClass in namespace SilverStripe\Security
Member::beforeMemberLoggedIn() — Method in class Member

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

Member::beforeMemberLoggedOut() — Method in class Member

Audit logging hook, called before a member is logged out

Security::basicauthlogin() — Method in class Security
SiteConfigLeftAndMain::Breadcrumbs() — Method in class SiteConfigLeftAndMain
SubsiteReportWrapper::beforeQuery() — Method in class SubsiteReportWrapper
$ SolrCellTextExtractor#base_urlProperty in class SolrCellTextExtractor

Base URL to use for Solr text extraction.

$ UserForm#button_textProperty in class UserForm
EditableCustomRule::buildExpression() — Method in class EditableCustomRule

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

$ UserForm#block_default_userforms_cssProperty in class UserForm

Set this to true to disable automatic inclusion of CSS files

$ UserForm#block_default_userforms_jsProperty 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

BlockArchiveExtensionClass in namespace SilverStripe\VersionedAdmin\Extensions

Adds a archive view for Elemental blocks

VersionedGridFieldItemRequest::Breadcrumbs() — Method in class VersionedGridFieldItemRequest
Requirements::backend() — Method in class Requirements
Requirements::block() — Method in class Requirements

Block inclusion of a specific file

Requirements_Backend::block() — Method in class Requirements_Backend

Block inclusion of a specific file

BaseHandlerTraitClass in namespace SilverStripe\WebAuthn

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

$ i18nTextCollector#basePathProperty in class i18nTextCollector

The directory base on which the collector should act.

$ i18nTextCollector#baseSavePathProperty in class i18nTextCollector

Save path

WorkflowInstance::beginWorkflow() — Method in class WorkflowInstance

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

BaseRunnerClass in namespace Symbiote\QueuedJobs\Tasks\Engines

Class BaseRunner

FluentExtension::BaseURLForLocale() — Method in class FluentExtension

Determine the baseurl within a specified $locale.

BrowserLocaleDetectorClass in namespace TractorCow\Fluent\State

Detects locale based on browser locale

C

CheckForUpdatesJobClass in namespace BringYourOwnIdeas\Maintenance\Jobs

Refresh report job. Runs as a queued job.

SiteSummary::columns() — Method in class SiteSummary

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

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

CheckComposerUpdatesExtensionClass in namespace BringYourOwnIdeas\UpdateChecker\Extensions

Task which does the actual checking of updates

ComposerLoaderExtensionClass in namespace BringYourOwnIdeas\UpdateChecker\Extensions
ComposerUpdateExtensionClass 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

CWPPageExtensionClass in namespace CWP\AgencyExtensions\Extensions

Class CWPPageExtension

CWPSiteConfigExtensionClass in namespace CWP\AgencyExtensions\Extensions

Class CWPCleanupSiteConfigExtension

CarouselPageExtensionClass in namespace CWP\AgencyExtensions\Extensions
ColorPickerFieldClass in namespace CWP\AgencyExtensions\Forms
CarouselItemClass 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
CustomSiteConfigClass in namespace CWP\CWP\Extensions

Adds new global settings.

CwpCommentingExtensionClass in namespace CWP\CWP\Extensions

Customises the comment form to conform to government usability standards

CwpSiteSummaryExtensionClass in namespace CWP\CWP\Extensions

Extends the site summary report to list the appropriate versions in the report header

CwpSiteTreeExtensionClass in namespace CWP\CWP\Extensions
CwpSiteTreeFileExtensionClass in namespace CWP\CWP\Extensions
CwpWorkflowDefinitionExtensionClass in namespace CWP\CWP\Extensions

Ensures that the default template is created

$ CwpWorkflowDefinitionExtension#create_default_workflowProperty in class CwpWorkflowDefinitionExtension

Create the default 'Two-step Workflow' when this extension is loaded

Quicklink::canCreate() — Method in class Quicklink
Quicklink::canEdit() — Method in class Quicklink
Quicklink::canDelete() — Method in class Quicklink
Quicklink::canView() — Method in class Quicklink
BasePageController::CurrentDatetime() — Method in class BasePageController

Provide current year.

DatedUpdateHolderController::CurrentTag() — Method in class DatedUpdateHolderController

Get the TaxonomyTerm related to the current tag GET parameter.

CwpStatsReportClass in namespace CWP\CWP\Report

Summary report on the page and file counts managed by this CMS.

CwpStatsReport::columns() — Method in class CwpStatsReport
CwpBasicAuthMiddlewareClass in namespace CWP\Core\Control
CWPVersionExtensionClass in namespace CWP\Core\Extension
CustomHtmlEditorFieldToolbarClass in namespace CWP\Core\Extension
CwpHtmlEditorConfigClass in namespace CWP\Core\Extension
CwpAtomFeedClass in namespace CWP\Core\Feed
CleanupGeneratedPdfBuildTaskClass in namespace CWP\PDFExport\Tasks
CleanupGeneratedPdfDailyTaskClass in namespace CWP\PDFExport\Tasks

If the silverstripe/crontask module is installed, this will enable the PDF cleanup task to be run on a schedule

CwpSearchEngineClass in namespace CWP\Search

Provides interface for generating search results for a SolrIndex

CwpSearchIndexClass in namespace CWP\Search

Abstract wrapper for all cwp-core features

$ CwpSearchIndex#copy_fieldsProperty in class CwpSearchIndex

Copy all fields into both search and spellcheck data source

CwpSearchPageClass in namespace CWP\Search

Dummy page to assist with display of search results

CwpSearchPage::canViewStage() — Method in class CwpSearchPage
CwpSearchPageControllerClass in namespace CWP\Search

Description of SearchPageController

CwpSearchResultClass in namespace CWP\Search

Container for a set of search results

CwpSearchBoostExtensionClass in namespace CWP\Search\Extensions

Adds field boosting capabilities to fulltext search for pages

$ SearchControllerExtension#classes_to_searchProperty in class SearchControllerExtension

Which classes should be queried when searching?

CwpSolrClass in namespace CWP\Search\Solr

CwpSolr configures Solr in a CWP-compatible manner.

CwpSolr::configure() — Method in class CwpSolr

Configure Solr.

CwpSolrConfigStoreClass in namespace CWP\Search\Solr
CwpSolrIndexClass in namespace CWP\Search\Solr

Default search index

HTTPBulkToolsResponse::createBody() — Method in class HTTPBulkToolsResponse

Creates the response JSON body

$ ElementalAreasExtension#clear_contentfieldProperty in class ElementalAreasExtension

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

BaseElement::canView() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::canEdit() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::canDelete() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::canCreate() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::CMSEditLink() — Method in class BaseElement
ElementalArea::canEdit() — Method in class ElementalArea
ElementalArea::canView() — Method in class ElementalArea
ElementTypeReport::columns() — Method in class ElementTypeReport
ElementsInUseReport::columns() — Method in class ElementsInUseReport
$ MigrateContentToElement#clear_contentProperty in class MigrateContentToElement

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

CacheAfterCallAspectClass in namespace LeKoala\DebugBar\Aspects
ConfigCollectorClass in namespace LeKoala\DebugBar\Collector

Collects data about the config usage during a SilverStripe request

ConfigCollector::collect() — Method in class ConfigCollector
DatabaseCollector::collect() — Method in class DatabaseCollector
HeaderCollector::collect() — Method in class HeaderCollector
PartialCacheCollector::collect() — Method in class PartialCacheCollector
PhpInfoCollector::collect() — Method in class PhpInfoCollector
SilverStripeCollector::collect() — Method in class SilverStripeCollector
DebugBar::clearDebugBar() — Method in class DebugBar

Clear the current instance of DebugBar

DebugBar::closeExtraTime() — Method in class DebugBar

Close any open extra time record

ControllerExtensionClass in namespace LeKoala\DebugBar\Extension

A controller extension to log times and render the Debug Bar

ConfigManifestProxyClass in namespace LeKoala\DebugBar\Proxy
DeltaConfigManifestProxy::createFromOriginal() — Method in class DeltaConfigManifestProxy
CMSBatchActionClass 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.

CMSBatchActionHandlerClass in namespace SilverStripe\Admin

Special request handler for admin/batchaction

CMSEditLinkExtensionClass in namespace SilverStripe\Admin

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

CMSEditLinkExtension::CMSEditLink() — Method in class CMSEditLinkExtension

Get a link to edit this DataObject in the CMS.

CMSMenuClass in namespace SilverStripe\Admin

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

CMSMenu::clear_menu() — Method in class CMSMenu

Clears the entire menu

CMSMenuItemClass in namespace SilverStripe\Admin

A simple CMS menu item.

$ CMSMenuItem#controllerProperty in class CMSMenuItem

Parent controller class name

CMSProfileControllerClass in namespace SilverStripe\Admin
CMSProfileController::canView() — Method in class CMSProfileController
LeftAndMain::canView() — Method in class LeftAndMain
LeftAndMain::Content() — Method in class LeftAndMain
LeftAndMain::currentPageID() — Method in class LeftAndMain

Identifier for the currently shown record, in most cases a database ID. Inspects the following sources (in this order):

  • GET/POST parameter named 'ID'
  • URL parameter named 'ID'
  • Session value namespaced by classname, e.g. "CMSMain.currentPage"
LeftAndMain::currentPage() — Method in class LeftAndMain

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

LeftAndMain::CMSVersion() — Method in class LeftAndMain

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

LeftAndMain::CMSVersionNumber() — Method in class LeftAndMain

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

AssetAdmin::createfolder() — Method in class AssetAdmin
AssetAdmin::canView() — Method in class AssetAdmin
CampaignAdminExtensionClass in namespace SilverStripe\AssetAdmin\Extensions

Extension that updates the Popover menu of FileFormFactory.

CreateFileMutationCreatorClass in namespace SilverStripe\AssetAdmin\GraphQL
CreateFolderMutationCreatorClass in namespace SilverStripe\AssetAdmin\GraphQL

API available but currently not used, as create folder uses FormBuilder

ReadFileQueryCreator::createConnection() — Method in class ReadFileQueryCreator
TestAssetStore::cleanFilename() — Method in class TestAssetStore
$ File#class_for_file_extensionProperty in class File

Map of file extensions to class type

$ File#ContentProperty in class File
File::canView() — Method in class File
File::canEdit() — Method in class File

Check if this file can be modified

File::canCreate() — Method in class File

Check if a file can be created

File::canDelete() — Method in class File

Check if this file can be deleted

File::collateDescendants() — Method in class File

Collate selected descendants of this page.

File::copyFile() — Method in class File

Copy to new filename.

File::canViewFile() — Method in class File

Check if the current user can view the given file.

File::CMSEditLink() — Method in class File
FileDefaultPermissions::canEdit() — Method in class FileDefaultPermissions

Can root be edited?

FileDefaultPermissions::canView() — Method in class FileDefaultPermissions

Can root be viewed?

FileDefaultPermissions::canDelete() — Method in class FileDefaultPermissions

Can root be deleted?

FileDefaultPermissions::canCreate() — Method in class FileDefaultPermissions

Can root objects be created?

FileIDHelper::cleanFilename() — Method in class FileIDHelper

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

FileIDHelperResolutionStrategy::cleanFilename() — Method in class FileIDHelperResolutionStrategy

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

FileResolutionStrategy::cleanFilename() — Method in class FileResolutionStrategy

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

HashFileIDHelper::cleanFilename() — Method in class HashFileIDHelper

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

LegacyFileIDHelper::cleanFilename() — Method in class LegacyFileIDHelper

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

NaturalFileIDHelper::cleanFilename() — Method in class NaturalFileIDHelper

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

FlysystemAssetStore::copy() — Method in class FlysystemAssetStore

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

FlysystemAssetStore::canView() — Method in class FlysystemAssetStore

Check if the current user can view the given file.

Folder::ChildFolders() — Method in class Folder

Get the children of this folder that are also folders.

ImageBackendFactory::create() — Method in class ImageBackendFactory

Creates a new service instance.

$ ImageManipulation#cms_thumbnail_widthProperty in class ImageManipulation

The width of an image thumbnail in the CMS.

$ ImageManipulation#cms_thumbnail_heightProperty in class ImageManipulation

The height of an image thumbnail in the CMS.

ImageManipulation::CropWidth() — Method in class ImageManipulation

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

ImageManipulation::CropHeight() — Method in class ImageManipulation

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

ImageManipulation::CMSThumbnail() — Method in class ImageManipulation

Default CMS thumbnail

Image_Backend::croppedResize() — Method in class Image_Backend

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

Image_Backend::crop() — Method in class Image_Backend

Crop's part of image.

InterventionBackend::croppedResize() — Method in class InterventionBackend

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

InterventionBackend::crop() — Method in class InterventionBackend

Crop's part of image.

AssetContainer::copyFile() — Method in class AssetContainer

Copy to new filename.

AssetContainer::canViewFile() — Method in class AssetContainer

Check if the current user can view the given file.

AssetStore::copy() — Method in class AssetStore

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

AssetStore::canView() — Method in class AssetStore

Check if the current user can view the given file.

DBFile::canViewFile() — Method in class DBFile

Check if the current user can view the given file.

DBFile::copyFile() — Method in class DBFile

Copy to new filename.

DefaultAssetNameGenerator::current() — Method in class DefaultAssetNameGenerator
FileHashingService::computeFromStream() — Method in class FileHashingService

Compute the Hash value of the provided stream.

FileHashingService::computeFromFile() — Method in class FileHashingService

Compute the hash of the provided file

FileHashingService::compare() — Method in class FileHashingService

Compare 2 full or partial hashes.

Sha1FileHashingService::computeFromStream() — Method in class Sha1FileHashingService

Compute the Hash value of the provided stream.

Sha1FileHashingService::computeFromFile() — Method in class Sha1FileHashingService

Compute the hash of the provided file

Sha1FileHashingService::compare() — Method in class Sha1FileHashingService

Compare 2 full or partial hashes.

Upload::clearErrors() — Method in class Upload

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

Upload_Validator::clearErrors() — Method in class Upload_Validator

Clear out all errors

AuditFactory::create() — Method in class AuditFactory

Creates a new service instance.

CoreInitializationPassClass in namespace SilverStripe\BehatExtension\Compiler

Loads SilverStripe core. Required to initialize autoloading.

BasicContext::closeModalDialog() — Method in class BasicContext

Close modal dialog if test scenario fails on CMS page

BasicContext::cleanAssetsAfterScenario() — Method in class BasicContext

Delete any created files and folders from assets directory

BasicContext::castRelativeToAbsoluteTime() — Method in class BasicContext

Transforms relative time statements compatible with strtotime().

BasicContext::castRelativeToAbsoluteDatetime() — Method in class BasicContext

Transforms relative date and time statements compatible with strtotime().

BasicContext::castRelativeToAbsoluteDate() — Method in class BasicContext

Transforms relative date statements compatible with strtotime().

SilverStripeContext::canIntercept() — Method in class SilverStripeContext
SilverStripeContext::clickLink() — Method in class SilverStripeContext

Overwritten to click the first visible link the DOM.

ModuleInitialisationController::configure() — Method in class ModuleInitialisationController

{@inheritdoc}

ModuleSuiteLocator::configure() — Method in class ModuleSuiteLocator

Configures command to be able to process it later.

Extension::configure() — Method in class Extension
TestMailer::clearEmails() — Method in class TestMailer

Clear the log of emails sent

Blog::canEdit() — Method in class Blog

{@inheritdoc}

Blog::canAddChildren() — Method in class Blog

{@inheritdoc}

Blog::canEditEditors() — Method in class Blog

Determine if this user can edit the editors list.

Blog::canEditWriters() — Method in class Blog

Determine if this user can edit writers list.

Blog::canEditContributors() — Method in class Blog

Determines if this user can edit the contributors list.

Blog::Categories() — Method in class Blog

List of categories in this blog

Blog::Contributors() — Method in class Blog

List of contributors

BlogController::category() — Method in class BlogController

Renders the blog posts for a given category.

BlogObject::canView() — Method in class BlogObject

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

BlogObject::canCreate() — Method in class BlogObject

{@inheritdoc}

BlogObject::canDelete() — Method in class BlogObject

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

BlogObject::canEdit() — Method in class BlogObject

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

BlogPost::canEditAuthors() — Method in class BlogPost

Determine if this user can edit the authors list.

BlogPost::canCreateCategories() — Method in class BlogPost

Determine whether user can create new categories.

BlogPost::canCreateTags() — Method in class BlogPost

Determine whether user can create new tags.

BlogPost::canView() — Method in class BlogPost

{@inheritdoc}

BlogPost::canPublish() — Method in class BlogPost

{@inheritdoc}

BlogPost::canEdit() — Method in class BlogPost

{@inheritdoc}

BlogPost::Categories() — Method in class BlogPost
CategorisationObjectClass in namespace SilverStripe\Blog\Model
ResourceField::create() — Method in class ResourceField
CKANRegistryPageClass in namespace SilverStripe\CKANRegistry\Page

A CKANRegistryPage will render a chosen CKAN data set on the frontend, provide the user with configurable filters and display a set of CMS configured columns.

CKANRegistryPageControllerClass in namespace SilverStripe\CKANRegistry\Page
CMSBatchAction_ArchiveClass in namespace SilverStripe\CMS\BatchActions

Delete items batch action.

CMSBatchAction_PublishClass in namespace SilverStripe\CMS\BatchActions

Publish items batch action.

CMSBatchAction_RestoreClass in namespace SilverStripe\CMS\BatchActions

Batch restore of pages

CMSBatchAction_UnpublishClass in namespace SilverStripe\CMS\BatchActions

Unpublish items batch action.

CMSMainClass in namespace SilverStripe\CMS\Controllers

The main "content" area of the CMS.

CMSMain::clearCache() — Method in class CMSMain

Clears all dependent cache backends

CMSMain::CanOrganiseSitetree() — Method in class CMSMain

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

CMSMain::childfilter() — Method in class CMSMain

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

CMSMain::currentPageID() — Method in class CMSMain

Identifier for the currently shown record, in most cases a database ID. Inspects the following sources (in this order):

  • GET/POST parameter named 'ID'
  • URL parameter named 'ID'
  • Session value namespaced by classname, e.g. "CMSMain.currentPage"
CMSPageAddControllerClass in namespace SilverStripe\CMS\Controllers
CMSPageEditControllerClass in namespace SilverStripe\CMS\Controllers
CMSPageHistoryControllerClass in namespace SilverStripe\CMS\Controllers

Legacy CMS History controller. This functionality has been moved to the silverstripe/versioned-admin module and this class will be removed completly in SilverStripe 5.0.0.

CMSPageHistoryController::compare() — Method in class CMSPageHistoryController
CMSPageHistoryController::CompareVersionsForm() — Method in class CMSPageHistoryController
CMSPageSettingsControllerClass in namespace SilverStripe\CMS\Controllers
CMSPagesControllerClass in namespace SilverStripe\CMS\Controllers
CMSSiteTreeFilterClass in namespace SilverStripe\CMS\Controllers

Base class for filtering the subtree for certain node statuses.

CMSSiteTreeFilter_ChangedPagesClass in namespace SilverStripe\CMS\Controllers

Gets all pages which have changed on stage.

CMSSiteTreeFilter_DeletedPagesClass in namespace SilverStripe\CMS\Controllers

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

CMSSiteTreeFilter_PublishedPagesClass 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_SearchClass in namespace SilverStripe\CMS\Controllers
CMSSiteTreeFilter_StatusDeletedPagesClass in namespace SilverStripe\CMS\Controllers

Filters pages which have a status "Deleted".

CMSSiteTreeFilter_StatusDraftPagesClass in namespace SilverStripe\CMS\Controllers

Filters pages which have a status "Draft".

CMSSiteTreeFilter_StatusRemovedFromDraftPagesClass in namespace SilverStripe\CMS\Controllers

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

ContentControllerClass in namespace SilverStripe\CMS\Controllers

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

ContentController::ChildrenOf() — Method in class ContentController

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

ContentController::ContentLocale() — Method in class ContentController

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

ModelAsController::controller_for() — Method in class ModelAsController

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

SilverStripeNavigatorItem::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_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_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.

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.

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.

CurrentPageIdentifierClass in namespace SilverStripe\CMS\Model

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

CurrentPageIdentifier::currentPageID() — Method in class CurrentPageIdentifier

Get the current page ID.

RedirectorPage::ContentSource() — Method in class RedirectorPage

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

$ SiteTree#can_be_rootProperty in class SiteTree

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

$ SiteTree#controller_nameProperty in class SiteTree

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

$ SiteTree#can_createProperty 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_pagesProperty in class SiteTree
$ SiteTree#ContentProperty 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::creatableChildren() — Method in class SiteTree
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#CopyContentFromIDProperty 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
ContentControllerSearchExtensionClass in namespace SilverStripe\CMS\Search

Extension to provide a search interface when applied to ContentController

SearchForm::classesToSearch() — Method in class SearchForm

Set the classes to search.

CampaignAdminClass 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

CampaignAdminExtensionClass in namespace SilverStripe\CampaignAdmin
CampaignAdminListClass in namespace SilverStripe\CampaignAdmin

Warning: Volatile API as placeholder for standard "GridField"

CommentNotifiableClass in namespace SilverStripe\CommentNotifications\Extensions
CommentNotifierClass in namespace SilverStripe\CommentNotifications\Extensions

Extension applied to CommentingController to invoke notifications

CommentAdminClass in namespace SilverStripe\Comments\Admin

Comment administration system within the CMS

CommentsGridFieldClass in namespace SilverStripe\Comments\Admin
CommentsGridFieldActionClass in namespace SilverStripe\Comments\Admin
CommentsGridFieldApproveActionClass in namespace SilverStripe\Comments\Admin
CommentHandlerClass in namespace SilverStripe\Comments\Admin\CommentsGridFieldBulkAction
CommentsGridFieldConfigClass in namespace SilverStripe\Comments\Admin
CommentsGridFieldSpamActionClass in namespace SilverStripe\Comments\Admin
CommentingControllerClass in namespace SilverStripe\Comments\Controllers
CommentingController::CommentsForm() — Method in class CommentingController

Post a comment form

CommentsExtensionClass in namespace SilverStripe\Comments\Extensions

Extension to {@link DataObject} to enable tracking comments.

$ CommentsExtension#commentsProperty in class CommentsExtension

Default configuration values

CommentsExtension::Comments() — Method in class CommentsExtension

Returns the root level comments, with spam and unmoderated items excluded, for use in the frontend

CommentsExtension::canPostComment() — Method in class CommentsExtension

Determine if a user can post comments on this item

CommentsExtension::canModerateComments() — Method in class CommentsExtension

Determine if this member can moderate comments in the CMS

CommentsExtension::CommentsForm() — Method in class CommentsExtension

Comments interface for the front end. Includes the CommentAddForm and the composition of the comments display.

CommentFormClass in namespace SilverStripe\Comments\Forms
CommentClass in namespace SilverStripe\Comments\Model

Represents a single comment object.

$ Comment#CommentProperty in class Comment
Comment::castingHelper() — Method in class Comment

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.

Comment::canCreate() — Method in class Comment
Comment::canView() — Method in class Comment

Checks for association with a page, and {@link SiteTree->ProvidePermission} flag being set to true.

Comment::canEdit() — Method in class Comment

Checks if the comment can be edited.

Comment::canDelete() — Method in class Comment

Checks if the comment can be deleted.

Comment::canPostComment() — Method in class Comment

Proxy for checking whether the has permission to comment on the comment parent.

Comment::ChildComments() — Method in class Comment

List of child comments

SecurityToken::checkRequest() — Method in class SecurityToken
CachedConfigCollectionClass in namespace SilverStripe\Config\Collections
CachedConfigCollection::create() — Method in class CachedConfigCollection
ConfigCollectionInterfaceClass in namespace SilverStripe\Config\Collections

This represents a collection of config keys and values.

DeltaConfigCollection::createFromCollection() — Method in class DeltaConfigCollection

Create a delta collection from a parent collection

MemoryConfigCollection::create() — Method in class MemoryConfigCollection
MemoryConfigCollection::checkForDeprecatedConfig() — Method in class MemoryConfigCollection
YamlTransformer::create() — Method in class YamlTransformer
ContentReviewCompatabilityClass 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.

ContentReviewCMSExtensionClass in namespace SilverStripe\ContentReview\Extensions

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

ContentReviewDefaultSettingsClass in namespace SilverStripe\ContentReview\Extensions

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

$ ContentReviewDefaultSettings#content_review_templateProperty 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.

ContentReviewLeftAndMainExtensionClass in namespace SilverStripe\ContentReview\Extensions
ContentReviewOwnerClass in namespace SilverStripe\ContentReview\Extensions
$ SiteTreeContentReview#ContentReviewTypeProperty in class SiteTreeContentReview
SiteTreeContentReview::ContentReviewOwners() — Method in class SiteTreeContentReview

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

SiteTreeContentReview::canBeReviewedBy() — Method in class SiteTreeContentReview

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

SiteTreeContentReview::ContentReviewGroups() — Method in class SiteTreeContentReview
SiteTreeContentReview::ContentReviewUsers() — Method in class SiteTreeContentReview
ReviewContentHandler::canSubmitReview() — Method in class ReviewContentHandler

Determine whether the user can submit a review

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

ContentReviewLogClass in namespace SilverStripe\ContentReview\Models
ContentReviewLog::canView() — Method in class ContentReviewLog
PagesDueForReviewReport::columns() — Method in class PagesDueForReviewReport
PagesWithoutReviewScheduleReport::columns() — Method in class PagesWithoutReviewScheduleReport
ContentReviewEmailsClass in namespace SilverStripe\ContentReview\Tasks

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

ContentReviewOwnerMigrationTaskClass in namespace SilverStripe\ContentReview\Tasks

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

ContentWidgetClass in namespace SilverStripe\ContentWidget

Content Widget

CLIRequestBuilderClass 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
CliControllerClass in namespace SilverStripe\Control

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

ContentNegotiatorClass 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_typeProperty in class ContentNegotiator
ControllerClass in namespace SilverStripe\Control

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

Controller::curr() — Method in class Controller

Returns the current controller.

Controller::can() — Method in class Controller

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

CookieClass in namespace SilverStripe\Control

A set of static methods for manipulating cookies.

CookieJarClass in namespace SilverStripe\Control

A default backend for the setting and getting of cookies

Cookie_BackendClass in namespace SilverStripe\Control

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

$ Email#cc_all_emails_toProperty in class Email
$ HTTP#cache_ajax_requestsProperty in class HTTP
$ HTTP#cache_controlProperty in class HTTP

List of names to add to the Cache-Control header.

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

CanonicalURLMiddlewareClass 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
ChangeDetectionMiddlewareClass in namespace SilverStripe\Control\Middleware

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

ConfirmationMiddlewareClass in namespace SilverStripe\Control\Middleware

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

ConfirmationMiddleware::canBypass() — Method in class ConfirmationMiddleware

Check whether the rules can be bypassed without user confirmation

AjaxBypass::checkRequestForBypass() — Method in class AjaxBypass

Returns true for AJAX requests

Bypass::checkRequestForBypass() — Method in class Bypass

Check the request for whether we can bypass the confirmation

CliBypassClass in namespace SilverStripe\Control\Middleware\ConfirmationMiddleware

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

CliBypass::checkRequestForBypass() — Method in class CliBypass

Returns true if the current process is running in CLI mode

EnvironmentBypass::checkRequestForBypass() — Method in class EnvironmentBypass

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

GetParameter::checkRequestForBypass() — Method in class GetParameter

Check the request for whether we can bypass the confirmation

HttpMethodBypass::checkRequestForBypass() — Method in class HttpMethodBypass

Returns true if the current process is running in CLI mode

Url::checkRequestForBypass() — Method in class Url

Check the request for whether we can bypass the confirmation

Url::checkRequest() — Method in class Url

Match the request against the rules

UrlPathStartswith::checkRequestForBypass() — Method in class UrlPathStartswith

Check the request for whether we can bypass the confirmation

RequestHandler::checkAccessAction() — Method in class RequestHandler

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

$ Session#cookie_domainProperty in class Session
$ Session#cookie_pathProperty in class Session
$ Session#cookie_secureProperty in class Session
$ Session#cookie_name_secureProperty in class Session
$ Session#cookie_samesiteProperty in class Session

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

Session::clear() — Method in class Session

Clear session value

Session::clearAll() — Method in class Session

Clear all values

Session::changedData() — Method in class Session

Returns the list of changed keys

IPUtils::checkIP() — Method in class IPUtils

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

IPUtils::checkIP4() — Method in class IPUtils

Compares two IPv4 addresses.

IPUtils::checkIP6() — Method in class IPUtils

Compares two IPv6 addresses.

ApcuCacheFactory::create() — Method in class ApcuCacheFactory
CacheFactoryClass in namespace SilverStripe\Core\Cache
CacheFactory::create() — Method in class CacheFactory

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

DefaultCacheFactory::create() — Method in class DefaultCacheFactory
FilesystemCacheFactory::create() — Method in class FilesystemCacheFactory
ManifestCacheFactory::create() — Method in class ManifestCacheFactory

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.

ManifestCacheFactory::createCache() — Method in class ManifestCacheFactory

Create cache directly without config / injector

MemcachedCacheFactory::create() — Method in class MemcachedCacheFactory
RateLimiter::clearAttempts() — Method in class RateLimiter
RateLimiter::canAccess() — Method in class RateLimiter
ClassInfoClass 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

ConfigClass in namespace SilverStripe\Core\Config
ConfigLoaderClass in namespace SilverStripe\Core\Config

Registers config sources via ConfigCollectionInterface

ConfigLoader::countManifests() — Method in class ConfigLoader

Check number of manifests

Config_ForClassClass in namespace SilverStripe\Core\Config
ConfigurableClass 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, .....).

CoreConfigFactoryClass in namespace SilverStripe\Core\Config

Factory for silverstripe configs

CoreConfigFactory::createRoot() — Method in class CoreConfigFactory

Create root application config.

CoreConfigFactory::createCore() — Method in class CoreConfigFactory

Rebuild new uncached config, which is mutable

ConvertClass in namespace SilverStripe\Core

Library of conversion functions, implemented as static methods.

CoreKernelClass in namespace SilverStripe\Core

Simple Kernel container

CustomMethodsClass in namespace SilverStripe\Core

Allows an object to declare a set of custom methods

Extension::clearOwner() — Method in class Extension

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

Factory::create() — Method in class Factory

Creates a new service instance.

Injectable::create() — Method in class Injectable

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

InjectionCreator::create() — Method in class InjectionCreator

Create a new instance of a class

Injector::convertServiceProperty() — Method in class Injector

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

Injector::create() — Method in class Injector

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

Injector::createWithArgs() — Method in class Injector

Creates an object with the supplied argument array

InjectorLoader::countManifests() — Method in class InjectorLoader

Check number of manifests

ClassContentRemoverClass in namespace SilverStripe\Core\Manifest

Class ClassContentRemover

ClassLoaderClass in namespace SilverStripe\Core\Manifest

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

ClassLoader::classExists() — Method in class ClassLoader

Returns true if a class or interface name exists in the manifest.

ClassManifestClass in namespace SilverStripe\Core\Manifest

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

ClassManifestErrorHandlerClass in namespace SilverStripe\Core\Manifest

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

ClassManifestVisitorClass in namespace SilverStripe\Core\Manifest
ModuleLoader::countManifests() — Method in class ModuleLoader

Check number of manifests

CallbackFlushDiscovererClass in namespace SilverStripe\Core\Startup

Handle a callable object as a discoverer

CompositeFlushDiscovererClass in namespace SilverStripe\Core\Startup

Implements the composite over flush discoverers

CronTaskControllerClass in namespace SilverStripe\CronTask\Controllers

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

CronTaskStatusClass in namespace SilverStripe\CronTask

Record status of each cron task execution

CronTaskClass 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#columnMapProperty in class BulkLoader

Map columns to DataObject-properties.

BulkLoader_Result::Count() — Method in class BulkLoader_Result

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

BulkLoader_Result::CreatedCount() — Method in class BulkLoader_Result
BulkLoader_Result::Created() — Method in class BulkLoader_Result

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

CLIClass in namespace SilverStripe\Dev

Class to facilitate command-line output.

CSSContentParserClass in namespace SilverStripe\Dev

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

CSVParserClass in namespace SilverStripe\Dev

Class to handle parsing of CSV files, where the column headers are in the first row.

CSVParser::current() — Method in class CSVParser
CliDebugViewClass in namespace SilverStripe\Dev

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

CsvBulkLoaderClass 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#columnsProperty in class DebugView

Column size to wrap long strings to

FixtureBlueprint::createObject() — Method in class FixtureBlueprint
FixtureFactory::createObject() — Method in class FixtureFactory

Writes the fixture into the database using DataObjects

FixtureFactory::createRaw() — Method in class FixtureFactory

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

FixtureFactory::clear() — Method in class FixtureFactory

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

FunctionalTest::content() — Method in class FunctionalTest

Return the most recent content

FunctionalTest::cssParser() — Method in class FunctionalTest

Return a CSSContentParser for the most recent content.

MySQLDatabaseConfigurationHelper::checkValidDatabaseName() — Method in class MySQLDatabaseConfigurationHelper

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

MySQLDatabaseConfigurationHelper::checkDatabasePermissionGrant() — Method in class MySQLDatabaseConfigurationHelper

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

MySQLDatabaseConfigurationHelper::checkDatabasePermission() — Method in class MySQLDatabaseConfigurationHelper

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

SapphireTest::clearFixtures() — Method in class SapphireTest

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

SapphireTest::clearEmails() — Method in class SapphireTest

Clear the log of emails sent

CleanupTestDatabasesTaskClass in namespace SilverStripe\Dev\Tasks

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

TestMailer::clearEmails() — Method in class TestMailer

Clear the log of emails sent

TestSession::cssParser() — Method in class TestSession

Return a CSSContentParser containing the most recent response

RelationValidationService::clearErrors() — Method in class RelationValidationService
BannerBlock::CallToActionLink() — Method in class BannerBlock

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

CacheHeadersCheckClass in namespace SilverStripe\EnvironmentCheck\Checks

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

CacheHeadersCheck::check() — Method in class CacheHeadersCheck

Check that correct caching headers are present.

DatabaseCheck::check() — Method in class DatabaseCheck
EnvTypeCheck::check() — Method in class EnvTypeCheck

Check the environment setting.

ExternalURLCheck::check() — Method in class ExternalURLCheck
FileAccessibilityAndValidationCheck::check() — Method in class FileAccessibilityAndValidationCheck
FileAgeCheck::check() — Method in class FileAgeCheck
FileWriteableCheck::check() — Method in class FileWriteableCheck
HasClassCheck::check() — Method in class HasClassCheck
HasFunctionCheck::check() — Method in class HasFunctionCheck
SMTPConnectCheck::check() — Method in class SMTPConnectCheck
SessionCheck::check() — Method in class SessionCheck

Check that the response for URL does not create a session

SolrIndexCheck::check() — Method in class SolrIndexCheck
URLCheck::check() — Method in class URLCheck
EnvironmentCheck::check() — Method in class EnvironmentCheck
EnvironmentChecker::canAccess() — Method in class EnvironmentChecker

Determine if the current member can access the environment checker

ClientFactoryClass 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#clientProperty in class Fetcher

Client for making requests, set vi Injector.

ErrorPage::canAddChildren() — Method in class ErrorPage
CMSExternalLinksControllerClass in namespace SilverStripe\ExternalLinks\Controllers
CheckExternalLinksJobClass 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#CompletedPagesProperty 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
CheckExternalLinksTaskClass in namespace SilverStripe\ExternalLinks\Tasks
CurlLinkCheckerClass 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

CheckboxFieldClass in namespace SilverStripe\Forms

Single checkbox field.

CheckboxField_ReadonlyClass in namespace SilverStripe\Forms

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

CheckboxSetFieldClass in namespace SilverStripe\Forms

Displays a set of checkboxes as a logical group.

CompositeFieldClass in namespace SilverStripe\Forms

Base class for all fields that contain other fields.

CompositeField::collateDataFields() — Method in class CompositeField

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

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

ConfirmedPasswordFieldClass in namespace SilverStripe\Forms

Two masked input fields, checks for matching passwords.

$ ConfirmedPasswordField#canBeEmptyProperty in class ConfirmedPasswordField

Allow empty fields in serverside validation

$ ConfirmedPasswordField#childrenProperty in class ConfirmedPasswordField

Child fields (_Password, _ConfirmPassword)

CurrencyFieldClass in namespace SilverStripe\Forms

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

CurrencyField_DisabledClass in namespace SilverStripe\Forms

Readonly version of a {@link CurrencyField}.

CurrencyField_ReadonlyClass in namespace SilverStripe\Forms

Readonly version of a {@link CurrencyField}.

FieldList::changeFieldOrder() — Method in class FieldList

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

$ Form#castingProperty in class Form
Form::clearFormState() — Method in class Form

Flush persistent form state details

Form::clearMessage() — Method in class Form

Clear form message (and in session)

Form::castingHelper() — Method in class Form

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

$ FormAction#castingProperty in class FormAction
FormField::castingHelper() — Method in class FormField

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

FormField::castedCopy() — Method in class FormField

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

FormField::canSubmitValue() — Method in class FormField

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

FormRequestHandler::checkAccessAction() — Method in class FormRequestHandler
GridFieldFilterHeader::canFilterAnyColumns() — Method in class GridFieldFilterHeader

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

ReadonlyField::castingHelper() — Method in class ReadonlyField

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

RequiredFields::canBeCached() — Method in class RequiredFields
AbstractSegmentFieldModifier::create() — Method in class AbstractSegmentFieldModifier
SelectField::castedCopy() — Method in class SelectField

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

SingleSelectField::castedCopy() — Method in class SingleSelectField

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

TreeDropdownField::castedCopy() — Method in class TreeDropdownField
Validator::canBeCached() — Method in class Validator

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

SearchCriteria::create() — Method in class SearchCriteria

Static create method provided so that you can perform method chaining.

$ SearchIndex#class_delimiterProperty in class SearchIndex

Used to separate class name and relation name in the sources array this string must not be present in class name

SearchIndex::commit() — Method in class SearchIndex
SearchIndex_Null::commit() — Method in class SearchIndex_Null
$ SearchIndex_Recording#committedProperty in class SearchIndex_Recording
SearchIndex_Recording::commit() — Method in class SearchIndex_Recording
$ SearchUpdateCommitJobProcessor#commit_queueProperty in class SearchUpdateCommitJobProcessor

The QueuedJob queue to use when processing commits

$ SearchUpdateCommitJobProcessor#cooldownProperty in class SearchUpdateCommitJobProcessor

If solrindex::commit has already been performed, but additional commits are necessary, how long do we wait before attempting to touch the index again?

$ SearchQuery#classesProperty in class SearchQuery
$ SearchQuery#criteriaProperty in class SearchQuery
SearchableService::clearCache() — Method in class SearchableService

Clears the internal cache

SearchUpdater::clear_dirty_indexes() — Method in class SearchUpdater

Throw away the recorded dirty IDs without doing anything with them.

SearchVariant::currentState() — Method in class SearchVariant

Return the current state

SearchVariant::clear_variant_cache() — Method in class SearchVariant

Clear the cached variants

SearchVariant::call() — Method in class SearchVariant

A shortcut to with when calling without passing in a class,

SearchVariant::current_state() — Method in class SearchVariant

Get the current state of every variant

SearchVariantSubsites::currentState() — Method in class SearchVariantSubsites

Return the current state

SearchVariantVersioned::currentState() — Method in class SearchVariantVersioned

Return the current state

SearchVariant_Caller::call() — Method in class SearchVariant_Caller
ContentControllerExtensionClass in namespace SilverStripe\FullTextSearch\Solr\Control
Solr4Service_Core::commit() — Method in class Solr4Service_Core

Replace underlying commit function to remove waitFlush in 4.0+, since it's been deprecated and 4.4 throws errors if you pass it

SolrService::coreIsActive() — Method in class SolrService

Is the passed core active?

SolrService::coreCreate() — Method in class SolrService

Create a new core

SolrService::coreReload() — Method in class SolrService

Reload a core

Solr::configure_server() — Method in class Solr

Update the configuration for Solr. See $solr_options for a discussion of the accepted array keys

SolrIndex::canAdd() — Method in class SolrIndex
SolrIndex::clearObsoleteClasses() — Method in class SolrIndex

Clear all records which do not match the given classname whitelist.

SolrIndex::commit() — Method in class SolrIndex
CombinationsArrayIteratorClass in namespace SilverStripe\FullTextSearch\Utils
CombinationsArrayIterator::current() — Method in class CombinationsArrayIterator
MultipleArrayIterator::current() — Method in class MultipleArrayIterator
WebDAV::curl_init() — Method in class WebDAV
ClearClass in namespace SilverStripe\GraphQLDevTools
Clear::clear() — Method in class Clear
ControllerClass in namespace SilverStripe\GraphQLDevTools
ConfigurationClass in namespace SilverStripe\GraphQL\Config
ControllerClass in namespace SilverStripe\GraphQL

Top level controller for handling graphql requests.

$ Controller#corsProperty in class Controller

Cors default config

ClientConfigProviderClass in namespace SilverStripe\GraphQL\Extensions
CSRFMiddlewareClass in namespace SilverStripe\GraphQL\Middleware

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

AbstractBulkLoader::collect() — Method in class AbstractBulkLoader
CollectionClass 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
CreateCreatorClass 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
CanViewPermissionClass 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
ContainsFilterClass 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
ConfigurationApplierClass in namespace SilverStripe\GraphQL\Schema\Interfaces

Applies an array of config to a class

ContextProviderClass 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
ComposedResolverClass 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
CodeGenerationStoreClass in namespace SilverStripe\GraphQL\Schema\Storage
$ CodeGenerationStore#configFilenameProperty in class CodeGenerationStore
CodeGenerationStore::clear() — Method in class CodeGenerationStore
CodeGenerationStoreCreatorClass in namespace SilverStripe\GraphQL\Schema\Storage
CodeGenerationStoreCreator::createStore() — Method in class CodeGenerationStoreCreator
CanonicalModelAwareClass in namespace SilverStripe\GraphQL\Schema\Type
TypeReference::createFromPath() — Method in class TypeReference
GridFieldQueuedExportButton::checkExport() — Method in class GridFieldQueuedExportButton

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

$ GenerateCSVJob#chunk_sizeProperty in class GenerateCSVJob
CryptoHandlerClass in namespace SilverStripe\HybridSessions\Crypto
HybridSession::close() — Method in class HybridSession
CookieStoreClass in namespace SilverStripe\HybridSessions\Store

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

CookieStore::close() — Method in class CookieStore
DatabaseStore::close() — Method in class DatabaseStore
LDAPAuthenticator::checkPassword() — Method in class LDAPAuthenticator

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

LDAPChangePasswordHandler::changePasswordForm() — Method in class LDAPChangePasswordHandler

Factory method for the lost password form

$ LDAPMemberExtension#create_users_in_ldapProperty in class LDAPMemberExtension

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

LDAPIterator::current() — Method in class LDAPIterator
LDAPGateway::changePassword() — Method in class LDAPGateway

Changes user password via LDAP.

LDAPService::createLDAPUser() — Method in class LDAPService

Creates a new LDAP user from the passed Member record.

LDAPService::createLDAPGroup() — Method in class LDAPService

Creates a new LDAP group from the passed Group record.

EnablerExtension::ContentLocale() — Method in class EnablerExtension

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

ChangePasswordHandlerClass in namespace SilverStripe\MFA\Authenticator

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

ChangePasswordHandler::changepassword() — Method in class ChangePasswordHandler

Handle the change password request

MemberExtension::currentUserCanViewMFAConfig() — Method in class MemberExtension

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

MemberExtension::currentUserCanEditMFAConfig() — Method in class MemberExtension

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

EnabledMembers::columns() — Method in class EnabledMembers

List the columns configured to display in the resulting reports GridField

RegistrationHandlerTrait::createStartRegistrationResponse() — Method in class RegistrationHandlerTrait

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

RegistrationHandlerTrait::completeRegistrationRequest() — Method in class RegistrationHandlerTrait

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

EnforcementManager::canSkipMFA() — Method in class EnforcementManager

Whether the provided member can skip the MFA registration process.

RegisteredMethodManager::canRemoveMethod() — Method in class RegisteredMethodManager

Determines if a method can be removed

Result::create() — Method in class Result
SessionStore::clear() — Method in class SessionStore

Clear any stored values for the given request

StoreInterface::clear() — Method in class StoreInterface

Clear any stored state for the given request

MimeUploadValidator::compareMime() — Method in class MimeUploadValidator

Check two MIME types roughly match eachother.

ArrayList::count() — Method in class ArrayList

Return the number of items in this list

ArrayList::column() — Method in class ArrayList

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

ArrayList::columnUnique() — Method in class ArrayList

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

ArrayList::canSortBy() — Method in class ArrayList

You can always sort a ArrayList

ArrayList::canFilterBy() — Method in class ArrayList

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

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

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

DBSchemaManager::checkAndRepairTable() — Method in class DBSchemaManager

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

DBSchemaManager::createDatabase() — Method in class DBSchemaManager

Create a database with the specified name

DBSchemaManager::createTable() — Method in class DBSchemaManager

Create a new table.

DBSchemaManager::createField() — Method in class DBSchemaManager

Create a new field on a table.

DBSchemaManager::clearCachedFieldlist() — Method in class DBSchemaManager

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

Database::clearAllData() — Method in class Database

Clear all data out of the database

Database::clearTable() — Method in class Database

Clear all data in a given table

Database::comparisonClause() — Method in class Database

Generate a WHERE clause for text matching.

Database::concatOperator() — Method in class Database

String operator for concatenation of strings

Database::canLock() — Method in class Database

Returns if the lock is available.

Database::connect() — Method in class Database

Instruct the database to generate a live connection

$ MySQLDatabase#connection_charsetProperty in class MySQLDatabase

Default connection charset (may be overridden in $databaseConfig)

$ MySQLDatabase#connection_collationProperty in class MySQLDatabase

Default connection collation

$ MySQLDatabase#charsetProperty in class MySQLDatabase

Default charset

$ MySQLDatabase#collationProperty in class MySQLDatabase

Default collation

MySQLDatabase::connect() — Method in class MySQLDatabase

Instruct the database to generate a live connection

MySQLDatabase::comparisonClause() — Method in class MySQLDatabase

Generate a WHERE clause for text matching.

MySQLDatabase::canLock() — Method in class MySQLDatabase

Returns if the lock is available.

MySQLDatabase::clearTable() — Method in class MySQLDatabase

Clear all data in a given table

MySQLSchemaManager::createTable() — Method in class MySQLSchemaManager

Create a new table.

MySQLSchemaManager::checkAndRepairTable() — Method in class MySQLSchemaManager

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

MySQLSchemaManager::createField() — Method in class MySQLSchemaManager

Create a new field on a table.

MySQLSchemaManager::createDatabase() — Method in class MySQLSchemaManager

Create a database with the specified name

MySQLSchemaManager::createIndex() — Method in class MySQLSchemaManager

Create an index on a table.

MySQLiConnector::connect() — Method in class MySQLiConnector

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

PDOConnector::connect() — Method in class PDOConnector
PDOStatementHandle::closeCursor() — Method in class PDOStatementHandle

Closes the cursor, enabling the statement to be executed again (PDOStatement::closeCursor)

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

Query::current() — Method in class Query

Iterator function implementation. Return the current item of the iterator.

TempDatabase::clearAllData() — Method in class TempDatabase

Remove all content from the temporary database.

DB::connect() — Method in class DB

Specify connection to a database

DB::connection_attempted() — Method in class DB

Returns true if a database connection has been attempted.

DB::create_database() — Method in class DB

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

DB::create_table() — Method in class DB

Create a new table.

DB::create_field() — Method in class DB

Create a new field on a table.

DB::check_and_repair_table() — Method in class DB

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

DataExtension::can() — Method in class DataExtension

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

DataExtension::canEdit() — Method in class DataExtension

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

DataExtension::canDelete() — Method in class DataExtension

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

DataExtension::canCreate() — Method in class DataExtension

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

DataList::canSortBy() — Method in class DataList

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

DataList::canFilterBy() — Method in class DataList

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

DataList::createDataObject() — Method in class DataList

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

DataList::count() — Method in class DataList

Return the number of items in this DataList

DataList::column() — Method in class DataList

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

DataList::columnUnique() — Method in class DataList

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

DataList::chunkedFetch() — Method in class DataList

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

$ DataObject#cascade_deletesProperty in class DataObject

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

$ DataObject#create_table_optionsProperty in class DataObject

Specify custom options for a CREATE TABLE call.

$ DataObject#ClassNameProperty in class DataObject

Class name of the DataObject

$ DataObject#CreatedProperty in class DataObject

Date and time of DataObject creation.

DataObject::castedUpdate() — Method in class DataObject

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

DataObject::castingHelper() — Method in class DataObject

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

DataObject::can() — Method in class DataObject

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

DataObject::canView() — Method in class DataObject
DataObject::canEdit() — Method in class DataObject
DataObject::canDelete() — Method in class DataObject
DataObject::canCreate() — Method in class DataObject
DataObjectSchema::classHasTable() — Method in class DataObjectSchema

Check if the given class has a table

DataObjectSchema::compositeFields() — Method in class DataObjectSchema

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

DataObjectSchema::compositeField() — Method in class DataObjectSchema

Get a composite field for a class

DataObjectSchema::classForField() — Method in class DataObjectSchema

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

DataQuery::count() — Method in class DataQuery

Return the number of records in this query.

DataQuery::conjunctiveGroup() — Method in class DataQuery

Create a conjunctive subgroup

DataQuery::column() — Method in class DataQuery

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

DataQuery_SubGroup::conditionSQL() — Method in class DataQuery_SubGroup

Determines the resulting SQL along with parameters for the group

DatabaseAdmin::cleanup() — Method in class DatabaseAdmin

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

DBClassName::clear_classname_cache() — Method in class DBClassName

Clear all cached classname specs. It's necessary to clear all cached subclassed names for any classes if a new class manifest is generated.

$ DBComposite#composite_dbProperty in class DBComposite

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

DBComposite::compositeDatabaseFields() — Method in class DBComposite

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

DBComposite::castingHelper() — Method in class DBComposite

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

$ DBCurrency#currency_symbolProperty in class DBCurrency
DBDatetime::clear_mock_now() — Method in class DBDatetime

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

DBField::create_field() — Method in class DBField

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

DBField::CDATA() — Method in class DBField

Safely escape for XML string

DBHTMLText::CDATA() — Method in class DBHTMLText

Safely escape for XML string

DBHTMLVarchar::CDATA() — Method in class DBHTMLVarchar

Safely escape for XML string

DBText::ContextSummary() — Method in class DBText

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

Filterable::canFilterBy() — Method in class Filterable

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

ComparisonFilterClass in namespace SilverStripe\ORM\Filters

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

Hierarchy::Children() — Method in class Hierarchy

Get the children for this DataObject filtered by canView()

MarkedSet::clearMarks() — Method in class MarkedSet

Reset marked nodes

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.

ManyManyThroughList::createDataObject() — Method in class ManyManyThroughList

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

Map::count() — Method in class Map

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

Map_Iterator::current() — Method in class Map_Iterator

Return the current element.

PaginatedList::CurrentPage() — Method in class PaginatedList
SQLAssignmentRow::clear() — Method in class SQLAssignmentRow

Clears all assignment values

SQLConditionGroup::conditionSQL() — Method in class SQLConditionGroup

Determines the resulting SQL along with parameters for the group

SQLDelete::create() — Method in class SQLDelete

Construct a new SQLDelete.

SQLInsert::create() — Method in class SQLInsert

Construct a new SQLInsert object

SQLInsert::currentRow() — Method in class SQLInsert

Returns the currently set row

SQLInsert::clearRow() — Method in class SQLInsert

Clears all currently set assignment values on the current row

SQLInsert::clear() — Method in class SQLInsert

Clears all rows

SQLSelect::create() — Method in class SQLSelect

Construct a new SQLSelect.

SQLSelect::canSortBy() — Method in class SQLSelect

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

SQLSelect::count() — Method in class SQLSelect

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

SQLUpdate::create() — Method in class SQLUpdate

Construct a new SQLUpdate object

SQLUpdate::clear() — Method in class SQLUpdate

Clears all currently set assignment values

SS_List::column() — Method in class SS_List

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

$ SearchContext#connectiveProperty in class SearchContext

The logical connective used to join WHERE clauses. Must be "AND".

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.

PostgreSQLConnector::connect() — Method in class PostgreSQLConnector

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

PostgreSQLConnector::checkStringTogglesLiteral() — Method in class PostgreSQLConnector

Determines if the SQL fragment either breaks into or out of a string literal by counting single quotes

PostgreSQLDatabase::connect() — Method in class PostgreSQLDatabase

Instruct the database to generate a live connection

PostgreSQLDatabase::currentSchema() — Method in class PostgreSQLDatabase

Returns the name of the current schema in use

PostgreSQLDatabase::comparisonClause() — Method in class PostgreSQLDatabase

Generate a WHERE clause for text matching.

PostgreSQLDatabase::clearTable() — Method in class PostgreSQLDatabase

Delete all entries from the table instead of truncating it.

PostgreSQLSchemaManager::createPostgresDatabase() — Method in class PostgreSQLSchemaManager

Creates a postgres database, ignoring model_schema_as_database

PostgreSQLSchemaManager::createDatabase() — Method in class PostgreSQLSchemaManager

Create a database with the specified name

PostgreSQLSchemaManager::createSchema() — Method in class PostgreSQLSchemaManager

Creates a schema in the current database

PostgreSQLSchemaManager::createTable() — Method in class PostgreSQLSchemaManager

Create a new table.

PostgreSQLSchemaManager::checkAndRepairTable() — Method in class PostgreSQLSchemaManager

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

PostgreSQLSchemaManager::createField() — Method in class PostgreSQLSchemaManager

Create a new field on a table.

PostgreSQLSchemaManager::clearCachedFieldlist() — Method in class PostgreSQLSchemaManager

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

PostgreSQLSchemaManager::createIndex() — Method in class PostgreSQLSchemaManager

Create an index on a table.

PostgreSQLSchemaManager::createOrReplaceTablespace() — Method in class PostgreSQLSchemaManager
PostgreSQLSchemaManager::createOrReplacePartition() — Method in class PostgreSQLSchemaManager
PostgreSQLSchemaManager::createLanguage() — Method in class PostgreSQLSchemaManager
Authenticator::checkPassword() — Method in class Authenticator

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

SiteTreeExtension::canView() — Method in class SiteTreeExtension

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

FederatedIdentity::createFromXML() — Method in class FederatedIdentity

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

FederatedIdentity::createFromJSON() — Method in class FederatedIdentity

create a FederatedIdentity from a JSON string.

RealMeService::current_realme_user() — Method in class RealMeService

Calls available user data and checks for validity

RealMeService::currentRealMeUser() — Method in class RealMeService

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

RealMeService::clearLogin() — Method in class RealMeService

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

RegistryAdmin::canView() — Method in class RegistryAdmin

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

RegistryPageController::canSortBy() — Method in class RegistryPageController

Loosely check if the record can be sorted by a property

RegistryPageController::Columns() — Method in class RegistryPageController

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

Report::columns() — Method in class Report
Report::canView() — Method in class Report
ReportAdmin::canView() — Method in class ReportAdmin

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

ReportWrapper::columns() — Method in class ReportWrapper
ReportWrapper::canView() — Method in class ReportWrapper
SideReportWrapper::columns() — Method in class SideReportWrapper
DataFormatter::convertDataObject() — Method in class DataFormatter

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

DataFormatter::convertDataObjectSet() — Method in class DataFormatter

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

DataFormatter::convertArray() — Method in class DataFormatter

Convert an array to this format. Return a string.

DataFormatter::convertStringToArray() — Method in class DataFormatter
FormEncodedDataFormatter::convertStringToArray() — Method in class FormEncodedDataFormatter
JSONDataFormatter::convertArray() — Method in class JSONDataFormatter
JSONDataFormatter::convertDataObject() — Method in class JSONDataFormatter

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

JSONDataFormatter::convertDataObjectToJSONObject() — Method in class JSONDataFormatter

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

JSONDataFormatter::convertDataObjectSet() — Method in class JSONDataFormatter

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

JSONDataFormatter::convertStringToArray() — Method in class JSONDataFormatter
JSONDataFormatter::cast() — Method in class JSONDataFormatter
XMLDataFormatter::convertArray() — Method in class XMLDataFormatter
XMLDataFormatter::convertArrayWithoutHeader() — Method in class XMLDataFormatter
XMLDataFormatter::convertDataObject() — Method in class XMLDataFormatter

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

XMLDataFormatter::convertDataObjectWithoutHeader() — Method in class XMLDataFormatter
XMLDataFormatter::convertDataObjectSet() — Method in class XMLDataFormatter

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

XMLDataFormatter::convertStringToArray() — Method in class XMLDataFormatter
SQLite3Connector::connect() — Method in class SQLite3Connector

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

SQLite3Database::connect() — Method in class SQLite3Database

Connect to a SQLite3 database.

SQLite3Database::clearTable() — Method in class SQLite3Database

Clear all data in a given table

SQLite3Database::comparisonClause() — Method in class SQLite3Database

Generate a WHERE clause for text matching.

SQLite3SchemaManager::createDatabase() — Method in class SQLite3SchemaManager

Create a database with the specified name

SQLite3SchemaManager::clearTable() — Method in class SQLite3SchemaManager

Empty a specific table

SQLite3SchemaManager::createTable() — Method in class SQLite3SchemaManager

Create a new table.

SQLite3SchemaManager::checkAndRepairTable() — Method in class SQLite3SchemaManager

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

SQLite3SchemaManager::createField() — Method in class SQLite3SchemaManager

Create a new field on a table.

SQLite3SchemaManager::createIndex() — Method in class SQLite3SchemaManager

Create an index on a table.

SQLiteDatabaseConfigurationHelper::create_db_dir() — Method in class SQLiteDatabaseConfigurationHelper

Creates the provided directory and prepares it for storing SQLlite. Use {@link secure_db_dir()} to secure it against unauthorized access.

SudoModeController::check() — Method in class SudoModeController

Checks whether sudo mode is active for the current user

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.

$ MemberReportExtension#castingProperty in class MemberReportExtension

Set cast of additional fields

$ SubsiteMemberReportExtension#castingProperty in class SubsiteMemberReportExtension

Set cast of additional field

$ UserSecurityReport#columnsProperty 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).

CMSSecurityClass 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#CodeProperty in class Group

Group code

Group::collateFamilyIDs() — Method in class Group

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

Group::collateAncestorIDs() — Method in class Group

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

Group::cmsCleanup_parentChanged() — Method in class Group

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

Group::canEdit() — Method in class Group

Checks for permission-code CMS_ACCESS_SecurityAdmin.

Group::canView() — Method in class Group

Checks for permission-code CMS_ACCESS_SecurityAdmin.

Group::canDelete() — Method in class Group
InheritedPermissions::canEditMultiple() — Method in class InheritedPermissions
InheritedPermissions::canViewMultiple() — Method in class InheritedPermissions
InheritedPermissions::canDeleteMultiple() — Method in class InheritedPermissions
InheritedPermissions::canDelete() — Method in class InheritedPermissions
InheritedPermissions::canEdit() — Method in class InheritedPermissions
InheritedPermissions::canView() — Method in class InheritedPermissions
InheritedPermissions::clearCache() — Method in class InheritedPermissions
$ InheritedPermissionsExtension#CanViewTypeProperty in class InheritedPermissionsExtension
$ InheritedPermissionsExtension#CanEditTypeProperty in class InheritedPermissionsExtension
$ Member#castingProperty in class Member
Member::checkPassword() — Method in class Member

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

Member::canLogin() — Method in class Member

Check if this user can login

Member::currentUser() — Method in class Member

Returns the current logged in user

Member::currentUserID() — Method in class Member

Get the ID of the current logged in user

Member::create_new_password() — Method in class Member

Generate a random password, with randomiser to kick in if there's no words file on the filesystem.

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.

CMSLoginHandlerClass in namespace SilverStripe\Security\MemberAuthenticator
CMSMemberAuthenticatorClass in namespace SilverStripe\Security\MemberAuthenticator

Provides authentication for the user within the CMS

CMSMemberLoginFormClass in namespace SilverStripe\Security\MemberAuthenticator

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

ChangePasswordFormClass in namespace SilverStripe\Security\MemberAuthenticator

Standard Change Password Form

ChangePasswordHandlerClass 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

CookieAuthenticationHandlerClass in namespace SilverStripe\Security\MemberAuthenticator

Authenticate a member passed on a session cookie

LoginHandler::checkLogin() — Method in class LoginHandler

Try to authenticate the user

MemberAuthenticator::checkPassword() — Method in class MemberAuthenticator

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

MemberPassword::checkPassword() — Method in class MemberPassword

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

$ Member_Validator#customRequiredProperty in class Member_Validator

Fields that are required by this validator

NullSecurityToken::check() — Method in class NullSecurityToken
NullSecurityToken::checkRequest() — Method in class NullSecurityToken
PasswordEncryptor::create_for_algorithm() — Method in class PasswordEncryptor
PasswordEncryptor::check() — Method in class PasswordEncryptor

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

PasswordEncryptor_Blowfish::checkAEncryptionLevel() — Method in class PasswordEncryptor_Blowfish

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

PasswordEncryptor_Blowfish::check() — Method in class PasswordEncryptor_Blowfish

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

PasswordEncryptor_LegacyPHPHash::check() — Method in class PasswordEncryptor_LegacyPHPHash

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

$ PasswordValidator#character_strength_testsProperty in class PasswordValidator
PasswordValidator::characterStrength() — Method in class PasswordValidator

Check the character strength of the password.

PasswordValidator::checkHistoricalPasswords() — Method in class PasswordValidator

Check a number of previous passwords that the user has used, and don't let them change to that.

Permission::check() — Method in class Permission

Check that the current member has the given permission.

Permission::checkMember() — Method in class Permission

Check that the given member has the given permission.

PermissionChecker::canEditMultiple() — Method in class PermissionChecker

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

PermissionChecker::canViewMultiple() — Method in class PermissionChecker

Get the canView information for a number of objects

PermissionChecker::canDeleteMultiple() — Method in class PermissionChecker

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

PermissionChecker::canDelete() — Method in class PermissionChecker

Check delete permission for a single record ID

PermissionChecker::canEdit() — Method in class PermissionChecker

Check edit permission for a single record ID

PermissionChecker::canView() — Method in class PermissionChecker

Check view permission for a single record ID

PermissionRole::canView() — Method in class PermissionRole
PermissionRole::canCreate() — Method in class PermissionRole
PermissionRole::canEdit() — Method in class PermissionRole
PermissionRole::canDelete() — Method in class PermissionRole
PermissionRole::Codes() — Method in class PermissionRole

List of PermissionRoleCode objects

PermissionRoleCode::canCreate() — Method in class PermissionRoleCode
PermissionRoleCode::canEdit() — Method in class PermissionRoleCode
PermissionRoleCode::canDelete() — Method in class PermissionRoleCode
RememberLoginHash::clear() — Method in class RememberLoginHash

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

Security::clearSessionMessage() — Method in class Security

Clear login message

Security::changepassword() — Method in class Security

Show the "change password" page.

Security::clear_default_admin() — Method in class Security

Flush the default admin credentials

Security::check_default_admin() — Method in class Security

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

Security::clear_database_is_ready() — Method in class Security

Resets the database_is_ready cache

SecurityToken::check() — Method in class SecurityToken

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

SecurityToken::checkRequest() — Method in class SecurityToken

See {@link check()}.

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#controllerProperty in class ShareDraftController

Controller for rendering draft pages.

SiteConfig::CMSEditLink() — Method in class SiteConfig
SiteConfig::current_site_config() — Method in class SiteConfig

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

SiteConfig::canView() — Method in class SiteConfig

Can a user view this SiteConfig instance?

SiteConfig::canViewPages() — Method in class SiteConfig

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

SiteConfig::canEditPages() — Method in class SiteConfig

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

SiteConfig::canEdit() — Method in class SiteConfig
SiteConfig::canCreateTopLevel() — Method in class SiteConfig

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

SiteConfig::CreateTopLevelGroups() — Method in class SiteConfig

List of groups that can create root-level pages.

SiteConfigPagePermissions::canEdit() — Method in class SiteConfigPagePermissions

Can root be edited?

SiteConfigPagePermissions::canView() — Method in class SiteConfigPagePermissions

Can root be viewed?

SiteConfigPagePermissions::canDelete() — Method in class SiteConfigPagePermissions

Can root be deleted?

SiteConfigPagePermissions::canCreate() — Method in class SiteConfigPagePermissions

Can root objects be created?

SitewideContentReport::columns() — Method in class SitewideContentReport

Returns columns for the grid fields on this report.

$ EditableSpamProtectionField#check_fieldsProperty in class EditableSpamProtectionField

Fields to include spam detection for

CommentSpamProtectionClass in namespace SilverStripe\SpamProtection\Extension

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

SpellProvider::checkWords() — Method in class SpellProvider

Spellchecks an array of words.

HunSpellProvider::checkWords() — Method in class HunSpellProvider

Spellchecks an array of words.

SiteTreePublishingEngine::collectChanges() — Method in class SiteTreePublishingEngine

Collect all changes for the given context.

$ Job#chunk_sizeProperty in class Job

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

  • time to render your pages
  • infrastructure
$ DeleteStaticCacheJob#chunk_sizeProperty 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.

CMSPageAddControllerExtensionClass in namespace SilverStripe\Subsites\Extensions
ControllerSubsitesClass in namespace SilverStripe\Subsites\Extensions
ControllerSubsites::controllerAugmentInit() — Method in class ControllerSubsites
ControllerSubsites::CurrentSubsite() — Method in class ControllerSubsites
FileSubsites::canEdit() — Method in class FileSubsites

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

FileSubsites::cacheKeyComponent() — Method in class FileSubsites

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

LeftAndMainSubsites::CanAddSubsites() — Method in class LeftAndMainSubsites
LeftAndMainSubsites::canAccess() — Method in class LeftAndMainSubsites

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

LeftAndMainSubsites::copytosubsite() — Method in class LeftAndMainSubsites
SiteConfigSubsites::cacheKeyComponent() — Method in class SiteConfigSubsites

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

SiteTreeSubsites::canEdit() — Method in class SiteTreeSubsites

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

  • Is in a group which has access to the subsite this page belongs to
  • Is in a group with edit permissions on the "main site"
SiteTreeSubsites::canDelete() — Method in class SiteTreeSubsites
SiteTreeSubsites::canAddChildren() — Method in class SiteTreeSubsites
SiteTreeSubsites::canPublish() — Method in class SiteTreeSubsites
SiteTreeSubsites::contentcontrollerInit() — Method in class SiteTreeSubsites

Called by ContentController::init();

SiteTreeSubsites::cacheKeyComponent() — Method in class SiteTreeSubsites

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

SiteTreeSubsites::canCreate() — Method in class SiteTreeSubsites
WildcardDomainField::checkHostname() — Method in class WildcardDomainField

Check if the given hostname is valid.

$ Subsite#check_is_publicProperty 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::currentSubsiteID() — Method in class Subsite

This function gets the current subsite ID from the session. It used in the backend so Ajax requests use the correct subsite. The frontend handles subsites differently. It calls getSubsiteIDForDomain directly from ModelAsController::getNestedController. Only gets Subsite instances which have their {@link IsPublic} flag set to TRUE.

Subsite::changeSubsite() — Method in class Subsite

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

Subsite::canEdit() — Method in class Subsite
SubsiteReportWrapper::columns() — Method in class SubsiteReportWrapper
$ Method#code_lengthProperty in class Method

The TOTP code length

TaxonomyTerm::canView() — Method in class TaxonomyTerm
TaxonomyTerm::canEdit() — Method in class TaxonomyTerm
TaxonomyTerm::canDelete() — Method in class TaxonomyTerm
TaxonomyTerm::canCreate() — Method in class TaxonomyTerm
TaxonomyTerm::Children() — Method in class TaxonomyTerm
CacheClass 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#castingProperty in class FileTextExtractable
UserDefinedFormAdmin::confirmfolderformschema() — Method in class UserDefinedFormAdmin

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

UserDefinedFormAdmin::ConfirmFolderForm() — Method in class UserDefinedFormAdmin

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

UserDefinedFormAdmin::confirmfolder() — Method in class UserDefinedFormAdmin

Sets the selected folder as the upload folder for an EditableFileField

UserFormFieldEditorExtension::createInitialFormStep() — Method in class UserFormFieldEditorExtension

A UserForm must have at least one step.

UserFormsFieldList::clearEmptySteps() — Method in class UserFormsFieldList

Remove all empty steps

$ EditableCustomRule#ConditionOptionProperty in class EditableCustomRule
$ EditableCustomRule#ConditionFieldIDProperty 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#CustomErrorMessageProperty 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#CheckedDefaultProperty in class EditableCheckbox
EditableFileField::createProtectedFolder() — Method in class EditableFileField
$ EditableLiteralField#ContentProperty in class EditableLiteralField
EditableOption::canEdit() — Method in class EditableOption
EditableOption::canDelete() — Method in class EditableOption
EditableOption::canView() — Method in class EditableOption
EditableOption::canCreate() — Method in class EditableOption

Return whether a user can create an object of this type

EditableOption::canPublish() — Method in class EditableOption
EditableOption::canUnpublish() — Method in class EditableOption
$ EmailRecipient#CustomRulesConditionProperty in class EmailRecipient
EmailRecipient::canCreate() — Method in class EmailRecipient

Return whether a user can create an object of this type

EmailRecipient::canView() — Method in class EmailRecipient
EmailRecipient::canEdit() — Method in class EmailRecipient
EmailRecipient::canDelete() — Method in class EmailRecipient
EmailRecipient::canSend() — Method in class EmailRecipient

Determine if this recipient may receive notifications for this submission

EmailRecipient::CustomRules() — Method in class EmailRecipient
$ EmailRecipientCondition#condition_optionsProperty in class EmailRecipientCondition

List of options

$ EmailRecipientCondition#ConditionFieldIDProperty in class EmailRecipientCondition
$ EmailRecipientCondition#ConditionOptionProperty in class EmailRecipientCondition
$ EmailRecipientCondition#ConditionValueProperty in class EmailRecipientCondition
EmailRecipientCondition::canCreate() — Method in class EmailRecipientCondition

Return whether a user can create an object of this type

EmailRecipientCondition::canView() — Method in class EmailRecipientCondition
EmailRecipientCondition::canEdit() — Method in class EmailRecipientCondition
EmailRecipientCondition::canDelete() — Method in class EmailRecipientCondition
EmailRecipientCondition::ConditionField() — Method in class EmailRecipientCondition
SubmittedForm::canCreate() — Method in class SubmittedForm
SubmittedForm::canView() — Method in class SubmittedForm
SubmittedForm::canEdit() — Method in class SubmittedForm
SubmittedForm::canDelete() — Method in class SubmittedForm
SubmittedFormField::canCreate() — Method in class SubmittedFormField
SubmittedFormField::canView() — Method in class SubmittedFormField
SubmittedFormField::canEdit() — Method in class SubmittedFormField
SubmittedFormField::canDelete() — Method in class SubmittedFormField
$ UserForm#castingProperty in class UserForm
CachedContentFilterClass in namespace SilverStripe\VersionFeed\Filters

Caches results of a callback

$ CachedContentFilter#cache_enabledProperty in class CachedContentFilter

Enable caching

ContentFilterClass in namespace SilverStripe\VersionFeed\Filters

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

$ ContentFilter#cache_lifetimeProperty in class ContentFilter

Cache lifetime

$ VersionFeed#changes_enabledProperty in class VersionFeed

Enables RSS feed for page-specific changes

$ VersionFeed#changes_limitProperty in class VersionFeed

Changes feed limit of items.

VersionFeedController::changes() — Method in class VersionFeedController

Get page-specific changes in a RSS feed.

ArchiveAdmin::createArchiveGridField() — Method in class ArchiveAdmin

Create a gridfield which displays archived objects

CMSPageHistoryViewerControllerClass in namespace SilverStripe\VersionedAdmin\Controllers

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

HistoryControllerFactory::create() — Method in class HistoryControllerFactory

Creates a new service instance.

HistoryViewerController::compareForm() — Method in class HistoryViewerController
CMSMainExtensionClass in namespace SilverStripe\VersionedAdmin\Extensions
ProxyCacheAdapter::clear() — Method in class ProxyCacheAdapter

{@inheritdoc}

ProxyCacheFactory::create() — Method in class ProxyCacheFactory
ChangeSetClass in namespace SilverStripe\Versioned

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

ChangeSet::canView() — Method in class ChangeSet
ChangeSet::canEdit() — Method in class ChangeSet
ChangeSet::canCreate() — Method in class ChangeSet
ChangeSet::canDelete() — Method in class ChangeSet
ChangeSet::canPublish() — Method in class ChangeSet

Check if this item is allowed to be published

ChangeSet::canRevert() — Method in class ChangeSet

Check if this changeset (if published) can be reverted

ChangeSet::can() — Method in class ChangeSet

Default permissions for this changeset

ChangeSet::Changes() — Method in class ChangeSet
ChangeSetItemClass in namespace SilverStripe\Versioned

A single line in a changeset

$ ChangeSetItem#ChangeSetIDProperty in class ChangeSetItem

ID of parent ChangeSet object

ChangeSetItem::canView() — Method in class ChangeSetItem
ChangeSetItem::canEdit() — Method in class ChangeSetItem
ChangeSetItem::canCreate() — Method in class ChangeSetItem
ChangeSetItem::canDelete() — Method in class ChangeSetItem
ChangeSetItem::canRevert() — Method in class ChangeSetItem

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

ChangeSetItem::canPublish() — Method in class ChangeSetItem

Check if this ChangeSetItem can be published

ChangeSetItem::can() — Method in class ChangeSetItem

Default permissions for this ChangeSetItem

ChangeSetItem::CMSEditLink() — Method in class ChangeSetItem

Get edit link for this item

ChangeSetItem::ChangeSet() — Method in class ChangeSetItem

Parent changeset

DataDifferencer::ChangedFields() — Method in class DataDifferencer

Get a SS_List of the changed fields.

DataDifferencer::changedFieldNames() — Method in class DataDifferencer

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

AbstractPublishOperationCreator::createOperation() — Method in class AbstractPublishOperationCreator
CopyToStageCreatorClass in namespace SilverStripe\Versioned\GraphQL\Operations

Scaffolds a "copy to stage" operation for DataObjects.

CopyToStageCreator::createOperation() — Method in class CopyToStageCreator
Rollback::createDefaultArgs() — Method in class Rollback
RollbackCreator::createOperation() — Method in class RollbackCreator
CopyToStageInputTypeClass in namespace SilverStripe\Versioned\GraphQL\Types
$ Versioned#castingProperty in class Versioned

Ensure versioned records cast extra fields properly

Versioned::canPublish() — Method in class Versioned

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

Versioned::canUnpublish() — Method in class Versioned

Check if the current user can delete this record from live

Versioned::canArchive() — Method in class Versioned

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

Versioned::canRevertToLive() — Method in class Versioned

Check if the user can revert this record to live

Versioned::canRestoreToDraft() — Method in class Versioned

Check if the user can restore this record to draft

Versioned::canView() — Method in class Versioned

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

Versioned::canViewVersioned() — Method in class Versioned

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

Versioned::canViewStage() — Method in class Versioned

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

Versioned::canBeVersioned() — Method in class Versioned

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

Versioned::copyVersionToStage() — Method in class Versioned

Move a database record from one stage to the other.

Versioned::compareVersions() — Method in class Versioned

Compare two version, and return the diff between them.

Versioned::can_choose_site_stage() — Method in class Versioned

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

Versioned::choose_site_stage() — Method in class Versioned

Choose the stage the site is currently on.

Versioned::current_archived_date() — Method in class Versioned

Get the current archive date.

Versioned::current_archived_stage() — Method in class Versioned

Get the current archive stage.

Versioned::cacheKeyComponent() — Method in class Versioned

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

HTML::createTag() — Method in class HTML

Construct and return HTML tag.

Diff::cleanHTML() — Method in class Diff

Attempt to clean invalid HTML, which messes up diffs.

Diff::compareHTML() — Method in class Diff
$ HTMLCleaner#configProperty 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.

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

Register the given JavaScript code into the list of requirements

Requirements::customCSS() — Method in class Requirements

Register the given CSS styles into the list of requirements

Requirements::css() — Method in class Requirements

Register the given stylesheet into the list of requirements.

Requirements::clear() — Method in class Requirements

Clear either a single or all requirements

Requirements::combine_files() — Method in class Requirements

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

Requirements::clear_combined_files() — Method in class Requirements

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

$ Requirements_Backend#combine_in_devProperty in class Requirements_Backend

Determine if files should be combined automatically on dev mode.

$ Requirements_Backend#combine_hash_querystringProperty 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

Register the given JavaScript code into the list of requirements

Requirements_Backend::customCSS() — Method in class Requirements_Backend

Register the given CSS styles into the list of requirements

Requirements_Backend::css() — Method in class Requirements_Backend

Register the given stylesheet into the list of requirements.

Requirements_Backend::clear() — Method in class Requirements_Backend

Clear either a single or all requirements

Requirements_Backend::combineFiles() — Method in class Requirements_Backend

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

Requirements_Backend::clearCombinedFiles() — Method in class Requirements_Backend

Clear all registered CSS and JavaScript file combinations

SSTemplateParser::construct() — Method in class SSTemplateParser

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

SSTemplateParser::CallArguments_Argument() — Method in class SSTemplateParser

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

SSTemplateParser::Comparison_Argument() — Method in class SSTemplateParser
SSTemplateParser::Comparison_ComparisonOperator() — Method in class SSTemplateParser
SSTemplateParser::CacheBlockArgument_DollarMarkedLookup() — Method in class SSTemplateParser
SSTemplateParser::CacheBlockArgument_QuotedString() — Method in class SSTemplateParser
SSTemplateParser::CacheBlockArgument_Lookup() — Method in class SSTemplateParser
SSTemplateParser::CacheBlockArguments_CacheBlockArgument() — Method in class SSTemplateParser
SSTemplateParser::CacheRestrictedTemplate_CacheBlock() — Method in class SSTemplateParser
SSTemplateParser::CacheRestrictedTemplate_UncachedBlock() — Method in class SSTemplateParser
SSTemplateParser::CacheBlock__construct() — Method in class SSTemplateParser
SSTemplateParser::CacheBlock_CacheBlockArguments() — Method in class SSTemplateParser
SSTemplateParser::CacheBlock_Condition() — Method in class SSTemplateParser
SSTemplateParser::CacheBlock_CacheBlock() — Method in class SSTemplateParser
SSTemplateParser::CacheBlock_UncachedBlock() — Method in class SSTemplateParser
SSTemplateParser::CacheBlock_CacheBlockTemplate() — Method in class SSTemplateParser
SSTemplateParser::ClosedBlock__construct() — Method in class SSTemplateParser

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

SSTemplateParser::ClosedBlock_BlockArguments() — Method in class SSTemplateParser
SSTemplateParser::ClosedBlock__finalise() — Method in class SSTemplateParser
SSTemplateParser::ClosedBlock_Handle_Loop() — Method in class SSTemplateParser

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

SSTemplateParser::ClosedBlock_Handle_With() — Method in class SSTemplateParser

The closed block handler for with blocks

SSTemplateParser::Comment__construct() — Method in class SSTemplateParser
SSTemplateParser::compileString() — Method in class SSTemplateParser

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

SSTemplateParser::compileFile() — Method in class SSTemplateParser

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

SSViewer::chooseTemplate() — Method in class SSViewer

Find the template to use for a given list

$ SSViewer_FromString#cache_templateProperty in class SSViewer_FromString

The global template caching behaviour if no instance override is specified

TemplateParser::compileString() — Method in class TemplateParser

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

$ ViewableData#castingProperty in class ViewableData

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

ViewableData::customise() — Method in class ViewableData

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

ViewableData::castingHelper() — Method in class ViewableData

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

ViewableData::castingClass() — Method in class ViewableData

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

ViewableData::cachedCall() — Method in class ViewableData

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

ViewableData::CSSClasses() — Method in class ViewableData

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

ViewableData_Customised::cachedCall() — Method in class ViewableData_Customised

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

CredentialRepositoryClass 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

CredentialRepositoryProviderTraitClass in namespace SilverStripe\WebAuthn
Widget::Content() — Method in class Widget

Renders the widget content in a custom template with the same name as the current class. This should be the main point of output customization.

Widget::CMSEditor() — Method in class Widget
Widget::ClassName() — Method in class Widget

A fully qualified class name is returned with underscores instead of backslashes so it is HTML safe. Dashes can't be used as they're handled in the Javascript for other purposes.

WidgetController::Content() — Method in class WidgetController

Overloaded from {@link Widget->Content()} to allow for controller / form linking.

IntlLocales::countryName() — Method in class IntlLocales

Get name of country

IntlLocales::countryFromLocale() — Method in class IntlLocales

Returns the country code / suffix on any locale

Locales::countryName() — Method in class Locales

Get name of country by code

Locales::countryFromLocale() — Method in class Locales

Returns the country code / suffix on any locale

i18nTextCollector::collect() — Method in class i18nTextCollector

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

i18nTextCollector::collectFromCode() — Method in class i18nTextCollector

Extracts translatables from .php files.

i18nTextCollector::collectFromTemplate() — Method in class i18nTextCollector

Extracts translatables from .ss templates (Self referencing)

i18nTextCollector::collectFromEntityProviders() — Method in class i18nTextCollector

Allows classes which implement i18nEntityProvider to provide additional translation strings.

i18n::convert_rfc1766() — Method in class i18n

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

CancelWorkflowActionClass in namespace Symbiote\AdvancedWorkflow\Actions

Description

PublishItemWorkflowAction::canPublishTarget() — Method in class PublishItemWorkflowAction

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

UnpublishItemWorkflowAction::canPublishTarget() — Method in class UnpublishItemWorkflowAction
AdvancedWorkflowAdmin::columns() — Method in class AdvancedWorkflowAdmin
WorkflowAction::canEditTarget() — Method in class WorkflowAction

Can documents in the current workflow state be edited?

WorkflowAction::canViewTarget() — Method in class WorkflowAction

Does this action restrict viewing of the document?

WorkflowAction::canPublishTarget() — Method in class WorkflowAction

Does this action restrict the publishing of a document?

WorkflowAction::canCreate() — Method in class WorkflowAction

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

WorkflowAction::canEdit() — Method in class WorkflowAction
WorkflowAction::canDelete() — Method in class WorkflowAction
WorkflowAction::canAddTransition() — Method in class WorkflowAction
WorkflowActionInstance::canEditTarget() — Method in class WorkflowActionInstance

Can documents in the current workflow state be edited?

WorkflowActionInstance::canViewTarget() — Method in class WorkflowActionInstance

Does this action restrict viewing of the document?

WorkflowActionInstance::canPublishTarget() — Method in class WorkflowActionInstance

Does this action restrict the publishing of a document?

WorkflowActionInstance::canView() — Method in class WorkflowActionInstance
WorkflowActionInstance::canEdit() — Method in class WorkflowActionInstance
WorkflowActionInstance::canDelete() — Method in class WorkflowActionInstance
WorkflowDefinition::canWorkflowPublish() — Method in class WorkflowDefinition

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

WorkflowDefinition::canCreate() — Method in class WorkflowDefinition
WorkflowDefinition::canView() — Method in class WorkflowDefinition
WorkflowDefinition::canEdit() — Method in class WorkflowDefinition
WorkflowDefinition::canDelete() — Method in class WorkflowDefinition
WorkflowInstance::canView() — Method in class WorkflowInstance
WorkflowInstance::canEdit() — Method in class WorkflowInstance
WorkflowInstance::canDelete() — Method in class WorkflowInstance
WorkflowInstance::canEditTarget() — Method in class WorkflowInstance

Can documents in the current workflow state be edited?

WorkflowInstance::canViewTarget() — Method in class WorkflowInstance

Does this action restrict viewing of the document?

WorkflowInstance::canPublishTarget() — Method in class WorkflowInstance

Does this action restrict the publishing of a document?

WorkflowInstance::CurrentAction() — Method in class WorkflowInstance
WorkflowTransition::canExecute() — Method in class WorkflowTransition

Check if the current user can execute this transition

WorkflowTransition::canCreate() — Method in class WorkflowTransition

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

WorkflowTransition::canEdit() — Method in class WorkflowTransition
WorkflowTransition::canDelete() — Method in class WorkflowTransition
WorkflowApplicable::canPublish() — Method in class WorkflowApplicable

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

WorkflowApplicable::canEdit() — Method in class WorkflowApplicable

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

WorkflowApplicable::canEditWorkflow() — Method in class WorkflowApplicable

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

WorkflowEmbargoExpiryExtension::clearPublishJob() — Method in class WorkflowEmbargoExpiryExtension

Clears any existing publish job against this dataobject

WorkflowEmbargoExpiryExtension::clearUnPublishJob() — Method in class WorkflowEmbargoExpiryExtension

Clears any existing unpublish job

WorkflowEmbargoExpiryExtension::canEdit() — Method in class WorkflowEmbargoExpiryExtension

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

WorkflowField::CreateableActions() — Method in class WorkflowField
WorkflowTemplate::createRelations() — Method in class WorkflowTemplate

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

MultiValueTextField::createReadonlyInput() — Method in class MultiValueTextField
MultiValueTextField::createInput() — Method in class MultiValueTextField
MultiValueField::csv() — Method in class MultiValueField

Convert to a textual list of items.

QueuedJobsAdmin::createjob() — Method in class QueuedJobsAdmin
QueuedJobDescriptor::cleanupJob() — Method in class QueuedJobDescriptor

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

CleanupJobClass in namespace Symbiote\QueuedJobs\Jobs

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

$ CleanupJob#cleanup_methodProperty in class CleanupJob

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

$ CleanupJob#cleanup_valueProperty in class CleanupJob

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

$ CleanupJob#cleanup_statusesProperty in class CleanupJob

Which JobStatus values are OK to be deleted

DoormanQueuedJobTask::canRunTask() — Method in class DoormanQueuedJobTask
EmailService::createMissingDefaultJobReport() — Method in class EmailService
EmailService::createStalledJobReport() — Method in class EmailService
EmailService::createReport() — Method in class EmailService

Create a generic email report useful for reporting queue service issues

JobErrorHandler::clear() — Method in class JobErrorHandler
$ QueuedJobService#cache_dirProperty in class QueuedJobService

The location for immediate jobs to be stored in

QueuedJobService::checkJobHealth() — Method in class QueuedJobService

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

QueuedJobService::checkDefaultJobs() — Method in class QueuedJobService

Checks through ll the scheduled jobs that are expected to exist

CheckJobHealthTaskClass in namespace Symbiote\QueuedJobs\Tasks
CreateQueuedJobTaskClass in namespace Symbiote\QueuedJobs\Tasks

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

$ DoormanRunner#child_runnerProperty in class DoormanRunner

Name of the dev task used to run the child process

FluentExtension::cacheKeyComponent() — Method in class FluentExtension

Ensure has_one cache is segmented by locale

CachableModelClass in namespace TractorCow\Fluent\Model

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

CachableModel::clearCached() — Method in class CachableModel
DeletePolicyFactory::create() — Method in class DeletePolicyFactory

Creates a new service instance.

FluentSearchVariant::currentState() — Method in class FluentSearchVariant

Return the current state

ConvertTranslatableTaskClass in namespace TractorCow\Fluent\Task

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

D

$ UpdatePackageInfoTask#dependenciesProperty in class UpdatePackageInfoTask
ApiLoader::doRequest() — Method in class ApiLoader

Perform an HTTP request for module health information

DatedUpdateHolderClass in namespace CWP\CWP\PageTypes
DatedUpdateHolderControllerClass in namespace CWP\CWP\PageTypes

The parameters apply in the following preference order:

  • Highest priority: Tag & date (or date range)
  • Month (and Year)
  • Pagination
DatedUpdateHolderController::DateRangeForm() — Method in class DatedUpdateHolderController
DatedUpdateHolderController::doDateFilter() — Method in class DatedUpdateHolderController
DatedUpdateHolderController::doDateReset() — Method in class DatedUpdateHolderController
DatedUpdatePageClass in namespace CWP\CWP\PageTypes
CwpStatsReport::description() — Method in class CwpStatsReport

Return the description of this report.

PdfExportControllerExtension::downloadpdf() — Method in class PdfExportControllerExtension

Serve the page rendered as PDF.

$ CwpSearchIndex#dictionaryProperty in class CwpSearchIndex

Default dictionary to use. This will overwrite the 'spellcheck.dictionary' option for searches given, unless set to empty.

DeleteHandlerClass in namespace Colymba\BulkManager\BulkAction

Bulk action handler for deleting records.

DeleteHandler::delete() — Method in class DeleteHandler

Delete the selected records passed from the delete bulk action.

EditHandler::doSave() — Method in class EditHandler

Handles bulkEditForm submission and parses and saves each records data.

$ ElementController#default_stylesProperty in class ElementController

A list of default (example) styles to include

DeleteBlocksMutationClass in namespace DNADesign\Elemental\GraphQL
DuplicateElementMutationClass in namespace DNADesign\Elemental\GraphQL
$ BaseElement#descriptionProperty in class BaseElement

Describe the purpose of this element

$ BaseElement#displays_title_in_templateProperty in class BaseElement

Display a show title button

DBObjectTypeClass in namespace DNADesign\Elemental\ORM\FieldType
DataExtensionClass in namespace DNADesign\Elemental\TopPage

Class DataExtension

DataExtension::disableTopPageUpdate() — Method in class DataExtension

Global flag manipulation - disable automatic top page determination Useful for unit tests as you may want to enable / disable this feature based on need

DatabaseCollectorClass in namespace LeKoala\DebugBar\Collector

Collects data about SQL statements executed through the proxied behaviour

DebugBarClass in namespace LeKoala\DebugBar

A simple helper

DebugBar::disabledCriteria() — Method in class DebugBar

Get all criteria why the DebugBar could be disabled

DebugBarControllerClass in namespace LeKoala\DebugBar

A open handler controller for DebugBar

DebugBarMiddlewareClass in namespace LeKoala\DebugBar\Middleware
DeltaConfigManifestProxyClass in namespace LeKoala\DebugBar\Proxy
$ AdminRootController#default_panelProperty in class AdminRootController
GroupImportForm::doImport() — Method in class GroupImportForm
LeftAndMain::delete() — Method in class LeftAndMain
MemberImportForm::doImport() — Method in class MemberImportForm
DeleteAssetsClass in namespace SilverStripe\AssetAdmin\BatchAction

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

DeleteFileMutationCreatorClass in namespace SilverStripe\AssetAdmin\GraphQL

Handles create and update

DescendantFileCountTypeClass in namespace SilverStripe\AssetAdmin\GraphQL

Define the return type for ReadDescendantFileCountsQueryCreator Return as an array of object with an 'id' property and 'count' property.

$ FileMigrationHelper#delete_invalid_filesProperty in class FileMigrationHelper

If a file fails to validate during migration, delete it.

$ TestAssetStore#denied_response_codeProperty in class TestAssetStore

Enable disclosure of secure assets

File::deleteFile() — Method in class File

Delete a file (and all variants).

$ FileNameFilter#default_use_transliteratorProperty in class FileNameFilter
$ FileNameFilter#default_replacementsProperty in class FileNameFilter
$ AssetAdapter#default_serverProperty in class AssetAdapter

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

$ FlysystemAssetStore#denied_response_codeProperty in class FlysystemAssetStore

Set HTTP error code for requests to secure denied assets.

FlysystemAssetStore::delete() — Method in class FlysystemAssetStore

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

$ FileLinkTracking#dependenciesProperty 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

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

DefaultAssetNameGeneratorClass in namespace SilverStripe\Assets\Storage

Basic filename renamer

FileHashingService::disableCache() — Method in class FileHashingService

Disable caching of computed hash.

$ Sha1FileHashingService#default_cachableProperty in class Sha1FileHashingService

Whetever Sha1FileHashingService should cache hash values by default.

Sha1FileHashingService::disableCache() — Method in class Sha1FileHashingService

Disable caching of computed hash.

$ Upload_Validator#default_max_file_sizeProperty in class Upload_Validator

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

MainContextAwareTrait::detectMainContext() — Method in class MainContextAwareTrait

Helper method to detect the main context

DebugToolsClass in namespace SilverStripe\BehatExtension\Utility

Step tools to help debug failing steps

DebugTools::dumpHtmlAfterStep() — Method in class DebugTools

Dump HTML when step fails.

DebugTools::dumpRenderedHtml() — Method in class DebugTools

Dump rendered HTML to disk Useful for seeing the state of a page when writing and debugging feature files

$ BlogController#disable_profilesProperty in class BlogController

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

$ ResourceLocatorField#default_endpointProperty in class ResourceLocatorField

The default CKAN endpoint to be used in a default isn't provided on construction

ResourceLocatorField::dataValue() — Method in class ResourceLocatorField

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

DropdownClass in namespace SilverStripe\CKANRegistry\Model\ResourceFilter

Provides a single select option for CKAN resources to be filtered by

CKANRegistryPage::DataResource() — Method in class CKANRegistryPage
CMSMain::doSearch() — Method in class CMSMain
CMSMain::delete() — Method in class CMSMain

Delete the current page from draft stage.

CMSMain::doRollback() — Method in class CMSMain

Rolls a site back to a given version ID

CMSMain::duplicate() — Method in class CMSMain
CMSMain::duplicatewithchildren() — Method in class CMSMain
CMSPageAddController::doAdd() — Method in class CMSPageAddController
CMSPageAddController::doCancel() — Method in class CMSPageAddController
ContentController::data() — Method in class ContentController

Returns the associated database record

ContentController::deleteinstallfiles() — Method in class ContentController
$ RootURLController#default_homepage_linkProperty in class RootURLController
$ SiteTree#default_childProperty in class SiteTree

The default child class for this page.

$ SiteTree#default_classnameProperty in class SiteTree

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

$ SiteTree#default_parentProperty in class SiteTree

The default parent class for this page.

$ SiteTree#descriptionProperty in class SiteTree

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

SiteTree::duplicateWithChildren() — Method in class SiteTree

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

SiteTree::duplicateAsChild() — Method in class SiteTree

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

SiteTree::DependentPages() — Method in class SiteTree

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

SiteTree::doRestoreToStage() — Method in class SiteTree

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

SiteTree::defaultChild() — Method in class SiteTree

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

SiteTree::defaultParent() — Method in class SiteTree

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

SiteTree::disableCMSFieldsExtensions() — Method in class SiteTree

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

$ SiteTreeLinkTracking#dependenciesProperty in class SiteTreeLinkTracking

Inject parser for each page

RemoveOrphanedPagesTask::doSubmit() — Method in class RemoveOrphanedPagesTask
CampaignAdmin::deleteCampaign() — Method in class CampaignAdmin

REST endpoint to delete a campaign.

$ CommentNotifiable#default_notification_subjectProperty in class CommentNotifiable

Default subject line if the owner doesn't override it

$ CommentNotifiable#default_notification_senderProperty in class CommentNotifiable

Default sender

$ CommentNotifiable#default_notification_templateProperty in class CommentNotifiable

Default template to use for comment notifications

CommentingController::decodeClassName() — Method in class CommentingController

Decode an "encoded" fully qualified class name back to its original

CommentingController::delete() — Method in class CommentingController

Deletes a given {@link Comment} via the URL.

CommentForm::doPreviewComment() — Method in class CommentForm
CommentForm::doPostComment() — Method in class CommentForm

Process which creates a {@link Comment} once a user submits a comment from this form.

$ Comment#DepthProperty in class Comment

Depth of this comment in the nested chain

Comment::DeleteLink() — Method in class Comment

Link to delete this comment

DeltaConfigCollectionClass in namespace SilverStripe\Config\Collections

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

DeltaMiddlewareClass in namespace SilverStripe\Config\Middleware

Applies a set of user-customised modifications to config

ContentReviewCompatability::done() — Method in class ContentReviewCompatability
$ ContentReviewDefaultSettings#dbProperty in class ContentReviewDefaultSettings
$ ContentReviewDefaultSettings#defaultsProperty in class ContentReviewDefaultSettings
$ ContentNegotiator#default_formatProperty in class ContentNegotiator
Controller::doInit() — Method in class Controller

A stand in function to protect the init function from failing to be called as well as providing before and after hooks for the init function itself

Controller::defaultAction() — Method in class Controller

This is the default action handler used if a method doesn't exist. It will process the controller object with the template returned by {@link getViewer()}.

Controller::disableBasicAuth() — Method in class Controller

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

$ Cookie#default_samesiteProperty in class Cookie

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

DirectorClass in namespace SilverStripe\Control

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

$ Director#default_base_urlProperty in class Director

Base url to populate if cannot be determined otherwise.

Email::debug() — Method in class Email
$ HTTP#disable_http_cacheProperty in class HTTP
HTTPRequest::detect_method() — Method in class HTTPRequest

Gets the "real" HTTP method for a request. This method is no longer used to mitigate the risk of web cache poisoning.

$ HTTPCacheControlMiddleware#defaultStateProperty in class HTTPCacheControlMiddleware

Set default state

$ HTTPCacheControlMiddleware#defaultForcingLevelProperty in class HTTPCacheControlMiddleware

Default forcing level

HTTPCacheControlMiddleware::disableCache() — Method in class HTTPCacheControlMiddleware

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

RSSFeed::Description() — Method in class RSSFeed

Get the description of this feed

RSSFeed_Entry::Description() — Method in class RSSFeed_Entry

Get the description of this entry

Session::destroy() — Method in class Session

Destroy this session

DefaultCacheFactoryClass in namespace SilverStripe\Core\Cache

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

  • PhpFilesCache (PHP 7 with opcache enabled)
  • ApcuCache (requires APC) with a FilesystemCache fallback (for larger cache volumes)
  • FilesystemCache if none of the above is available
ClassInfo::dataClassesFor() — Method in class ClassInfo

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

DeployFlushDiscovererClass in namespace SilverStripe\Core\Startup

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

$ BulkLoader#duplicateChecksProperty in class BulkLoader

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

$ BulkLoader#deleteExistingRecordsProperty in class BulkLoader
BulkLoader_Result::DeletedCount() — Method in class BulkLoader_Result
BulkLoader_Result::Deleted() — Method in class BulkLoader_Result
CliDebugView::debugVariable() — Method in class CliDebugView

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

CliDebugView::debugVariableText() — Method in class CliDebugView

Get debug text for this object

$ CsvBulkLoader#delimiterProperty in class CsvBulkLoader

Delimiter character (Default: comma).

DebugClass in namespace SilverStripe\Dev

Supports debugging and core error handling.

Debug::dump() — Method in class Debug

Quick dump of a variable.

DebugViewClass in namespace SilverStripe\Dev

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

DebugView::debugVariable() — Method in class DebugView

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

DebugView::debugVariableText() — Method in class DebugView

Get debug text for this object

DeprecationClass in namespace SilverStripe\Dev

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

Deprecation::disable() — Method in class Deprecation

Disable throwing deprecation warnings.

Deprecation::dump_settings() — Method in class Deprecation

This method is no longer used

DevBuildControllerClass in namespace SilverStripe\Dev
DevConfigControllerClass in namespace SilverStripe\Dev

Outputs the full configuration.

DevConfirmationControllerClass in namespace SilverStripe\Dev

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

DevelopmentAdminClass in namespace SilverStripe\Dev

Base class for development tools.

$ DevelopmentAdmin#deny_non_cliProperty in class DevelopmentAdmin

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

$ FixtureBlueprint#dependenciesProperty in class FixtureBlueprint
FixtureFactory::define() — Method in class FixtureFactory
DatabaseAdapterRegistryClass in namespace SilverStripe\Dev\Install

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

DatabaseConfigurationHelperClass in namespace SilverStripe\Dev\Install

Interface for database helper classes.

MigrationTask::down() — Method in class MigrationTask
DatabaseAdminExtensionClass in namespace SilverStripe\Dev\Validation

Hook up static validation to the deb/build process

DBLinkClass in namespace SilverStripe\ElementalBannerBlock\ORM\FieldType

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

DatabaseCheckClass in namespace SilverStripe\EnvironmentCheck\Checks

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

DevCheckControllerClass in namespace SilverStripe\EnvironmentCheck\Controllers

Class DevCheckController

DevHealthControllerClass in namespace SilverStripe\EnvironmentCheck\Controllers

Class DevHealthController

EnvironmentCheckSuiteResult::Details() — Method in class EnvironmentCheckSuiteResult

Returns detailed status information about each check.

CheckboxField::dataValue() — Method in class CheckboxField

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

CompositeField::debug() — Method in class CompositeField
CurrencyField::dataValue() — Method in class CurrencyField

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

DatalessFieldClass in namespace SilverStripe\Forms

Abstract class for all fields without data.

DateFieldClass in namespace SilverStripe\Forms

Form used for editing a date string

DateField_DisabledClass in namespace SilverStripe\Forms

Disabled version of {@link DateField}.

DatetimeFieldClass in namespace SilverStripe\Forms

Form field used for editing date time strings.

DisabledTransformationClass in namespace SilverStripe\Forms

Transformation that disables all the fields on the form.

DropdownFieldClass in namespace SilverStripe\Forms

Dropdown field, created from a select tag.

FieldList::dataFields() — Method in class FieldList

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

FieldList::dataFieldNames() — Method in class FieldList

Return array of all field names

FieldList::dataFieldByName() — Method in class FieldList

Returns a named field in a sequential set.

$ Form#default_classesProperty in class Form
Form::defaultAction() — Method in class Form

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

Form::disableDefaultAction() — Method in class Form

Disable the default button.

Form::disableSecurityToken() — Method in class Form

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

Form::debug() — Method in class Form
$ FormField#default_classesProperty in class FormField
FormField::dataValue() — Method in class FormField

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

FormField::debug() — Method in class FormField
GridFieldAddExistingAutocompleter::doSearch() — Method in class GridFieldAddExistingAutocompleter

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

GridFieldDetailForm_ItemRequest::doSave() — Method in class GridFieldDetailForm_ItemRequest
GridFieldDetailForm_ItemRequest::doDelete() — Method in class GridFieldDetailForm_ItemRequest
$ GridFieldPaginator#default_items_per_pageProperty in class GridFieldPaginator

Specifies default items per page

GridState::dataValue() — Method in class GridState

Returns a json encoded string representation of this state.

$ HTMLEditorConfig#default_configProperty in class HTMLEditorConfig

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

$ HTMLEditorField#default_rowsProperty in class HTMLEditorField

Number of rows

TinyMCEConfig::disablePlugins() — Method in class TinyMCEConfig

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

MoneyField::dataValue() — Method in class MoneyField

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

NullableField::debug() — Method in class NullableField
NumericField::dataValue() — Method in class NumericField

Get internal database value

RequiredFields::debug() — Method in class RequiredFields

Debug helper

TreeMultiselectField::dataValue() — Method in class TreeMultiselectField

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

DisableIndexingOnFileMigrationClass in namespace SilverStripe\FullTextSearch\Search\Extensions

This extension can be applied to SilverStripe\Dev\Tasks\MigrateFileTask to avoid constantly re-indexing files while the file migration is running.

$ SearchIndex#dependancyListProperty in class SearchIndex
$ SearchIndex#derivedFieldsProperty in class SearchIndex
SearchIndex::delete() — Method in class SearchIndex
SearchIndex_Null::delete() — Method in class SearchIndex_Null
$ SearchIndex_Recording#deletedProperty in class SearchIndex_Recording
SearchIndex_Recording::delete() — Method in class SearchIndex_Recording
$ SearchUpdateCommitJobProcessor#dirty_indexesProperty in class SearchUpdateCommitJobProcessor

List of dirty indexes to be committed

$ SearchQuery#default_page_sizeProperty in class SearchQuery
$ SolrIndex#default_fieldProperty in class SolrIndex

Name of default field

SolrIndex::delete() — Method in class SolrIndex
$ Controller#default_schemaProperty in class Controller
DevelopmentAdminClass in namespace SilverStripe\GraphQL\Dev
DebugSchemaStateClass in namespace SilverStripe\GraphQL\Dev\State
DisableTypeCacheStateClass in namespace SilverStripe\GraphQL\Dev\State
DevBuildExtensionClass in namespace SilverStripe\GraphQL\Extensions
DevErrorHandlerClass in namespace SilverStripe\GraphQL\QueryHandler

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

DataObjectModelClass in namespace SilverStripe\GraphQL\Schema\DataObject

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

DeleteCreatorClass in namespace SilverStripe\GraphQL\Schema\DataObject

Creates a delete operation for a DataObject

InheritanceUnionBuilder::defaultUnionFormatter() — Method in class InheritanceUnionBuilder
InterfaceBuilder::defaultInterfaceFormatter() — Method in class InterfaceBuilder
DBDateArgsClass in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
DBDatetimeArgsClass in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
DBDecimalArgsClass in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
DBFieldArgsClass in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs

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

DBFieldArgsPluginClass in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
DBFloatArgsClass in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
DBHTMLTextArgsClass in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
DBTextArgsClass in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
DBTimeArgsClass in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
DBFieldTypesClass in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin
DefaultFieldsProviderClass in namespace SilverStripe\GraphQL\Schema\Interfaces

For models that can provide a default set of fields

Logger::debug() — Method in class Logger
$ PaginationPlugin#default_limitProperty in class PaginationPlugin
DefaultResolverClass in namespace SilverStripe\GraphQL\Schema\Resolver

Default field resolver for any type

DefaultResolver::defaultFieldResolver() — Method in class DefaultResolver

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

DefaultResolverStrategyClass in namespace SilverStripe\GraphQL\Schema\Resolver

A good starting point for a resolver discovery implementation.

SchemaConfig::discoverResolver() — Method in class SchemaConfig
$ CodeGenerationStore#dirNameProperty in class CodeGenerationStore
GridFieldQueuedExportButton::downloadExport() — Method in class GridFieldQueuedExportButton
CryptoHandler::decrypt() — Method in class CryptoHandler
McryptCrypto::decrypt() — Method in class McryptCrypto

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

OpenSSLCrypto::decrypt() — Method in class OpenSSLCrypto

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

HybridSession::destroy() — Method in class HybridSession
CookieStore::destroy() — Method in class CookieStore
DatabaseStoreClass in namespace SilverStripe\HybridSessions\Store
DatabaseStore::destroy() — Method in class DatabaseStore
LDAPDebugController::DefaultGroup() — Method in class LDAPDebugController
$ LDAPMemberExtension#delete_users_in_ldapProperty in class LDAPMemberExtension

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

LDAPGateway::delete() — Method in class LDAPGateway

Deletes an LDAP object.

$ LDAPService#default_groupProperty in class LDAPService

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

LDAPService::deleteLDAPMember() — Method in class LDAPService

Delete an LDAP user mapped to the Member record

LDAPService::delete() — Method in class LDAPService

A simple proxy to LDAP delete operation.

$ LDAPGroupSyncTask#destructiveProperty in class LDAPGroupSyncTask

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

$ LDAPMemberSyncTask#destructiveProperty in class LDAPMemberSyncTask

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

DebugViewFriendlyErrorFormatterClass in namespace SilverStripe\Logging

Produce a friendly error message

DetailedErrorFormatterClass in namespace SilverStripe\Logging

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

EnablerExtension::darkModeIsEnabled() — Method in class EnablerExtension
LoginHandler::doLogin() — Method in class LoginHandler

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

SecurityExtension::doResetAccount() — Method in class SecurityExtension

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

$ MemberExtension#DefaultRegisteredMethodProperty in class MemberExtension
$ MemberExtension#DefaultRegisteredMethodIDProperty in class MemberExtension
$ RegisteredMethod#DataProperty in class RegisteredMethod
EnabledMembers::description() — Method in class EnabledMembers

Return the description of this report.

DefusePHPEncryptionAdapterClass in namespace SilverStripe\MFA\Service

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

DefusePHPEncryptionAdapter::decrypt() — Method in class DefusePHPEncryptionAdapter

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

EncryptionAdapterInterface::decrypt() — Method in class EncryptionAdapterInterface

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

$ MethodRegistry#default_backup_methodProperty in class MethodRegistry

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

$ Notification#dependenciesProperty in class Notification
RegisteredMethodManager::deleteFromMember() — Method in class RegisteredMethodManager

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

ArrayList::dataClass() — Method in class ArrayList

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

ArrayList::debug() — Method in class ArrayList
DBConnectorClass in namespace SilverStripe\ORM\Connect

Represents an object responsible for wrapping DB connector api

$ DBConnector#ddl_operationsProperty in class DBConnector

List of operations to treat as DDL

DBQueryBuilderClass in namespace SilverStripe\ORM\Connect

Builds a SQL query string from a SQLExpression object

DBSchemaManagerClass in namespace SilverStripe\ORM\Connect

Represents and handles all schema management for a database

DBSchemaManager::doesSchemaNeedUpdating() — Method in class DBSchemaManager

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

DBSchemaManager::dontRequireTable() — Method in class DBSchemaManager

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

DBSchemaManager::dontRequireField() — Method in class DBSchemaManager

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

DBSchemaManager::dbDataType() — Method in class DBSchemaManager
DBSchemaManager::databaseList() — Method in class DBSchemaManager

Retrieves the list of all databases the user has access to

DBSchemaManager::databaseExists() — Method in class DBSchemaManager

Determine if the database with the specified name exists

DBSchemaManager::dropDatabase() — Method in class DBSchemaManager

Drops a database with the specified name

DBSchemaManager::date() — Method in class DBSchemaManager

Returns data type for 'date' column

DBSchemaManager::decimal() — Method in class DBSchemaManager

Returns data type for 'decimal' column

DBSchemaManager::datetime() — Method in class DBSchemaManager

Returns data type for 'datetime' column

DatabaseClass in namespace SilverStripe\ORM\Connect

Abstract database connectivity class.

Database::datetimeIntervalClause() — Method in class Database

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

Database::datetimeDifferenceClause() — Method in class Database

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

Database::databaseExists() — Method in class Database

Determine if the database with the specified name exists

Database::databaseList() — Method in class Database

Retrieves the list of all databases the user has access to

Database::dropSelectedDatabase() — Method in class Database

Drop the database that this object is currently connected to.

DatabaseExceptionClass in namespace SilverStripe\ORM\Connect

Error class for database exceptions

MySQLDatabase::datetimeIntervalClause() — Method in class MySQLDatabase

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

MySQLDatabase::datetimeDifferenceClause() — Method in class MySQLDatabase

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

MySQLSchemaManager::databaseList() — Method in class MySQLSchemaManager

Retrieves the list of all databases the user has access to

MySQLSchemaManager::databaseExists() — Method in class MySQLSchemaManager

Determine if the database with the specified name exists

MySQLSchemaManager::dropDatabase() — Method in class MySQLSchemaManager

Drops a database with the specified name

MySQLSchemaManager::dbDataType() — Method in class MySQLSchemaManager
MySQLSchemaManager::date() — Method in class MySQLSchemaManager

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

MySQLSchemaManager::decimal() — Method in class MySQLSchemaManager

Return a decimal type-formatted string

MySQLSchemaManager::datetime() — Method in class MySQLSchemaManager

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

TempDatabase::deleteAll() — Method in class TempDatabase

Clear all temp DBs on this connection

DBClass in namespace SilverStripe\ORM

Global database interface, complete with static methods.

DB::dont_require_table() — Method in class DB

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

DB::dont_require_field() — Method in class DB

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

DataExtensionClass in namespace SilverStripe\ORM

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

DataListClass in namespace SilverStripe\ORM

Implements a "lazy loading" DataObjectSet.

DataList::dataClass() — Method in class DataList

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

DataList::dataQuery() — Method in class DataList

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

DataList::distinct() — Method in class DataList

Return a new DataList instance with distinct records or not

DataList::debug() — Method in class DataList
DataList::dbObject() — Method in class DataList
DataObjectClass in namespace SilverStripe\ORM

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

$ DataObject#default_classnameProperty in class DataObject

Allows specification of a default value for the ClassName field.

$ DataObject#destroyedProperty in class DataObject
$ DataObject#dbProperty in class DataObject

Database field definitions.

$ DataObject#defaultsProperty in class DataObject

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

$ DataObject#default_recordsProperty in class DataObject

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

$ DataObject#default_sortProperty in class DataObject

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

DataObject::destroy() — Method in class DataObject

Destroy all of this objects dependent objects and local caches.

DataObject::duplicate() — Method in class DataObject

Create a duplicate of this node. Can duplicate many_many relations

DataObject::defineMethods() — Method in class DataObject

Adds methods from the extensions.

DataObject::data() — Method in class DataObject

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

DataObject::doValidate() — Method in class DataObject

Public accessor for {see DataObject::validate()}

DataObject::delete() — Method in class DataObject

Delete this data object.

DataObject::delete_by_id() — Method in class DataObject

Delete the record with the given ID.

DataObject::database_extensions() — Method in class DataObject

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

DataObject::debug() — Method in class DataObject

Debugging used by Debug::show()

DataObject::dbObject() — Method in class DataObject

Return the DBField object that represents the given field.

DataObject::defaultSearchFilters() — Method in class DataObject

Defines a default list of filters for the search context.

DataObject::disable_subclass_access() — Method in class DataObject

Temporarily disable subclass access in data object qeur

DataObjectInterfaceClass in namespace SilverStripe\ORM

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

DataObjectInterface::delete() — Method in class DataObjectInterface

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

DataObjectSchemaClass in namespace SilverStripe\ORM

Provides dataobject and database schema mapping functionality

DataObjectSchema::databaseFields() — Method in class DataObjectSchema

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

DataObjectSchema::databaseField() — Method in class DataObjectSchema

Gets a single database field.

DataObjectSchema::databaseIndexes() — Method in class DataObjectSchema
DataQueryClass in namespace SilverStripe\ORM

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

DataQuery::dataClass() — Method in class DataQuery

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

DataQuery::disjunctiveGroup() — Method in class DataQuery

Create a disjunctive subgroup.

DataQuery::distinct() — Method in class DataQuery

Set whether this query should be distinct or not.

DataQueryManipulatorClass in namespace SilverStripe\ORM

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

DataQuery_SubGroupClass in namespace SilverStripe\ORM

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

DatabaseAdminClass in namespace SilverStripe\ORM

DatabaseAdmin class

DatabaseAdmin::doBuild() — Method in class DatabaseAdmin

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

DBBigIntClass in namespace SilverStripe\ORM\FieldType

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

DBBooleanClass in namespace SilverStripe\ORM\FieldType

Represents a boolean field.

DBClassNameClass in namespace SilverStripe\ORM\FieldType

Represents a classname selector, which respects obsolete clasess.

DBCompositeClass in namespace SilverStripe\ORM\FieldType

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

DBComposite::dbObject() — Method in class DBComposite

Get a db object for the named field

DBCurrencyClass in namespace SilverStripe\ORM\FieldType

Represents a decimal field containing a currency amount.

DBDateClass in namespace SilverStripe\ORM\FieldType

Represents a date field.

DBDate::DayOfWeek() — Method in class DBDate

Returns the day of the week

DBDate::DayOfMonth() — Method in class DBDate

Returns the day of the month.

DBDatetimeClass in namespace SilverStripe\ORM\FieldType

Represents a date-time field.

DBDatetime::Date() — Method in class DBDatetime

Returns the standard localised date

DBDecimalClass in namespace SilverStripe\ORM\FieldType

Represents a Decimal field.

DBDoubleClass in namespace SilverStripe\ORM\FieldType

Supports double precision DB types

DBEnumClass in namespace SilverStripe\ORM\FieldType

Class Enum represents an enumeration of a set of strings.

DBFieldClass in namespace SilverStripe\ORM\FieldType

Single field in the database.

$ DBField#default_search_filter_classProperty in class DBField

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

DBField::defaultSearchFilter() — Method in class DBField
DBField::debug() — Method in class DBField
DBFloatClass in namespace SilverStripe\ORM\FieldType

Represents a floating point field.

DBForeignKeyClass in namespace SilverStripe\ORM\FieldType

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

$ DBForeignKey#dropdown_field_thresholdProperty in class DBForeignKey

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

DBHTMLTextClass in namespace SilverStripe\ORM\FieldType

Represents a large text field that contains HTML content.

DBHTMLVarcharClass in namespace SilverStripe\ORM\FieldType

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

DBIndexableClass in namespace SilverStripe\ORM\FieldType

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

DBIntClass in namespace SilverStripe\ORM\FieldType

Represents a signed 32 bit integer field.

DBLocaleClass in namespace SilverStripe\ORM\FieldType

Locale database field, mainly used in {@link Translatable} extension.

DBMoneyClass in namespace SilverStripe\ORM\FieldType

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

DBMultiEnumClass in namespace SilverStripe\ORM\FieldType

Represents an multi-select enumeration field.

DBPercentageClass in namespace SilverStripe\ORM\FieldType

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

DBPolymorphicForeignKeyClass in namespace SilverStripe\ORM\FieldType

A special ForeignKey class that handles relations with arbitrary class types

DBPrimaryKeyClass in namespace SilverStripe\ORM\FieldType

A special type Int field used for primary keys.

DBStringClass in namespace SilverStripe\ORM\FieldType

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

DBString::defaultEllipsis() — Method in class DBString

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

DBTextClass in namespace SilverStripe\ORM\FieldType

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

DBTimeClass in namespace SilverStripe\ORM\FieldType

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

DBVarcharClass in namespace SilverStripe\ORM\FieldType

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

DBYearClass in namespace