Index | SilverStripe API

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

$ ElementalAreaController#allowed_actions — Property in class ElementalAreaController

ElementalAreaController::apiSaveForm() — Method in class ElementalAreaController

Save an inline edit form for a block

$ ElementalContentControllerExtension#allowed_actions — Property in class ElementalContentControllerExtension

$ ElementalAreaField#area — Property in class ElementalAreaField

AddElementToAreaMutation — Class 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#anchor — Property in class BaseElement

For caching 'getAnchor'

BaseElement::AbsoluteLink() — Method in class BaseElement

DataExtension::assignTopPage() — Method in class DataExtension

Assigns top page relation

DataExtension::assignFixedTopPage() — Method in class DataExtension

Assigns top page relation based on fixed id

FluentExtension::assignTopPage() — Method in class FluentExtension

Assigns top page relation

FluentExtension::assignFixedTopPage() — Method in class FluentExtension

Assigns top page relation based on fixed id

SiteTreeExtension::addDuplicatedObject() — Method in class SiteTreeExtension

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

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

DebugBarMiddleware::afterRequest() — Method in class DebugBarMiddleware

Inject DebugBar requirements for the frontend

$ SSViewerProxy#allTemplates — Property in class SSViewerProxy

Tracks all templates used in the current request

PhockitoClassManifestUpdater::addDouble() — Method in class PhockitoClassManifestUpdater

AdminErrorExtension — Class in namespace SilverStripe\Admin

AdminRootController — Class in namespace SilverStripe\Admin

AdminRootController::admin_url() — Method in class AdminRootController

Returns the root admin URL for the site with trailing slash

AdminRootController::add_rule_for_controller() — Method in class AdminRootController

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

CMSBatchAction::applicablePagesHelper() — Method in class CMSBatchAction

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

CMSBatchAction::applicablePages() — Method in class CMSBatchAction

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

$ CMSBatchActionHandler#allowed_actions — Property in class CMSBatchActionHandler

CMSBatchActionHandler::actionByName() — Method in class CMSBatchActionHandler

Get an action for a given name

CMSMenu::add_controller() — Method in class CMSMenu

Add a LeftAndMain controller to the CMS menu.

CMSMenu::add_link() — Method in class CMSMenu

Add an arbitrary URL to the CMS menu.

CMSMenu::add_menu_item() — Method in class CMSMenu

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

CMSMenu::add_menu_item_obj() — Method in class CMSMenu

Add a previously built menu item object to the menu

$ CMSMenuItem#attributes — Property in class CMSMenuItem

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

$ UsedOnTable#allowed_actions — Property in class UsedOnTable

$ LeftAndMain#allowed_actions — Property in class LeftAndMain

$ LeftAndMain#admin_themes — Property in class LeftAndMain

Themes to use within the CMS

$ LeftAndMain#application_link — Property in class LeftAndMain

The href for the anchor on the Silverstripe logo

$ LeftAndMain#application_name — Property in class LeftAndMain

The application name

LeftAndMain::afterHandleRequest() — Method in class LeftAndMain

Cleanup for the handleRequest method

LeftAndMain::ApplicationLink() — Method in class LeftAndMain

LeftAndMainExtension::accessedCMS() — Method in class LeftAndMainExtension

LeftAndMainExtension::augmentNewSiteTreeItem() — Method in class LeftAndMainExtension

$ ModalController#allowed_actions — Property in class ModalController

$ ModelAdmin#allowed_actions — Property in class ModelAdmin

$ SecurityAdmin#allowed_actions — Property in class SecurityAdmin

AkismetField — Class in namespace SilverStripe\Akismet

Form field to handle akismet error display and handling

AkismetSpamProtector — Class in namespace SilverStripe\Akismet

Spam protector for Akismet

$ AkismetSpamProtector#api_key — Property in class AkismetSpamProtector

Set this to your API key

$ AkismetSpamProtector#apiKey — Property in class AkismetSpamProtector

The API key that will be used for the service. Can be set on the singleton to take priority over configuration.

AkismetConfig — Class in namespace SilverStripe\Akismet\Config

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

AkismetMiddleware — Class in namespace SilverStripe\Akismet\Config

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

AkismetService — Class in namespace SilverStripe\Akismet\Service

Describes TijsVerkoyen\Akismet\Akismet

AkismetServiceBackend — Class in namespace SilverStripe\Akismet\Service

Applies AkismetService to TijsVerkoyen\Akismet\Akismet

AssetAdmin — Class in namespace SilverStripe\AssetAdmin\Controller

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

$ AssetAdmin#allowed_actions — Property in class AssetAdmin

AssetAdmin::apiCreateFile() — Method in class AssetAdmin

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

AssetAdmin::apiUploadFile() — Method in class AssetAdmin

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

AssetAdmin::apiHistory() — Method in class AssetAdmin

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

AssetAdmin::addtocampaign() — Method in class AssetAdmin

Action handler for adding pages to a campaign

AssetAdmin::addToCampaignForm() — Method in class AssetAdmin

Url handler for add to campaign form

AssetAdminFieldsExtension — Class in namespace SilverStripe\AssetAdmin\Controller

AssetAdminFile — Class in namespace SilverStripe\AssetAdmin\Controller

Update File dataobjects to be editable in this asset admin

$ RemoteFileModalExtension#allowed_actions — Property in class RemoteFileModalExtension

AssetFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms

$ UploadField#allowed_actions — Property in class UploadField

$ UploadField#attachEnabled — Property in class UploadField

Set if selecting existing files is enabled.

$ UploadField#allowedMaxFileNumber — Property in class UploadField

The number of files allowed for this field

$ CreateFileMutationCreator#accessor — Property in class CreateFileMutationCreator

CreateFileMutationCreator::attributes() — Method in class CreateFileMutationCreator

CreateFileMutationCreator::args() — Method in class CreateFileMutationCreator

$ CreateFolderMutationCreator#accessor — Property in class CreateFolderMutationCreator

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#accessor — Property in class FileInputTypeCreator

FileInputTypeCreator::attributes() — Method in class FileInputTypeCreator

FileInterfaceTypeCreator::attributes() — Method in class FileInterfaceTypeCreator

$ FileTypeCreator#accessor — Property in class FileTypeCreator

FileTypeCreator::attributes() — Method in class FileTypeCreator

FileUsageType::attributes() — Method in class FileUsageType

$ FolderInputTypeCreator#accessor — Property in class FolderInputTypeCreator

FolderInputTypeCreator::attributes() — Method in class FolderInputTypeCreator

FolderTypeCreator::attributes() — Method in class FolderTypeCreator

$ MoveFilesMutationCreator#accessor — Property in class MoveFilesMutationCreator

MoveFilesMutationCreator::attributes() — Method in class MoveFilesMutationCreator

MoveFilesMutationCreator::args() — Method in class MoveFilesMutationCreator

PublicationMutationCreator::attributes() — Method in class PublicationMutationCreator

PublicationMutationCreator::args() — Method in class PublicationMutationCreator

PublicationMutationCreator::addWarningMessage() — Method in class PublicationMutationCreator

PublicationNoticeType::attributes() — Method in class PublicationNoticeType

ReadDescendantFileCountsQueryCreator::attributes() — Method in class ReadDescendantFileCountsQueryCreator

ReadDescendantFileCountsQueryCreator::args() — Method in class ReadDescendantFileCountsQueryCreator

ReadFileConnection::applySort() — Method in class ReadFileConnection

Always sort by folders before files

ReadFileQueryCreator::attributes() — Method in class ReadFileQueryCreator

ReadFileUsageQueryCreator::attributes() — Method in class ReadFileUsageQueryCreator

ReadFileUsageQueryCreator::args() — Method in class ReadFileUsageQueryCreator

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

$ UpdateFileMutationCreator#accessor — Property in class UpdateFileMutationCreator

UpdateFileMutationCreator::attributes() — Method in class UpdateFileMutationCreator

UpdateFileMutationCreator::args() — Method in class UpdateFileMutationCreator

AssetControlExtension — Class in namespace SilverStripe\Assets

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

AssetControlExtension::addAssetsFromOtherStages() — Method in class AssetControlExtension

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

AssetControlExtension::addAssetsFromRecord() — Method in class AssetControlExtension

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

AssetManipulationList — Class in namespace SilverStripe\Assets

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

AssetManipulationList::addAsset() — Method in class AssetManipulationList

Add asset with the given state

AssetManipulationList::addPublicAsset() — Method in class AssetManipulationList

Mark a file as public

AssetManipulationList::addProtectedAsset() — Method in class AssetManipulationList

Record an asset as protected

AssetManipulationList::addDeletedAsset() — Method in class AssetManipulationList

Record an asset as deleted

TestAssetStore::activate() — Method in class TestAssetStore

Set this store as the new asset backend

$ File#allowed_extensions — Property in class File

$ File#app_categories — Property in class File

$ File#apply_restrictions_to_admin — Property in class File

File::AbsoluteLink() — Method in class File

Just an alias function to keep a consistent API with SiteTree

File::appCategory() — Method in class File

Returns a category based on the file extension.

FileFinder::acceptDir() — Method in class FileFinder

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

FileFinder::acceptFile() — Method in class FileFinder

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

AssetAdapter — Class in namespace SilverStripe\Assets\Flysystem

Adapter for local filesystem based on assets directory

FlysystemAssetStore::applyToFileOnFilesystem() — Method in class FlysystemAssetStore

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

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

FlysystemAssetStore::applyToFileIDOnFilesystem() — Method in class FlysystemAssetStore

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

$ GeneratedAssets#assetStore — Property in class GeneratedAssets

Flysystem store for files

$ ImageManipulation#allowGeneration — Property in class ImageManipulation

If image resizes are allowed

$ ImageManipulation#asset_preview_width — Property in class ImageManipulation

The width of an image preview in the Asset section

$ ImageManipulation#asset_preview_height — Property in class ImageManipulation

The height of an image preview in the Asset section

FileLinkTracking::augmentSyncLinkTracking() — Method in class FileLinkTracking

Find HTMLText fields on owner to scrape for links that need tracking

$ FileShortcodeProvider#allow_session_grant — Property in class FileShortcodeProvider

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

$ ImageShortcodeProvider#attribute_whitelist — Property in class ImageShortcodeProvider

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

AssetContainer — Class in namespace SilverStripe\Assets\Storage

Represents a container for a specific asset.

AssetNameGenerator — Class in namespace SilverStripe\Assets\Storage

Provides a mechanism for suggesting filename alterations to a file

AssetStore — Class in namespace SilverStripe\Assets\Storage

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

AssetStoreRouter — Class in namespace SilverStripe\Assets\Storage

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

$ DBFile#allowedCategories — Property in class DBFile

List of allowed file categories.

DBFile::AbsoluteLink() — Method in class DBFile

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

DBFile::assertFilenameValid() — Method in class DBFile

Check filename, and raise a ValidationException if invalid

$ ProtectedFileController#allowed_actions — Property in class ProtectedFileController

Sha1FileHashingService::algo() — Method in class Sha1FileHashingService

Valid hashing algorithm constant that can be passed to hash_init.

$ Upload#allowed_actions — Property in class Upload

$ Upload_Validator#allowedMaxFileSize — Property in class Upload_Validator

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

$ Upload_Validator#allowedExtensions — Property in class Upload_Validator

AuditFactory — Class in namespace SilverStripe\Auditor

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

AuditHook — Class in namespace SilverStripe\Auditor

Provides logging hooks that are inserted into Framework objects.

AuditHook::afterMemberLoggedIn() — Method in class AuditHook

Log successful login attempts.

AuditHook::authenticationFailed() — Method in class AuditHook

Log failed login attempts.

AuditHook::authenticationFailedUnknownUser() — Method in class AuditHook

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

AuditHook::afterMemberLoggedOut() — Method in class AuditHook

Log successful logout.

AuditHookMFA — Class in namespace SilverStripe\Auditor

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

AuditHookManyManyList — Class in namespace SilverStripe\Auditor

AuditHookMemberGroupSet — Class in namespace SilverStripe\Auditor

AuditHookSessionManager — Class in namespace SilverStripe\Auditor

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

BasicContext::appendErrorHandlerBeforeStep() — Method in class BasicContext

$ FixtureContext#activatedConfigFiles — Property in class FixtureContext

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

$ SilverStripeAwareInitializer#ajaxSteps — Property in class SilverStripeAwareInitializer

$ SilverStripeAwareInitializer#ajaxTimeout — Property in class SilverStripeAwareInitializer

$ SilverStripeAwareInitializer#adminUrl — Property in class SilverStripeAwareInitializer

$ SilverStripeContext#ajaxSteps — Property in class SilverStripeContext

$ SilverStripeContext#ajaxTimeout — Property in class SilverStripeContext

$ SilverStripeContext#adminUrl — Property in class SilverStripeContext

GridFieldMergeAction::augmentColumns() — Method in class GridFieldMergeAction

Modify the list of columns displayed in the table.

$ Blog#allowed_children — Property in class Blog

Blog::addCMSRequirements() — Method in class Blog

Adds CMS related css and js overrides

Blog::assignGroup() — Method in class Blog

Assign users as necessary to the blog group.

$ BlogController#allowed_actions — Property in class BlogController

BlogController::archive() — Method in class BlogController

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

$ BlogPost#allowed_children — Property in class BlogPost

$ BlogPost#add_default_author — Property in class BlogPost

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

$ BlogPost#AuthorNames — Property in class BlogPost

BlogPost::Authors() — Method in class BlogPost

BlogPostFilter::augmentSQL() — Method in class BlogPostFilter

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

BlogPostFilter::augmentLoadLazyFields() — Method in class BlogPostFilter

{@inheritDoc}

$ BlogArchiveWidget#ArchiveType — Property in class BlogArchiveWidget

$ CKANRegistryPageController#allowed_actions — Property in class CKANRegistryPageController

APIClient — Class in namespace SilverStripe\CKANRegistry\Service

APIClientInterface — Class in namespace SilverStripe\CKANRegistry\Service

A service responsible for communicating with a CKAN API endpoint

$ ResourcePopulator#apiClient — Property in class ResourcePopulator

CMSBatchAction_Archive::applicablePages() — Method in class CMSBatchAction_Archive

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

CMSBatchAction_Publish::applicablePages() — Method in class CMSBatchAction_Publish

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

CMSBatchAction_Restore::applicablePages() — Method in class CMSBatchAction_Restore

{SiteTree::canEdit()}

CMSBatchAction_Unpublish::applicablePages() — Method in class CMSBatchAction_Unpublish

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

$ CMSMain#allowed_actions — Property in class CMSMain

CMSMain::archive() — Method in class CMSMain

Delete this page from both live and stage

$ CMSPageAddController#allowed_actions — Property in class CMSPageAddController

CMSPageAddController::AddForm() — Method in class CMSPageAddController

$ CMSPageEditController#allowed_actions — Property in class CMSPageEditController

CMSPageEditController::addtocampaign() — Method in class CMSPageEditController

Action handler for adding pages to a campaign

CMSPageEditController::AddToCampaignForm() — Method in class CMSPageEditController

Url handler for add to campaign form

$ CMSPageHistoryController#allowed_actions — Property in class CMSPageHistoryController

CMSSiteTreeFilter::applyDefaultFilters() — Method in class CMSSiteTreeFilter

Applies the default filters to a specified DataList of pages

$ ContentController#allowed_actions — Property in class ContentController

AnchorLinkFormFactory — Class in namespace SilverStripe\CMS\Forms

AnchorSelectorField — Class in namespace SilverStripe\CMS\Forms

Assists with selecting anchors on a given page

$ AnchorSelectorField#allowed_actions — Property in class AnchorSelectorField

AnchorSelectorField::anchors() — Method in class AnchorSelectorField

Find all anchors available on the given page.

$ InternalLinkModalExtension#allowed_actions — Property in class InternalLinkModalExtension

$ SiteTreeURLSegmentField#allowed_actions — Property in class SiteTreeURLSegmentField

LinkablePlugin::apply() — Method in class LinkablePlugin

LinkablePlugin::applyLinkFilter() — Method in class LinkablePlugin

$ RedirectorPageController#allowed_actions — Property in class RedirectorPageController

$ SiteTree#allowed_children — Property in class SiteTree

Indicates what kind of children this page type can have.

SiteTree::AbsoluteLink() — Method in class SiteTree

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

SiteTree::allowedChildren() — Method in class SiteTree

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

SiteTreeLinkTracking::augmentSyncLinkTracking() — Method in class SiteTreeLinkTracking

Find HTMLText fields on owner to scrape for links that need tracking

VirtualPage::allowedChildren() — Method in class VirtualPage

VirtualPage::allMethodNames() — Method in class VirtualPage

{@inheritdoc}

$ ContentControllerSearchExtension#allowed_actions — Property in class ContentControllerSearchExtension

SearchForm::addStarsToKeywords() — Method in class SearchForm

$ RemoveOrphanedPagesTask#allowed_actions — Property in class RemoveOrphanedPagesTask

$ SiteTreeMaintenanceTask#allowed_actions — Property in class SiteTreeMaintenanceTask

AddToCampaignHandler — Class in namespace SilverStripe\CampaignAdmin

Class AddToCampaignHandler - handle the AddToCampaign action.

AddToCampaignHandler::addToCampaign() — Method in class AddToCampaignHandler

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

AddToCampaignHandler_FormAction — Class in namespace SilverStripe\CampaignAdmin

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

AddToCampaignValidator — Class in namespace SilverStripe\CampaignAdmin

$ CampaignAdmin#allowed_actions — Property in class CampaignAdmin

$ CommentAdmin#allowed_actions — Property in class CommentAdmin

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.

ApproveHandler — Class in namespace SilverStripe\Comments\Admin\CommentsGridFieldBulkAction

A Handler for bulk approving comments

$ Handler#allowed_actions — Property in class Handler

Handler::approve() — Method in class Handler

CommentsGridFieldSpamAction::augmentColumns() — Method in class CommentsGridFieldSpamAction

Modify the list of columns displayed in the table.

$ CommentingController#allowed_actions — Property in class CommentingController

{@inheritDoc}

CommentingController::approve() — Method in class CommentingController

Marks a given 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 SiteTree object

$ Comment#AllowHtml — Property in class Comment

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

Comment::actionLink() — Method in class Comment

Generate a secure admin-action link authorised for the specified member

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

DeltaConfigCollection::addDelta() — Method in class DeltaConfigCollection

Push new delta

DeltaMiddleware::applyDelta() — Method in class DeltaMiddleware

Apply a single delta to a class config

MiddlewareAware::addMiddleware() — Method in class MiddlewareAware

YamlTransformer::addRule() — Method in class YamlTransformer

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

YamlTransformer::addDependencies() — Method in class YamlTransformer

Incapsulates the logic for adding before/after dependencies.

$ ContentReviewCMSExtension#allowed_actions — Property in class ContentReviewCMSExtension

SiteTreeContentReview::addReviewNote() — Method in class SiteTreeContentReview

Creates a ContentReviewLog and connects it to this Page.

SiteTreeContentReview::advanceReviewDate() — Method in class SiteTreeContentReview

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

$ CliController#allowed_actions — Property in class CliController

$ Controller#action — Property in class Controller

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

$ Controller#allowed_actions — Property in class Controller

Controller::afterHandleRequest() — Method in class Controller

Cleanup for the handleRequest method

$ Director#alternate_base_folder — Property in class Director

$ Director#alternate_public_dir — Property 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_email — Property 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#allParams — Property in class HTTPRequest

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

HTTPRequest::addHeader() — Method in class HTTPRequest

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

HTTPRequest::allParams() — Method in class HTTPRequest

HTTPRequest::allParsed() — Method in class HTTPRequest

Returns true if the URL has been completely parsed.

HTTPResponse::addHeader() — Method in class HTTPResponse

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

AllowedHostsMiddleware — Class in namespace SilverStripe\Control\Middleware

Secures requests by only allowing a whitelist of Host values

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

Bypass for AJAX requests

HttpMethodBypass::addMethods() — Method in class HttpMethodBypass

Add new HTTP methods to the list

Url::addHttpMethods() — Method in class Url

Add HTTP methods to check against

$ HTTPCacheControlMiddleware#allowed_directives — Property in class HTTPCacheControlMiddleware

A list of allowed cache directives for HTTPResponses

HTTPCacheControlMiddleware::addVary() — Method in class HTTPCacheControlMiddleware

Add a vary

HTTPCacheControlMiddleware::applyChangeLevel() — Method in class HTTPCacheControlMiddleware

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

HTTPCacheControlMiddleware::applyToResponse() — Method in class HTTPCacheControlMiddleware

Generate all headers to add to this object

HTTPCacheControlMiddleware::augmentState() — Method in class HTTPCacheControlMiddleware

Update state based on current request and response objects

HTTPMiddlewareAware::addMiddleware() — Method in class HTTPMiddlewareAware

RateLimitMiddleware::addHeadersToResponse() — Method in class RateLimitMiddleware

$ RSSFeed#authorField — Property in class RSSFeed

Name of the author field of feed entries

$ RSSFeed_Entry#authorField — Property in class RSSFeed_Entry

Name of the author field of feed entries

RSSFeed_Entry::Author() — Method in class RSSFeed_Entry

Get the author of this entry

RSSFeed_Entry::AbsoluteLink() — Method in class RSSFeed_Entry

Get a link to this entry

$ RequestHandler#allowed_actions — Property in class RequestHandler

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

RequestHandler::addBackURLParam() — Method in class RequestHandler

RequestHandler::allowedActions() — Method in class RequestHandler

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

Session::addToArray() — Method in class Session

Merge value with array

Application — Class in namespace SilverStripe\Core

Identifies a class as a root silverstripe application

BaseKernel::activate() — Method in class BaseKernel

Ensures this kernel is the active kernel after or during nesting

ApcuCacheFactory — Class in namespace SilverStripe\Core\Cache

$ DefaultCacheFactory#args — Property in class DefaultCacheFactory

ClassInfo::allClasses() — Method in class ClassInfo

Wrapper for classes getter.

ClassInfo::ancestry() — Method in class ClassInfo

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

ConfigLoader::activate() — Method in class ConfigLoader

Mark this instance as the current instance

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

CustomMethods::addMethodsFrom() — Method in class CustomMethods

Add all the methods from an object property (which is an Extension) to this object.

CustomMethods::addWrapperMethod() — Method in class CustomMethods

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

CustomMethods::addCallbackMethod() — Method in class CustomMethods

Add callback as a method.

$ Extensible#afterExtendCallbacks — Property in class Extensible

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

Extensible::afterExtending() — Method in class Extensible

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

Extensible::add_extension() — Method in class Extensible

Add an extension to a specific class.

$ Extension#allowed_actions — Property in class Extension

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

Extension::add_to_class() — Method in class Extension

Called when this extension is added to a particular class

AfterCallAspect — Class in namespace SilverStripe\Core\Injector

An AfterCallAspect is run after a method is executed

AfterCallAspect::afterCall() — Method in class AfterCallAspect

Call this aspect after a method is executed

AopProxyService — Class in namespace SilverStripe\Core\Injector

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

$ AopProxyService#afterCall — Property in class AopProxyService

Injector::addAutoProperty() — Method in class Injector

Add an object that should be automatically set on managed objects

InjectorLoader::activate() — Method in class InjectorLoader

Mark this instance as the current instance

Kernel::activate() — Method in class Kernel

Ensures this kernel is the active kernel after or during nesting

ManifestFileFinder::acceptDir() — Method in class ManifestFileFinder

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

ManifestFileFinder::anyParents() — Method in class ManifestFileFinder

Check if any parents match the given callback

Module::activate() — Method in class Module

Activate _config.php for this module, if one exists

ModuleManifest::addModule() — Method in class ModuleManifest

Adds a path as a module

ModuleManifest::activateConfig() — Method in class ModuleManifest

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

PrioritySorter::addVariables() — Method in class PrioritySorter

If variables are defined, interpolate their values

BulkLoader_Result::addCreated() — Method in class BulkLoader_Result

BulkLoader_Result::addUpdated() — Method in class BulkLoader_Result

BulkLoader_Result::addDeleted() — Method in class BulkLoader_Result

$ DevBuildController#allowed_actions — Property in class DevBuildController

$ DevConfigController#allowed_actions — Property in class DevConfigController

DevConfigController::audit() — Method in class DevConfigController

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

$ DevelopmentAdmin#allowed_actions — Property in class DevelopmentAdmin

$ DevelopmentAdmin#allow_all_cli — Property in class DevelopmentAdmin

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

FixtureBlueprint::addCallback() — Method in class FixtureBlueprint

See class documentation.

$ FunctionalTest#autoFollowRedirection — Property in class FunctionalTest

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

FunctionalTest::assertPartialMatchBySelector() — Method in class FunctionalTest

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

FunctionalTest::assertExactMatchBySelector() — Method in class FunctionalTest

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

FunctionalTest::assertPartialHTMLMatchBySelector() — Method in class FunctionalTest

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

FunctionalTest::assertExactHTMLMatchBySelector() — Method in class FunctionalTest

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

$ DatabaseAdapterRegistry#adapters — Property in class DatabaseAdapterRegistry

Internal array of registered database adapters

DatabaseAdapterRegistry::autodiscover() — Method in class DatabaseAdapterRegistry

Detects all _register_database.php files and invokes them.

DatabaseAdapterRegistry::autoconfigure() — Method in class DatabaseAdapterRegistry

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

$ InstallerTest#allowed_actions — Property in class InstallerTest

$ SapphireInfo#allowed_actions — Property in class SapphireInfo

SapphireTest::allFixtureIDs() — Method in class SapphireTest

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

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

$ TaskRunner#allowed_actions — Property in class TaskRunner

TaskRunner::addCssToHeader() — Method in class TaskRunner

Inject task runner CSS into the heaader

MigrateFileTask::addLogHandlers() — Method in class MigrateFileTask

TODO Refactor this whole mess into Symfony Console on a TaskRunner level, with a thin wrapper to show coloured console output via a browser: https://github.com/silverstripe/silverstripe-framework/issues/5542

$ RelationValidationService#allow_rules — Property in class RelationValidationService

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

$ ImportField#allowed_actions — Property in class ImportField

$ DevCheckController#allowed_actions — Property in class DevCheckController

$ DevHealthController#allowed_actions — Property in class DevHealthController

EnvironmentCheckSuiteResult::addResult() — Method in class EnvironmentCheckSuiteResult

$ ErrorPage#allowed_children — Property in class ErrorPage

$ CMSExternalLinksController#allowed_actions — Property in class CMSExternalLinksController

CompositeValidator::addValidator() — Method in class CompositeValidator

$ DatalessField#allowHTML — Property in class DatalessField

FieldList::addFieldToTab() — Method in class FieldList

Add an extra field to a tab within this FieldList.

FieldList::addFieldsToTab() — Method in class FieldList

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

$ Form#actions — Property in class Form

$ Form#attributes — Property in class Form

Any custom form attributes set through setAttributes().

Form::actionIsValidationExempt() — Method in class Form

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

Form::Actions() — Method in class Form

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

Form::addExtraClass() — Method in class Form

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

$ FormAction#action — Property in class FormAction

Action name, normally prefixed with 'action_'

FormAction::actionName() — Method in class FormAction

Get the action name

$ FormField#autofocus — Property in class FormField

FormField::addExtraClass() — Method in class FormField

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

FormField::attrTitle() — Method in class FormField

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

FormField::attrValue() — Method in class FormField

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

$ FormRequestHandler#allowed_actions — Property in class FormRequestHandler

FormRequestHandler::addBackURLParam() — Method in class FormRequestHandler

Helper to add ?BackURL= to any link

$ FormScaffolder#ajaxSafe — Property in class FormScaffolder

FormScaffolder::addManyManyRelationshipFields() — Method in class FormScaffolder

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

AbstractGridFieldComponent — Class in namespace SilverStripe\Forms\GridField

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

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

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

$ GridField#allowed_actions — Property in class GridField

GridField::addAllStateToUrl() — Method in class GridField

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

GridField::addDataFields() — Method in class GridField

Add additional calculated data fields to be used on this GridField

GridFieldConfig::addComponent() — Method in class GridFieldConfig

GridFieldConfig::addComponents() — Method in class GridFieldConfig

GridFieldDataColumns::augmentColumns() — Method in class GridFieldDataColumns

Modify the list of columns displayed in the table.

GridFieldDeleteAction::augmentColumns() — Method in class GridFieldDeleteAction

Add a column 'Delete'

$ GridFieldDetailForm_ItemRequest#allowed_actions — Property in class GridFieldDetailForm_ItemRequest

GridFieldEditButton::augmentColumns() — Method in class GridFieldEditButton

Add a column 'Delete'

GridFieldEditButton::addExtraClass() — Method in class GridFieldEditButton

Add an extra HTML class

$ GridFieldLevelup#attributes — Property in class GridFieldLevelup

GridFieldStateManager::addStateToURL() — Method in class GridFieldStateManager

GridFieldStateManagerInterface::addStateToURL() — Method in class GridFieldStateManagerInterface

GridFieldViewButton::augmentColumns() — Method in class GridFieldViewButton

Modify the list of columns displayed in the table.

GridField_ActionMenu::augmentColumns() — Method in class GridField_ActionMenu

Modify the list of columns displayed in the table.

GridField_ColumnProvider::augmentColumns() — Method in class GridField_ColumnProvider

Modify the list of columns displayed in the table.

$ GridField_FormAction#args — Property in class GridField_FormAction

$ GridField_FormAction#actionName — Property in class GridField_FormAction

GridState::array_to_object() — Method in class GridState

GridState::attrValue() — Method in class GridState

HTMLEditorSanitiser::addValidElements() — Method in class HTMLEditorSanitiser

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

HTMLEditorSanitiser::attributeMatchesRule() — Method in class HTMLEditorSanitiser

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

$ TinyMCECombinedGenerator#assetHandler — Property in class TinyMCECombinedGenerator

TinyMCEConfig::addButtonsToLine() — Method in class TinyMCEConfig

Add buttons to the end of a line

$ MoneyField#allowedCurrencies — Property in class MoneyField

Limit the currencies

$ PasswordField#autocomplete — Property in class PasswordField

Controls the autocomplete attribute on the field.

$ PasswordField#allowValuePostback — Property in class PasswordField

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

RequiredFields::addRequiredField() — Method in class RequiredFields

Adds a single required field to required fields stack.

RequiredFields::appendRequiredFields() — Method in class RequiredFields

Add RequiredField objects together

$ SegmentField#allowed_actions — Property in class SegmentField

AbstractSegmentFieldModifier — Class in namespace SilverStripe\Forms\SegmentFieldModifier

$ TreeDropdownField#allowed_actions — Property in class TreeDropdownField

$ SearchCriteria#adapter — Property in class SearchCriteria

SearchCriteria::appendPreparedStatementTo() — Method in class SearchCriteria

SearchCriteria::addAnd() — Method in class SearchCriteria

SearchCriteria::addOr() — Method in class SearchCriteria

SearchCriteria::addClause() — Method in class SearchCriteria

SearchCriteria::addConjunction() — 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#adapter — Property in class SearchCriterion

SearchCriterion::appendPreparedStatementTo() — Method in class SearchCriterion

$ FullTextSearch#all_indexes — Property in class FullTextSearch

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#added — Property 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

AbstractSearchQueryWriter — Class in namespace SilverStripe\FullTextSearch\Search\Queries

Class AbstractSearchQueryWriter

$ SearchQuery#adapter — Property in class SearchQuery

SearchQuery::addSearchTerm() — Method in class SearchQuery

SearchQuery::addFuzzySearchTerm() — Method in class SearchQuery

Similar to 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 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 addFilter().

SearchQuery::addCriteria() — Method in class SearchQuery

$ SearchIntrospection#ancestry — Property in class SearchIntrospection

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

SearchVariant::addFilterField() — Method in class SearchVariant

Add new filter field to index safely.

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

$ ContentControllerExtension#allowed_actions — Property in class ContentControllerExtension

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#analyzerFields — Property in class SolrIndex

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

SolrIndex::applySearchVariants() — Method in class SolrIndex

With a common set of variants that are relevant to at least one class in the list (from either the query or the current index), allow them to alter the query to add their variant column conditions.

$ CombinationsArrayIterator#arrays — Property in class CombinationsArrayIterator

$ MultipleArrayIterator#arrays — Property in class MultipleArrayIterator

$ MultipleArrayIterator#active — Property in class MultipleArrayIterator

$ Clear#allowed_actions — Property in class Clear

AuthenticatorInterface — Class in namespace SilverStripe\GraphQL\Auth

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

AuthenticatorInterface::authenticate() — Method in class AuthenticatorInterface

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

BasicAuthAuthenticator::authenticate() — Method in class BasicAuthAuthenticator

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

Configuration::apply() — Method in class Configuration

$ Controller#autobuildSchema — Property in class Controller

Controller::autobuildEnabled() — Method in class Controller

Controller::addCorsHeaders() — Method in class Controller

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

Controller::applyContext() — Method in class Controller

$ Build#allowed_actions — Property in class Build

$ DevelopmentAdmin#allowed_actions — Property in class DevelopmentAdmin

QueryRecorderExtension::augmentDataQueryCreation() — Method in class QueryRecorderExtension

Record query against a given class.

QueryHandler::addContextProvider() — Method in class QueryHandler

QueryHandler::addMiddleware() — Method in class QueryHandler

QueryHandlerInterface::addContextProvider() — Method in class QueryHandlerInterface

ApplyVersionFilters — Class 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

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

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

AbstractBulkLoader::applyConfig() — Method in class AbstractBulkLoader

BulkLoaderSet::applyConfig() — Method in class BulkLoaderSet

BulkLoaderSet::addLoader() — Method in class BulkLoaderSet

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

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

$ FieldAccessor#allowed_aggregates — Property in class FieldAccessor

FieldAccessor::accessField() — Method in class FieldAccessor

Resolves complex dot syntax references.

InheritanceUnionBuilder::applyUnionsToQueries() — Method in class InheritanceUnionBuilder

Changes all queries to use inheritance unions where applicable

InterfaceBuilder::applyBaseInterface() — Method in class InterfaceBuilder

InterfaceBuilder::applyInterfacesToQueries() — Method in class InterfaceBuilder

ModelCreator::appliesTo() — Method in class ModelCreator

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

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

AbstractCanViewPermission::apply() — Method in class AbstractCanViewPermission

DBDateArgs::applyToField() — Method in class DBDateArgs

DBDecimalArgs::applyToField() — Method in class DBDecimalArgs

DBFieldArgs::applyToField() — Method in class DBFieldArgs

DBFieldArgsPlugin::apply() — Method in class DBFieldArgsPlugin

DBFloatArgs::applyToField() — Method in class DBFloatArgs

DBHTMLTextArgs::applyToField() — Method in class DBHTMLTextArgs

DBTextArgs::applyToField() — Method in class DBTextArgs

DBTimeArgs::applyToField() — Method in class DBTimeArgs

DBFieldTypes::apply() — Method in class DBFieldTypes

FirstResult::apply() — Method in class FirstResult

Inheritance::apply() — Method in class Inheritance

InheritedPlugins::apply() — Method in class InheritedPlugins

FieldFilterInterface::apply() — Method in class FieldFilterInterface

FieldFilterRegistry::addFilter() — Method in class FieldFilterRegistry

FilterRegistryInterface::addFilter() — Method in class FilterRegistryInterface

ContainsFilter::apply() — Method in class ContainsFilter

EndsWithFilter::apply() — Method in class EndsWithFilter

EqualToFilter::apply() — Method in class EqualToFilter

GreaterThanFilter::apply() — Method in class GreaterThanFilter

GreaterThanOrEqualFilter::apply() — Method in class GreaterThanOrEqualFilter

InFilter::apply() — Method in class InFilter

LessThanFilter::apply() — Method in class LessThanFilter

LessThanOrEqualFilter::apply() — Method in class LessThanOrEqualFilter

NotEqualFilter::apply() — Method in class NotEqualFilter

StartsWithFilter::apply() — Method in class StartsWithFilter

QueryFilter::apply() — Method in class QueryFilter

QuerySort::apply() — Method in class QuerySort

ScalarDBField::apply() — Method in class ScalarDBField

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

An abstraction of a field argument

Argument::applyConfig() — Method in class Argument

Field::applyConfig() — Method in class Field

Field::addArg() — Method in class Field

Field::addResolverContext() — Method in class Field

Field::addResolverMiddleware() — Method in class Field

Field::addResolverAfterware() — Method in class Field

ModelField::applyConfig() — Method in class ModelField

ConfigurationApplier::applyConfig() — Method in class ConfigurationApplier

FieldPlugin::apply() — Method in class FieldPlugin

ModelFieldPlugin::apply() — Method in class ModelFieldPlugin

ModelMutationPlugin::apply() — Method in class ModelMutationPlugin

ModelQueryPlugin::apply() — Method in class ModelQueryPlugin

ModelTypePlugin::apply() — Method in class ModelTypePlugin

MutationPlugin::apply() — Method in class MutationPlugin

QueryPlugin::apply() — Method in class QueryPlugin

SchemaModelCreatorInterface::appliesTo() — Method in class SchemaModelCreatorInterface

TypePlugin::apply() — Method in class TypePlugin

Logger::alert() — Method in class Logger

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

Generic plugin that can be used for filter inputs

AbstractQueryFilterPlugin::apply() — Method in class AbstractQueryFilterPlugin

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

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

AbstractQuerySortPlugin::apply() — Method in class AbstractQuerySortPlugin

PaginationPlugin::apply() — Method in class PaginationPlugin

PluginConsumer::addPlugin() — Method in class PluginConsumer

SortPlugin::apply() — Method in class SortPlugin

EncodedResolver::addContext() — Method in class EncodedResolver

EncodedResolver::addMiddleware() — Method in class EncodedResolver

EncodedResolver::addAfterware() — Method in class EncodedResolver

Schema::applyConfig() — Method in class Schema

Converts a configuration array to instance state.

Schema::addQuery() — Method in class Schema

Schema::addMutation() — Method in class Schema

Schema::addType() — Method in class Schema

Schema::addEnum() — Method in class Schema

Schema::addScalar() — Method in class Schema

Schema::addModel() — Method in class Schema

Schema::addModelbyClassName() — Method in class Schema

Schema::addInterface() — Method in class Schema

Schema::addUnion() — Method in class Schema

Schema::applyBulkLoader() — Method in class Schema

Schema::applyBulkLoaders() — Method in class Schema

Schema::assertValidConfig() — Method in class Schema

Schema::assertValidName() — Method in class Schema

NestedInputBuilder::addInputTypesToSchema() — Method in class NestedInputBuilder

$ SchemaTranscriber#assetHandler — Property in class SchemaTranscriber

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

Enum::addValue() — Method in class Enum

InterfaceType::applyConfig() — Method in class InterfaceType

ModelType::applyConfig() — Method in class ModelType

ModelType::addField() — Method in class ModelType

ModelType::addFields() — Method in class ModelType

ModelType::addAllFields() — Method in class ModelType

ModelType::addAllOperations() — Method in class ModelType

ModelType::applyOperationsConfig() — Method in class ModelType

ModelType::addOperation() — Method in class ModelType

Scalar::applyConfig() — Method in class Scalar

Type::applyConfig() — Method in class Type

Type::addField() — Method in class Type

Type::addInterface() — Method in class Type

UnionType::applyConfig() — Method in class UnionType

$ LDAPAuthenticator#allow_email_login — Property in class LDAPAuthenticator

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

LDAPAuthenticator::authenticate() — Method in class LDAPAuthenticator

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

$ LDAPChangePasswordHandler#allowed_actions — Property in class LDAPChangePasswordHandler

$ LDAPLoginHandler#allowed_actions — Property in class LDAPLoginHandler

$ LDAPLostPasswordHandler#authenticatorClass — Property in class LDAPLostPasswordHandler

$ LDAPLostPasswordHandler#allowed_actions — Property in class LDAPLostPasswordHandler

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

$ LDAPDebugController#allowed_actions — Property in class LDAPDebugController

$ LDAPMemberExtension#allow_update_failure_during_login — Property in class LDAPMemberExtension

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

LDAPMemberExtension::afterMemberLoggedIn() — Method in class LDAPMemberExtension

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

$ LDAPLoginForm#authenticator_class — Property in class LDAPLoginForm

LDAPGateway::authenticate() — Method in class LDAPGateway

Authenticate the given username and password with LDAP.

LDAPGateway::add() — Method in class LDAPGateway

Add an LDAP object.

LDAPService::authenticate() — Method in class LDAPService

Authenticate the given username and password with LDAP.

LDAPService::addLDAPUserToGroup() — Method in class LDAPService

Add LDAP user by DN to LDAP group.

LDAPService::add() — Method in class LDAPService

A simple proxy to LDAP add operation.

EnablerExtension::afterCallActionHandler() — Method in class EnablerExtension

GridFieldSiteTreeState::augmentColumns() — Method in class GridFieldSiteTreeState

Modify the list of columns displayed in the table.

$ ChangePasswordHandler#allowed_actions — Property in class ChangePasswordHandler

$ LoginHandler#allowed_actions — Property in class LoginHandler

Method::applyRequirements() — Method in class Method

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

AdminRegistrationController — Class in namespace SilverStripe\MFA\Controller

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

$ AdminRegistrationController#allowed_actions — Property in class AdminRegistrationController

AuthenticationFailedException — Class in namespace SilverStripe\MFA\Exception

$ MemberExtension#AccountResetHash — Property in class MemberExtension

$ MemberExtension#AccountResetExpired — Property in class MemberExtension

$ SecurityAdminExtension#allowed_actions — Property in class SecurityAdminExtension

$ SecurityExtension#allowed_actions — Property in class SecurityExtension

MemberExtension::afterMemberLoggedIn() — Method in class MemberExtension

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

MethodInterface::applyRequirements() — Method in class MethodInterface

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

BaseHandlerTrait::applyRequirements() — Method in class BaseHandlerTrait

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

AvailableMethodDetails — Class in namespace SilverStripe\MFA\State

AvailableMethodDetailsInterface — Class in namespace SilverStripe\MFA\State

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

$ BackupCode#algorithm — Property in class BackupCode

SessionStore::addState() — Method in class SessionStore

Add to the state in the store

SessionStore::addVerifiedMethod() — Method in class SessionStore

Add and keep track of methods that have been verified

StoreInterface::addState() — Method in class StoreInterface

Add to the state in the store

StoreInterface::addVerifiedMethod() — Method in class StoreInterface

Add and keep track of methods that have been verified

ArrayLib — Class in namespace SilverStripe\ORM

Library of static methods for manipulating arrays.

ArrayLib::array_values_recursive() — Method in class ArrayLib

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

ArrayLib::array_map_recursive() — Method in class ArrayLib

Similar to array_map, but recurses when arrays are encountered.

ArrayLib::array_merge_recursive() — Method in class ArrayLib

Recursively merges two or more arrays.

ArrayList — Class in namespace SilverStripe\ORM

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

ArrayList::add() — Method in class ArrayList

Add this $item into this list

DBConnector::affectedRows() — Method in class DBConnector

Determines the number of affected rows from the last SQL query

DBSchemaManager::alterationMessage() — Method in class DBSchemaManager

Show a message about database alteration

DBSchemaManager::alterIndex() — Method in class DBSchemaManager

Alter an index on a table.

DBSchemaManager::alterTable() — Method in class DBSchemaManager

Alter a table's schema.

Database::affectedRows() — Method in class Database

Return the number of rows affected by the previous operation.

MySQLSchemaManager::alterTable() — Method in class MySQLSchemaManager

Alter a table's schema.

MySQLSchemaManager::alterField() — Method in class MySQLSchemaManager

Change the database type of the given field.

MySQLSchemaManager::alterIndex() — Method in class MySQLSchemaManager

Alter an index on a table.

MySQLiConnector::affectedRows() — Method in class MySQLiConnector

Determines the number of affected rows from the last SQL query

PDOConnector::affectedRows() — Method in class PDOConnector

Determines the number of affected rows from the last SQL query

$ DB#alternative_database_enabled — Property in class DB

Allow alternative DB to be disabled.

DB::affected_rows() — Method in class DB

Return the number of rows affected by the previous operation.

DB::alteration_message() — Method in class DB

Show a message about database alteration

DataExtension::augmentSQL() — Method in class DataExtension

Edit the given query object to support queries for this extension

DataExtension::augmentDatabase() — Method in class DataExtension

Update the database schema as required by this extension.

DataExtension::augmentWrite() — Method in class DataExtension

Augment a write-record request.

DataList::alterDataQuery() — Method in class DataList

Return a new DataList instance with the underlying DataQuery object altered

DataList::addFilter() — Method in class DataList

Return a new instance of the list with an added filter

DataList::applyRelation() — Method in class DataList

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

DataList::avg() — Method in class DataList

Return the average value of the given field in this DataList

DataList::addMany() — Method in class DataList

Add a number of items to the component set.

DataList::add() — Method in class DataList

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

$ DataObject#api_access — Property in class DataObject

Allow API access to this object?

DataObject::afterUpdateCMSFields() — Method in class DataObject

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

DataQuery::avg() — Method in class DataQuery

Return the average value of the given field in this DataList

DataQuery::aggregate() — Method in class DataQuery

Runs a raw aggregate expression. Please handle escaping yourself

DataQuery::applyRelationPrefix() — Method in class DataQuery

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

DataQuery::applyRelation() — Method in class DataQuery

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

DataQuery::addSelectFromTable() — Method in class DataQuery

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

DataQueryManipulator::afterGetFinalisedQuery() — Method in class DataQueryManipulator

Invoked after getFinalisedQuery()

$ DatabaseAdmin#allowed_actions — Property in class DatabaseAdmin

DBComposite::addToQuery() — Method in class DBComposite

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

DBDate::Ago() — Method in class DBDate

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

$ DBField#arrayValue — Property in class DBField

Used for generating DB schema. {DBSchemaManager}

DBField::addToQuery() — Method in class DBField

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

DBField::ATT() — Method in class DBField

Gets the value appropriate for a HTML attribute string

DBHTMLText::AbsoluteLinks() — Method in class DBHTMLText

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

$ DBPrimaryKey#autoIncrement — Property in class DBPrimaryKey

ComparisonFilter::applyOne() — Method in class ComparisonFilter

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

ExactMatchFilter::applyOne() — Method in class ExactMatchFilter

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

ExactMatchFilter::applyMany() — Method in class ExactMatchFilter

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

FulltextFilter::applyOne() — Method in class FulltextFilter

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

PartialMatchFilter::apply() — Method in class PartialMatchFilter

Apply filter criteria to a SQL query.

PartialMatchFilter::applyOne() — Method in class PartialMatchFilter

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

PartialMatchFilter::applyMany() — Method in class PartialMatchFilter

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

$ SearchFilter#aggregate — Property in class SearchFilter

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

SearchFilter::addRelation() — Method in class SearchFilter

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

SearchFilter::addAggregate() — Method in class SearchFilter

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

SearchFilter::applyAggregate() — Method in class SearchFilter

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

SearchFilter::apply() — Method in class SearchFilter

Apply filter criteria to a SQL query.

SearchFilter::applyOne() — Method in class SearchFilter

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

SearchFilter::applyMany() — Method in class SearchFilter

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

WithinRangeFilter::applyOne() — Method in class WithinRangeFilter

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

HasManyList::add() — Method in class HasManyList

Adds the item to this relation.

Hierarchy::AllChildren() — Method in class Hierarchy

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

Hierarchy::AllChildrenIncludingDeleted() — Method in class Hierarchy

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

Hierarchy::AllHistoricalChildren() — Method in class Hierarchy

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

ListDecorator::add() — Method in class ListDecorator

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

ManyManyList::appendExtraFieldsToQuery() — Method in class ManyManyList

Adds the many_many_extraFields to the select of the underlying DataQuery.

ManyManyList::add() — Method in class ManyManyList

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

ManyManyThroughList::add() — Method in class ManyManyThroughList

ManyManyThroughQueryManipulator::afterGetFinalisedQuery() — Method in class ManyManyThroughQueryManipulator

Invoked after getFinalisedQuery()

PolymorphicHasManyList::add() — Method in class PolymorphicHasManyList

Adds the item to this relation.

$ SQLAssignmentRow#assignments — Property in class SQLAssignmentRow

List of field values to store for this query

SQLAssignmentRow::addAssignments() — Method in class SQLAssignmentRow

Adds assignments for a list of several fields

SQLAssignmentRow::assign() — Method in class SQLAssignmentRow

Set the value for a single field

SQLAssignmentRow::assignSQL() — Method in class SQLAssignmentRow

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

SQLConditionalExpression::addFrom() — Method in class SQLConditionalExpression

Add a table to include in the query or update

SQLConditionalExpression::addLeftJoin() — Method in class SQLConditionalExpression

Add a LEFT JOIN criteria to the tables list.

SQLConditionalExpression::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#assignment — Property in class SQLUpdate

The assignment to create for this update

SQLUpdate::addAssignments() — Method in class SQLUpdate

Adds assignments for a list of several fields.

SQLUpdate::assign() — Method in class SQLUpdate

Set the value for a single field

SQLUpdate::assignSQL() — Method in class SQLUpdate

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

SQLWriteExpression::addAssignments() — Method in class SQLWriteExpression

Adds assignments for a list of several fields.

SQLWriteExpression::assign() — Method in class SQLWriteExpression

Set the value for a single field

SQLWriteExpression::assignSQL() — Method in class SQLWriteExpression

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

$ RelationList#addCallbacks — Property in class RelationList

RelationList::addCallbacks() — Method in class RelationList

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

SS_List::add() — Method in class SS_List

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

SearchContext::applyBaseTableFields() — Method in class SearchContext

SearchContext::addFilter() — Method in class SearchContext

Adds a instance of SearchFilter.

SearchContext::addField() — Method in class SearchContext

Adds a new FormField instance.

UnsavedRelationList::add() — Method in class UnsavedRelationList

Add an item to this relationship

UnsavedRelationList::addMany() — Method in class UnsavedRelationList

Add a number of items to the relation.

ValidationResult::addError() — Method in class ValidationResult

Record an error against this validation result,

ValidationResult::addFieldError() — Method in class ValidationResult

Record an error against this validation result,

ValidationResult::addMessage() — Method in class ValidationResult

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

ValidationResult::addFieldMessage() — Method in class ValidationResult

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

PostgreSQLConnector::affectedRows() — Method in class PostgreSQLConnector

Determines the number of affected rows from the last SQL query

$ PostgreSQLDatabase#allow_query_master_postgres — Property 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.

Authenticator — Class in namespace SilverStripe\RealMe

Class RealMeAuthenticator

Authenticator::authenticate() — Method in class Authenticator

Method to authenticate an user.

$ LoginForm#authenticator_class — Property in class LoginForm

$ LoginHandler#allowed_actions — Property in class LoginHandler

LoginHandler::acs() — Method in class LoginHandler

$ RealMeService#allowed_realme_environments — Property in class RealMeService

$ RealMeService#allowed_realme_integration_types — Property in class RealMeService

$ RealMeService#authn_contexts — Property in class RealMeService

$ RealMeService#allowed_authn_context_list — Property in class RealMeService

$ RegistryImportFeed#assetHandler — Property in class RegistryImportFeed

The class used to manipulate imported feed files on the filesystem

$ RegistryImportFeed#assetsDir — Property in class RegistryImportFeed

The "assets" folder name

$ RegistryImportFeedController#allowed_actions — Property in class RegistryImportFeedController

$ RegistryPageController#allowed_actions — Property in class RegistryPageController

RegistryPageController::AllQueryVars() — Method in class RegistryPageController

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

ReportWrapper::afterQuery() — Method in class ReportWrapper

Override this method to perform some actions after querying.

BasicRestfulAuthenticator::authenticate() — Method in class BasicRestfulAuthenticator

The authenticate function

$ JSONDataFormatter#api_base — Property in class JSONDataFormatter

$ XMLDataFormatter#api_base — Property in class XMLDataFormatter

$ RestfulServer#api_base — Property in class RestfulServer

$ RestfulServer#authenticator — Property in class RestfulServer

$ RestfulServer#allowed_actions — Property in class RestfulServer

RestfulServer::authenticate() — Method in class RestfulServer

A function to authenticate a user

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

SudoModeController::activate() — Method in class SudoModeController

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

SudoModeOnLoginExtension::afterLogin() — Method in class SudoModeOnLoginExtension

Activates sudo mode on a successful log in

SudoModeService::activate() — Method in class SudoModeService

SudoModeServiceInterface::activate() — Method in class SudoModeServiceInterface

AuthenticationHandler — Class in namespace SilverStripe\Security

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

AuthenticationHandler::authenticateRequest() — Method in class AuthenticationHandler

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

AuthenticationMiddleware — Class in namespace SilverStripe\Security

$ AuthenticationMiddleware#authenticationHandler — Property in class AuthenticationMiddleware

Authenticator — Class in namespace SilverStripe\Security

Abstract base class for an authentication method

Authenticator::authenticate() — Method in class Authenticator

Method to authenticate an user.

$ CMSSecurity#allowed_actions — Property in class CMSSecurity

$ Handler#allowed_actions — Property in class Handler

Group::AllChildrenIncludingDeleted() — Method in class Group

Returns all of the children for the CMS Tree.

$ LoginForm#authenticator_class — Property in class LoginForm

$ LoginForm#authenticatorClass — Property in class LoginForm

Authenticator class to use with this login form

$ Member#auto_login_token_lifetime — Property in class Member

Default lifetime of auto login token.

$ Member#AutoLoginHash — Property in class Member

$ Member#AutoLoginExpired — Property in class Member

Member::afterMemberLoggedIn() — Method in class Member

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

Member::afterMemberLoggedOut() — Method in class Member

Audit logging hook, called after a member is logged out

Member::actAs() — Method in class Member

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

Member::addToGroupByCode() — Method in class Member

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

$ CMSLoginHandler#allowed_actions — Property in class CMSLoginHandler

CMSMemberAuthenticator::authenticateMember() — Method in class CMSMemberAuthenticator

$ ChangePasswordHandler#authenticator — Property in class ChangePasswordHandler

$ ChangePasswordHandler#allowed_actions — Property in class ChangePasswordHandler

CookieAuthenticationHandler::authenticateRequest() — Method in class CookieAuthenticationHandler

$ LoginHandler#authenticator — Property in class LoginHandler

$ LoginHandler#allowed_actions — Property in class LoginHandler

$ LogoutHandler#allowed_actions — Property in class LogoutHandler

$ LostPasswordHandler#authenticatorClass — Property in class LostPasswordHandler

Authentication class to use

$ LostPasswordHandler#allowed_actions — Property in class LostPasswordHandler

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

MemberAuthenticator::authenticate() — Method in class MemberAuthenticator

Method to authenticate an user.

MemberAuthenticator::authenticateMember() — Method in class MemberAuthenticator

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

SessionAuthenticationHandler::authenticateRequest() — Method in class SessionAuthenticationHandler

Member_GroupSet::add() — Method in class Member_GroupSet

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

NullSecurityToken::addToUrl() — Method in class NullSecurityToken

$ PasswordEncryptor_PHPHash#algorithm — Property in class PasswordEncryptor_PHPHash

PasswordExpirationMiddleware::absoluteUrl() — Method in class PasswordExpirationMiddleware

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

PasswordExpirationMiddleware::allowCurrentRequest() — Method in class PasswordExpirationMiddleware

Allow the current request to be finished without password expiration check

$ Permission#admin_implies_all — Property in class Permission

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

RequestAuthenticationHandler::authenticateRequest() — Method in class RequestAuthenticationHandler

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

$ Security#allowed_actions — Property in class Security

$ Security#autologin_enabled — Property in class Security

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

Security::aggregateTabbedForms() — Method in class Security

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

Security::aggregateAuthenticatorResponses() — Method in class Security

We have three possible scenarios.

SecurityToken::addToUrl() — Method in class SecurityToken

$ LoginSessionController#allowed_actions — Property in class LoginSessionController

LogInAuthenticationHandler::authenticateRequest() — Method in class LogInAuthenticationHandler

LogOutAuthenticationHandler::authenticateRequest() — Method in class LogOutAuthenticationHandler

$ ShareDraftController#allowed_actions — Property in class ShareDraftController

$ ShareDraftContentControllerExtension#allowed_actions — Property in class ShareDraftContentControllerExtension

$ ShareDraftContentSiteTreeExtension#allowed_actions — Property in class ShareDraftContentSiteTreeExtension

CommentSpamProtection::alterCommentForm() — Method in class CommentSpamProtection

SpellController::assembleData() — Method in class SpellController

Assemble an output data structure that is expected for TinyMCE 4

$ Publisher#add_timestamp — Property in class Publisher

UrlBundleInterface::addUrls() — Method in class UrlBundleInterface

Add URLs to this bundle

UrlBundleService::addUrls() — Method in class UrlBundleService

UrlBundleService::assignPriorityToUrls() — Method in class UrlBundleService

Add priority data to URLs

FileSubsites::alternateTreeTitle() — Method in class FileSubsites

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

FileSubsites::augmentSQL() — Method in class FileSubsites

Update any requests to limit the results to the current site

GroupSubsites::augmentSQL() — Method in class GroupSubsites

Update any requests to limit the results to the current site

GroupSubsites::alternateCanEdit() — Method in class GroupSubsites

$ LeftAndMainSubsites#allowed_actions — Property in class LeftAndMainSubsites

LeftAndMainSubsites::alternateMenuDisplayCheck() — Method in class LeftAndMainSubsites

LeftAndMainSubsites::alternateAccessCheck() — Method in class LeftAndMainSubsites

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

LeftAndMainSubsites::augmentNewSiteTreeItem() — Method in class LeftAndMainSubsites

SiteConfigSubsites::augmentSQL() — Method in class SiteConfigSubsites

Update any requests to limit the results to the current site

SiteTreeSubsites::augmentSQL() — Method in class SiteTreeSubsites

Update any requests to limit the results to the current site

SiteTreeSubsites::alternateSiteConfig() — Method in class SiteTreeSubsites

SiteTreeSubsites::alternateAbsoluteLink() — Method in class SiteTreeSubsites

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

$ GridFieldSubsiteDetailFormItemRequest#allowed_actions — Property in class GridFieldSubsiteDetailFormItemRequest

$ SubsitesTreeDropdownField#allowed_actions — Property in class SubsitesTreeDropdownField

$ InitStateMiddleware#admin_url_paths — Property in class InitStateMiddleware

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

$ Subsite#allowed_themes — Property in class Subsite

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

Subsite::all_sites() — Method in class Subsite

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

Subsite::all_accessible_sites() — Method in class Subsite

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

$ StringTagField#allowed_actions — Property in class StringTagField

$ TagField#allowed_actions — Property in class TagField

$ TaxonomyDirectoryController#allowed_actions — Property in class TaxonomyDirectoryController

$ UserDefinedFormAdmin#allowed_actions — Property in class UserDefinedFormAdmin

$ UserDefinedFormController#allowed_actions — Property in class UserDefinedFormController

UserDefinedFormController::addUserFormsValidatei18n() — Method in class UserDefinedFormController

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

$ EditableFormField#abstract — Property in class EditableFormField

Define this field as abstract (not inherited)

$ EditableFormField#allowed_css — Property in class EditableFormField

A list of CSS classes that can be added

$ EditableFileField#allowed_extensions_blacklist — Property in class EditableFileField

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

$ EditableMultipleOptionField#abstract — Property in class EditableMultipleOptionField

Define this field as abstract (not inherited)

$ EditableOption#allow_empty_values — Property in class EditableOption

EditableOption::allow_empty_values() — Method in class EditableOption

Returns whether to allow empty values or not.

$ EditableTextField#autocomplete_options — Property in class EditableTextField

$ EditableTextField#Autocomplete — Property in class EditableTextField

$ EmailRecipient#allow_unbound_recipient_fields — Property in class EmailRecipient

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

$ UserFormRecipientItemRequest#allowed_actions — Property in class UserFormRecipientItemRequest

$ VersionFeed#allchanges_enabled — Property in class VersionFeed

Enable the allchanges feed

$ VersionFeed#allchanges_limit — Property in class VersionFeed

Allchanges feed limit of items.

$ VersionFeedController#allowed_actions — Property in class VersionFeedController

VersionFeedController::allchanges() — Method in class VersionFeedController

Get all changes from the site in a RSS feed.

ArchiveAdmin — Class in namespace SilverStripe\VersionedAdmin

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

$ HistoryViewerController#allowed_actions — Property in class HistoryViewerController

ArchiveRestoreAction — Class in namespace SilverStripe\VersionedAdmin\Extensions

Adds a restore action to the item edit form of ArchiveAdmin

ArchiveViewProvider — Class in namespace SilverStripe\VersionedAdmin\Interfaces

A provider of a view for the archive admin

ChangeSet::addObject() — Method in class ChangeSet

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

$ ChangeSetItem#Added — Property in class ChangeSetItem

DeleteExtension::augmentMutation() — Method in class DeleteExtension

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

Scaffolds a generic update operation for DataObjects.

UnpublishOnDelete::apply() — Method in class UnpublishOnDelete

VersionedDataObject::apply() — Method in class VersionedDataObject

VersionedRead::apply() — Method in class VersionedRead

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

Reading a specific stage (Stage or Live)

Versioned::augmentSQLStageUnique() — Method in class Versioned

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

Versioned::augmentSQLVersioned() — Method in class Versioned

Augment SQL to select from _Versions table instead.

Versioned::augmentSQLVersionedArchive() — Method in class Versioned

Filter the versioned history by a specific date and archive stage

Versioned::augmentSQLVersionedLatestSingle() — Method in class Versioned

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

Versioned::augmentSQLVersionedLatest() — Method in class Versioned

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

Versioned::augmentSQLVersionedVersion() — Method in class Versioned

If selecting a specific version, filter it here

Versioned::augmentSQLVersionedAll() — Method in class Versioned

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

Versioned::augmentLoadLazyFields() — Method in class Versioned

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

Versioned::augmentDatabase() — Method in class Versioned

Update the database schema as required by this extension.

Versioned::augmentWriteVersioned() — Method in class Versioned

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

Versioned::augmentWriteStaged() — Method in class Versioned

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

Versioned::augmentWrite() — Method in class Versioned

Augment a write-record request.

Versioned::allVersions() — Method in class Versioned

Return a list of all the versions available.

Versioned::Author() — Method in class Versioned

Get author of this record.

VersionedGridFieldItemRequest::addVersionedButtons() — Method in class VersionedGridFieldItemRequest

Getting buttons that are for versioned objects

VersionedGridFieldItemRequest::addUnversionedButtons() — Method in class VersionedGridFieldItemRequest

Getting buttons that are for unversioned objects

VersionedGridFieldState::augmentColumns() — Method in class VersionedGridFieldState

Modify the list of columns displayed in the table.

Versioned_Version::Author() — Method in class Versioned_Version

Author of this DataObject

ArrayData — Class in namespace SilverStripe\View

Lets you wrap a bunch of array data, or object members, into a ViewableData object.

$ ArrayData#array — Property in class ArrayData

ArrayData::array_to_object() — Method in class ArrayData

Converts an associative array to a simple object

AttributesHTML — Class in namespace SilverStripe\View

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

$ AttributesHTML#attributes — Property in class AttributesHTML

List of attributes to render on the frontend

SQLFormatter::addNewlines() — Method in class SQLFormatter

Newlines for tokens defined in $newline_before_tokens.

$ ShortcodeParser#active_instance — Property in class ShortcodeParser

$ ShortcodeParser#attrrx — Property in class ShortcodeParser

ShortcodeParser::attrrx() — Method in class ShortcodeParser

$ URLSegmentFilter#allowMultibyte — Property in class URLSegmentFilter

Requirements::add_i18n_javascript() — Method in class Requirements

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

$ Requirements_Backend#assetHandler — Property in class Requirements_Backend

Requirements_Backend::add_i18n_javascript() — Method in class Requirements_Backend

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

SSTemplateParser::addClosedBlock() — Method in class SSTemplateParser

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

SSTemplateParser::addOpenBlock() — Method in class SSTemplateParser

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

SSTemplateParser::Argument_DollarMarkedLookup() — Method in class SSTemplateParser

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

SSTemplateParser::Argument_QuotedString() — Method in class SSTemplateParser

SSTemplateParser::Argument_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_whitelist — Property 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'

CredentialRepository::assertCredentialID() — Method in class CredentialRepository

Assert that the given credential ID matches a stored credential

Method::applyRequirements() — Method in class Method

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

$ RegisterHandler#authenticator_attachment — Property in class RegisterHandler

The default attachment mode to use for Authentication Selection Criteria.

$ WidgetContentControllerExtension#allowed_actions — Property in class WidgetContentControllerExtension

WidgetAreaEditor::AvailableWidgets() — Method in class WidgetAreaEditor

$ WidgetController#allowed_actions — Property in class WidgetController

AssignUsersToWorkflowAction — Class in namespace Symbiote\AdvancedWorkflow\Actions

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

AdvancedWorkflowAdmin — Class in namespace Symbiote\AdvancedWorkflow\Admin

$ AdvancedWorkflowAdmin#allowed_actions — Property in class AdvancedWorkflowAdmin

AdvancedWorkflowActionController — Class in namespace Symbiote\AdvancedWorkflow\Controllers

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

WorkflowActionInstance::actionStart() — Method in class WorkflowActionInstance

Called when this instance is started within the workflow

WorkflowActionInstance::actionComplete() — Method in class WorkflowActionInstance

Called when this action has been completed within the workflow

WorkflowTransition::Action() — Method in class WorkflowTransition

AdvancedWorkflowExtension — Class in namespace Symbiote\AdvancedWorkflow\Extensions

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

$ AdvancedWorkflowExtension#allowed_actions — Property in class AdvancedWorkflowExtension

WorkflowApplicable::AbsoluteEditLink() — Method in class WorkflowApplicable

Included in CMS-generated email templates for a NotifyUsersWorkflowAction.

$ WorkflowField#allowed_actions — Property in class WorkflowField

WorkflowField::action() — Method in class WorkflowField

WorkflowField::ActionLink() — Method in class WorkflowField

$ WorkflowFieldActionController#allowed_actions — Property in class WorkflowFieldActionController

$ WorkflowFieldItemController#allowed_actions — Property in class WorkflowFieldItemController

$ WorkflowFieldTransitionController#allowed_actions — Property in class WorkflowFieldTransitionController

AWRequiredFields — Class in namespace Symbiote\AdvancedWorkflow\Forms

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

GridFieldExportAction::augmentColumns() — Method in class GridFieldExportAction

Add a column 'Delete'

GridFieldWorkflowRestrictedEditButton::augmentColumns() — Method in class GridFieldWorkflowRestrictedEditButton

Add a column

WorkflowTemplate::addManyManyToObject() — Method in class WorkflowTemplate

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

$ GridFieldAddExistingSearchButton#allowed_actions — Property in class GridFieldAddExistingSearchButton

$ GridFieldAddExistingSearchHandler#allowed_actions — Property in class GridFieldAddExistingSearchHandler

GridFieldAddExistingSearchHandler::add() — Method in class GridFieldAddExistingSearchHandler

$ GridFieldAddNewMultiClass#allowed_actions — Property in class GridFieldAddNewMultiClass

$ GridFieldEditableColumns#allowed_actions — Property in class GridFieldEditableColumns

GridFieldExternalLink::augmentColumns() — Method in class GridFieldExternalLink

Add a column for the actions

$ GridFieldOrderableRows#allowed_actions — Property in class GridFieldOrderableRows

GridFieldOrderableRows::augmentColumns() — Method in class GridFieldOrderableRows

Modify the list of columns displayed in the table.

$ GridFieldRequestHandler#allowed_actions — Property in class GridFieldRequestHandler

$ QueuedJobsAdmin#allowed_actions — Property in class QueuedJobsAdmin

$ QueuedTaskRunner#allowed_actions — Property in class QueuedTaskRunner

QueuedJobDescriptor::activateOnQueue() — Method in class QueuedJobDescriptor

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

$ GridFieldQueuedJobExecute#action — Property in class GridFieldQueuedJobExecute

GridFieldQueuedJobExecute::augmentColumns() — Method in class GridFieldQueuedJobExecute

Add a column 'Delete'

QJUtils::ajaxResponse() — Method in class QJUtils

AbstractQueuedJob — Class in namespace Symbiote\QueuedJobs\Services

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

AbstractQueuedJob::afterComplete() — Method in class AbstractQueuedJob

Called when the job is determined to be 'complete'

AbstractQueuedJob::addMessage() — Method in class AbstractQueuedJob

QueuedJob::addMessage() — Method in class QueuedJob

Add an arbitrary text message into a job

FluentBadgeExtension::addFluentBadge() — Method in class FluentBadgeExtension

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

FluentExtension::anyMatch() — Method in class FluentExtension

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

FluentExtension::augmentDatabase() — Method in class FluentExtension

Update the database schema as required by this extension.

FluentExtension::augmentDatabaseDontRequire() — Method in class FluentExtension

FluentExtension::augmentDatabaseRequireTable() — Method in class FluentExtension

Require the given localisation table

FluentExtension::augmentSQL() — Method in class FluentExtension

Edit the given query object to support queries for this extension

FluentExtension::augmentWrite() — Method in class FluentExtension

Augment a write-record request.

FluentExtension::augmentDataQueryCreation() — Method in class FluentExtension

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

FluentFilteredExtension::augmentSQL() — Method in class FluentFilteredExtension

FluentSiteTreeExtension::addLocaleStatusMessage() — Method in class FluentSiteTreeExtension

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

FluentSiteTreeExtension::addLocalePrefixToUrlSegment() — Method in class FluentSiteTreeExtension

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

FluentVersionedExtension::augmentDatabaseDontRequire() — Method in class FluentVersionedExtension

FluentVersionedExtension::augmentDatabaseRequireTable() — Method in class FluentVersionedExtension

Require the given localisation table

FluentVersionedExtension::augmentSQL() — Method in class FluentVersionedExtension

Edit the given query object to support queries for this extension

FluentVersionedExtension::addLocaleFallbackChain() — Method in class FluentVersionedExtension

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

FluentVersionedExtension::augmentWrite() — Method in class FluentVersionedExtension

Apply versioning to write

$ InitStateMiddleware#admin_url_paths — Property 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

$ GridFieldSortableRows#append_to_top — Property in class GridFieldSortableRows

B

$ Package#badges — Property in class Package

$ ComposerLoader#basePath — Property in class ComposerLoader

ComposerLoader::build() — Method in class ComposerLoader

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

CwpSiteTreeFileExtension::BackLinkHTMLList() — Method in class CwpSiteTreeFileExtension

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

$ TaxonomyTermExtension#belongs_many_many — Property in class TaxonomyTermExtension

BaseHomePage — Class in namespace CWP\CWP\PageTypes

BaseHomePage is the basic home page.

BaseHomePageController — Class in namespace CWP\CWP\PageTypes

BasePage — Class 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.

$ BasePage#belongs_many_many — Property in class BasePage

BasePageController — Class in namespace CWP\CWP\PageTypes

$ PdfExportExtension#bypass_pdf_binary_check — Property in class PdfExportExtension

Used to bypass the check to see if the wkhtmltopdf binary is avilable Only used for unit testing

$ ArchiveHandler#buttonClasses — Property in class ArchiveHandler

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

$ DeleteHandler#buttonClasses — Property in class DeleteHandler

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

$ EditHandler#buttonClasses — Property in class EditHandler

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

EditHandler::bulkEditForm() — Method in class EditHandler

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

EditHandler::Breadcrumbs() — Method in class EditHandler

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

$ Handler#buttonClasses — Property in class Handler

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

$ PublishHandler#buttonClasses — Property in class PublishHandler

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

$ UnPublishHandler#buttonClasses — Property in class UnPublishHandler

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

$ UnlinkHandler#buttonClasses — Property in class UnlinkHandler

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

BulkManager — Class in namespace Colymba\BulkManager

GridField component for editing attached models in bulk.

BulkUploadField — Class in namespace Colymba\BulkUpload

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

BulkUploadHandler — Class in namespace Colymba\BulkUpload

Handles request from the GridFieldBulkUpload component.

BulkUploader — Class in namespace Colymba\BulkUpload

GridField component for uploading images in bulk.

BulkUploader::bulkUploadField() — Method in class BulkUploader

Returned a configured UploadField instance embedded in the gridfield heard.

BaseElement — Class in namespace DNADesign\Elemental\Models

Class BaseElement

ElementalArea::Breadcrumbs() — Method in class ElementalArea

Necessary to display results in CMS site search.

$ DebugBar#bufferingEnabled — Property in class DebugBar

ControllerExtension::beforeCallActionHandler() — Method in class ControllerExtension

DebugBarMiddleware::beforeRequest() — Method in class DebugBarMiddleware

Track the start up of the framework boot

CMSBatchAction::batchaction() — Method in class CMSBatchAction

Helper method for processing batch actions.

$ CMSBatchActionHandler#batch_actions — Property in class CMSBatchActionHandler

CMSBatchActionHandler::batchActionList() — Method in class CMSBatchActionHandler

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

Link
Title

CMSBatchActionHandler::buildAction() — Method in class CMSBatchActionHandler

Safely generate batch action object for a given classname

CMSBatchActionHandler::batchActions() — Method in class CMSBatchActionHandler

Get all registered actions through the static defaults set by register().

CMSProfileController::Breadcrumbs() — Method in class CMSProfileController

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

LeftAndMain::Breadcrumbs() — Method in class LeftAndMain

LeftAndMain::batchactions() — Method in class LeftAndMain

Batch Actions Handler

LeftAndMain::BatchActionsForm() — Method in class LeftAndMain

LeftAndMain::BaseCSSClasses() — Method in class LeftAndMain

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

ModelAdmin::Breadcrumbs() — Method in class ModelAdmin

SecurityAdmin::Backlink() — Method in class SecurityAdmin

Disable GridFieldDetailForm backlinks for this view, as its

SecurityAdmin::Breadcrumbs() — Method in class SecurityAdmin

$ AkismetSpamProtector#bypass_permission — Property in class AkismetSpamProtector

Permission required to bypass check

$ AkismetSpamProtector#bypass_members — Property in class AkismetSpamProtector

Set to try to bypass check for all logged in users

$ AssetAdmin#bust_cache — Property in class AssetAdmin

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

AssetAdmin::breadcrumbs() — Method in class AssetAdmin

AssetAdmin::baseCSSClasses() — Method in class AssetAdmin

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

AssetFormFactory::buildFileStatusIcon() — Method in class AssetFormFactory

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

$ TestAssetStore#basedir — Property in class TestAssetStore

Base dir of current file

TestAssetStore::base_path() — Method in class TestAssetStore

Get absolute path to basedir

File::BackLinkTracking() — Method in class File

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

File::BackLinkTrackingCount() — Method in class File

Count of backlinks Note: Doesn't filter broken records

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.

BasicContext — Class in namespace SilverStripe\BehatExtension\Context

BasicContext

EmailContext::before() — Method in class EmailContext

FixtureContext::beforeDatabaseDefaults() — Method in class FixtureContext

SilverStripeContext::before() — Method in class SilverStripeContext

ModuleInitialisationController::baseExecute() — Method in class ModuleInitialisationController

BlogAdminSidebar — Class in namespace SilverStripe\Blog\Forms

$ GridFieldAddByDBField#buttonName — Property in class GridFieldAddByDBField

Name for the buttons displayed in the CMS

Blog — Class in namespace SilverStripe\Blog\Model

Blog Holder

BlogCategory — Class in namespace SilverStripe\Blog\Model

A blog category for generalising blog posts.

$ BlogCategory#belongs_many_many — Property in class BlogCategory

$ BlogCategory#BlogID — Property in class BlogCategory

BlogCategory::Blog() — Method in class BlogCategory

BlogCommentExtension — Class in namespace SilverStripe\Blog\Model

Adds Blog specific behaviour to Comment.

BlogController — Class in namespace SilverStripe\Blog\Model

$ BlogController#blogPosts — Property in class BlogController

The current Blog Post DataList query.

BlogFilter — Class in namespace SilverStripe\Blog\Model

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

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

Enables children of non-editable pages to be edited.

BlogMemberExtension — Class in namespace SilverStripe\Blog\Model

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

$ BlogMemberExtension#belongs_many_many — Property in class BlogMemberExtension

BlogObject — Class in namespace SilverStripe\Blog\Model

An object shared by BlogTag and BlogCategory.

BlogObject::BlogPosts() — Method in class BlogObject

BlogPost — Class in namespace SilverStripe\Blog\Model

An individual blog post.

BlogPostController — Class in namespace SilverStripe\Blog\Model

BlogPostFeaturedExtension — Class in namespace SilverStripe\Blog\Model

Adds a checkbox field for featured blog posts widget.

BlogPostFilter — Class in namespace SilverStripe\Blog\Model

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

BlogPostNotifications — Class in namespace SilverStripe\Blog\Model

Customise blog post to support comment notifications.

BlogTag — Class in namespace SilverStripe\Blog\Model

A blog tag for keyword descriptions of a blog post.

$ BlogTag#belongs_many_many — Property in class BlogTag

$ BlogTag#BlogID — Property in class BlogTag

BlogTag::Blog() — Method in class BlogTag

CategorisationObject::BlogPosts() — Method in class CategorisationObject

BlogArchiveWidget — Class in namespace SilverStripe\Blog\Widgets

BlogArchiveWidget::Blog() — Method in class BlogArchiveWidget

BlogArchiveWidgetController — Class in namespace SilverStripe\Blog\Widgets

BlogCategoriesWidget — Class in namespace SilverStripe\Blog\Widgets

BlogCategoriesWidget::Blog() — Method in class BlogCategoriesWidget

BlogCategoriesWidgetController — Class in namespace SilverStripe\Blog\Widgets

BlogFeaturedPostsWidget — Class in namespace SilverStripe\Blog\Widgets

BlogFeaturedPostsWidget::Blog() — Method in class BlogFeaturedPostsWidget

BlogRecentPostsWidget — Class in namespace SilverStripe\Blog\Widgets

BlogRecentPostsWidget::Blog() — Method in class BlogRecentPostsWidget

BlogRecentPostsWidgetController — Class in namespace SilverStripe\Blog\Widgets

BlogTagsCloudWidget — Class in namespace SilverStripe\Blog\Widgets

BlogTagsCloudWidget::Blog() — Method in class BlogTagsCloudWidget

BlogTagsCloudWidgetController — Class in namespace SilverStripe\Blog\Widgets

BlogTagsWidget — Class in namespace SilverStripe\Blog\Widgets

BlogTagsWidget::Blog() — Method in class BlogTagsWidget

BlogTagsWidgetController — Class in namespace SilverStripe\Blog\Widgets

CMSMain::Breadcrumbs() — Method in class CMSMain

CMSMain::batchactions() — Method in class CMSMain

Batch Actions Handler

CMSMain::BatchActionParameters() — Method in class CMSMain

Returns a LiteralField containing parameter field HTML for batch actions

CMSMain::BatchActionList() — Method in class CMSMain

Returns a list of batch actions

CMSPagesController::Breadcrumbs() — Method in class CMSPagesController

ModelAsController::beforeHandleRequest() — Method in class ModelAsController

A bootstrap for the handleRequest method

RootURLController::beforeHandleRequest() — Method in class RootURLController

A bootstrap for the handleRequest method

$ SiteTree#base_plural_name — Property in class SiteTree

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

$ SiteTree#base_singular_name — Property in class SiteTree

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

$ SiteTree#base_description — Property in class SiteTree

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

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

BrokenFilesReport — Class in namespace SilverStripe\CMS\Reports

BrokenLinksReport — Class in namespace SilverStripe\CMS\Reports

Content side-report listing pages with broken links

BrokenRedirectorPagesReport — Class in namespace SilverStripe\CMS\Reports

BrokenVirtualPagesReport — Class in namespace SilverStripe\CMS\Reports

$ ApproveHandler#buttonClasses — Property in class ApproveHandler

$ SpamHandler#buttonClasses — Property in class SpamHandler

$ Comment#BaseClass — Property in class Comment

$ CachedConfigCollection#building — Property in class CachedConfigCollection

Set to true while building config.

$ YamlTransformer#baseDirectory — Property in class YamlTransformer

Base directory used to find yaml files.

$ SiteTreeContentReview#belongs_many_many — Property in class SiteTreeContentReview

$ Controller#basicAuthEnabled — Property in class Controller

$ Controller#baseInitCalled — Property in class Controller

Controller::beforeHandleRequest() — Method in class Controller

A bootstrap for the handleRequest method

Director::baseURL() — Method in class Director

Return the root-relative url for the baseurl

Director::baseFolder() — Method in class Director

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

$ Email#bcc_all_emails_to — Property in class Email

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

$ HTTPRequest#body — Property in class HTTPRequest

Raw HTTP body, used by PUT and POST requests.

$ HTTPResponse#body — Property in class HTTPResponse

$ ConfirmationMiddleware#bypasses — Property in class ConfirmationMiddleware

The list of bypasses

ConfirmationMiddleware::buildConfirmationRedirect() — Method in class ConfirmationMiddleware

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

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

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

GetParameter::buildConfirmationItem() — Method in class GetParameter

Generates the confirmation item

Url::buildConfirmationItem() — Method in class Url

Generates the confirmation item

UrlPathStartswith::buildConfirmationItem() — Method in class UrlPathStartswith

Generates the confirmation item

URLSpecialsMiddleware::buildImpactRedirect() — Method in class URLSpecialsMiddleware

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

$ RequestHandler#brokenOnConstruct — Property in class RequestHandler

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

BaseKernel — Class in namespace SilverStripe\Core

Simple Kernel container

$ BaseKernel#basePath — Property in class BaseKernel

BaseKernel::bootPHP() — Method in class BaseKernel

Initialise PHP with default variables

BaseKernel::bootManifests() — Method in class BaseKernel

Boot all manifests

BaseKernel::bootConfigs() — Method in class BaseKernel

Include all _config.php files

BaseKernel::bootErrorHandling() — Method in class BaseKernel

Turn on error handling

BaseKernel::boot() — Method in class BaseKernel

BaseKernel::buildManifestCacheFactory() — Method in class BaseKernel

ClassInfo::baseDataClass() — Method in class ClassInfo

CoreConfigFactory::buildYamlTransformer() — Method in class CoreConfigFactory

CoreConfigFactory::buildStaticTransformer() — Method in class CoreConfigFactory

CoreConfigFactory::buildYamlTransformerForPath() — Method in class CoreConfigFactory

Convert::base64url_encode() — Method in class Convert

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

Convert::base64url_decode() — Method in class Convert

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

Convert::bytes2memstring() — Method in class Convert

CoreKernel::boot() — Method in class CoreKernel

CoreKernel::bootDatabaseGlobals() — Method in class CoreKernel

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

CoreKernel::bootDatabaseEnvVars() — Method in class CoreKernel

Load default database configuration from environment variable

$ CustomMethods#built_in_methods — Property in class CustomMethods

Non-custom methods

$ Extensible#beforeExtendCallbacks — Property in class Extensible

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

Extensible::beforeExtending() — Method in class Extensible

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

$ AopProxyService#beforeCall — Property in class AopProxyService

BeforeCallAspect — Class in namespace SilverStripe\Core\Injector

A BeforeCallAspect is run before a method is executed.

BeforeCallAspect::beforeCall() — Method in class BeforeCallAspect

Call this aspect before a method is executed

Kernel::boot() — Method in class Kernel

$ ClassManifest#base — Property in class ClassManifest

base manifest directory

ClassManifestVisitor::beforeTraverse() — Method in class ClassManifestVisitor

$ Module#basePath — Property in class Module

Base folder of application with no trailing slash

$ ModuleManifest#base — Property in class ModuleManifest

The base path used when building the manifest

Backtrace — Class in namespace SilverStripe\Dev

Backtrace helper

Backtrace::backtrace() — Method in class Backtrace

Render or return a backtrace from the given scope.

BehatFixtureFactory — Class in namespace SilverStripe\Dev

BuildTask — Class in namespace SilverStripe\Dev

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

BulkLoader — Class in namespace SilverStripe\Dev

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

BulkLoader_Result — Class in namespace SilverStripe\Dev

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

DebugView::Breadcrumbs() — Method in class DebugView

Generate breadcrumb links to the URL path being displayed

DevBuildController::build() — Method in class DevBuildController

DevelopmentAdmin::buildDefaults() — Method in class DevelopmentAdmin

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

$ FixtureFactory#blueprints — Property in class FixtureFactory

SapphireInfo::BaseURL() — Method in class SapphireInfo

$ SapphireTest#backupGlobals — Property in class SapphireTest

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

TestKernel::bootPHP() — Method in class TestKernel

Initialise PHP with default variables

TestKernel::bootErrorHandling() — Method in class TestKernel

Turn on error handling

BannerBlock — Class in namespace SilverStripe\ElementalBannerBlock\Block

BlockLinkField — Class in namespace SilverStripe\ElementalBannerBlock\Form

BlockLinkField_Readonly — Class in namespace SilverStripe\ElementalBannerBlock\Form

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

BrokenExternalLink — Class in namespace SilverStripe\ExternalLinks\Model

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

BrokenExternalPageTrack — Class in namespace SilverStripe\ExternalLinks\Model

Represents a track for a single page

BrokenExternalPageTrackStatus — Class in namespace SilverStripe\ExternalLinks\Model

Represents the status of a track run

BrokenExternalPageTrackStatus::BrokenLinks() — Method in class BrokenExternalPageTrackStatus

BrokenExternalLinksReport — Class in namespace SilverStripe\ExternalLinks\Reports

Content side-report listing pages with external broken links

$ CurlLinkChecker#bypass_cache — Property in class CurlLinkChecker

If we want to bypass the cache Set via YAML file

Form::buildRequestHandler() — Method in class Form

Scaffold new request handler for this form

$ FormAction#buttonContent — Property in class FormAction

Literal button content, used when useButtonTag is true.

$ FormMessageBootstrapExtension#bootstrapAlertsMap — Property in class FormMessageBootstrapExtension

$ FormRequestHandler#buttonClickedFunc — Property in class FormRequestHandler

FormRequestHandler::buttonClicked() — Method in class FormRequestHandler

Get instance of button which was clicked for this request

GridField::buildColumnDispatch() — Method in class GridField

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

$ GridFieldAddNewButton#buttonName — Property in class GridFieldAddNewButton

GridFieldDetailForm_ItemRequest::Breadcrumbs() — Method in class GridFieldDetailForm_ItemRequest

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

$ TinyMCEConfig#base_dir — Property in class TinyMCEConfig

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

plugins
themes
skins

$ TinyMCEConfig#buttons — Property in class TinyMCEConfig

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

MoneyField::buildCurrencyField() — Method in class MoneyField

Builds a new currency field based on the allowed currencies configured

$ PopoverField#buttonTooltip — Property in class PopoverField

Tooltip to put on button

$ TreeDropdownField#baseID — Property in class TreeDropdownField

Filter for base record

SearchIndex::buildDependancyList() — Method in class SearchIndex

$ SearchUpdateBatchedProcessor#batches — Property in class SearchUpdateBatchedProcessor

List of batches to be processed

$ SearchUpdateBatchedProcessor#batch_size — Property in class SearchUpdateBatchedProcessor

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

$ SearchUpdateBatchedProcessor#batch_soft_cap — Property 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

$ SolrReindexQueuedJob#batchSize — Property in class SolrReindexQueuedJob

Size of each batch to run

$ SolrIndex#boostedFields — Property in class SolrIndex

List of boosted fields

BasicAuthAuthenticator — Class in namespace SilverStripe\GraphQL\Auth

An authenticator using SilverStripe's BasicAuth

Handler::buildAuthenticator() — Method in class Handler

Build — Class in namespace SilverStripe\GraphQL\Dev

Build::build() — Method in class Build

Build::buildSchema() — Method in class Build

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

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

DBFieldArgs::baseFormatResolver() — Method in class DBFieldArgs

QuerySort::buildAllFieldsConfig() — Method in class QuerySort

Resolver::baseResolve() — Method in class Resolver

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

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

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

SchemaBuilder::build() — Method in class SchemaBuilder

Stores a schema and fetches the graphql-php instance

SchemaBuilder::buildByName() — Method in class SchemaBuilder

Boots a schema, persists it, and fetches it

SchemaBuilder::boot() — Method in class SchemaBuilder

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

NestedInputBuilder::buildAllFieldsConfig() — Method in class NestedInputBuilder

NestedInputBuilder::buildPathsFromArgs() — Method in class NestedInputBuilder

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

AbstractTypeRegistry::Boolean() — Method in class AbstractTypeRegistry

ModelType::buildOperations() — Method in class ModelType

BaseStore — Class in namespace SilverStripe\HybridSessions\Store

DatabaseStore::binaryDataJsonEncode() — Method in class DatabaseStore

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

DatabaseStore::binaryDataJsonDecode() — Method in class DatabaseStore

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

LDAPUtil::bin_to_str_guid() — Method in class LDAPUtil

LDAPUtil::bin_to_str_sid() — Method in class LDAPUtil

EnablerExtension::beforeCallActionHandler() — Method in class EnablerExtension

BaseHandlerTrait — Class in namespace SilverStripe\MFA\RequestHandler

BackupCodeGenerator — Class in namespace SilverStripe\MFA\Service

$ BackupCodeGenerator#backup_code_count — Property in class BackupCodeGenerator

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

$ BackupCodeGenerator#backup_code_length — Property in class BackupCodeGenerator

The length of each individual backup code.

BackupCodeGeneratorInterface — Class in namespace SilverStripe\MFA\Service

A service class implementation for generating and hashing backup codes.

BackupCode — Class in namespace SilverStripe\MFA\State

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

ArrayList::byIDs() — Method in class ArrayList

Filter this list to only contain the given Primary IDs

ArrayList::byID() — Method in class ArrayList

Return the first item with the given ID

DBQueryBuilder::buildSQL() — Method in class DBQueryBuilder

Builds a sql query with the specified connection

DBQueryBuilder::buildSelectQuery() — Method in class DBQueryBuilder

Builds a query from a SQLSelect expression

DBQueryBuilder::buildDeleteQuery() — Method in class DBQueryBuilder

Builds a query from a SQLDelete expression

DBQueryBuilder::buildInsertQuery() — Method in class DBQueryBuilder

Builds a query from a SQLInsert expression

DBQueryBuilder::buildUpdateQuery() — Method in class DBQueryBuilder

Builds a query from a SQLUpdate expression

DBQueryBuilder::buildSelectFragment() — Method in class DBQueryBuilder

Returns the SELECT clauses ready for inserting into a query.

DBQueryBuilder::buildDeleteFragment() — Method in class DBQueryBuilder

Return the DELETE clause ready for inserting into a query.

DBQueryBuilder::buildUpdateFragment() — Method in class DBQueryBuilder

Return the UPDATE clause ready for inserting into a query.

DBQueryBuilder::buildFromFragment() — Method in class DBQueryBuilder

Return the FROM clause ready for inserting into a query.

DBQueryBuilder::buildWhereFragment() — Method in class DBQueryBuilder

Returns the WHERE clauses ready for inserting into a query.

DBQueryBuilder::buildOrderByFragment() — Method in class DBQueryBuilder

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

DBQueryBuilder::buildGroupByFragment() — Method in class DBQueryBuilder

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

DBQueryBuilder::buildHavingFragment() — Method in class DBQueryBuilder

Returns the HAVING clauses ready for inserting into a query.

DBQueryBuilder::buildLimitFragment() — Method in class DBQueryBuilder

Return the LIMIT clause ready for inserting into a query.

DBSchemaManager::boolean() — Method in class DBSchemaManager

Returns data type for 'boolean' column

Database::benchmarkQuery() — Method in class Database

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

MySQLQueryBuilder::buildLimitFragment() — Method in class MySQLQueryBuilder

Return the LIMIT clause ready for inserting into a query.

MySQLSchemaManager::boolean() — Method in class MySQLSchemaManager

Return a boolean type-formatted string

MySQLSchemaManager::bigint() — Method in class MySQLSchemaManager

Return a bigint type-formatted string

$ MySQLStatement#bound — Property in class MySQLStatement

Is the statement bound to the current resultset?

$ MySQLStatement#boundValues — Property in class MySQLStatement

List of bound variables in the current row

MySQLStatement::bind() — Method in class MySQLStatement

Binds this statement to the variables

MySQLiConnector::beforeQuery() — Method in class MySQLiConnector

Invoked before any query is executed

MySQLiConnector::bindParameters() — Method in class MySQLiConnector

Binds a list of parameters to a statement

PDOConnector::beforeQuery() — Method in class PDOConnector

Invoked before any query is executed

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

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

$ DataObject#brokenOnWrite — Property in class DataObject

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

$ DataObject#belongs_to — Property in class DataObject

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

$ DataObject#belongs_many_many — Property in class DataObject

The inverse side of a many-many relationship.

DataObject::belongsTo() — Method in class DataObject

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

DataObject::beforeUpdateCMSFields() — Method in class DataObject

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

DataObject::baseTable() — Method in class DataObject

Get the name of the base table for this object

DataObject::baseClass() — Method in class DataObject

Get the base class for this object

DataObjectSchema::baseDataClass() — Method in class DataObjectSchema

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

DataObjectSchema::baseDataTable() — Method in class DataObjectSchema

Get the base table

DataObjectSchema::buildTableName() — Method in class DataObjectSchema

Generate table name for a class.

DataObjectSchema::buildCustomDatabaseIndexes() — Method in class DataObjectSchema

Look for custom indexes declared on the class

DataObjectSchema::buildSortDatabaseIndexes() — Method in class DataObjectSchema

DataObjectSchema::belongsToComponent() — Method in class DataObjectSchema

Return data for a specific belongs_to component.

DataQueryManipulator::beforeGetFinalisedQuery() — Method in class DataQueryManipulator

Invoked prior to getFinalisedQuery()

DatabaseAdmin::build() — Method in class DatabaseAdmin

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

DatabaseAdmin::buildDefaults() — Method in class DatabaseAdmin

Build the default data, calling requireDefaultRecords on all DataObject classes

$ DBClassName#baseClass — Property in class DBClassName

Base classname of class to enumerate.

DBComposite::bindTo() — Method in class DBComposite

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

Filterable::byID() — Method in class Filterable

Return the first item with the given ID

Filterable::byIDs() — Method in class Filterable

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

$ UnsavedRelationList#baseClass — Property in class UnsavedRelationList

The DataObject class name that this relation is on

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::buildPostgresIndexName() — Method in class PostgreSQLSchemaManager

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

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#BirthInfoQuality — Property in class FederatedIdentity

$ FederatedIdentity#BirthYear — Property in class FederatedIdentity

$ FederatedIdentity#BirthMonth — Property in class FederatedIdentity

$ FederatedIdentity#BirthDay — Property in class FederatedIdentity

$ FederatedIdentity#BirthPlaceQuality — Property in class FederatedIdentity

$ FederatedIdentity#BirthPlaceCountry — Property in class FederatedIdentity

$ FederatedIdentity#BirthPlaceLocality — Property in class FederatedIdentity

RegistryPage::Breadcrumbs() — Method in class RegistryPage

Modified version of Breadcrumbs, to cater for viewing items.

ReportAdmin::Breadcrumbs() — Method in class ReportAdmin

Returns the Breadcrumbs for the ReportAdmin

$ ReportWrapper#baseReport — Property in class ReportWrapper

ReportWrapper::beforeQuery() — Method in class ReportWrapper

Override this method to perform some actions prior to querying.

BasicRestfulAuthenticator — Class in namespace SilverStripe\RestfulServer

A simple authenticator for the Restful server.

SQLite3QueryBuilder::buildInsertQuery() — Method in class SQLite3QueryBuilder

SQLite3QueryBuilder::buildLimitFragment() — Method in class SQLite3QueryBuilder

Return the LIMIT clause ready for inserting into a query.

SQLite3SchemaManager::buildSQLiteIndexName() — Method in class SQLite3SchemaManager

Builds the internal SQLLite index name given the silverstripe table and index name.

SQLite3SchemaManager::boolean() — Method in class SQLite3SchemaManager

Return a boolean type-formatted string

SQLite3SchemaManager::bigint() — Method in class SQLite3SchemaManager

Return a bigint type-formatted string

BasicAuth — Class in namespace SilverStripe\Security

Provides an interface to HTTP basic authentication.

BasicAuthMiddleware — Class in namespace SilverStripe\Security

Form::buildActionList() — Method in class Form

Form::buildFieldList() — Method in class Form

Builds the form fields taking the confirmation items from the storage

Form::buildEmptyFieldList() — Method in class Form

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

$ InheritedPermissions#baseClass — Property in class InheritedPermissions

Class name

InheritedPermissions::batchPermissionCheck() — Method in class InheritedPermissions

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

InheritedPermissions::batchPermissionCheckForStage() — Method in class InheritedPermissions

$ Member#belongs_many_many — Property in class Member

Member::beforeMemberLoggedIn() — Method in class Member

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

Member::beforeMemberLoggedOut() — Method in class Member

Audit logging hook, called before a member is logged out

$ PermissionRole#belongs_many_many — Property in class PermissionRole

Security::basicauthlogin() — Method in class Security

$ LoginSession#belongs_to — Property in class LoginSession

SiteConfigLeftAndMain::Breadcrumbs() — Method in class SiteConfigLeftAndMain

BaseElementSubsites — Class in namespace SilverStripe\Subsites\Extensions

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

$ Subsite#belongs_many_many — Property in class Subsite

SubsiteReportWrapper::beforeQuery() — Method in class SubsiteReportWrapper

$ PDFTextExtractor#binary_location — Property in class PDFTextExtractor

Set to bin path this extractor can execute

PDFTextExtractor::bin() — Method in class PDFTextExtractor

Accessor to get the location of the binary

$ SolrCellTextExtractor#base_url — Property in class SolrCellTextExtractor

Base URL to use for Solr text extraction.

UserDefinedFormController::buildWatchJS() — Method in class UserDefinedFormController

Outputs the required JS from the $watch input

$ UserFormFileExtension#belongs_to — Property in class UserFormFileExtension

$ GridFieldAddClassesButton#buttonName — Property in class GridFieldAddClassesButton

Button title

$ GridFieldAddClassesButton#buttonClass — Property in class GridFieldAddClassesButton

Additonal CSS classes for the button

$ UserForm#button_text — Property in class UserForm

EditableCustomRule::buildExpression() — Method in class EditableCustomRule

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

$ EditableFieldGroupEnd#belongs_to — Property in class EditableFieldGroupEnd

$ UserForm#block_default_userforms_css — Property in class UserForm

Set this to true to disable automatic inclusion of CSS files

$ UserForm#block_default_userforms_js — Property in class UserForm

Set this to true to disable automatic inclusion of JavaScript files

ArchiveAdmin::Breadcrumbs() — Method in class ArchiveAdmin

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

BlockArchiveExtension — Class in namespace SilverStripe\VersionedAdmin\Extensions

Adds a archive view for Elemental blocks

$ ChangeSetItem#belongs_many_many — Property in class ChangeSetItem

Versioned::baseTable() — Method in class Versioned

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

VersionedGridFieldItemRequest::Breadcrumbs() — Method in class VersionedGridFieldItemRequest

$ RequirementsTestState#backend — Property in class RequirementsTestState

$ ShortcodeParser#block_level_elements — Property in class ShortcodeParser

$ Requirements#backend — Property in class Requirements

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

Requirements::backend() — Method in class Requirements

Requirements::block() — Method in class Requirements

Block inclusion of a specific file

$ Requirements_Backend#blocked — Property in class Requirements_Backend

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

Requirements_Backend::block() — Method in class Requirements_Backend

Block inclusion of a specific file

$ ThemeManifest#base — Property in class ThemeManifest

Base path

$ ThemeResourceLoader#base — Property in class ThemeResourceLoader

The base path of the application

BaseHandlerTrait — Class in namespace SilverStripe\WebAuthn

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

$ i18nTextCollector#basePath — Property in class i18nTextCollector

The directory base on which the collector should act.

$ i18nTextCollector#baseSavePath — Property in class i18nTextCollector

Save path

WorkflowInstance::beginWorkflow() — Method in class WorkflowInstance

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

$ GridFieldAddExistingSearchHandler#button — Property in class GridFieldAddExistingSearchHandler

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

Class BaseRunner

FluentExtension::BaseURLForLocale() — Method in class FluentExtension

Determine the baseurl within a specified $locale.

BrowserLocaleDetector — Class in namespace TractorCow\Fluent\State

Detects locale based on browser locale

C

$ GridFieldLinkButton#caption — Property in class GridFieldLinkButton

Caption text for the button to show

CheckForUpdatesJob — Class in namespace BringYourOwnIdeas\Maintenance\Jobs

Refresh report job. Runs as a queued job.

SiteSummary::columns() — Method in class SiteSummary

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

$ UpdatePackageInfoTask#composerLoader — Property in class UpdatePackageInfoTask

$ ApiLoader#cache — Property in class ApiLoader

ApiLoader::createRequest() — Method in class ApiLoader

Create a request with some standard headers

ComposerLoader — Class in namespace BringYourOwnIdeas\Maintenance\Util

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

$ SecurityAlertCheckJob#checkTask — Property in class SecurityAlertCheckJob

CheckComposerUpdatesExtension — Class in namespace BringYourOwnIdeas\UpdateChecker\Extensions

Task which does the actual checking of updates

ComposerLoaderExtension — Class in namespace BringYourOwnIdeas\UpdateChecker\Extensions

$ ComposerLoaderExtension#composer — Property in class ComposerLoaderExtension

ComposerUpdateExtension — Class in namespace BringYourOwnIdeas\UpdateChecker\Extensions

Describes any available updates to an installed Composer package

UpdateChecker::checkForUpdates() — Method in class UpdateChecker

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

CWPPageExtension — Class in namespace CWP\AgencyExtensions\Extensions

Class CWPPageExtension

CWPSiteConfigExtension — Class in namespace CWP\AgencyExtensions\Extensions

Class CWPCleanupSiteConfigExtension

CarouselPageExtension — Class in namespace CWP\AgencyExtensions\Extensions

ColorPickerField — Class in namespace CWP\AgencyExtensions\Forms

CarouselItem — Class in namespace CWP\AgencyExtensions\Model

CarouselItem::canCreate() — Method in class CarouselItem

CarouselItem::canEdit() — Method in class CarouselItem

CarouselItem::canDelete() — Method in class CarouselItem

CarouselItem::canView() — Method in class CarouselItem

CustomSiteConfig — Class in namespace CWP\CWP\Extensions

Adds new global settings.

CwpCommentingExtension — Class in namespace CWP\CWP\Extensions

Customises the comment form to conform to government usability standards

CwpSiteSummaryExtension — Class in namespace CWP\CWP\Extensions

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

CwpSiteTreeExtension — Class in namespace CWP\CWP\Extensions

CwpSiteTreeFileExtension — Class in namespace CWP\CWP\Extensions

CwpWorkflowDefinitionExtension — Class in namespace CWP\CWP\Extensions

Ensures that the default template is created

$ CwpWorkflowDefinitionExtension#create_default_workflow — Property 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#casting — Property in class DatedUpdateHolderController

DatedUpdateHolderController::CurrentTag() — Method in class DatedUpdateHolderController

Get the TaxonomyTerm related to the current tag GET parameter.

$ EventPage#can_be_root — Property in class EventPage

$ NewsPage#can_be_root — Property in class NewsPage

CwpStatsReport — Class in namespace CWP\CWP\Report

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

CwpStatsReport::columns() — Method in class CwpStatsReport

PopulateThemeSampleDataTask::createContactForm() — Method in class PopulateThemeSampleDataTask

Create a "contact us" userform. Please note that this form does not have any recipients by default, so no emails will be sent. To add recipients - edit the page in the CMS and add a recipient via the "Recipients" tab.

CwpBasicAuthMiddleware — Class in namespace CWP\Core\Control

CwpBasicAuthMiddleware::checkMatchingURL() — Method in class CwpBasicAuthMiddleware

Check for any whitelisted IP addresses. If one matches the current user's IP then return false early, otherwise allow the default BasicAuthMiddleware to continue its logic.

InitialisationMiddleware::configureEgressProxy() — Method in class InitialisationMiddleware

If the outbound egress proxy details have been defined in environment variables, configure the proxy variables that are used to configure it.

InitialisationMiddleware::configureProxyDomainExclusions() — Method in class InitialisationMiddleware

Configure any domains that should be excluded from egress proxy rules and provide them to the environment

CWPVersionExtension — Class in namespace CWP\Core\Extension

CustomHtmlEditorFieldToolbar — Class in namespace CWP\Core\Extension

CwpHtmlEditorConfig — Class in namespace CWP\Core\Extension

$ RichLinksExtension#casting — Property in class RichLinksExtension

CwpAtomFeed — Class in namespace CWP\Core\Feed

CleanupGeneratedPdfBuildTask — Class in namespace CWP\PDFExport\Tasks

CleanupGeneratedPdfDailyTask — Class 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

CwpSearchEngine — Class in namespace CWP\Search

Provides interface for generating search results for a SolrIndex

CwpSearchIndex — Class in namespace CWP\Search

Abstract wrapper for all cwp-core features

$ CwpSearchIndex#copy_fields — Property in class CwpSearchIndex

Copy all fields into both search and spellcheck data source

CwpSearchPage — Class in namespace CWP\Search

Dummy page to assist with display of search results

CwpSearchPage::canViewStage() — Method in class CwpSearchPage

CwpSearchPageController — Class in namespace CWP\Search

Description of SearchPageController

CwpSearchResult — Class in namespace CWP\Search

Container for a set of search results

$ CwpSearchResult#casting — Property in class CwpSearchResult

CwpSearchBoostExtension — Class in namespace CWP\Search\Extensions

Adds field boosting capabilities to fulltext search for pages

$ SearchControllerExtension#classes_to_search — Property in class SearchControllerExtension

Which classes should be queried when searching?

CwpSolr — Class in namespace CWP\Search\Solr

CwpSolr configures Solr in a CWP-compatible manner.

CwpSolr::configure() — Method in class CwpSolr

Configure Solr.

CwpSolrConfigStore — Class in namespace CWP\Search\Solr

CwpSolrIndex — Class in namespace CWP\Search\Solr

Default search index

$ Handler#component — Property in class Handler

GridFieldBulkManager instance.

$ BulkManager#config — Property in class BulkManager

component configuration.

HTTPBulkToolsResponse::createBody() — Method in class HTTPBulkToolsResponse

Creates the response JSON body

$ BulkUploadHandler#component — Property in class BulkUploadHandler

Bulk upload component.

BulkUploadHandler::createDataObject() — Method in class BulkUploadHandler

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

$ BulkUploader#config — Property in class BulkUploader

Component configuration.

$ ElementForm#controller_class — Property in class ElementForm

$ ElementalAreasExtension#clear_contentfield — Property in class ElementalAreasExtension

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

$ ElementalPageExtension#cascade_duplicates — Property in class ElementalPageExtension

$ BaseElement#casting — Property in class BaseElement

$ BaseElement#controller_class — Property in class BaseElement

$ BaseElement#controller_template — Property in class BaseElement

$ BaseElement#controller — Property in class BaseElement

BaseElement::canView() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::canEdit() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::canDelete() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::canCreate() — Method in class BaseElement

Basic permissions, defaults to page perms where possible.

BaseElement::CMSEditLink() — Method in class BaseElement

$ ElementalArea#cascade_deletes — Property in class ElementalArea

$ ElementalArea#cascade_duplicates — Property in class ElementalArea

ElementalArea::canEdit() — Method in class ElementalArea

ElementalArea::canView() — Method in class ElementalArea

ElementTypeReport::columns() — Method in class ElementTypeReport

ElementsInUseReport::columns() — Method in class ElementsInUseReport

$ ElementTypeRegistry#cache — Property in class ElementTypeRegistry

$ MigrateContentToElement#clear_content — Property in class MigrateContentToElement

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

DataExtension::clearTopPage() — Method in class DataExtension

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

FluentExtension::clearTopPage() — Method in class FluentExtension

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

CacheAfterCallAspect — Class in namespace LeKoala\DebugBar\Aspects

ConfigCollector — Class 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

DatabaseCollector::collectData() — Method in class DatabaseCollector

Collects data

$ HeaderCollector#controller — Property in class HeaderCollector

HeaderCollector::collect() — Method in class HeaderCollector

PartialCacheCollector::collect() — Method in class PartialCacheCollector

PhpInfoCollector::collect() — Method in class PhpInfoCollector

$ SilverStripeCollector#controller — Property in class SilverStripeCollector

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

ControllerExtension — Class in namespace LeKoala\DebugBar\Extension

A controller extension to log times and render the Debug Bar

ControllerExtension::clearBuffer() — Method in class ControllerExtension

ConfigManifestProxy — Class in namespace LeKoala\DebugBar\Proxy

$ ConfigManifestProxy#configCalls — Property in class ConfigManifestProxy

$ DeltaConfigManifestProxy#configCalls — Property in class DeltaConfigManifestProxy

DeltaConfigManifestProxy::createFromOriginal() — Method in class DeltaConfigManifestProxy

$ SSViewerProxy#cached — Property in class SSViewerProxy

Whether the class has been used, meaning whether the page has been cached

CMSBatchAction — Class in namespace SilverStripe\Admin

A class representing back actions.

CMSBatchAction::canView() — Method in class CMSBatchAction

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

CMSBatchActionHandler — Class in namespace SilverStripe\Admin

Special request handler for admin/batchaction

CMSBatchActionHandler::cleanIDs() — Method in class CMSBatchActionHandler

Sanitise ID list from string input

CMSEditLinkExtension — Class in namespace SilverStripe\Admin

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

$ CMSEditLinkExtension#cms_edit_owner — Property in class CMSEditLinkExtension

CMSEditLinkExtension::CMSEditLink() — Method in class CMSEditLinkExtension

Get a link to edit this DataObject in the CMS.

CMSMenu — Class in namespace SilverStripe\Admin

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

CMSMenu::clear_menu() — Method in class CMSMenu

Clears the entire menu

CMSMenuItem — Class in namespace SilverStripe\Admin

A simple CMS menu item.

$ CMSMenuItem#controller — Property in class CMSMenuItem

Parent controller class name

CMSProfileController — Class in namespace SilverStripe\Admin

CMSProfileController::canView() — Method in class CMSProfileController

$ LeftAndMain#client_debugging — Property in class LeftAndMain

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

LeftAndMain::canView() — Method in class LeftAndMain

LeftAndMain::Content() — Method in class LeftAndMain

LeftAndMain::currentPageID() — Method in class LeftAndMain

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

GET/POST parameter named 'ID'
URL parameter named 'ID'
Session value namespaced by classname, e.g. "CMSMain.currentPage"

LeftAndMain::currentPage() — Method in class LeftAndMain

Uses 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

$ ModalController#controller — Property in class ModalController

AkismetField::confirmationField() — Method in class AkismetField

Get the nested confirmation checkbox field

AssetAdmin::createfolder() — Method in class AssetAdmin

AssetAdmin::canView() — Method in class AssetAdmin

CampaignAdminExtension — Class in namespace SilverStripe\AssetAdmin\Extensions

Extension that updates the Popover menu of FileFormFactory.

CreateFileMutationCreator — Class in namespace SilverStripe\AssetAdmin\GraphQL

CreateFolderMutationCreator — Class in namespace SilverStripe\AssetAdmin\GraphQL

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

ReadFileQueryCreator::createConnection() — Method in class ReadFileQueryCreator

UnpublishFileMutationCreator::countLiveOwners() — Method in class UnpublishFileMutationCreator

Count number of live owners this file uses

TestAssetStore::cleanFilename() — Method in class TestAssetStore

Performs filename cleanup before sending it back.

$ File#casting — Property in class File

$ File#class_for_file_extension — Property in class File

Map of file extensions to class type

$ File#Content — Property in class File

File::canView() — Method in class File

File::canEdit() — Method in class File

Check if this file can be modified

File::canCreate() — Method in class File

Check if a file can be created

File::canDelete() — Method in class File

Check if this file can be deleted

File::collateDescendants() — Method in class File

Collate selected descendants of this page.

File::copyFile() — Method in class File

Copy to new filename.

File::canViewFile() — Method in class File

Check if the current user can view the given file.

File::CMSEditLink() — Method in class File

FileDefaultPermissions::canEdit() — Method in class FileDefaultPermissions

Can root be edited?

FileDefaultPermissions::canView() — Method in class FileDefaultPermissions

Can root be viewed?

FileDefaultPermissions::canDelete() — Method in class FileDefaultPermissions

Can root be deleted?

FileDefaultPermissions::canCreate() — Method in class FileDefaultPermissions

Can root objects be created?

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.

$ Filesystem#cache_folderModTime — Property in class Filesystem

AssetAdapter::configureServer() — Method in class AssetAdapter

Configure server files for this store

FlysystemAssetStore::copy() — Method in class FlysystemAssetStore

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

FlysystemAssetStore::canView() — Method in class FlysystemAssetStore

Check if the current user can view the given file.

FlysystemAssetStore::cleanFilename() — Method in class FlysystemAssetStore

Performs filename cleanup before sending it back.

FlysystemAssetStore::createResponseFor() — Method in class FlysystemAssetStore

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

FlysystemAssetStore::createDeniedResponse() — Method in class FlysystemAssetStore

Generate a response for requests to a denied protected file

FlysystemAssetStore::createMissingResponse() — Method in class FlysystemAssetStore

Generate a response for missing file requests

FlysystemAssetStore::createErrorResponse() — Method in class FlysystemAssetStore

Create a response with the given error code

GeneratedAssets::checkOrCreate() — Method in class GeneratedAssets

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

Folder::ChildFolders() — Method in class Folder

Get the children of this folder that are also folders.

$ ImageBackendFactory#cache — Property in class ImageBackendFactory

In memory cache keyed by hash/variant

$ ImageBackendFactory#creator — Property in class ImageBackendFactory

ImageBackendFactory::create() — Method in class ImageBackendFactory

Creates a new service instance.

$ ImageManipulation#cms_thumbnail_width — Property in class ImageManipulation

The width of an image thumbnail in the CMS.

$ ImageManipulation#cms_thumbnail_height — Property in class ImageManipulation

The height of an image thumbnail in the CMS.

ImageManipulation::CropWidth() — Method in class ImageManipulation

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

ImageManipulation::CropHeight() — Method in class ImageManipulation

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

ImageManipulation::CMSThumbnail() — Method in class ImageManipulation

Default CMS thumbnail

ImageManipulation::castDimension() — Method in class ImageManipulation

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

Image_Backend::croppedResize() — Method in class Image_Backend

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

Image_Backend::crop() — Method in class Image_Backend

Crop's part of image.

InterventionBackend::croppedResize() — Method in class InterventionBackend

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

InterventionBackend::crop() — Method in class InterventionBackend

Crop's part of image.

InterventionBackend::createCloneWithResource() — Method in class InterventionBackend

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

ImageShortcodeProvider::createImageTag() — Method in class ImageShortcodeProvider

Construct and return HTML image tag.

AssetContainer::copyFile() — Method in class AssetContainer

Copy to new filename.

AssetContainer::canViewFile() — Method in class AssetContainer

Check if the current user can view the given file.

AssetStore::copy() — Method in class AssetStore

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

AssetStore::canView() — Method in class AssetStore

Check if the current user can view the given file.

$ DBFile#composite_db — Property in class DBFile

$ DBFile#casting — Property in class DBFile

DBFile::canViewFile() — Method in class DBFile

Check if the current user can view the given file.

DBFile::copyFile() — Method in class DBFile

Copy to new filename.

DefaultAssetNameGenerator::current() — Method in class DefaultAssetNameGenerator

FileHashingService::computeFromStream() — Method in class FileHashingService

Compute the Hash value of the provided stream.

FileHashingService::computeFromFile() — Method in class FileHashingService

Compute the hash of the provided file

FileHashingService::compare() — Method in class FileHashingService

Compare 2 full or partial hashes.

Sha1FileHashingService::computeFromStream() — Method in class Sha1FileHashingService

Compute the Hash value of the provided stream.

Sha1FileHashingService::computeFromFile() — Method in class Sha1FileHashingService

Compute the hash of the provided file

Sha1FileHashingService::compare() — Method in class Sha1FileHashingService

Compare 2 full or partial hashes.

Upload::clearErrors() — Method in class Upload

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

Upload_Validator::clearErrors() — Method in class Upload_Validator

Clear out all errors

AuditFactory::create() — Method in class AuditFactory

Creates a new service instance.

CoreInitializationPass — Class 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().

$ FixtureContext#context — Property in class FixtureContext

$ FixtureContext#createdFilesPaths — Property in class FixtureContext

$ FixtureContext#createdAssets — Property in class FixtureContext

FixtureContext::convertTypeToClass() — Method in class FixtureContext

Converts a natural language class description to an actual class name.

FixtureContext::convertFields() — Method in class FixtureContext

Updates an object with values, resolving aliases set through DataObject->fieldLabels().

FixtureContext::clearConfigFiles() — Method in class FixtureContext

SilverStripeContext::canIntercept() — Method in class SilverStripeContext

SilverStripeContext::clickLink() — Method in class SilverStripeContext

Overwritten to click the first visible link the DOM.

$ ModuleInitialisationController#container — Property in class ModuleInitialisationController

ModuleInitialisationController::configure() — Method in class ModuleInitialisationController

{@inheritdoc}

$ ModuleSuiteLocator#container — Property in class ModuleSuiteLocator

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

GridFieldCategorisationConfig::changeColumnOrder() — Method in class GridFieldCategorisationConfig

Reorders GridField columns so that Actions is last.

$ GridFieldMergeAction#childMethod — Property in class GridFieldMergeAction

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

Blog::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#casting — Property in class BlogController

BlogController::category() — Method in class BlogController

Renders the blog posts for a given category.

BlogObject::canView() — Method in class BlogObject

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

BlogObject::canCreate() — Method in class BlogObject

{@inheritdoc}

BlogObject::canDelete() — Method in class BlogObject

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

BlogObject::canEdit() — Method in class BlogObject

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

$ BlogPost#casting — Property in class BlogPost

$ BlogPost#can_be_root — Property in class BlogPost

BlogPost::canEditAuthors() — Method in class BlogPost

Determine if this user can edit the authors list.

BlogPost::canCreateCategories() — Method in class BlogPost

Determine whether user can create new categories.

BlogPost::canCreateTags() — Method in class BlogPost

Determine whether user can create new tags.

BlogPost::canView() — Method in class BlogPost

{@inheritdoc}

BlogPost::canPublish() — Method in class BlogPost

{@inheritdoc}

BlogPost::canEdit() — Method in class BlogPost

{@inheritdoc}

BlogPost::Categories() — Method in class BlogPost

CategorisationObject — Class in namespace SilverStripe\Blog\Model

$ BlogArchiveWidget#cmsTitle — Property in class BlogArchiveWidget

$ BlogCategoriesWidget#cmsTitle — Property in class BlogCategoriesWidget

$ BlogFeaturedPostsWidget#cmsTitle — Property in class BlogFeaturedPostsWidget

$ BlogRecentPostsWidget#cmsTitle — Property in class BlogRecentPostsWidget

$ BlogTagsCloudWidget#cmsTitle — Property in class BlogTagsCloudWidget

$ BlogTagsWidget#cmsTitle — Property in class BlogTagsWidget

ResourceField::create() — Method in class ResourceField

CKANRegistryPage — Class 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.

CKANRegistryPageController — Class in namespace SilverStripe\CKANRegistry\Page

$ APIClient#cache — Property in class APIClient

Instance cache for repeated calls within the same request

CMSBatchAction_Archive — Class in namespace SilverStripe\CMS\BatchActions

Delete items batch action.

CMSBatchAction_Publish — Class in namespace SilverStripe\CMS\BatchActions

Publish items batch action.

CMSBatchAction_Restore — Class in namespace SilverStripe\CMS\BatchActions

Batch restore of pages

CMSBatchAction_Unpublish — Class in namespace SilverStripe\CMS\BatchActions

Unpublish items batch action.

CMSMain — Class in namespace SilverStripe\CMS\Controllers

The main "content" area of the CMS.

$ CMSMain#casting — Property in class CMSMain

CMSMain::clearCache() — Method in class CMSMain

Clears all dependent cache backends

CMSMain::CanOrganiseSitetree() — Method in class CMSMain

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

CMSMain::collateDescendants() — Method in class CMSMain

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

CMSMain::childfilter() — Method in class CMSMain

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

CMSMain::currentPageID() — Method in class CMSMain

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

GET/POST parameter named 'ID'
URL parameter named 'ID'
Session value namespaced by classname, e.g. "CMSMain.currentPage"

CMSPageAddController — Class in namespace SilverStripe\CMS\Controllers

CMSPageEditController — Class in namespace SilverStripe\CMS\Controllers

CMSPageHistoryController — Class 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

CMSPageSettingsController — Class in namespace SilverStripe\CMS\Controllers

CMSPagesController — Class in namespace SilverStripe\CMS\Controllers

CMSSiteTreeFilter — Class in namespace SilverStripe\CMS\Controllers

Base class for filtering the subtree for certain node statuses.

$ CMSSiteTreeFilter#childrenMethod — Property in class CMSSiteTreeFilter

CMSSiteTreeFilter_ChangedPages — Class in namespace SilverStripe\CMS\Controllers

Gets all pages which have changed on stage.

CMSSiteTreeFilter_DeletedPages — Class in namespace SilverStripe\CMS\Controllers

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

$ CMSSiteTreeFilter_DeletedPages#childrenMethod — Property in class CMSSiteTreeFilter_DeletedPages

CMSSiteTreeFilter_PublishedPages — Class in namespace SilverStripe\CMS\Controllers

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

$ CMSSiteTreeFilter_PublishedPages#childrenMethod — Property in class CMSSiteTreeFilter_PublishedPages

CMSSiteTreeFilter_Search — Class in namespace SilverStripe\CMS\Controllers

CMSSiteTreeFilter_StatusDeletedPages — Class in namespace SilverStripe\CMS\Controllers

Filters pages which have a status "Deleted".

$ CMSSiteTreeFilter_StatusDeletedPages#childrenMethod — Property in class CMSSiteTreeFilter_StatusDeletedPages

CMSSiteTreeFilter_StatusDraftPages — Class in namespace SilverStripe\CMS\Controllers

Filters pages which have a status "Draft".

CMSSiteTreeFilter_StatusRemovedFromDraftPages — Class in namespace SilverStripe\CMS\Controllers

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

ContentController — Class in namespace SilverStripe\CMS\Controllers

The most common kind of controller; effectively a controller linked to a DataObject.

$ ContentController#casting — Property in class ContentController

ContentController::ChildrenOf() — Method in class ContentController

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

ContentController::ContentLocale() — Method in class ContentController

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

ModelAsController::controller_for() — Method in class ModelAsController

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

$ RootURLController#cached_homepage_link — Property in class RootURLController

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

CurrentPageIdentifier — Class in namespace SilverStripe\CMS\Model

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

CurrentPageIdentifier::currentPageID() — Method in class CurrentPageIdentifier

Get the current page ID.

RedirectorPage::ContentSource() — Method in class RedirectorPage

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

$ SiteTree#can_be_root — Property in class SiteTree

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

$ SiteTree#controller_name — Property in class SiteTree

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

$ SiteTree#cms_edit_owner — Property in class SiteTree

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

$ SiteTree#cascade_deletes — Property in class SiteTree

$ SiteTree#casting — Property in class SiteTree

$ SiteTree#can_create — Property in class SiteTree

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

$ SiteTree#create_default_pages — Property in class SiteTree

$ SiteTree#creatableChildrenCache — Property in class SiteTree

$ SiteTree#Content — Property in class SiteTree

HTML content of the page.

SiteTree::CMSEditLink() — Method in class SiteTree

Generates a link to edit this page in the CMS.

SiteTree::can() — Method in class SiteTree

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

SiteTree::canAddChildren() — Method in class SiteTree

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

SiteTree::canView() — Method in class SiteTree

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

SiteTree::canPublish() — Method in class SiteTree

Check if this page can be published

SiteTree::canDelete() — Method in class SiteTree

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

SiteTree::canCreate() — Method in class SiteTree

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

SiteTree::canEdit() — Method in class SiteTree