Index
A
- AdminRootController — Class in namespace SilverStripe\Admin
- AdminRootController::admin_url() — Method in class AdminRootController
Returns the root admin URL for the site with trailing slash
- CMSBatchAction::applicablePagesHelper() — Method in class CMSBatchAction
Helper method for applicablePages() methods. Acts as a skeleton implementation.
- CMSBatchAction::applicablePages() — Method in class CMSBatchAction
Given a list of object IDs, filter out which items can have this batch action applied to them.
- CMSMenu::add_controller() — Method in class CMSMenu
Add a LeftAndMain controller to the CMS menu.
- CMSMenu::add_link() — Method in class CMSMenu
Add an arbitrary URL to the CMS menu.
- CMSMenu::add_menu_item() — Method in class CMSMenu
Add a navigation item to the main administration menu showing in the top bar.
- $ UsedOnTable#allowed_actions — Property in class UsedOnTable
- $ LeftAndMain#admin_themes — Property in class LeftAndMain
Assign themes to use for 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::ApplicationLink() — Method in class LeftAndMain
- LeftAndMainExtension::accessedCMS() — Method in class LeftAndMainExtension
- LeftAndMainExtension::augmentNewSiteTreeItem() — Method in class LeftAndMainExtension
- AssetAdmin — Class in namespace SilverStripe\AssetAdmin\Controller
AssetAdmin is the 'file store' section of the CMS.
- $ AssetAdmin#allowed_max_file_size — 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
- AssetFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms
- $ UploadField#allowed_actions — Property in class UploadField
- CreateFileMutationCreator::attributes() — Method in class CreateFileMutationCreator
- CreateFileMutationCreator::args() — Method in class CreateFileMutationCreator
- CreateFolderMutationCreator::attributes() — Method in class CreateFolderMutationCreator
- CreateFolderMutationCreator::args() — Method in class CreateFolderMutationCreator
- DeleteFileMutationCreator::attributes() — Method in class DeleteFileMutationCreator
- DeleteFileMutationCreator::args() — Method in class DeleteFileMutationCreator
- FileFilterInputTypeCreator::attributes() — Method in class FileFilterInputTypeCreator
- FileInputTypeCreator::attributes() — Method in class FileInputTypeCreator
- FileInterfaceTypeCreator::attributes() — Method in class FileInterfaceTypeCreator
- FileTypeCreator::attributes() — Method in class FileTypeCreator
- FileUsageType::attributes() — Method in class FileUsageType
- FolderInputTypeCreator::attributes() — Method in class FolderInputTypeCreator
- FolderTypeCreator::attributes() — Method in class FolderTypeCreator
- MoveFilesMutationCreator::attributes() — Method in class MoveFilesMutationCreator
- MoveFilesMutationCreator::args() — Method in class MoveFilesMutationCreator
- PublicationMutationCreator::attributes() — Method in class PublicationMutationCreator
- PublicationMutationCreator::args() — Method in class PublicationMutationCreator
- PublicationNoticeType::attributes() — Method in class PublicationNoticeType
- ReadFileQueryCreator::attributes() — Method in class ReadFileQueryCreator
- ReadFileUsageQueryCreator::attributes() — Method in class ReadFileUsageQueryCreator
- ReadFileUsageQueryCreator::args() — Method in class ReadFileUsageQueryCreator
- 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.
- AssetManipulationList — Class in namespace SilverStripe\Assets
Provides a mechanism for determining the effective visibility of a set of assets (identified by filename and hash), given their membership to objects of varying visibility.
- AssetManipulationList::addAsset() — Method in class AssetManipulationList
Add asset with the given state
- AssetManipulationList::addPublicAsset() — Method in class AssetManipulationList
Mark a file as public
- AssetManipulationList::addProtectedAsset() — Method in class AssetManipulationList
Record an asset as protected
- AssetManipulationList::addDeletedAsset() — Method in class AssetManipulationList
Record an asset as deleted
- TestAssetStore::activate() — Method in class TestAssetStore
Set this store as the new asset backend
- $ File#allowed_extensions — Property in class File
- $ File#app_categories — Property in class File
- $ File#apply_restrictions_to_admin — Property in class File
- File::AbsoluteLink() — Method in class File
Just an alias function to keep a consistent API with SiteTree
- File::appCategory() — Method in class File
Returns a category based on the file extension.
- AssetAdapter — Class in namespace SilverStripe\Assets\Flysystem
Adapter for local filesystem based on assets directory
- $ ImageManipulation#asset_preview_width — Property in class ImageManipulation
The width of an image preview in the Asset section
- $ ImageManipulation#asset_preview_height — Property in class ImageManipulation
The height of an image preview in the Asset section
- FileLinkTracking::augmentSyncLinkTracking() — Method in class FileLinkTracking
Find HTMLText fields on {@link owner} to scrape for links that need tracking
- $ FileShortcodeProvider#allow_session_grant — Property in class FileShortcodeProvider
Set to true if shortcodes should apply a session grant on their calls to
getAsURL
.- AssetContainer — Class in namespace SilverStripe\Assets\Storage
Represents a container for a specific asset.
- AssetNameGenerator — Class in namespace SilverStripe\Assets\Storage
Provides a mechanism for suggesting filename alterations to a file
- AssetStore — Class in namespace SilverStripe\Assets\Storage
Represents an abstract asset persistence layer. Acts as a backend to files.
- AssetStoreRouter — Class in namespace SilverStripe\Assets\Storage
Represents a store usable with ProtectedFileController to serve up non-direct file requests
- DBFile::AbsoluteLink() — Method in class DBFile
Return absolute URL for this image. Alias for getAbsoluteURL()
- $ Upload_Validator#allowedMaxFileSize — Property in class Upload_Validator
Restrict filesize for either all filetypes or a specific extension, with extension-name as array-key and the size-restriction in bytes as array-value.
- $ Upload_Validator#allowedExtensions — Property in class Upload_Validator
- CMSBatchAction_Archive::applicablePages() — Method in class CMSBatchAction_Archive
Given a list of object IDs, filter out which items can have this batch action applied to them.
- CMSBatchAction_Publish::applicablePages() — Method in class CMSBatchAction_Publish
Given a list of object IDs, filter out which items can have this batch action applied to them.
- CMSBatchAction_Restore::applicablePages() — Method in class CMSBatchAction_Restore
{see SiteTree::canEdit()}
- CMSBatchAction_Unpublish::applicablePages() — Method in class CMSBatchAction_Unpublish
Given a list of object IDs, filter out which items can have this batch action applied to them.
- CMSMain::archive() — Method in class CMSMain
Delete this page from both live and stage
- CMSPageAddController::AddForm() — Method in class CMSPageAddController
- CMSPageEditController::addtocampaign() — Method in class CMSPageEditController
Action handler for adding pages to a campaign
- CMSPageEditController::AddToCampaignForm() — Method in class CMSPageEditController
Url handler for add to campaign form
- AnchorLinkFormFactory — Class in namespace SilverStripe\CMS\Forms
- AnchorSelectorField — Class in namespace SilverStripe\CMS\Forms
Assists with selecting anchors on a given page
- AnchorSelectorField::anchors() — Method in class AnchorSelectorField
Find all anchors available on the given page.
- $ SiteTree#allowed_children — Property in class SiteTree
Indicates what kind of children this page type can have.
- SiteTree::AbsoluteLink() — Method in class SiteTree
Get the absolute URL for this page, including protocol and host.
- SiteTree::allowedChildren() — Method in class SiteTree
Returns an array of the class names of classes that are allowed to be children of this class.
- SiteTreeLinkTracking::augmentSyncLinkTracking() — Method in class SiteTreeLinkTracking
Find HTMLText fields on {@link owner} to scrape for links that need tracking
- VirtualPage::allowedChildren() — Method in class VirtualPage
- VirtualPage::allMethodNames() — Method in class VirtualPage
{@inheritdoc}
- AddToCampaignHandler — Class in namespace SilverStripe\CampaignAdmin
Class AddToCampaignHandler - handle the AddToCampaign action.
- AddToCampaignHandler::addToCampaign() — Method in class AddToCampaignHandler
Performs the actual action of adding the object to the ChangeSet, once the ChangeSet ID is known
- AddToCampaignHandler_FormAction — Class in namespace SilverStripe\CampaignAdmin
A form action to return from getCMSActions or otherwise include in a CMS Edit Form that has the right action name and CSS classes to trigger the AddToCampaignHandler.
- AddToCampaignValidator — Class in namespace SilverStripe\CampaignAdmin
- ConfigCollectionInterface::addMiddleware() — Method in class ConfigCollectionInterface
- MiddlewareAware::addMiddleware() — Method in class MiddlewareAware
- YamlTransformer::addRule() — Method in class YamlTransformer
This allows external rules to be added to only/except checks. Config is only supposed to be setup once, so adding rules is a one-way system. You cannot remove rules after being set. This also prevent built-in rules from being removed.
- $ 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.
- BASE - Append this path to the base url (i.e. behaves as though
- Absolute urls (e.g.
- 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::addHeader() — Method in class HTTPRequest
Add a HTTP header to the response, replacing any header of the same name.
- HTTPRequest::allParams() — Method in class HTTPRequest
- HTTPRequest::allParsed() — Method in class HTTPRequest
Returns true if the URL has been completely parsed.
- HTTPResponse::addHeader() — Method in class HTTPResponse
Add a HTTP header to the response, replacing any header of the same name.
- AllowedHostsMiddleware — Class in namespace SilverStripe\Control\Middleware
Secures requests by only allowing a whitelist of Host values
- AjaxBypass — Class in namespace SilverStripe\Control\Middleware\ConfirmationMiddleware
Bypass for AJAX requests
- HttpMethodBypass::addMethods() — Method in class HttpMethodBypass
Add new HTTP methods to the list
- Url::addHttpMethods() — Method in class Url
Add HTTP methods to check against
- $ HTTPCacheControlMiddleware#allowed_directives — Property in class HTTPCacheControlMiddleware
A list of allowed cache directives for HTTPResponses
- HTTPCacheControlMiddleware::addVary() — Method in class HTTPCacheControlMiddleware
Add a vary
- HTTPCacheControlMiddleware::applyToResponse() — Method in class HTTPCacheControlMiddleware
Generate all headers to add to this object
- HTTPMiddlewareAware::addMiddleware() — Method in class HTTPMiddlewareAware
- RSSFeed_Entry::Author() — Method in class RSSFeed_Entry
Get the author of this entry
- RSSFeed_Entry::AbsoluteLink() — Method in class RSSFeed_Entry
Get a link to this entry
- $ RequestHandler#allowed_actions — Property in class RequestHandler
Define a list of action handling methods that are allowed to be called directly by URLs.
- RequestHandler::allowedActions() — Method in class RequestHandler
Get a array of allowed actions defined on this controller, any parent classes or extensions.
- Session::addToArray() — Method in class Session
Merge value with array
- Application — Class in namespace SilverStripe\Core
Identifies a class as a root silverstripe application
- ApcuCacheFactory — Class in namespace SilverStripe\Core\Cache
- ClassInfo::allClasses() — Method in class ClassInfo
Wrapper for classes getter.
- ClassInfo::ancestry() — Method in class ClassInfo
Returns the passed class name along with all its parent class names in an array, sorted with the root class first.
- ConfigLoader::activate() — Method in class ConfigLoader
Mark this instance as the current instance
- Convert::array2json() — Method in class Convert
Encode an array as a JSON encoded string.
- CoreKernel::activate() — Method in class CoreKernel
Ensures this kernel is the active kernel after or during nesting
- CustomMethods::allMethodNames() — Method in class CustomMethods
Return the names of all the methods available on this object
- Extensible::add_extension() — Method in class Extensible
Add an extension to a specific class.
- Extension::add_to_class() — Method in class Extension
Called when this extension is added to a particular class
- AfterCallAspect — Class in namespace SilverStripe\Core\Injector
An AfterCallAspect is run after a method is executed
- AfterCallAspect::afterCall() — Method in class AfterCallAspect
Call this aspect after a method is executed
- AopProxyService — Class in namespace SilverStripe\Core\Injector
A class that proxies another, allowing various functionality to be injected.
- $ AopProxyService#afterCall — Property in class AopProxyService
- Injector::addAutoProperty() — Method in class Injector
Add an object that should be automatically set on managed objects
- InjectorLoader::activate() — Method in class InjectorLoader
Mark this instance as the current instance
- Kernel::activate() — Method in class Kernel
Ensures this kernel is the active kernel after or during nesting
- ManifestFileFinder::acceptDir() — Method in class ManifestFileFinder
- Module::activate() — Method in class Module
Activate _config.php for this module, if one exists
- ModuleManifest::addModule() — Method in class ModuleManifest
Adds a path as a module
- ModuleManifest::activateConfig() — Method in class ModuleManifest
Includes all of the php _config.php files found by this manifest.
- BulkLoader_Result::addCreated() — Method in class BulkLoader_Result
- BulkLoader_Result::addUpdated() — Method in class BulkLoader_Result
- BulkLoader_Result::addDeleted() — Method in class BulkLoader_Result
- ArraySubset — Class in namespace SilverStripe\Dev\Constraint
Constraint that asserts that the array it is evaluated for has a specified subset.
- $ DevelopmentAdmin#allow_all_cli — Property in class DevelopmentAdmin
Assume that CLI equals admin permissions If set to false, normal permission model will apply even in CLI mode Applies to all development admin tasks (E.g. TaskRunner, DatabaseAdmin)
- FixtureBlueprint::addCallback() — Method in class FixtureBlueprint
See class documentation.
- FunctionalTest::assertPartialMatchBySelector() — Method in class FunctionalTest
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
- FunctionalTest::assertExactMatchBySelector() — Method in class FunctionalTest
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
- FunctionalTest::assertPartialHTMLMatchBySelector() — Method in class FunctionalTest
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
- FunctionalTest::assertExactHTMLMatchBySelector() — Method in class FunctionalTest
Assert that the most recently queried page contains a number of content tags specified by a CSS selector.
- DatabaseAdapterRegistry::autodiscover() — Method in class DatabaseAdapterRegistry
Detects all _register_database.php files and invokes them.
- DatabaseAdapterRegistry::autoconfigure() — Method in class DatabaseAdapterRegistry
Detects all _configure_database.php files and invokes them Called by ConfigureFromEnv.php.
- SapphireTest::assertArraySubset() — Method in class SapphireTest
Asserts that an array has a specified subset.
- SapphireTest::assertContains() — Method in class SapphireTest
- SapphireTest::assertNotContains() — Method in class SapphireTest
- SapphireTest::assertEmailSent() — Method in class SapphireTest
Assert that the matching email was sent since the last call to clearEmails() All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
- SapphireTest::assertListContains() — Method in class SapphireTest
Assert that the given {@link SS_List} includes DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
- SapphireTest::assertDOSContains() — Method in class SapphireTest
- SapphireTest::assertListNotContains() — Method in class SapphireTest
Asserts that no items in a given list appear in the given dataobject list
- SapphireTest::assertNotDOSContains() — Method in class SapphireTest
- SapphireTest::assertListEquals() — Method in class SapphireTest
Assert that the given {@link SS_List} includes only DataObjects matching the given key-value pairs. Each match must correspond to 1 distinct record.
- SapphireTest::assertDOSEquals() — Method in class SapphireTest
- SapphireTest::assertListAllMatch() — Method in class SapphireTest
Assert that the every record in the given {@link SS_List} matches the given key-value pairs.
- SapphireTest::assertDOSAllMatch() — Method in class SapphireTest
- SapphireTest::assertSQLEquals() — Method in class SapphireTest
Asserts that two SQL queries are equivalent
- SapphireTest::assertSQLContains() — Method in class SapphireTest
Asserts that a SQL query contains a SQL fragment
- SapphireTest::assertSQLNotContains() — Method in class SapphireTest
Asserts that a SQL query contains a SQL fragment
- SapphireTest::actWithPermission() — Method in class SapphireTest
A wrapper for automatically performing callbacks as a user with a specific permission
- $ ErrorPageExtension#allowed_children — Property in class ErrorPageExtension
- FieldList::addFieldToTab() — Method in class FieldList
Add an extra field to a tab within this FieldList.
- FieldList::addFieldsToTab() — Method in class FieldList
Add a number of extra fields to a tab within this FieldList.
- Form::actionIsValidationExempt() — Method in class Form
Passed a FormAction, returns true if that action is exempt from Form validation
- Form::Actions() — Method in class Form
Return the form's action buttons - used by the templates
- Form::addExtraClass() — Method in class Form
Add a CSS-class to the form-container. If needed, multiple classes can be added by delimiting a string with spaces.
- FormAction::actionName() — Method in class FormAction
Get the action name
- FormField::addExtraClass() — Method in class FormField
Add one or more CSS-classes to the FormField container.
- FormField::attrTitle() — Method in class FormField
Returns a version of a title suitable for insertion into an HTML attribute.
- FormField::attrValue() — Method in class FormField
Returns a version of a title suitable for insertion into an HTML attribute.
- $ FormRequestHandler#allowed_actions — Property in class FormRequestHandler
- $ FormScaffolder#ajaxSafe — Property in class FormScaffolder
- FormScaffolder::addManyManyRelationshipFields() — Method in class FormScaffolder
Adds the default many-many relation fields for the relationship provided.
- 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::addDataFields() — Method in class GridField
Add additional calculated data fields to be used on this GridField
- GridFieldConfig::addComponent() — Method in class GridFieldConfig
- GridFieldConfig::addComponents() — Method in class GridFieldConfig
- GridFieldDataColumns::augmentColumns() — Method in class GridFieldDataColumns
Modify the list of columns displayed in the table.
- GridFieldDeleteAction::augmentColumns() — Method in class GridFieldDeleteAction
Add a column 'Delete'
- GridFieldEditButton::augmentColumns() — Method in class GridFieldEditButton
Add a column 'Delete'
- GridFieldEditButton::addExtraClass() — Method in class GridFieldEditButton
Add an extra HTML class
- GridFieldStateManager::addStateToURL() — Method in class GridFieldStateManager
- GridFieldStateManagerInterface::addStateToURL() — Method in class GridFieldStateManagerInterface
- GridFieldViewButton::augmentColumns() — Method in class GridFieldViewButton
Modify the list of columns displayed in the table.
- GridField_ActionMenu::augmentColumns() — Method in class GridField_ActionMenu
Modify the list of columns displayed in the table.
- GridField_ColumnProvider::augmentColumns() — Method in class GridField_ColumnProvider
Modify the list of columns displayed in the table.
- GridState::array_to_object() — Method in class GridState
- GridState::attrValue() — Method in class GridState
- TinyMCEConfig::addButtonsToLine() — Method in class TinyMCEConfig
Add buttons to the end of a line
- RequiredFields::addRequiredField() — Method in class RequiredFields
Adds a single required field to required fields stack.
- RequiredFields::appendRequiredFields() — Method in class RequiredFields
Add {@link RequiredField} objects together
- AuthenticatorInterface — Class in namespace SilverStripe\GraphQL\Auth
An AuthenticatorInterface is responsible for authenticating against a SilverStripe CMS Member from the given request data.
- AuthenticatorInterface::authenticate() — Method in class AuthenticatorInterface
Given the current request, authenticate the request for non-session authorization (outside the CMS).
- BasicAuthAuthenticator::authenticate() — Method in class BasicAuthAuthenticator
Given the current request, authenticate the request for non-session authorization (outside the CMS).
- Configuration::apply() — Method in class Configuration
- Controller::autobuildEnabled() — Method in class Controller
- Controller::addCorsHeaders() — Method in class Controller
Process the CORS config options and add the appropriate headers to the response.
- QueryRecorderExtension::augmentDataQueryCreation() — Method in class QueryRecorderExtension
Record query against a given class.
- QueryHandler::addContextProvider() — Method in class QueryHandler
- QueryHandler::addMiddleware() — Method in class QueryHandler
- QueryHandlerInterface::addContextProvider() — Method in class QueryHandlerInterface
- ApplyVersionFilters — Class in namespace SilverStripe\GraphQL\Resolvers
- ApplyVersionFilters::applyToReadingState() — Method in class ApplyVersionFilters
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().
- ApplyVersionFilters::applyToList() — Method in class ApplyVersionFilters
- AbstractBulkLoader — Class in namespace SilverStripe\GraphQL\Schema\BulkLoader
Provides base functionality to all bulk loaders. Should override the collect() method with computations that parse the include/exclude directives and return a collection of classes.
- AbstractBulkLoader::applyConfig() — Method in class AbstractBulkLoader
- BulkLoaderSet::applyConfig() — Method in class BulkLoaderSet
- BulkLoaderSet::addLoader() — Method in class BulkLoaderSet
- AbstractTypeResolver — Class in namespace SilverStripe\GraphQL\Schema\DataObject
Used for unions and interfaces to map a class instance to a type
- $ FieldAccessor#allowed_aggregates — Property in class FieldAccessor
- FieldAccessor::accessField() — Method in class FieldAccessor
Resolves complex dot syntax references.
- InheritanceUnionBuilder::applyUnionsToQueries() — Method in class InheritanceUnionBuilder
Changes all queries to use inheritance unions where applicable
- InterfaceBuilder::applyBaseInterface() — Method in class InterfaceBuilder
- InterfaceBuilder::applyInterfacesToQueries() — Method in class InterfaceBuilder
- ModelCreator::appliesTo() — Method in class ModelCreator
- AbstractCanViewPermission — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin
Defines a permission checking plugin for queries. Subclasses just need to provide a resolver function
- AbstractCanViewPermission::apply() — Method in class AbstractCanViewPermission
- DBDateArgs::applyToField() — Method in class DBDateArgs
- DBDecimalArgs::applyToField() — Method in class DBDecimalArgs
- DBFieldArgs::applyToField() — Method in class DBFieldArgs
- DBFieldArgsPlugin::apply() — Method in class DBFieldArgsPlugin
- DBFloatArgs::applyToField() — Method in class DBFloatArgs
- DBHTMLTextArgs::applyToField() — Method in class DBHTMLTextArgs
- DBTextArgs::applyToField() — Method in class DBTextArgs
- DBTimeArgs::applyToField() — Method in class DBTimeArgs
- DBFieldTypes::apply() — Method in class DBFieldTypes
- FirstResult::apply() — Method in class FirstResult
- Inheritance::apply() — Method in class Inheritance
- InheritedPlugins::apply() — Method in class InheritedPlugins
- FieldFilterInterface::apply() — Method in class FieldFilterInterface
- FieldFilterRegistry::addFilter() — Method in class FieldFilterRegistry
- FilterRegistryInterface::addFilter() — Method in class FilterRegistryInterface
- ContainsFilter::apply() — Method in class ContainsFilter
- EndsWithFilter::apply() — Method in class EndsWithFilter
- EqualToFilter::apply() — Method in class EqualToFilter
- GreaterThanFilter::apply() — Method in class GreaterThanFilter
- GreaterThanOrEqualFilter::apply() — Method in class GreaterThanOrEqualFilter
- InFilter::apply() — Method in class InFilter
- LessThanFilter::apply() — Method in class LessThanFilter
- LessThanOrEqualFilter::apply() — Method in class LessThanOrEqualFilter
- NotEqualFilter::apply() — Method in class NotEqualFilter
- StartsWithFilter::apply() — Method in class StartsWithFilter
- QueryFilter::apply() — Method in class QueryFilter
- QuerySort::apply() — Method in class QuerySort
- ScalarDBField::apply() — Method in class ScalarDBField
- Argument — Class in namespace SilverStripe\GraphQL\Schema\Field
An abstraction of a field argument
- Argument::applyConfig() — Method in class Argument
- Field::applyConfig() — Method in class Field
- Field::addArg() — Method in class Field
- Field::addResolverContext() — Method in class Field
- Field::addResolverMiddleware() — Method in class Field
- Field::addResolverAfterware() — Method in class Field
- ModelField::applyConfig() — Method in class ModelField
- ConfigurationApplier::applyConfig() — Method in class ConfigurationApplier
- FieldPlugin::apply() — Method in class FieldPlugin
- ModelFieldPlugin::apply() — Method in class ModelFieldPlugin
- ModelMutationPlugin::apply() — Method in class ModelMutationPlugin
- ModelQueryPlugin::apply() — Method in class ModelQueryPlugin
- ModelTypePlugin::apply() — Method in class ModelTypePlugin
- MutationPlugin::apply() — Method in class MutationPlugin
- QueryPlugin::apply() — Method in class QueryPlugin
- SchemaModelCreatorInterface::appliesTo() — Method in class SchemaModelCreatorInterface
- TypePlugin::apply() — Method in class TypePlugin
- Logger::alert() — Method in class Logger
- AbstractQueryFilterPlugin — Class in namespace SilverStripe\GraphQL\Schema\Plugin
Generic plugin that can be used for filter inputs
- AbstractQueryFilterPlugin::apply() — Method in class AbstractQueryFilterPlugin
- AbstractQuerySortPlugin — Class in namespace SilverStripe\GraphQL\Schema\Plugin
Generic plugin that can be used to add sort paramaters to a query
- AbstractQuerySortPlugin::apply() — Method in class AbstractQuerySortPlugin
- PaginationPlugin::apply() — Method in class PaginationPlugin
- PluginConsumer::addPlugin() — Method in class PluginConsumer
- SortPlugin::apply() — Method in class SortPlugin
- EncodedResolver::addContext() — Method in class EncodedResolver
- EncodedResolver::addMiddleware() — Method in class EncodedResolver
- EncodedResolver::addAfterware() — Method in class EncodedResolver
- Schema::applyConfig() — Method in class Schema
Converts a configuration array to instance state.
- Schema::addQuery() — Method in class Schema
- Schema::addMutation() — Method in class Schema
- Schema::addType() — Method in class Schema
- Schema::addEnum() — Method in class Schema
- Schema::addScalar() — Method in class Schema
- Schema::addModel() — Method in class Schema
- Schema::addModelbyClassName() — Method in class Schema
- Schema::addInterface() — Method in class Schema
- Schema::addUnion() — Method in class Schema
- Schema::applyBulkLoader() — Method in class Schema
- Schema::applyBulkLoaders() — Method in class Schema
- Schema::assertValidConfig() — Method in class Schema
- Schema::assertValidName() — Method in class Schema
- AbstractTypeRegistry — Class in namespace SilverStripe\GraphQL\Schema\Storage
- Enum::addValue() — Method in class Enum
- InterfaceType::applyConfig() — Method in class InterfaceType
- ModelType::applyConfig() — Method in class ModelType
- ModelType::addField() — Method in class ModelType
- ModelType::addFields() — Method in class ModelType
- ModelType::addAllFields() — Method in class ModelType
- ModelType::addAllOperations() — Method in class ModelType
- ModelType::applyOperationsConfig() — Method in class ModelType
- ModelType::addOperation() — Method in class ModelType
- Scalar::applyConfig() — Method in class Scalar
- Type::applyConfig() — Method in class Type
- Type::addField() — Method in class Type
- Type::addInterface() — Method in class Type
- UnionType::applyConfig() — Method in class UnionType
- 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 {@link DataQuery} object altered
- DataList::addFilter() — Method in class DataList
Return a new instance of the list with an added filter
- DataList::applyRelation() — Method in class DataList
Given a field or relation name, apply it safely to this datalist.
- DataList::avg() — Method in class DataList
Return the average value of the given field in this DataList
- DataList::addMany() — Method in class DataList
Add a number of items to the component set.
- DataList::add() — Method in class DataList
This method are overloaded by HasManyList and ManyMany list to perform more sophisticated list manipulation
- $ DataObject#api_access — Property in class DataObject
Allow API access to this object?
- DataQuery::avg() — Method in class DataQuery
Return the average value of the given field in this DataList
- DataQuery::aggregate() — Method in class DataQuery
Runs a raw aggregate expression. Please handle escaping yourself
- DataQuery::applyRelationPrefix() — Method in class DataQuery
Prefix of all joined table aliases. E.g. ->filter('Banner.Image.Title)' Will join the Banner, and then Image relations
$relationPrefx
will bebanner_image_
Each table in the Image chain will be suffixed to this prefix. E.g.- DataQuery::applyRelation() — Method in class DataQuery
Traverse the relationship fields, and add the table mappings to the query object state. This has to be called in any overloaded {@link SearchFilter->apply()} methods manually.
- DataQuery::addSelectFromTable() — Method in class DataQuery
Add the given fields from the given table to the select statement.
- DataQueryManipulator::afterGetFinalisedQuery() — Method in class DataQueryManipulator
Invoked after getFinalisedQuery()
- DBComposite::addToQuery() — Method in class DBComposite
Add all columns which are defined through {@link requireField()} and {@link $composite_db}, or any additional SQL that is required to get to these columns. Will mostly just write to the {@link SQLSelect->select} array.
- DBDate::Ago() — Method in class DBDate
Returns the number of seconds/minutes/hours/days or months since the timestamp.
- DBField::addToQuery() — Method in class DBField
Add custom query parameters for this field, mostly SELECT statements for multi-value fields.
- DBField::ATT() — Method in class DBField
Gets the value appropriate for a HTML attribute string
- DBHTMLText::AbsoluteLinks() — Method in class DBHTMLText
Return the value of the field with relative links converted to absolute urls (with placeholders parsed).
- PartialMatchFilter::apply() — Method in class PartialMatchFilter
Apply filter criteria to a SQL query.
- SearchFilter::applyAggregate() — Method in class SearchFilter
Given an escaped HAVING clause, add it along with the appropriate GROUP BY clause
- SearchFilter::apply() — Method in class SearchFilter
Apply filter criteria to a SQL query.
- HasManyList::add() — Method in class HasManyList
Adds the item to this relation.
- Hierarchy::AllChildren() — Method in class Hierarchy
Return all children, including those 'not in menus'.
- Hierarchy::AllChildrenIncludingDeleted() — Method in class Hierarchy
Return all children, including those that have been deleted but are still in live.
- Hierarchy::AllHistoricalChildren() — Method in class Hierarchy
Return all the children that this page had, including pages that were deleted from both stage & live.
- ListDecorator::add() — Method in class ListDecorator
Adds an item to the list, making no guarantees about where it will appear.
- ManyManyList::add() — Method in class ManyManyList
Add an item to this many_many relationship Does so by adding an entry to the joinTable.
- ManyManyThroughList::add() — Method in class ManyManyThroughList
- ManyManyThroughQueryManipulator::afterGetFinalisedQuery() — Method in class ManyManyThroughQueryManipulator
Invoked after getFinalisedQuery()
- PolymorphicHasManyList::add() — Method in class PolymorphicHasManyList
Adds the item to this relation.
- SQLAssignmentRow::addAssignments() — Method in class SQLAssignmentRow
Adds assignments for a list of several fields
- SQLAssignmentRow::assign() — Method in class SQLAssignmentRow
Set the value for a single field
- SQLAssignmentRow::assignSQL() — Method in class SQLAssignmentRow
Assigns a value to a field using the literal SQL expression, rather than a value to be escaped
- SQLConditionalExpression::addFrom() — Method in class SQLConditionalExpression
Add a table to include in the query or update
- SQLConditionalExpression::addLeftJoin() — Method in class SQLConditionalExpression
Add a LEFT JOIN criteria to the tables list.
- SQLConditionalExpression::addInnerJoin() — Method in class SQLConditionalExpression
Add an INNER JOIN criteria
- SQLConditionalExpression::addFilterToJoin() — Method in class SQLConditionalExpression
Add an additional filter (part of the ON clause) on a join.
- SQLConditionalExpression::addWhere() — Method in class SQLConditionalExpression
Adds a WHERE clause.
- SQLConditionalExpression::addWhereAny() — Method in class SQLConditionalExpression
- SQLDelete::addDelete() — Method in class SQLDelete
Sets the list of tables to limit the delete to, if multiple tables are specified in the condition clause
- SQLInsert::addRow() — Method in class SQLInsert
Appends a new row to insert
- SQLInsert::addRows() — Method in class SQLInsert
Adds the list of rows to the array
- SQLInsert::addAssignments() — Method in class SQLInsert
Adds assignments for a list of several fields.
- SQLInsert::assign() — Method in class SQLInsert
Set the value for a single field
- SQLInsert::assignSQL() — Method in class SQLInsert
Assigns a value to a field using the literal SQL expression, rather than a value to be escaped
- SQLSelect::addSelect() — Method in class SQLSelect
Add to the list of columns to be selected by the query.
- SQLSelect::addOrderBy() — Method in class SQLSelect
Add ORDER BY clause either as SQL snippet or in array format.
- SQLSelect::addGroupBy() — Method in class SQLSelect
Add a GROUP BY clause.
- SQLSelect::addHaving() — Method in class SQLSelect
Add a HAVING clause
- SQLSelect::aggregate() — Method in class SQLSelect
Return a new SQLSelect that calls the given aggregate functions on this data.
- SQLUpdate::addAssignments() — Method in class SQLUpdate
Adds assignments for a list of several fields.
- SQLUpdate::assign() — Method in class SQLUpdate
Set the value for a single field
- SQLUpdate::assignSQL() — Method in class SQLUpdate
Assigns a value to a field using the literal SQL expression, rather than a value to be escaped
- SQLWriteExpression::addAssignments() — Method in class SQLWriteExpression
Adds assignments for a list of several fields.
- SQLWriteExpression::assign() — Method in class SQLWriteExpression
Set the value for a single field
- SQLWriteExpression::assignSQL() — Method in class SQLWriteExpression
Assigns a value to a field using the literal SQL expression, rather than a value to be escaped
- SS_List::add() — Method in class SS_List
Adds an item to the list, making no guarantees about where it will appear.
- SearchContext::addFilter() — Method in class SearchContext
Adds a instance of {@link SearchFilter}.
- SearchContext::addField() — Method in class SearchContext
Adds a new {@link FormField} instance.
- UnsavedRelationList::add() — Method in class UnsavedRelationList
Add an item to this relationship
- UnsavedRelationList::addMany() — Method in class UnsavedRelationList
Add a number of items to the relation.
- ValidationResult::addError() — Method in class ValidationResult
Record an error against this validation result,
- ValidationResult::addFieldError() — Method in class ValidationResult
Record an error against this validation result,
- ValidationResult::addMessage() — Method in class ValidationResult
Add a message to this ValidationResult without necessarily marking it as an error
- ValidationResult::addFieldMessage() — Method in class ValidationResult
Add a message to this ValidationResult without necessarily marking it as an error
- ReportWrapper::afterQuery() — Method in class ReportWrapper
Override this method to perform some actions after querying.
- AuthenticationHandler — Class in namespace SilverStripe\Security
An AuthenticationHandler is responsible for providing an identity (in the form of a Member object) for a given HTTPRequest.
- AuthenticationHandler::authenticateRequest() — Method in class AuthenticationHandler
Given the current request, authenticate the request for non-session authorization (outside the CMS).
- AuthenticationMiddleware — Class in namespace SilverStripe\Security
- Authenticator — Class in namespace SilverStripe\Security
Abstract base class for an authentication method
- Authenticator::authenticate() — Method in class Authenticator
Method to authenticate an user.
- Group::AllChildrenIncludingDeleted() — Method in class Group
Returns all of the children for the CMS Tree.
- $ Member#auto_login_token_lifetime — Property in class Member
Default lifetime of auto login token.
- $ Member#AutoLoginHash — Property in class Member
- $ Member#AutoLoginExpired — Property in class Member
- Member::afterMemberLoggedIn() — Method in class Member
Called after a member is logged in via session/cookie/etc
- Member::afterMemberLoggedOut() — Method in class Member
Audit logging hook, called after a member is logged out
- Member::actAs() — Method in class Member
Temporarily act as the specified user, limited to a $callback, but without logging in as that user.
- Member::addToGroupByCode() — Method in class Member
Adds the member to a group. This will create the group if the given group code does not return a valid group object.
- CookieAuthenticationHandler::authenticateRequest() — Method in class CookieAuthenticationHandler
- $ LoginHandler#allowed_actions — Property in class LoginHandler
- $ LostPasswordHandler#allowed_actions — Property in class LostPasswordHandler
Since the logout and dologin actions may be conditionally removed, it's necessary to ensure these remain valid actions regardless of the member login state.
- MemberAuthenticator::authenticate() — Method in class MemberAuthenticator
Method to authenticate an user.
- SessionAuthenticationHandler::authenticateRequest() — Method in class SessionAuthenticationHandler
- Member_GroupSet::add() — Method in class Member_GroupSet
Add an item to this many_many relationship Does so by adding an entry to the joinTable.
- NullSecurityToken::addToUrl() — Method in class NullSecurityToken
- PasswordExpirationMiddleware::allowCurrentRequest() — Method in class PasswordExpirationMiddleware
Allow the current request to be finished without password expiration check
- $ Permission#admin_implies_all — Property in class Permission
Set to false to prevent the 'ADMIN' permission from implying all permissions in the system
- RequestAuthenticationHandler::authenticateRequest() — Method in class RequestAuthenticationHandler
Given the current request, authenticate the request for non-session authorization (outside the CMS).
- $ Security#autologin_enabled — Property in class Security
Showing "Remember me"-checkbox on loginform, and saving encrypted credentials to a cookie.
- SecurityToken::addToUrl() — Method in class SecurityToken
- ArchiveAdmin — Class in namespace SilverStripe\VersionedAdmin
Archive admin is a section of the CMS that displays archived records from versioned objects and allows for users to restore them.
- ArchiveRestoreAction — Class in namespace SilverStripe\VersionedAdmin\Extensions
Adds a restore action to the item edit form of ArchiveAdmin
- ArchiveViewProvider — Class in namespace SilverStripe\VersionedAdmin\Interfaces
A provider of a view for the archive admin
- ChangeSet::addObject() — Method in class ChangeSet
Add a new change to this changeset. Will automatically include all owned changes as those are dependencies of this item.
- $ ChangeSetItem#Added — Property in class ChangeSetItem
- DeleteExtension::augmentMutation() — Method in class DeleteExtension
Hooks into the
augmentMutation
extension point in see Delete::resolve- CopyToStageInputType::attributes() — Method in class CopyToStageInputType
- VersionedInputType::attributes() — Method in class VersionedInputType
- GridFieldArchiveAction::augmentColumns() — Method in class GridFieldArchiveAction
Add a column 'Actions'
- GridFieldRestoreAction::augmentColumns() — Method in class GridFieldRestoreAction
Add a column 'Delete'
- Versioned::augmentDataQueryCreation() — Method in class Versioned
Amend freshly created DataQuery objects with versioned-specific information.
- Versioned::augmentSQL() — Method in class Versioned
Augment the the SQLSelect that is created by the DataQuery
- Versioned::augmentLoadLazyFields() — Method in class Versioned
For lazy loaded fields requiring extra sql manipulation, ie versioning.
- Versioned::augmentDatabase() — Method in class Versioned
Update the database schema as required by this extension.
- Versioned::augmentWrite() — Method in class Versioned
Augment a write-record request.
- Versioned::Author() — Method in class Versioned
Get author of this record.
- VersionedGridFieldState::augmentColumns() — Method in class VersionedGridFieldState
Modify the list of columns displayed in the table.
- ArrayData — Class in namespace SilverStripe\View
Lets you wrap a bunch of array data, or object members, into a {@link ViewableData} object.
- ArrayData::array_to_object() — Method in class ArrayData
Converts an associative array to a simple object
- Requirements::add_i18n_javascript() — Method in class Requirements
Add i18n files from the given javascript directory. SilverStripe expects that the given directory will contain a number of JavaScript files named by language: en_US.js, de_DE.js, etc.
- Requirements_Backend::add_i18n_javascript() — Method in class Requirements_Backend
Add i18n files from the given javascript directory. SilverStripe expects that the given directory will contain a number of JavaScript files named by language: en_US.js, de_DE.js, etc.
- SSTemplateParser::addClosedBlock() — Method in class SSTemplateParser
Add a closed block callable to allow <% name %><% end_name %> syntax
- SSTemplateParser::addOpenBlock() — Method in class SSTemplateParser
Add a closed block callable to allow <% name %> syntax
- SSTemplateParser::Argument_DollarMarkedLookup() — Method in class SSTemplateParser
If we get a bare value, we don't know enough to determine exactly what php would be the translation, because we don't know if the position of use indicates a lookup or a string argument.
- SSTemplateParser::Argument_QuotedString() — Method in class SSTemplateParser
- SSTemplateParser::Argument_Null() — Method in class SSTemplateParser
- SSTemplateParser::Argument_Boolean() — Method in class SSTemplateParser
- SSTemplateParser::Argument_IntegerOrFloat() — Method in class SSTemplateParser
- SSTemplateParser::Argument_Lookup() — Method in class SSTemplateParser
- SSTemplateParser::Argument_FreeString() — Method in class SSTemplateParser
- SSViewer::add_themes() — Method in class SSViewer
Add to the list of active themes to apply
- ThemeResourceLoader::addSet() — Method in class ThemeResourceLoader
Add a new theme manifest for a given identifier. E.g. '$default'
B
- CMSBatchAction::batchaction() — Method in class CMSBatchAction
Helper method for processing batch actions.
- $ CMSBatchActionHandler#batch_actions — Property in class CMSBatchActionHandler
- CMSBatchActionHandler::batchActionList() — Method in class CMSBatchActionHandler
Return a SS_List of ArrayData objects containing the following pieces of info about each batch action:
- Link
- Title
- CMSBatchActionHandler::batchActions() — Method in class CMSBatchActionHandler
Get all registered actions through the static defaults set by {@link register()}.
- CMSProfileController::Breadcrumbs() — Method in class CMSProfileController
Only show first element, as the profile form is limited to editing the current member it doesn't make much sense to show the member name in the breadcrumbs.
- LeftAndMain::Breadcrumbs() — Method in class LeftAndMain
- LeftAndMain::batchactions() — Method in class LeftAndMain
Batch Actions Handler
- LeftAndMain::BatchActionsForm() — Method in class LeftAndMain
- LeftAndMain::BaseCSSClasses() — Method in class LeftAndMain
Same as {@link ViewableData->CSSClasses()}, but with a changed name to avoid problems when using {@link ViewableData->customise()} (which always returns "ArrayData" from the $original object).
- ModelAdmin::Breadcrumbs() — Method in class ModelAdmin
- SecurityAdmin::Backlink() — Method in class SecurityAdmin
Disable GridFieldDetailForm backlinks for this view, as its
- SecurityAdmin::Breadcrumbs() — Method in class SecurityAdmin
- AssetAdmin::breadcrumbs() — Method in class AssetAdmin
- AssetAdmin::baseCSSClasses() — Method in class AssetAdmin
Don't include class namespace in auto-generated CSS class
- $ 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
- CMSMain::Breadcrumbs() — Method in class CMSMain
- CMSMain::batchactions() — Method in class CMSMain
Batch Actions Handler
- CMSMain::BatchActionParameters() — Method in class CMSMain
- CMSMain::BatchActionList() — Method in class CMSMain
Returns a list of batch actions
- CMSPagesController::Breadcrumbs() — Method in class CMSPagesController
- $ SiteTree#base_plural_name — Property in class SiteTree
Plural form for SiteTree / Page classes. Not inherited by subclasses.
- $ SiteTree#base_singular_name — Property in class SiteTree
Plural form for SiteTree / Page classes. Not inherited by subclasses.
- $ SiteTree#base_description — Property in class SiteTree
Description for Page and SiteTree classes, but not inherited by subclasses.
- SiteTree::Breadcrumbs() — Method in class SiteTree
Return a breadcrumb trail to this page. Excludes "hidden" pages (with ShowInMenus=0) by default.
- SiteTree::BackLinkTracking() — Method in class SiteTree
Get the back-link tracking objects that link to this page
- SiteTree::BackLinks() — Method in class SiteTree
List of SiteTreeLink objects attached to this page
- SiteTreeFileExtension::BackLinkHTMLList() — Method in class SiteTreeFileExtension
Generate an HTML list which provides links to where a file is used.
- BrokenFilesReport — Class in namespace SilverStripe\CMS\Reports
- BrokenLinksReport — Class in namespace SilverStripe\CMS\Reports
Content side-report listing pages with broken links
- BrokenRedirectorPagesReport — Class in namespace SilverStripe\CMS\Reports
- BrokenVirtualPagesReport — Class in namespace SilverStripe\CMS\Reports
- Director::baseURL() — Method in class Director
Return the root-relative url for the baseurl
- Director::baseFolder() — Method in class Director
Returns the root filesystem folder for the site. It will be automatically calculated unless it is overridden with {@link setBaseFolder()}.
- $ 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
- Bypass — Class in namespace SilverStripe\Control\Middleware\ConfirmationMiddleware
A bypass for manual confirmation by user (depending on some runtime conditions)
- URLSpecialsMiddleware::buildImpactRedirect() — Method in class URLSpecialsMiddleware
Looks up for the special flags passed in the request and schedules the changes accordingly for the next request.
- ClassInfo::baseDataClass() — Method in class ClassInfo
- CoreConfigFactory::buildStaticTransformer() — Method in class CoreConfigFactory
- CoreConfigFactory::buildYamlTransformerForPath() — Method in class CoreConfigFactory
- Convert::base64url_encode() — Method in class Convert
Encode a value into a string that can be used as part of a filename.
- Convert::base64url_decode() — Method in class Convert
Decode a value that was encoded with Convert::base64url_encode.
- Convert::bytes2memstring() — Method in class Convert
- CoreKernel::boot() — Method in class CoreKernel
- $ AopProxyService#beforeCall — Property in class AopProxyService
- BeforeCallAspect — Class in namespace SilverStripe\Core\Injector
A BeforeCallAspect is run before a method is executed.
- BeforeCallAspect::beforeCall() — Method in class BeforeCallAspect
Call this aspect before a method is executed
- Kernel::boot() — Method in class Kernel
- ClassManifestVisitor::beforeTraverse() — Method in class ClassManifestVisitor
- Backtrace — Class in namespace SilverStripe\Dev
Backtrace helper
- Backtrace::backtrace() — Method in class Backtrace
Render or return a backtrace from the given scope.
- BehatFixtureFactory — Class in namespace SilverStripe\Dev
- BuildTask — Class in namespace SilverStripe\Dev
Interface for a generic build task. Does not support dependencies. This will simply run a chunk of code when called.
- BulkLoader — Class in namespace SilverStripe\Dev
A base for bulk loaders of content into the SilverStripe database.
- BulkLoader_Result — Class in namespace SilverStripe\Dev
Encapsulates the result of a {@link BulkLoader} import (usually through the {@link BulkLoader->processAll()} method).
- DebugView::Breadcrumbs() — Method in class DebugView
Generate breadcrumb links to the URL path being displayed
- DevBuildController::build() — Method in class DevBuildController
- DevelopmentAdmin::buildDefaults() — Method in class DevelopmentAdmin
Build the default data, calling requireDefaultRecords on all DataObject classes Should match the $url_handlers rule: 'build/defaults' => 'buildDefaults',
- SapphireInfo::BaseURL() — Method in class SapphireInfo
- FormRequestHandler::buttonClicked() — Method in class FormRequestHandler
Get instance of button which was clicked for this request
- GridFieldDetailForm_ItemRequest::Breadcrumbs() — Method in class GridFieldDetailForm_ItemRequest
CMS-specific functionality: Passes through navigation breadcrumbs to the template, and includes the currently edited record (if any).
- $ TinyMCEConfig#base_dir — Property in class TinyMCEConfig
Location of module relative to BASE_DIR. This must contain the following dirs
- plugins
- themes
- skins
- BasicAuthAuthenticator — Class in namespace SilverStripe\GraphQL\Auth
An authenticator using SilverStripe's BasicAuth
- Build — Class in namespace SilverStripe\GraphQL\Dev
- Build::build() — Method in class Build
- Build::buildSchema() — Method in class Build
- BulkLoaderSet — Class in namespace SilverStripe\GraphQL\Schema\BulkLoader
Composed with a list of bulk loaders to be executed in serial and return the aggregate result of all their collect() calls
- DBFieldArgs::baseFormatResolver() — Method in class DBFieldArgs
- Resolver::baseResolve() — Method in class Resolver
Just the basic ViewableData field accessor bit, without all the property mapping overhead. Useful for custom dataobject types that circumvent the model layer.
- BaseFieldsProvider — Class in namespace SilverStripe\GraphQL\Schema\Interfaces
Defines a model that provides required fields for all the types it creates
- SchemaBuilder::build() — Method in class SchemaBuilder
Stores a schema and fetches the graphql-php instance
- SchemaBuilder::buildByName() — Method in class SchemaBuilder
Boots a schema, persists it, and fetches it
- SchemaBuilder::boot() — Method in class SchemaBuilder
Auto-discovers the schema based on the provided schema key in Silverstripe's configuration layer. Merges the global schema with specifics for this schema key.
- NestedInputBuilder::buildPathsFromArgs() — Method in class NestedInputBuilder
Public API that can be used by a resolver to flatten the input argument into dot.separated.paths that can be normalised
- AbstractTypeRegistry::Boolean() — Method in class AbstractTypeRegistry
- ModelType::buildOperations() — Method in class ModelType
- ArrayList::byIDs() — Method in class ArrayList
Filter this list to only contain the given Primary IDs
- ArrayList::byID() — Method in class ArrayList
Return the first item with the given ID
- DBQueryBuilder::buildSQL() — Method in class DBQueryBuilder
Builds a sql query with the specified connection
- DBQueryBuilder::buildDeleteFragment() — Method in class DBQueryBuilder
Return the DELETE clause ready for inserting into a query.
- DBQueryBuilder::buildUpdateFragment() — Method in class DBQueryBuilder
Return the UPDATE clause ready for inserting into a query.
- DBQueryBuilder::buildFromFragment() — Method in class DBQueryBuilder
Return the FROM clause ready for inserting into a query.
- DBQueryBuilder::buildWhereFragment() — Method in class DBQueryBuilder
Returns the WHERE clauses ready for inserting into a query.
- DBQueryBuilder::buildOrderByFragment() — Method in class DBQueryBuilder
Returns the ORDER BY clauses ready for inserting into a query.
- DBQueryBuilder::buildGroupByFragment() — Method in class DBQueryBuilder
Returns the GROUP BY clauses ready for inserting into a query.
- DBQueryBuilder::buildHavingFragment() — Method in class DBQueryBuilder
Returns the HAVING clauses ready for inserting into a query.
- DBQueryBuilder::buildLimitFragment() — Method in class DBQueryBuilder
Return the LIMIT clause ready for inserting into a query.
- DBSchemaManager::boolean() — Method in class DBSchemaManager
Returns data type for 'boolean' column
- MySQLQueryBuilder::buildLimitFragment() — Method in class MySQLQueryBuilder
Return the LIMIT clause ready for inserting into a query.
- MySQLSchemaManager::boolean() — Method in class MySQLSchemaManager
Return a boolean type-formatted string
- MySQLSchemaManager::bigint() — Method in class MySQLSchemaManager
Return a bigint type-formatted string
- MySQLiConnector::bindParameters() — Method in class MySQLiConnector
Binds a list of parameters to a statement
- PDOConnector::bindParameters() — Method in class PDOConnector
Bind all parameters to a PDOStatement
- TempDatabase::build() — Method in class TempDatabase
Create temp DB without creating extra objects
- DB::build_sql() — Method in class DB
Builds a sql query with the specified connection
- DataList::byIDs() — Method in class DataList
Filter this list to only contain the given Primary IDs
- DataList::byID() — Method in class DataList
Return the first DataObject with the given ID
- $ DataObject#belongs_to — Property in class DataObject
A meta-relationship that allows you to define the reverse side of a {@link DataObject::$has_one}.
- $ DataObject#belongs_many_many — Property in class DataObject
The inverse side of a many-many relationship.
- DataObject::belongsTo() — Method in class DataObject
Returns the class of a remote belongs_to relationship. If no component is specified a map of all components and their class name will be returned.
- DataObject::baseTable() — Method in class DataObject
Get the name of the base table for this object
- DataObject::baseClass() — Method in class DataObject
Get the base class for this object
- DataObjectSchema::baseDataClass() — Method in class DataObjectSchema
Returns the root class (the first to extend from DataObject) for the passed class.
- DataObjectSchema::baseDataTable() — Method in class DataObjectSchema
Get the base table
- DataObjectSchema::belongsToComponent() — Method in class DataObjectSchema
Return data for a specific belongs_to component.
- DataQueryManipulator::beforeGetFinalisedQuery() — Method in class DataQueryManipulator
Invoked prior to getFinalisedQuery()
- DatabaseAdmin::build() — Method in class DatabaseAdmin
Updates the database schema, creating tables & fields as necessary.
- DatabaseAdmin::buildDefaults() — Method in class DatabaseAdmin
Build the default data, calling requireDefaultRecords on all DataObject classes
- DBComposite::bindTo() — Method in class DBComposite
Bind this field to the dataobject, and set the underlying table to that of the owner
- Filterable::byID() — Method in class Filterable
Return the first item with the given ID
- Filterable::byIDs() — Method in class Filterable
Filter this list to only contain the given Primary IDs
- 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()
- ReportAdmin::Breadcrumbs() — Method in class ReportAdmin
Returns the Breadcrumbs for the ReportAdmin
- ReportWrapper::beforeQuery() — Method in class ReportWrapper
Override this method to perform some actions prior to querying.
- BasicAuth — Class in namespace SilverStripe\Security
Provides an interface to HTTP basic authentication.
- BasicAuthMiddleware — Class in namespace SilverStripe\Security
- Member::beforeMemberLoggedIn() — Method in class Member
Called before a member is logged in via session/cookie/etc
- Member::beforeMemberLoggedOut() — Method in class Member
Audit logging hook, called before a member is logged out
- Security::basicauthlogin() — Method in class Security
- SiteConfigLeftAndMain::Breadcrumbs() — Method in class SiteConfigLeftAndMain
- ArchiveAdmin::Breadcrumbs() — Method in class ArchiveAdmin
Use 'Archives' as the top title rather than the model title
- BlockArchiveExtension — Class in namespace SilverStripe\VersionedAdmin\Extensions
Adds a archive view for Elemental blocks
- VersionedGridFieldItemRequest::Breadcrumbs() — Method in class VersionedGridFieldItemRequest
- Requirements::backend() — Method in class Requirements
- Requirements::block() — Method in class Requirements
Block inclusion of a specific file
- Requirements_Backend::block() — Method in class Requirements_Backend
Block inclusion of a specific file
- $ i18nTextCollector#basePath — Property in class i18nTextCollector
The directory base on which the collector should act.
- $ i18nTextCollector#baseSavePath — Property in class i18nTextCollector
Save path
C
- 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
- CMSMenu — Class in namespace SilverStripe\Admin
The object manages the main CMS menu. See {@link LeftAndMain::init()} for example usage.
- CMSMenu::clear_menu() — Method in class CMSMenu
Clears the entire menu
- CMSMenuItem — Class in namespace SilverStripe\Admin
A simple CMS menu item.
- $ CMSMenuItem#controller — Property in class CMSMenuItem
Parent controller class name
- CMSProfileController — Class in namespace SilverStripe\Admin
- CMSProfileController::canView() — Method in class CMSProfileController
- LeftAndMain::canView() — Method in class LeftAndMain
- LeftAndMain::Content() — Method in class LeftAndMain
- LeftAndMain::currentPageID() — Method in class LeftAndMain
Identifier for the currently shown record, in most cases a database ID. Inspects the following sources (in this order):
- GET/POST parameter named 'ID'
- URL parameter named 'ID'
- Session value namespaced by classname, e.g. "CMSMain.currentPage"
- LeftAndMain::currentPage() — Method in class LeftAndMain
Uses {@link getRecord()} and {@link currentPageID()} to get the currently selected record.
- LeftAndMain::CMSVersion() — Method in class LeftAndMain
Return the version number of this application, ie. 'CMS: 4.2.1'
- LeftAndMain::CMSVersionNumber() — Method in class LeftAndMain
Return the version number of the CMS, ie. '4.2.1'
- 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
- TestAssetStore::cleanFilename() — Method in class TestAssetStore
- $ File#class_for_file_extension — Property in class File
Map of file extensions to class type
- $ File#Content — Property in class File
- File::canView() — Method in class File
- File::canEdit() — Method in class File
Check if this file can be modified
- File::canCreate() — Method in class File
Check if a file can be created
- File::canDelete() — Method in class File
Check if this file can be deleted
- File::collateDescendants() — Method in class File
Collate selected descendants of this page.
- File::copyFile() — Method in class File
Copy to new filename.
- File::canViewFile() — Method in class File
Check if the current user can view the given file.
- File::CMSEditLink() — Method in class File
- FileDefaultPermissions::canEdit() — Method in class FileDefaultPermissions
Can root be edited?
- FileDefaultPermissions::canView() — Method in class FileDefaultPermissions
Can root be viewed?
- FileDefaultPermissions::canDelete() — Method in class FileDefaultPermissions
Can root be deleted?
- FileDefaultPermissions::canCreate() — Method in class FileDefaultPermissions
Can root objects be created?
- FlysystemAssetStore::copy() — Method in class FlysystemAssetStore
Copy a file (and all variants) to a new filename
- FlysystemAssetStore::canView() — Method in class FlysystemAssetStore
Check if the current user can view the given file.
- Folder::ChildFolders() — Method in class Folder
Get the children of this folder that are also folders.
- ImageBackendFactory::create() — Method in class ImageBackendFactory
Creates a new service instance.
- $ ImageManipulation#cms_thumbnail_width — Property in class ImageManipulation
The width of an image thumbnail in the CMS.
- $ ImageManipulation#cms_thumbnail_height — Property in class ImageManipulation
The height of an image thumbnail in the CMS.
- ImageManipulation::CropWidth() — Method in class ImageManipulation
Crop image on X axis if it exceeds specified width. Retain height.
- ImageManipulation::CropHeight() — Method in class ImageManipulation
Crop image on Y axis if it exceeds specified height. Retain width.
- ImageManipulation::CMSThumbnail() — Method in class ImageManipulation
Default CMS thumbnail
- Image_Backend::croppedResize() — Method in class Image_Backend
Resize an image to cover the given width/height completely, and crop off any overhanging edges.
- Image_Backend::crop() — Method in class Image_Backend
Crop's part of image.
- InterventionBackend::croppedResize() — Method in class InterventionBackend
Resize an image to cover the given width/height completely, and crop off any overhanging edges.
- InterventionBackend::crop() — Method in class InterventionBackend
Crop's part of image.
- AssetContainer::copyFile() — Method in class AssetContainer
Copy to new filename.
- AssetContainer::canViewFile() — Method in class AssetContainer
Check if the current user can view the given file.
- AssetStore::copy() — Method in class AssetStore
Copy a file (and all variants) to a new filename
- AssetStore::canView() — Method in class AssetStore
Check if the current user can view the given file.
- DBFile::canViewFile() — Method in class DBFile
Check if the current user can view the given file.
- DBFile::copyFile() — Method in class DBFile
Copy to new filename.
- DefaultAssetNameGenerator::current() — Method in class DefaultAssetNameGenerator
- 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
- CMSBatchAction_Archive — Class in namespace SilverStripe\CMS\BatchActions
Delete items batch action.
- CMSBatchAction_Publish — Class in namespace SilverStripe\CMS\BatchActions
Publish items batch action.
- CMSBatchAction_Restore — Class in namespace SilverStripe\CMS\BatchActions
Batch restore of pages
- CMSBatchAction_Unpublish — Class in namespace SilverStripe\CMS\BatchActions
Unpublish items batch action.
- CMSMain — Class in namespace SilverStripe\CMS\Controllers
The main "content" area of the CMS.
- CMSMain::clearCache() — Method in class CMSMain
Clears all dependent cache backends
- CMSMain::CanOrganiseSitetree() — Method in class CMSMain
Whether the current member has the permission to reorganise SiteTree objects.
- CMSMain::childfilter() — Method in class CMSMain
Callback to request the list of page types allowed under a given page instance.
- CMSMain::currentPageID() — Method in class CMSMain
Identifier for the currently shown record, in most cases a database ID. Inspects the following sources (in this order):
- GET/POST parameter named 'ID'
- URL parameter named 'ID'
- Session value namespaced by classname, e.g. "CMSMain.currentPage"
- CMSPageAddController — Class in namespace SilverStripe\CMS\Controllers
- CMSPageEditController — Class in namespace SilverStripe\CMS\Controllers
- CMSPageSettingsController — Class in namespace SilverStripe\CMS\Controllers
- CMSPagesController — Class in namespace SilverStripe\CMS\Controllers
- CMSSiteTreeFilter — Class in namespace SilverStripe\CMS\Controllers
Base class for filtering the subtree for certain node statuses.
- CMSSiteTreeFilter_ChangedPages — Class in namespace SilverStripe\CMS\Controllers
Gets all pages which have changed on stage.
- CMSSiteTreeFilter_DeletedPages — Class in namespace SilverStripe\CMS\Controllers
Works a bit different than the other filters: Shows all pages including those deleted from stage and live.
- CMSSiteTreeFilter_PublishedPages — Class in namespace SilverStripe\CMS\Controllers
This filter will display the SiteTree as a site visitor might see the site, i.e only the pages that is currently published.
- CMSSiteTreeFilter_Search — Class in namespace SilverStripe\CMS\Controllers
- CMSSiteTreeFilter_StatusDeletedPages — Class in namespace SilverStripe\CMS\Controllers
Filters pages which have a status "Deleted".
- CMSSiteTreeFilter_StatusDraftPages — Class in namespace SilverStripe\CMS\Controllers
Filters pages which have a status "Draft".
- CMSSiteTreeFilter_StatusRemovedFromDraftPages — Class in namespace SilverStripe\CMS\Controllers
Filters pages which have a status "Removed from Draft".
- ContentController — Class in namespace SilverStripe\CMS\Controllers
The most common kind of controller; effectively a controller linked to a {@link DataObject}.
- ContentController::ChildrenOf() — Method in class ContentController
Return the children of a given page. The parent reference can either be a page link or an ID.
- ContentController::ContentLocale() — Method in class ContentController
Returns an RFC1766 compliant locale string, e.g. 'fr-CA'.
- ModelAsController::controller_for() — Method in class ModelAsController
Get the appropriate {@link ContentController} for handling a {@link SiteTree} object, link it to the object and return it.
- SilverStripeNavigatorItem::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.
- 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.
- $ SiteTree#can_be_root — Property in class SiteTree
Controls whether a page can be in the root of the site tree.
- $ SiteTree#controller_name — Property in class SiteTree
You can define the class of the controller that maps to your SiteTree object here if you don't want to rely on the magic of appending Controller to the Classname
- $ SiteTree#can_create — Property in class SiteTree
If this is false, the class cannot be created in the CMS by regular content authors, only by ADMINs.
- $ SiteTree#create_default_pages — Property in class SiteTree
- $ SiteTree#Content — Property in class SiteTree
HTML content of the page.
- SiteTree::CMSEditLink() — Method in class SiteTree
Generates a link to edit this page in the CMS.
- SiteTree::can() — Method in class SiteTree
This function should return true if the current user can execute this action. It can be overloaded to customise the security model for an application.
- SiteTree::canAddChildren() — Method in class SiteTree
This function should return true if the current user can add children to this page. It can be overloaded to customise the security model for an application.
- SiteTree::canView() — Method in class SiteTree
This function should return true if the current user can view this page. It can be overloaded to customise the security model for an application.
- SiteTree::canPublish() — Method in class SiteTree
Check if this page can be published
- SiteTree::canDelete() — Method in class SiteTree
This function should return true if the current user can delete this page. It can be overloaded to customise the security model for an application.
- SiteTree::canCreate() — Method in class SiteTree
This function should return true if the current user can create new pages of this class, regardless of class. It can be overloaded to customise the security model for an application.
- SiteTree::canEdit() — Method in class SiteTree
This function should return true if the current user can edit this page. It can be overloaded to customise the security model for an application.
- SiteTree::collateDescendants() — Method in class SiteTree
Collate selected descendants of this page.
- SiteTree::ContentSource() — Method in class SiteTree
Returns the object that contains the content that a user would associate with this page.
- SiteTree::creatableChildren() — Method in class SiteTree
- SiteTree::creatableChildPages() — Method in class SiteTree
Gets a list of the page types that can be created under this specific page, including font icons
- SiteTree::CMSTreeClasses() — Method in class SiteTree
Return the CSS classes to apply to this node in the CMS tree.
- SiteTree::classDescription() — Method in class SiteTree
Get description for this page type
- SiteTreeExtension::canAddChildren() — Method in class SiteTreeExtension
Hook called to determine if a user may add children to this SiteTree object
- SiteTreeExtension::canPublish() — Method in class SiteTreeExtension
Hook called to determine if a user may publish this SiteTree object
- $ VirtualPage#CopyContentFromID — Property in class VirtualPage
- VirtualPage::ContentSource() — Method in class VirtualPage
- VirtualPage::canPublish() — Method in class VirtualPage
We can only publish the page if there is a published source page
- VirtualPage::CMSTreeClasses() — Method in class VirtualPage
- VirtualPage::castingHelper() — Method in class VirtualPage
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.
- VirtualPage::CopyContentFrom() — Method in class VirtualPage
- BrokenFilesReport::columns() — Method in class BrokenFilesReport
- BrokenLinksReport::columns() — Method in class BrokenLinksReport
- BrokenRedirectorPagesReport::columns() — Method in class BrokenRedirectorPagesReport
- BrokenVirtualPagesReport::columns() — Method in class BrokenVirtualPagesReport
- EmptyPagesReport::columns() — Method in class EmptyPagesReport
- RecentlyEditedReport::columns() — Method in class RecentlyEditedReport
- ContentControllerSearchExtension — Class in namespace SilverStripe\CMS\Search
Extension to provide a search interface when applied to ContentController
- SearchForm::classesToSearch() — Method in class SearchForm
Set the classes to search.
- CampaignAdmin — Class in namespace SilverStripe\CampaignAdmin
Campaign section of the CMS
- CampaignAdmin::campaignEditForm() — Method in class CampaignAdmin
Url handler for edit form
- CampaignAdmin::campaignCreateForm() — Method in class CampaignAdmin
Url handler for create form
- CampaignAdminExtension — Class in namespace SilverStripe\CampaignAdmin
- CampaignAdminList — Class in namespace SilverStripe\CampaignAdmin
Warning: Volatile API as placeholder for standard "GridField"
- CachedConfigCollection — Class in namespace SilverStripe\Config\Collections
- CachedConfigCollection::create() — Method in class CachedConfigCollection
- ConfigCollectionInterface — Class in namespace SilverStripe\Config\Collections
This represents a collection of config keys and values.
- DeltaConfigCollection::createFromCollection() — Method in class DeltaConfigCollection
Create a delta collection from a parent collection
- MemoryConfigCollection::create() — Method in class MemoryConfigCollection
- YamlTransformer::create() — Method in class YamlTransformer
- CLIRequestBuilder — Class in namespace SilverStripe\Control
CLI specific request building logic
- CLIRequestBuilder::cleanEnvironment() — Method in class CLIRequestBuilder
Clean up HTTP global vars for $_GET / $_REQUEST prior to bootstrapping
- CLIRequestBuilder::createFromVariables() — Method in class CLIRequestBuilder
- CliController — Class in namespace SilverStripe\Control
Base class invoked from CLI rather than the webserver (Cron jobs, handling email bounces).
- ContentNegotiator — Class in namespace SilverStripe\Control
The content negotiator performs "text/html" or "application/xhtml+xml" switching. It does this through the public static function ContentNegotiator::process(). By default, ContentNegotiator will comply to the Accept headers the clients sends along with the HTTP request, which is most likely "application/xhtml+xml" (see "Order of selection" below).
- $ ContentNegotiator#content_type — Property in class ContentNegotiator
- Controller — Class in namespace SilverStripe\Control
Controllers are the cornerstone of all site functionality in SilverStripe. The {@link Director} selects a controller to pass control to, and then calls {@link handleRequest()}. This method will execute the appropriate action - either by calling the action method, or displaying the action's template.
- Controller::curr() — Method in class Controller
Returns the current controller.
- Controller::can() — Method in class Controller
Returns true if the member is allowed to do the given action. Defaults to the currently logged in user.
- Cookie — Class in namespace SilverStripe\Control
A set of static methods for manipulating cookies.
- CookieJar — Class in namespace SilverStripe\Control
A default backend for the setting and getting of cookies
- Cookie_Backend — Class in namespace SilverStripe\Control
The Cookie_Backend interface for use with
Cookie::$inst
.- $ Email#cc_all_emails_to — Property in class Email
- $ HTTP#cache_ajax_requests — Property in class HTTP
- $ HTTP#cache_control — Property in class HTTP
List of names to add to the Cache-Control header.
- HTTPRequestBuilder::createFromEnvironment() — Method in class HTTPRequestBuilder
Create HTTPRequest instance from the current environment variables.
- HTTPRequestBuilder::createFromVariables() — Method in class HTTPRequestBuilder
Build HTTPRequest from given variables
- HTTPRequestBuilder::cleanEnvironment() — Method in class HTTPRequestBuilder
Clean up HTTP global vars for $_GET / $_REQUEST prior to bootstrapping
- IPUtils::checkIP() — Method in class IPUtils
Checks if an IPv4 or IPv6 address is contained in the list of given IPs or subnets.
- IPUtils::checkIP4() — Method in class IPUtils
Compares two IPv4 addresses.
- IPUtils::checkIP6() — Method in class IPUtils
Compares two IPv6 addresses.
- CanonicalURLMiddleware — Class in namespace SilverStripe\Control\Middleware
Implements the following URL normalisation rules
- redirect basic auth requests to HTTPS
- force WWW, redirect to the subdomain "www."
- force SSL, redirect to https
- ChangeDetectionMiddleware — Class in namespace SilverStripe\Control\Middleware
Handles internal change detection via etag / ifmodifiedsince headers, conditionally sending a 304 not modified if possible.
- ConfirmationMiddleware — Class in namespace SilverStripe\Control\Middleware
Checks whether user manual confirmation is required for HTTPRequest depending on the rules given.
- ConfirmationMiddleware::canBypass() — Method in class ConfirmationMiddleware
Check whether the rules can be bypassed without user confirmation
- AjaxBypass::checkRequestForBypass() — Method in class AjaxBypass
Returns true for AJAX requests
- Bypass::checkRequestForBypass() — Method in class Bypass
Check the request for whether we can bypass the confirmation
- CliBypass — Class in namespace SilverStripe\Control\Middleware\ConfirmationMiddleware
Allows a bypass when the request has been run in CLI mode
- CliBypass::checkRequestForBypass() — Method in class CliBypass
Returns true if the current process is running in CLI mode
- EnvironmentBypass::checkRequestForBypass() — Method in class EnvironmentBypass
Checks whether the current environment type in the list of allowed ones
- GetParameter::checkRequestForBypass() — Method in class GetParameter
Check the request for whether we can bypass the confirmation
- HttpMethodBypass::checkRequestForBypass() — Method in class HttpMethodBypass
Returns true if the current process is running in CLI mode
- Url::checkRequestForBypass() — Method in class Url
Check the request for whether we can bypass the confirmation
- Url::checkRequest() — Method in class Url
Match the request against the rules
- UrlPathStartswith::checkRequestForBypass() — Method in class UrlPathStartswith
Check the request for whether we can bypass the confirmation
- RequestHandler::checkAccessAction() — Method in class RequestHandler
Check that the given action is allowed to be called from a URL.
- $ Session#cookie_domain — Property in class Session
- $ Session#cookie_path — Property in class Session
- $ Session#cookie_secure — Property in class Session
- $ Session#cookie_name_secure — Property in class Session
- Session::clear() — Method in class Session
Clear session value
- Session::clearAll() — Method in class Session
Clear all values
- Session::changedData() — Method in class Session
Returns the list of changed keys
- ApcuCacheFactory::create() — Method in class ApcuCacheFactory
- CacheFactory — Class in namespace SilverStripe\Core\Cache
- CacheFactory::create() — Method in class CacheFactory
Note: While the returned object is used as a singleton (by the originating Injector->get() call), this cache object shouldn't be a singleton itself - it has varying constructor args for the same service name.
- DefaultCacheFactory::create() — Method in class DefaultCacheFactory
- FilesystemCacheFactory::create() — Method in class FilesystemCacheFactory
- ManifestCacheFactory::create() — Method in class ManifestCacheFactory
Note: While the returned object is used as a singleton (by the originating Injector->get() call), this cache object shouldn't be a singleton itself - it has varying constructor args for the same service name.
- ManifestCacheFactory::createCache() — Method in class ManifestCacheFactory
Create cache directly without config / injector
- MemcachedCacheFactory::create() — Method in class MemcachedCacheFactory
- RateLimiter::clearAttempts() — Method in class RateLimiter
- RateLimiter::canAccess() — Method in class RateLimiter
- ClassInfo — Class in namespace SilverStripe\Core
Provides introspection information about the class tree.
- ClassInfo::class_name() — Method in class ClassInfo
Convert a class name in any case and return it as it was defined in PHP
- ClassInfo::classImplements() — Method in class ClassInfo
Returns true if the given class implements the given interface
- ClassInfo::classes_for_file() — Method in class ClassInfo
Get all classes contained in a file.
- ClassInfo::classes_for_folder() — Method in class ClassInfo
Returns all classes contained in a certain folder.
- Config — Class in namespace SilverStripe\Core\Config
- ConfigLoader — Class in namespace SilverStripe\Core\Config
Registers config sources via ConfigCollectionInterface
- ConfigLoader::countManifests() — Method in class ConfigLoader
Check number of manifests
- Config_ForClass — Class in namespace SilverStripe\Core\Config
- Configurable — Class in namespace SilverStripe\Core\Config
Provides extensions to this object to integrate it with standard config API methods.
- Configurable::config() — Method in class Configurable
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
- CoreConfigFactory — Class in namespace SilverStripe\Core\Config
Factory for silverstripe configs
- CoreConfigFactory::createRoot() — Method in class CoreConfigFactory
Create root application config.
- CoreConfigFactory::createCore() — Method in class CoreConfigFactory
Rebuild new uncached config, which is mutable
- Convert — Class in namespace SilverStripe\Core
Library of conversion functions, implemented as static methods.
- CoreKernel — Class in namespace SilverStripe\Core
Simple Kernel container
- CustomMethods — Class in namespace SilverStripe\Core
Allows an object to declare a set of custom methods
- Extension::clearOwner() — Method in class Extension
Clear the current owner, and restore extension to the state prior to the last setOwner()
- Factory::create() — Method in class Factory
Creates a new service instance.
- Injectable::create() — Method in class Injectable
An implementation of the factory method, allows you to create an instance of a class
- InjectionCreator::create() — Method in class InjectionCreator
Creates a new service instance.
- Injector::convertServiceProperty() — Method in class Injector
Recursively convert a value into its proper representation with service references resolved to actual objects
- Injector::create() — Method in class Injector
Similar to get() but always returns a new object of the given type
- Injector::createWithArgs() — Method in class Injector
Creates an object with the supplied argument array
- InjectorLoader::countManifests() — Method in class InjectorLoader
Check number of manifests
- ClassContentRemover — Class in namespace SilverStripe\Core\Manifest
Class ClassContentRemover
- ClassLoader — Class in namespace SilverStripe\Core\Manifest
A class that handles loading classes and interfaces from a class manifest instance.
- ClassLoader::classExists() — Method in class ClassLoader
Returns true if a class or interface name exists in the manifest.
- ClassManifest — Class in namespace SilverStripe\Core\Manifest
A utility class which builds a manifest of all classes, interfaces and caches it.
- ClassManifestErrorHandler — Class in namespace SilverStripe\Core\Manifest
Error handler which throws, but retains the original path context.
- ClassManifestVisitor — Class in namespace SilverStripe\Core\Manifest
- ModuleLoader::countManifests() — Method in class ModuleLoader
Check number of manifests
- CallbackFlushDiscoverer — Class in namespace SilverStripe\Core\Startup
Handle a callable object as a discoverer
- CompositeFlushDiscoverer — Class in namespace SilverStripe\Core\Startup
Implements the composite over flush discoverers
- BehatFixtureFactory::createObject() — Method in class BehatFixtureFactory
Writes the fixture into the database using DataObjects
- $ BulkLoader#columnMap — Property in class BulkLoader
Map columns to DataObject-properties.
- BulkLoader_Result::Count() — Method in class BulkLoader_Result
Returns the count of all objects which were created or updated.
- BulkLoader_Result::CreatedCount() — Method in class BulkLoader_Result
- BulkLoader_Result::Created() — Method in class BulkLoader_Result
Returns all created objects. Each object might contain specific importer feedback in the "_BulkLoaderMessage" property.
- CLI — Class in namespace SilverStripe\Dev
Class to facilitate command-line output.
- CSSContentParser — Class in namespace SilverStripe\Dev
CSSContentParser enables parsing & assertion running of HTML content via CSS selectors.
- CSVParser — Class in namespace SilverStripe\Dev
Class to handle parsing of CSV files, where the column headers are in the first row.
- CSVParser::current() — Method in class CSVParser
- CliDebugView — Class in namespace SilverStripe\Dev
A basic HTML wrapper for stylish rendering of a developement info view.
- CsvBulkLoader — Class in namespace SilverStripe\Dev
Utility class to facilitate complex CSV-imports by defining column-mappings and custom converters.
- Debug::caller() — Method in class Debug
Returns the caller for a specific method
- Debug::create_debug_view() — Method in class Debug
Create an instance of an appropriate DebugView object.
- $ DebugView#columns — Property in class DebugView
Column size to wrap long strings to
- FixtureBlueprint::createObject() — Method in class FixtureBlueprint
- FixtureFactory::createObject() — Method in class FixtureFactory
Writes the fixture into the database using DataObjects
- FixtureFactory::createRaw() — Method in class FixtureFactory
Writes the fixture into the database directly using a database manipulation.
- FixtureFactory::clear() — Method in class FixtureFactory
Remove all fixtures previously defined through {@link createObject()} or {@link createRaw()}, both from the internal fixture mapping and the database.
- FunctionalTest::content() — Method in class FunctionalTest
Return the most recent content
- FunctionalTest::cssParser() — Method in class FunctionalTest
Return a CSSContentParser for the most recent content.
- MySQLDatabaseConfigurationHelper::checkValidDatabaseName() — Method in class MySQLDatabaseConfigurationHelper
Determines if a given database name is a valid Silverstripe name.
- MySQLDatabaseConfigurationHelper::checkDatabasePermissionGrant() — Method in class MySQLDatabaseConfigurationHelper
Checks if a specified grant proves that the current user has the specified permission on the specified database
- MySQLDatabaseConfigurationHelper::checkDatabasePermission() — Method in class MySQLDatabaseConfigurationHelper
Checks if the current user has the specified permission on the specified database
- SapphireTest::clearFixtures() — Method in class SapphireTest
Clear all fixtures which were previously loaded through {@link loadFixture()}
- SapphireTest::clearEmails() — Method in class SapphireTest
Clear the log of emails sent
- CleanupTestDatabasesTask — Class in namespace SilverStripe\Dev\Tasks
Cleans up leftover databases from aborted test executions (starting with ss_tmpdb) Task is restricted to users with administrator rights or running through CLI.
- TestMailer::clearEmails() — Method in class TestMailer
Clear the log of emails sent
- TestSession::cssParser() — Method in class TestSession
Return a CSSContentParser containing the most recent response
- ErrorPageExtension::canAddChildren() — Method in class ErrorPageExtension
- ErrorPageExtension::createErrorCodeField() — Method in class ErrorPageExtension
- CheckboxField — Class in namespace SilverStripe\Forms
Single checkbox field.
- CheckboxField_Readonly — Class in namespace SilverStripe\Forms
Readonly version of a checkbox field - "Yes" or "No".
- CheckboxSetField — Class in namespace SilverStripe\Forms
Displays a set of checkboxes as a logical group.
- CompositeField — Class in namespace SilverStripe\Forms
Base class for all fields that contain other fields.
- CompositeField::collateDataFields() — Method in class CompositeField
Add all of the non-composite fields contained within this field to the list.
- ConfirmedPasswordField — Class in namespace SilverStripe\Forms
Two masked input fields, checks for matching passwords.
- $ ConfirmedPasswordField#canBeEmpty — Property in class ConfirmedPasswordField
Allow empty fields in serverside validation
- $ ConfirmedPasswordField#children — Property in class ConfirmedPasswordField
Child fields (_Password, _ConfirmPassword)
- CurrencyField — Class in namespace SilverStripe\Forms
Renders a text field, validating its input as a currency.
- CurrencyField_Disabled — Class in namespace SilverStripe\Forms
Readonly version of a {@link CurrencyField}.
- CurrencyField_Readonly — Class in namespace SilverStripe\Forms
Readonly version of a {@link CurrencyField}.
- FieldList::changeFieldOrder() — Method in class FieldList
Change the order of fields in this FieldList by specifying an ordered list of field names.
- $ Form#casting — Property in class Form
- Form::clearFormState() — Method in class Form
Flush persistant form state details
- Form::clearMessage() — Method in class Form
Clear form message (and in session)
- Form::castingHelper() — Method in class Form
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
- $ FormAction#casting — Property in class FormAction
- FormField::castingHelper() — Method in class FormField
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
- FormField::castedCopy() — Method in class FormField
Returns another instance of this field, but "cast" to a different class. The logic tries to retain all of the instance properties, and may be overloaded by subclasses to set additional ones.
- FormField::canSubmitValue() — Method in class FormField
Determine if the value of this formfield accepts front-end submitted values and is saveable.
- FormRequestHandler::checkAccessAction() — Method in class FormRequestHandler
- GridFieldFilterHeader::canFilterAnyColumns() — Method in class GridFieldFilterHeader
Returns whether this {@link GridField} has any columns to filter on at all
- ReadonlyField::castingHelper() — Method in class ReadonlyField
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
- SelectField::castedCopy() — Method in class SelectField
Returns another instance of this field, but "cast" to a different class.
- SingleSelectField::castedCopy() — Method in class SingleSelectField
Returns another instance of this field, but "cast" to a different class.
- TreeDropdownField::castedCopy() — Method in class TreeDropdownField
- Configuration — Class in namespace SilverStripe\GraphQL\Config
- Controller — Class in namespace SilverStripe\GraphQL
Top level controller for handling graphql requests.
- $ Controller#cors — Property in class Controller
Cors default config
- ClientConfigProvider — Class in namespace SilverStripe\GraphQL\Extensions
- CSRFMiddleware — Class in namespace SilverStripe\GraphQL\Middleware
Adds functionality that checks a request for a token before allowing a mutation to happen. Protects against CSRF attacks
- AbstractBulkLoader::collect() — Method in class AbstractBulkLoader
- Collection — Class in namespace SilverStripe\GraphQL\Schema\BulkLoader
Defines a collection of class names paired with file paths
- Collection::createFromClassList() — Method in class Collection
- ExtensionLoader::collect() — Method in class ExtensionLoader
- FilepathLoader::collect() — Method in class FilepathLoader
- InheritanceLoader::collect() — Method in class InheritanceLoader
- NamespaceLoader::collect() — Method in class NamespaceLoader
- CreateCreator — Class in namespace SilverStripe\GraphQL\Schema\DataObject
Creates a "create" mutation for a DataObject
- CreateCreator::createOperation() — Method in class CreateCreator
- DeleteCreator::createOperation() — Method in class DeleteCreator
- InheritanceUnionBuilder::createUnions() — Method in class InheritanceUnionBuilder
- InterfaceBuilder::createInterfaces() — Method in class InterfaceBuilder
- ModelCreator::createModel() — Method in class ModelCreator
- CanViewPermission — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin
A permission checking plugin for DataLists
- QueryCollector::collectQueries() — Method in class QueryCollector
- QueryCollector::collectQueriesForType() — Method in class QueryCollector
- ContainsFilter — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter\Filters
A filter that selects records that partially match a keyword
- ReadCreator::createOperation() — Method in class ReadCreator
- ReadOneCreator::createOperation() — Method in class ReadOneCreator
- UpdateCreator::createOperation() — Method in class UpdateCreator
- ConfigurationApplier — Class in namespace SilverStripe\GraphQL\Schema\Interfaces
Applies an array of config to a class
- ContextProvider — Class in namespace SilverStripe\GraphQL\Schema\Interfaces
A class that can store a generic array of context
- OperationCreator::createOperation() — Method in class OperationCreator
- SchemaModelCreatorInterface::createModel() — Method in class SchemaModelCreatorInterface
- SchemaStorageCreator::createStore() — Method in class SchemaStorageCreator
- SchemaStorageInterface::clear() — Method in class SchemaStorageInterface
- Logger::critical() — Method in class Logger
- PaginationPlugin::createPaginationResult() — Method in class PaginationPlugin
- ComposedResolver — Class in namespace SilverStripe\GraphQL\Schema\Resolver
Given a stack of resolver middleware and afterware, compress it into one composed function, passing along the return value.
- Schema::createStoreableSchema() — Method in class Schema
Creates a readonly object that can be used by a storage service.
- Schema::createModel() — Method in class Schema
- SchemaConfig::createModel() — Method in class SchemaConfig
- CodeGenerationStore — Class in namespace SilverStripe\GraphQL\Schema\Storage
- $ CodeGenerationStore#configFilename — Property in class CodeGenerationStore
- CodeGenerationStore::clear() — Method in class CodeGenerationStore
- CodeGenerationStoreCreator — Class in namespace SilverStripe\GraphQL\Schema\Storage
- CodeGenerationStoreCreator::createStore() — Method in class CodeGenerationStoreCreator
- CanonicalModelAware — Class in namespace SilverStripe\GraphQL\Schema\Type
- TypeReference::createFromPath() — Method in class TypeReference
- ArrayList::count() — Method in class ArrayList
Return the number of items in this list
- ArrayList::column() — Method in class ArrayList
Returns an array of a single field value for all items in the list.
- ArrayList::columnUnique() — Method in class ArrayList
Returns a unique array of a single field value for all the items in the list
- ArrayList::canSortBy() — Method in class ArrayList
You can always sort a ArrayList
- ArrayList::canFilterBy() — Method in class ArrayList
Returns true if the given column can be used to filter the records.
- CMSPreviewable — Class in namespace SilverStripe\ORM
Interface to provide enough information about a record to make it previewable through the CMS. It uses the record database ID, its "frontend" and "backend" links to link up the edit form with its preview.
- CMSPreviewable::CMSEditLink() — Method in class CMSPreviewable
- DBConnector::connect() — Method in class DBConnector
Link this connector to the database given the specified parameters Will throw an exception rather than return a success state.
- $ DBSchemaManager#check_and_repair_on_build — Property in class DBSchemaManager
- DBSchemaManager::cancelSchemaUpdate() — Method in class DBSchemaManager
Cancels the schema updates requested during (but not after) schemaUpdate() call.
- DBSchemaManager::checkAndRepairTable() — Method in class DBSchemaManager
Checks a table's integrity and repairs it if necessary.
- DBSchemaManager::createDatabase() — Method in class DBSchemaManager
Create a database with the specified name
- DBSchemaManager::createTable() — Method in class DBSchemaManager
Create a new table.
- DBSchemaManager::createField() — Method in class DBSchemaManager
Create a new field on a table.
- DBSchemaManager::clearCachedFieldlist() — Method in class DBSchemaManager
This allows the cached values for a table's field list to be erased.
- Database::clearAllData() — Method in class Database
Clear all data out of the database
- Database::clearTable() — Method in class Database
Clear all data in a given table
- Database::comparisonClause() — Method in class Database
Generate a WHERE clause for text matching.
- Database::concatOperator() — Method in class Database
String operator for concatenation of strings
- Database::canLock() — Method in class Database
Returns if the lock is available.
- Database::connect() — Method in class Database
Instruct the database to generate a live connection
- $ MySQLDatabase#connection_charset — Property in class MySQLDatabase
Default connection charset (may be overridden in $databaseConfig)
- $ MySQLDatabase#connection_collation — Property in class MySQLDatabase
Default connection collation
- $ MySQLDatabase#charset — Property in class MySQLDatabase
Default charset
- $ MySQLDatabase#collation — Property in class MySQLDatabase
Default collation
- MySQLDatabase::connect() — Method in class MySQLDatabase
Instruct the database to generate a live connection
- MySQLDatabase::comparisonClause() — Method in class MySQLDatabase
Generate a WHERE clause for text matching.
- MySQLDatabase::canLock() — Method in class MySQLDatabase
Returns if the lock is available.
- MySQLDatabase::clearTable() — Method in class MySQLDatabase
Clear all data in a given table
- MySQLSchemaManager::createTable() — Method in class MySQLSchemaManager
Create a new table.
- MySQLSchemaManager::checkAndRepairTable() — Method in class MySQLSchemaManager
Checks a table's integrity and repairs it if necessary.
- MySQLSchemaManager::createField() — Method in class MySQLSchemaManager
Create a new field on a table.
- MySQLSchemaManager::createDatabase() — Method in class MySQLSchemaManager
Create a database with the specified name
- MySQLSchemaManager::createIndex() — Method in class MySQLSchemaManager
Create an index on a table.
- MySQLiConnector::connect() — Method in class MySQLiConnector
Link this connector to the database given the specified parameters Will throw an exception rather than return a success state.
- PDOConnector::connect() — Method in class PDOConnector
Link this connector to the database given the specified parameters Will throw an exception rather than return a success state.
- PDOStatementHandle::closeCursor() — Method in class PDOStatementHandle
Closes the cursor, enabling the statement to be executed again (PDOStatement::closeCursor)
- Query::column() — Method in class Query
Return an array containing all the values from a specific column. If no column is set, then the first will be returned
- TempDatabase::clearAllData() — Method in class TempDatabase
Remove all content from the temporary database.
- DB::connect() — Method in class DB
Specify connection to a database
- DB::connection_attempted() — Method in class DB
Returns true if a database connection has been attempted.
- DB::create_database() — Method in class DB
Create the database and connect to it. This can be called if the initial database connection is not successful because the database does not exist.
- DB::create_table() — Method in class DB
Create a new table.
- DB::create_field() — Method in class DB
Create a new field on a table.
- DB::check_and_repair_table() — Method in class DB
Checks a table's integrity and repairs it if necessary.
- DataExtension::can() — Method in class DataExtension
- DataExtension::canEdit() — Method in class DataExtension
- DataExtension::canDelete() — Method in class DataExtension
- DataExtension::canCreate() — Method in class DataExtension
- DataList::canSortBy() — Method in class DataList
Returns true if this DataList can be sorted by the given field.
- DataList::canFilterBy() — Method in class DataList
Returns true if this DataList can be filtered by the given field.
- DataList::createDataObject() — Method in class DataList
Create a DataObject from the given SQL row
- DataList::count() — Method in class DataList
Return the number of items in this DataList
- DataList::column() — Method in class DataList
Returns an array of a single field value for all items in the list.
- DataList::columnUnique() — Method in class DataList
Returns a unique array of a single field value for all items in the list.
- $ DataObject#cascade_deletes — Property in class DataObject
List of relations that should be cascade deleted, similar to
owns
Note: This will trigger delete on many_many objects, not only the mapping table.- $ DataObject#create_table_options — Property in class DataObject
Specify custom options for a CREATE TABLE call.
- $ DataObject#ClassName — Property in class DataObject
Class name of the DataObject
- $ DataObject#Created — Property in class DataObject
Date and time of DataObject creation.
- DataObject::castedUpdate() — Method in class DataObject
Pass changes as a map, and try to get automatic casting for these fields.
- DataObject::castingHelper() — Method in class DataObject
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
- DataObject::can() — Method in class DataObject
Returns true if the member is allowed to do the given action.
- DataObject::canView() — Method in class DataObject
- DataObject::canEdit() — Method in class DataObject
- DataObject::canDelete() — Method in class DataObject
- DataObject::canCreate() — Method in class DataObject
- DataObjectSchema::classHasTable() — Method in class DataObjectSchema
Check if the given class has a table
- DataObjectSchema::compositeFields() — Method in class DataObjectSchema
Returns a list of all the composite if the given db field on the class is a composite field.
- DataObjectSchema::compositeField() — Method in class DataObjectSchema
Get a composite field for a class
- DataObjectSchema::classForField() — Method in class DataObjectSchema
Returns the class name in the class hierarchy which contains a given field column for a {@link DataObject}. If the field does not exist, this will return null.
- DataQuery::count() — Method in class DataQuery
Return the number of records in this query.
- DataQuery::conjunctiveGroup() — Method in class DataQuery
Create a conjunctive subgroup
- DataQuery::column() — Method in class DataQuery
Query the given field column from the database and return as an array.
- DataQuery_SubGroup::conditionSQL() — Method in class DataQuery_SubGroup
Determines the resulting SQL along with parameters for the group
- DatabaseAdmin::cleanup() — Method in class DatabaseAdmin
Remove invalid records from tables - that is, records that don't have corresponding records in their parent class tables.
- DBClassName::clear_classname_cache() — Method in class DBClassName
Clear all cached classname specs. It's necessary to clear all cached subclassed names for any classes if a new class manifest is generated.
- $ DBComposite#composite_db — Property in class DBComposite
Similiar to {@link DataObject::$db}, holds an array of composite field names.
- DBComposite::compositeDatabaseFields() — Method in class DBComposite
Return array in the format of {@link $composite_db}.
- DBComposite::castingHelper() — Method in class DBComposite
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
- $ DBCurrency#currency_symbol — Property in class DBCurrency
- DBDatetime::clear_mock_now() — Method in class DBDatetime
Clear any mocked date, which causes {@link Now()} to return the current system date.
- DBField::create_field() — Method in class DBField
Create a DBField object that's not bound to any particular field.
- DBField::CDATA() — Method in class DBField
Safely escape for XML string
- DBHTMLText::CDATA() — Method in class DBHTMLText
Safely escape for XML string
- DBHTMLVarchar::CDATA() — Method in class DBHTMLVarchar
Safely escape for XML string
- DBText::ContextSummary() — Method in class DBText
Perform context searching to give some context to searches, optionally highlighting the search term.
- Filterable::canFilterBy() — Method in class Filterable
Returns TRUE if the list can be filtered by a given field expression.
- ComparisonFilter — Class in namespace SilverStripe\ORM\Filters
Base class for creating comparison filters, eg; greater than, less than, greater than or equal, etc
- Hierarchy::Children() — Method in class Hierarchy
Get the children for this DataObject filtered by canView()
- MarkedSet::clearMarks() — Method in class MarkedSet
Reset marked nodes
- ListDecorator::Count() — Method in class ListDecorator
- ListDecorator::column() — Method in class ListDecorator
Returns an array of a single field value for all items in the list.
- ListDecorator::columnUnique() — Method in class ListDecorator
- ListDecorator::canSortBy() — Method in class ListDecorator
Returns TRUE if the list can be sorted by a field.
- ListDecorator::canFilterBy() — Method in class ListDecorator
Returns TRUE if the list can be filtered by a given field expression.
- ManyManyList::createDataObject() — Method in class ManyManyList
Create a DataObject from the given SQL row.
- ManyManyThroughList::createDataObject() — Method in class ManyManyThroughList
Create a DataObject from the given SQL row
- Map::count() — Method in class Map
Returns the count of items in the list including the additional items set through {@link Map::push()} and {@link Map::unshift}.
- PaginatedList::CurrentPage() — Method in class PaginatedList
- SQLAssignmentRow::clear() — Method in class SQLAssignmentRow
Clears all assignment values
- SQLConditionGroup::conditionSQL() — Method in class SQLConditionGroup
Determines the resulting SQL along with parameters for the group
- SQLDelete::create() — Method in class SQLDelete
Construct a new SQLDelete.
- SQLInsert::create() — Method in class SQLInsert
Construct a new SQLInsert object
- SQLInsert::currentRow() — Method in class SQLInsert
Returns the currently set row
- SQLInsert::clearRow() — Method in class SQLInsert
Clears all currently set assigment values on the current row
- SQLInsert::clear() — Method in class SQLInsert
Clears all rows
- SQLSelect::create() — Method in class SQLSelect
Construct a new SQLSelect.
- SQLSelect::canSortBy() — Method in class SQLSelect
Returns true if this query can be sorted by the given field.
- SQLSelect::count() — Method in class SQLSelect
Return the number of rows in this query, respecting limit and offset.
- SQLUpdate::create() — Method in class SQLUpdate
Construct a new SQLUpdate object
- SQLUpdate::clear() — Method in class SQLUpdate
Clears all currently set assigment values
- SS_List::column() — Method in class SS_List
Returns an array of a single field value for all items in the list.
- $ SearchContext#connective — Property in class SearchContext
The logical connective used to join WHERE clauses. Defaults to AND.
- SearchContext::clearEmptySearchFields() — Method in class SearchContext
Callback map function to filter fields with empty values from being included in the search expression.
- Sortable::canSortBy() — Method in class Sortable
Returns TRUE if the list can be sorted by a field.
- UnsavedRelationList::changeToList() — Method in class UnsavedRelationList
Save all the items in this list into the RelationList
- UnsavedRelationList::column() — Method in class UnsavedRelationList
Returns an array of a single field value for all items in the list.
- UnsavedRelationList::columnUnique() — Method in class UnsavedRelationList
Returns a unique array of a single field value for all items in the list.
- ValidationResult::combineAnd() — Method in class ValidationResult
Combine this Validation Result with the ValidationResult given in other.
- Report::columns() — Method in class Report
- Report::canView() — Method in class Report
- ReportAdmin::canView() — Method in class ReportAdmin
Does the parent permission checks, but also makes sure that instantiatable subclasses of {@link SilverStripe\Reports\Report} exist. By default, the CMS doesn't include any Reports, so there's no point in showing
- ReportWrapper::columns() — Method in class ReportWrapper
- ReportWrapper::canView() — Method in class ReportWrapper
- SideReportWrapper::columns() — Method in class SideReportWrapper
- Authenticator::checkPassword() — Method in class Authenticator
Check if the passed password matches the stored one (if the member is not locked out).
- CMSSecurity — Class in namespace SilverStripe\Security
Provides a security interface functionality within the cms
- Item::confirm() — Method in class Item
Mark the item as confirmed
- Storage::cleanup() — Method in class Storage
Remove all the data from the storage Cleans up Session and Cookie related to this storage
- Storage::confirm() — Method in class Storage
Gets user input data (usually POST array), checks all the items in the storage has been confirmed and marks them as such.
- Storage::check() — Method in class Storage
Check all items to be confirmed in the storage
- DefaultAdminService::clearDefaultAdmin() — Method in class DefaultAdminService
Flush the default admin credentials.
- DefaultPermissionChecker::canEdit() — Method in class DefaultPermissionChecker
Can root be edited?
- DefaultPermissionChecker::canView() — Method in class DefaultPermissionChecker
Can root be viewed?
- DefaultPermissionChecker::canDelete() — Method in class DefaultPermissionChecker
Can root be deleted?
- DefaultPermissionChecker::canCreate() — Method in class DefaultPermissionChecker
Can root objects be created?
- $ Group#Code — Property in class Group
Group code
- Group::collateFamilyIDs() — Method in class Group
Return a set of this record's "family" of IDs - the IDs of this record and all its descendants.
- Group::collateAncestorIDs() — Method in class Group
Returns an array of the IDs of this group and all its parents
- Group::cmsCleanup_parentChanged() — Method in class Group
This isn't a descendant of SiteTree, but needs this in case the group is "reorganised";
- Group::canEdit() — Method in class Group
Checks for permission-code CMS_ACCESS_SecurityAdmin.
- Group::canView() — Method in class Group
Checks for permission-code CMS_ACCESS_SecurityAdmin.
- Group::canDelete() — Method in class Group
- InheritedPermissions::canEditMultiple() — Method in class InheritedPermissions
- InheritedPermissions::canViewMultiple() — Method in class InheritedPermissions
- InheritedPermissions::canDeleteMultiple() — Method in class InheritedPermissions
- InheritedPermissions::canDelete() — Method in class InheritedPermissions
- InheritedPermissions::canEdit() — Method in class InheritedPermissions
- InheritedPermissions::canView() — Method in class InheritedPermissions
- InheritedPermissions::clearCache() — Method in class InheritedPermissions
- $ InheritedPermissionsExtension#CanViewType — Property in class InheritedPermissionsExtension
- $ InheritedPermissionsExtension#CanEditType — Property in class InheritedPermissionsExtension
- $ Member#casting — Property in class Member
- Member::checkPassword() — Method in class Member
Check if the passed password matches the stored one (if the member is not locked out).
- Member::canLogin() — Method in class Member
Check if this user can login
- Member::currentUser() — Method in class Member
Returns the current logged in user
- Member::currentUserID() — Method in class Member
Get the ID of the current logged in user
- Member::create_new_password() — Method in class Member
Generate a random password, with randomiser to kick in if there's no words file on the filesystem.
- Member::canView() — Method in class Member
Users can view their own record.
- Member::canEdit() — Method in class Member
Users can edit their own record.
- Member::canDelete() — Method in class Member
Users can edit their own record.
- Member::changePassword() — Method in class Member
Change password. This will cause rehashing according to the
PasswordEncryption
property via theonBeforeWrite()
method. This method will allow extensions to perform actions and augment the validation result if required before the password is written and can check it after the write also.- CMSLoginHandler — Class in namespace SilverStripe\Security\MemberAuthenticator
- CMSMemberAuthenticator — Class in namespace SilverStripe\Security\MemberAuthenticator
Provides authentication for the user within the CMS
- CMSMemberLoginForm — Class in namespace SilverStripe\Security\MemberAuthenticator
Provides the in-cms session re-authentication form for the "member" authenticator
- ChangePasswordForm — Class in namespace SilverStripe\Security\MemberAuthenticator
Standard Change Password Form
- ChangePasswordHandler — Class in namespace SilverStripe\Security\MemberAuthenticator
- ChangePasswordHandler::changepassword() — Method in class ChangePasswordHandler
Handle the change password request
- ChangePasswordHandler::changePasswordForm() — Method in class ChangePasswordHandler
Factory method for the lost password form
- CookieAuthenticationHandler — Class in namespace SilverStripe\Security\MemberAuthenticator
Authenticate a member pased on a session cookie
- LoginHandler::checkLogin() — Method in class LoginHandler
Try to authenticate the user
- MemberAuthenticator::checkPassword() — Method in class MemberAuthenticator
Check if the passed password matches the stored one (if the member is not locked out).
- MemberPassword::checkPassword() — Method in class MemberPassword
Check if the given password is the same as the one stored in this record.
- $ Member_Validator#customRequired — Property in class Member_Validator
Fields that are required by this validator
- NullSecurityToken::check() — Method in class NullSecurityToken
- NullSecurityToken::checkRequest() — Method in class NullSecurityToken
- PasswordEncryptor::create_for_algorithm() — Method in class PasswordEncryptor
- PasswordEncryptor::check() — Method in class PasswordEncryptor
This usually just returns a strict string comparison, but is necessary for retain compatibility with password hashed with flawed algorithms - see {@link PasswordEncryptor_LegacyPHPHash} and {@link PasswordEncryptor_Blowfish}
- PasswordEncryptor_Blowfish::checkAEncryptionLevel() — Method in class PasswordEncryptor_Blowfish
The algorithm returned by using '$2a$' is not consistent - it might be either the correct (y), incorrect (x) or mostly-correct (a) version, depending on the version of PHP and the operating system, so we need to test it.
- PasswordEncryptor_Blowfish::check() — Method in class PasswordEncryptor_Blowfish
This usually just returns a strict string comparison, but is necessary for retain compatibility with password hashed with flawed algorithms - see {@link PasswordEncryptor_LegacyPHPHash} and {@link PasswordEncryptor_Blowfish}
- PasswordEncryptor_LegacyPHPHash::check() — Method in class PasswordEncryptor_LegacyPHPHash
This usually just returns a strict string comparison, but is necessary for retain compatibility with password hashed with flawed algorithms - see {@link PasswordEncryptor_LegacyPHPHash} and {@link PasswordEncryptor_Blowfish}
- $ PasswordValidator#character_strength_tests — Property in class PasswordValidator
- PasswordValidator::characterStrength() — Method in class PasswordValidator
- PasswordValidator::checkHistoricalPasswords() — Method in class PasswordValidator
- Permission::check() — Method in class Permission
Check that the current member has the given permission.
- Permission::checkMember() — Method in class Permission
Check that the given member has the given permission.
- PermissionChecker::canEditMultiple() — Method in class PermissionChecker
Get the 'can edit' information for a number of SiteTree pages.
- PermissionChecker::canViewMultiple() — Method in class PermissionChecker
Get the canView information for a number of objects
- PermissionChecker::canDeleteMultiple() — Method in class PermissionChecker
Get the 'can edit' information for a number of SiteTree pages.
- PermissionChecker::canDelete() — Method in class PermissionChecker
Check delete permission for a single record ID
- PermissionChecker::canEdit() — Method in class PermissionChecker
Check edit permission for a single record ID
- PermissionChecker::canView() — Method in class PermissionChecker
Check view permission for a single record ID
- PermissionRole::canView() — Method in class PermissionRole
- PermissionRole::canCreate() — Method in class PermissionRole
- PermissionRole::canEdit() — Method in class PermissionRole
- PermissionRole::canDelete() — Method in class PermissionRole
- PermissionRole::Codes() — Method in class PermissionRole
List of PermissionRoleCode objects
- PermissionRoleCode::canCreate() — Method in class PermissionRoleCode
- PermissionRoleCode::canEdit() — Method in class PermissionRoleCode
- PermissionRoleCode::canDelete() — Method in class PermissionRoleCode
- RememberLoginHash::clear() — Method in class RememberLoginHash
Deletes existing tokens for this member if logout_across_devices is true, all tokens are deleted, otherwise only the token for the provided device ID will be removed
- Security::clearSessionMessage() — Method in class Security
Clear login message
- Security::changepassword() — Method in class Security
Show the "change password" page.
- Security::clear_default_admin() — Method in class Security
Flush the default admin credentials
- Security::check_default_admin() — Method in class Security
Checks if the passed credentials are matching the default-admin.
- Security::clear_database_is_ready() — Method in class Security
Resets the database_is_ready cache
- SecurityToken::check() — Method in class SecurityToken
Checks for an existing CSRF token in the current users session.
- SecurityToken::checkRequest() — Method in class SecurityToken
See {@link check()}.
- SiteConfig::CMSEditLink() — Method in class SiteConfig
- SiteConfig::current_site_config() — Method in class SiteConfig
Get the current sites SiteConfig, and creates a new one through {@link make_site_config()} if none is found.
- SiteConfig::canView() — Method in class SiteConfig
Can a user view this SiteConfig instance?
- SiteConfig::canViewPages() — Method in class SiteConfig
Can a user view pages on this site? This method is only called if a page is set to Inherit, but there is nothing to inherit from.
- SiteConfig::canEditPages() — Method in class SiteConfig
Can a user edit pages on this site? This method is only called if a page is set to Inherit, but there is nothing to inherit from, or on new records without a parent.
- SiteConfig::canEdit() — Method in class SiteConfig
- SiteConfig::canCreateTopLevel() — Method in class SiteConfig
Can a user create pages in the root of this site?
- SiteConfig::CreateTopLevelGroups() — Method in class SiteConfig
List of groups that can create root-level pages.
- SiteConfigPagePermissions::canEdit() — Method in class SiteConfigPagePermissions
Can root be edited?
- SiteConfigPagePermissions::canView() — Method in class SiteConfigPagePermissions
Can root be viewed?
- SiteConfigPagePermissions::canDelete() — Method in class SiteConfigPagePermissions
Can root be deleted?
- SiteConfigPagePermissions::canCreate() — Method in class SiteConfigPagePermissions
Can root objects be created?
- ArchiveAdmin::createArchiveGridField() — Method in class ArchiveAdmin
Create a gridfield which displays archived objects
- CMSPageHistoryViewerController — Class in namespace SilverStripe\VersionedAdmin\Controllers
The history viewer controller replaces the {@link CMSPageHistoryController} and uses the React based {@link HistoryViewerField} to display the history for a {@link DataObject} that has the {@link Versioned} extension.
- HistoryControllerFactory::create() — Method in class HistoryControllerFactory
Creates a new service instance.
- HistoryViewerController::compareForm() — Method in class HistoryViewerController
- CMSMainExtension — Class in namespace SilverStripe\VersionedAdmin\Extensions
- ProxyCacheAdapter::clear() — Method in class ProxyCacheAdapter
{@inheritdoc}
- ProxyCacheFactory::create() — Method in class ProxyCacheFactory
- ChangeSet — Class in namespace SilverStripe\Versioned
The ChangeSet model tracks several VersionedAndStaged objects for later publication as a single atomic action
- ChangeSet::canView() — Method in class ChangeSet
- ChangeSet::canEdit() — Method in class ChangeSet
- ChangeSet::canCreate() — Method in class ChangeSet
- ChangeSet::canDelete() — Method in class ChangeSet
- ChangeSet::canPublish() — Method in class ChangeSet
Check if this item is allowed to be published
- ChangeSet::canRevert() — Method in class ChangeSet
Check if this changeset (if published) can be reverted
- ChangeSet::can() — Method in class ChangeSet
Default permissions for this changeset
- ChangeSet::Changes() — Method in class ChangeSet
- ChangeSetItem — Class in namespace SilverStripe\Versioned
A single line in a changeset
- $ ChangeSetItem#ChangeSetID — Property in class ChangeSetItem
ID of parent ChangeSet object
- ChangeSetItem::canView() — Method in class ChangeSetItem
- ChangeSetItem::canEdit() — Method in class ChangeSetItem
- ChangeSetItem::canCreate() — Method in class ChangeSetItem
- ChangeSetItem::canDelete() — Method in class ChangeSetItem
- ChangeSetItem::canRevert() — Method in class ChangeSetItem
Check if the BeforeVersion of this changeset can be restored to draft
- ChangeSetItem::canPublish() — Method in class ChangeSetItem
Check if this ChangeSetItem can be published
- ChangeSetItem::can() — Method in class ChangeSetItem
Default permissions for this ChangeSetItem
- ChangeSetItem::CMSEditLink() — Method in class ChangeSetItem
Get edit link for this item
- ChangeSetItem::ChangeSet() — Method in class ChangeSetItem
Parent changeset
- DataDifferencer::ChangedFields() — Method in class DataDifferencer
Get a SS_List of the changed fields.
- DataDifferencer::changedFieldNames() — Method in class DataDifferencer
Get an array of the names of every fields that has changed.
- Rollback::createDefaultArgs() — Method in class Rollback
- CopyToStageInputType — Class in namespace SilverStripe\Versioned\GraphQL\Types
- $ Versioned#casting — Property in class Versioned
Ensure versioned records cast extra fields properly
- Versioned::canPublish() — Method in class Versioned
This function should return true if the current user can publish this record.
- Versioned::canUnpublish() — Method in class Versioned
Check if the current user can delete this record from live
- Versioned::canArchive() — Method in class Versioned
Check if the current user is allowed to archive this record.
- Versioned::canRevertToLive() — Method in class Versioned
Check if the user can revert this record to live
- Versioned::canRestoreToDraft() — Method in class Versioned
Check if the user can restore this record to draft
- Versioned::canView() — Method in class Versioned
Extend permissions to include additional security for objects that are not published to live.
- Versioned::canViewVersioned() — Method in class Versioned
Determine if there are any additional restrictions on this object for the given reading version.
- Versioned::canViewStage() — Method in class Versioned
Determines canView permissions for the latest version of this object on a specific stage.
- Versioned::canBeVersioned() — Method in class Versioned
Determine if a class is supporting the Versioned extensions (e.g.
- Versioned::copyVersionToStage() — Method in class Versioned
Move a database record from one stage to the other.
- Versioned::compareVersions() — Method in class Versioned
Compare two version, and return the diff between them.
- Versioned::can_choose_site_stage() — Method in class Versioned
Determine if the current user is able to set the given site stage / archive
- Versioned::choose_site_stage() — Method in class Versioned
Choose the stage the site is currently on.
- Versioned::current_archived_date() — Method in class Versioned
Get the current archive date.
- Versioned::current_archived_stage() — Method in class Versioned
Get the current archive stage.
- Versioned::cacheKeyComponent() — Method in class Versioned
Return a piece of text to keep DataObject cache keys appropriately specific.
- HTML::createTag() — Method in class HTML
Construct and return HTML tag.
- Diff::cleanHTML() — Method in class Diff
Attempt to clean invalid HTML, which messes up diffs.
- Diff::compareHTML() — Method in class Diff
- $ HTMLCleaner#config — Property in class HTMLCleaner
Configuration variables for HTMLCleaners that support configuration (like Tidy)
- HTMLCleaner::cleanHTML() — Method in class HTMLCleaner
Passed a string, return HTML that has been tidied.
- PurifierHTMLCleaner::cleanHTML() — Method in class PurifierHTMLCleaner
Passed a string, return HTML that has been tidied.
- ShortcodeParser::clear() — Method in class ShortcodeParser
Remove all registered shortcodes.
- ShortcodeParser::callShortcode() — Method in class ShortcodeParser
Call a shortcode and return its replacement text Returns false if the shortcode isn't registered
- TidyHTMLCleaner::cleanHTML() — Method in class TidyHTMLCleaner
Passed a string, return HTML that has been tidied.
- Requirements::customScript() — Method in class Requirements
Register the given JavaScript code into the list of requirements
- Requirements::customCSS() — Method in class Requirements
Register the given CSS styles into the list of requirements
- Requirements::css() — Method in class Requirements
Register the given stylesheet into the list of requirements.
- Requirements::clear() — Method in class Requirements
Clear either a single or all requirements
- Requirements::combine_files() — Method in class Requirements
Concatenate several css or javascript files into a single dynamically generated file. This increases performance by fewer HTTP requests.
- Requirements::clear_combined_files() — Method in class Requirements
Re-sets the combined files definition. See {@link Requirements_Backend::clear_combined_files()}
- $ Requirements_Backend#combine_in_dev — Property in class Requirements_Backend
Determine if files should be combined automatically on dev mode.
- $ Requirements_Backend#combine_hash_querystring — Property in class Requirements_Backend
Flag to include the hash in the querystring instead of the filename for combined files.
- Requirements_Backend::customScript() — Method in class Requirements_Backend
Register the given JavaScript code into the list of requirements
- Requirements_Backend::customCSS() — Method in class Requirements_Backend
Register the given CSS styles into the list of requirements
- Requirements_Backend::css() — Method in class Requirements_Backend
Register the given stylesheet into the list of requirements.
- Requirements_Backend::clear() — Method in class Requirements_Backend
Clear either a single or all requirements
- Requirements_Backend::combineFiles() — Method in class Requirements_Backend
Concatenate several css or javascript files into a single dynamically generated file. This increases performance by fewer HTTP requests.
- Requirements_Backend::clearCombinedFiles() — Method in class Requirements_Backend
Clear all registered CSS and JavaScript file combinations
- SSTemplateParser::construct() — Method in class SSTemplateParser
Override the function that constructs the result arrays to also prepare a 'php' item in the array
- SSTemplateParser::CallArguments_Argument() — Method in class SSTemplateParser
Values are bare words in templates, but strings in PHP. We rely on PHP's type conversion to back-convert strings to numbers when needed.
- SSTemplateParser::Comparison_Argument() — Method in class SSTemplateParser
- SSTemplateParser::Comparison_ComparisonOperator() — Method in class SSTemplateParser
- SSTemplateParser::CacheBlockArgument_DollarMarkedLookup() — Method in class SSTemplateParser
- SSTemplateParser::CacheBlockArgument_QuotedString() — Method in class SSTemplateParser
- SSTemplateParser::CacheBlockArgument_Lookup() — Method in class SSTemplateParser
- SSTemplateParser::CacheBlockArguments_CacheBlockArgument() — Method in class SSTemplateParser
- SSTemplateParser::CacheRestrictedTemplate_CacheBlock() — Method in class SSTemplateParser
- SSTemplateParser::CacheRestrictedTemplate_UncachedBlock() — Method in class SSTemplateParser
- SSTemplateParser::CacheBlock__construct() — Method in class SSTemplateParser
- SSTemplateParser::CacheBlock_CacheBlockArguments() — Method in class SSTemplateParser
- SSTemplateParser::CacheBlock_Condition() — Method in class SSTemplateParser
- SSTemplateParser::CacheBlock_CacheBlock() — Method in class SSTemplateParser
- SSTemplateParser::CacheBlock_UncachedBlock() — Method in class SSTemplateParser
- SSTemplateParser::CacheBlock_CacheBlockTemplate() — Method in class SSTemplateParser
- SSTemplateParser::ClosedBlock__construct() — Method in class SSTemplateParser
As mentioned in the parser comment, block handling is kept fairly generic for extensibility. The match rule builds up two important elements in the match result array: 'ArgumentCount' - how many arguments were passed in the opening tag 'Arguments' an array of the Argument match rule result arrays
- SSTemplateParser::ClosedBlock_BlockArguments() — Method in class SSTemplateParser
- SSTemplateParser::ClosedBlock__finalise() — Method in class SSTemplateParser
- SSTemplateParser::ClosedBlock_Handle_Loop() — Method in class SSTemplateParser
This is an example of a block handler function. This one handles the loop tag.
- SSTemplateParser::ClosedBlock_Handle_With() — Method in class SSTemplateParser
The closed block handler for with blocks
- SSTemplateParser::Comment__construct() — Method in class SSTemplateParser
- SSTemplateParser::compileString() — Method in class SSTemplateParser
Compiles some passed template source code into the php code that will execute as per the template source.
- SSTemplateParser::compileFile() — Method in class SSTemplateParser
Compiles some file that contains template source code, and returns the php code that will execute as per that source
- SSViewer::chooseTemplate() — Method in class SSViewer
Find the template to use for a given list
- $ SSViewer_FromString#cache_template — Property in class SSViewer_FromString
The global template caching behaviour if no instance override is specified
- TemplateParser::compileString() — Method in class TemplateParser
Compiles some passed template source code into the php code that will execute as per the template source.
- $ ViewableData#casting — Property in class ViewableData
An array of objects to cast certain fields to. This is set up as an array in the format:
- ViewableData::customise() — Method in class ViewableData
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
- ViewableData::castingHelper() — Method in class ViewableData
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
- ViewableData::castingClass() — Method in class ViewableData
Get the class name a field on this object will be casted to.
- ViewableData::cachedCall() — Method in class ViewableData
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
- ViewableData::CSSClasses() — Method in class ViewableData
Get part of the current classes ancestry to be used as a CSS class.
- ViewableData_Customised::cachedCall() — Method in class ViewableData_Customised
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
- IntlLocales::countryName() — Method in class IntlLocales
Get name of country
- IntlLocales::countryFromLocale() — Method in class IntlLocales
Returns the country code / suffix on any locale
- Locales::countryName() — Method in class Locales
Get name of country by code
- Locales::countryFromLocale() — Method in class Locales
Returns the country code / suffix on any locale
- i18nTextCollector::collect() — Method in class i18nTextCollector
Extract all strings from modules and return these grouped by module name
- i18nTextCollector::collectFromCode() — Method in class i18nTextCollector
Extracts translatables from .php files.
- i18nTextCollector::collectFromTemplate() — Method in class i18nTextCollector
Extracts translatables from .ss templates (Self referencing)
- i18nTextCollector::collectFromEntityProviders() — Method in class i18nTextCollector
Allows classes which implement i18nEntityProvider to provide additional translation strings.
- i18n::convert_rfc1766() — Method in class i18n
Gets a RFC 1766 compatible language code, e.g. "en-US".
D
- $ AdminRootController#default_panel — Property in class AdminRootController
- GroupImportForm::doImport() — Method in class GroupImportForm
- LeftAndMain::delete() — Method in class LeftAndMain
- MemberImportForm::doImport() — Method in class MemberImportForm
- DeleteAssets — Class in namespace SilverStripe\AssetAdmin\BatchAction
Delete multiple {@link Folder} records (and the associated filesystem nodes).
- DeleteFileMutationCreator — Class in namespace SilverStripe\AssetAdmin\GraphQL
Handles create and update
- $ FileMigrationHelper#delete_invalid_files — Property in class FileMigrationHelper
If a file fails to validate during migration, delete it.
- $ TestAssetStore#denied_response_code — Property in class TestAssetStore
Enable disclosure of secure assets
- File::deleteFile() — Method in class File
Delete a file (and all variants).
- $ FileNameFilter#default_use_transliterator — Property in class FileNameFilter
- $ FileNameFilter#default_replacements — Property in class FileNameFilter
- $ AssetAdapter#default_server — Property in class AssetAdapter
Default server configuration to use if the server type defined by the environment is not found
- $ FlysystemAssetStore#denied_response_code — Property in class FlysystemAssetStore
Set HTTP error code for requests to secure denied assets.
- FlysystemAssetStore::delete() — Method in class FlysystemAssetStore
Delete a file (and all variants) identified by the given filename and hash
- $ FileLinkTracking#dependencies — Property in class FileLinkTracking
Inject parser for each page
- AssetContainer::deleteFile() — Method in class AssetContainer
Delete a file (and all variants).
- AssetStore::delete() — Method in class AssetStore
Delete a file (and all variants) identified by the given filename and hash
- DBFile — Class in namespace SilverStripe\Assets\Storage
Represents a file reference stored in a database
- DBFile::deleteFile() — Method in class DBFile
Delete a file (and all variants).
- DefaultAssetNameGenerator — Class in namespace SilverStripe\Assets\Storage
Basic filename renamer
- $ Upload_Validator#default_max_file_size — Property in class Upload_Validator
Contains a list of the max file sizes shared by all upload fields. This is then duplicated into the "allowedMaxFileSize" instance property on construct.
- CMSMain::doSearch() — Method in class CMSMain
- CMSMain::delete() — Method in class CMSMain
Delete the current page from draft stage.
- CMSMain::doRollback() — Method in class CMSMain
Rolls a site back to a given version ID
- CMSMain::duplicate() — Method in class CMSMain
- CMSMain::duplicatewithchildren() — Method in class CMSMain
- CMSPageAddController::doAdd() — Method in class CMSPageAddController
- CMSPageAddController::doCancel() — Method in class CMSPageAddController
- ContentController::data() — Method in class ContentController
Returns the associated database record
- ContentController::deleteinstallfiles() — Method in class ContentController
- $ RootURLController#default_homepage_link — Property in class RootURLController
- $ SiteTree#default_child — Property in class SiteTree
The default child class for this page.
- $ SiteTree#default_classname — Property in class SiteTree
Default value for SiteTree.ClassName enum {see DBClassName::getDefault}
- $ SiteTree#default_parent — Property in class SiteTree
The default parent class for this page.
- $ SiteTree#description — Property in class SiteTree
Description of the class functionality, typically shown to a user when selecting which page type to create. Translated through {@link provideI18nEntities()}.
- SiteTree::duplicateWithChildren() — Method in class SiteTree
Duplicates each child of this node recursively and returns the top-level duplicate node.
- SiteTree::duplicateAsChild() — Method in class SiteTree
Duplicate this node and its children as a child of the node with the given ID
- SiteTree::DependentPages() — Method in class SiteTree
Returns the pages that depend on this page. This includes virtual pages, pages that link to it, etc.
- SiteTree::doRestoreToStage() — Method in class SiteTree
Restore the content in the active copy of this SiteTree page to the stage site.
- SiteTree::defaultChild() — Method in class SiteTree
Returns the class name of the default class for children of this page.
- SiteTree::defaultParent() — Method in class SiteTree
Returns the class name of the default class for the parent of this page.
- SiteTree::disableCMSFieldsExtensions() — Method in class SiteTree
Stops extendCMSFields() being called on getCMSFields(). This is useful when you need access to fields added by subclasses of SiteTree in a extension. Call before calling parent::getCMSFields(), and reenable afterwards.
- $ SiteTreeLinkTracking#dependencies — Property in class SiteTreeLinkTracking
Inject parser for each page
- RemoveOrphanedPagesTask::doSubmit() — Method in class RemoveOrphanedPagesTask
- CampaignAdmin::deleteCampaign() — Method in class CampaignAdmin
REST endpoint to delete a campaign.
- DeltaConfigCollection — Class in namespace SilverStripe\Config\Collections
Applies config modifications as a set of deltas on top of the middleware, instead of as modifications to the underlying list.
- DeltaMiddleware — Class in namespace SilverStripe\Config\Middleware
Applies a set of user-customised modifications to config
- $ ContentNegotiator#default_format — Property in class ContentNegotiator
- Controller::doInit() — Method in class Controller
A stand in function to protect the init function from failing to be called as well as providing before and after hooks for the init function itself
- Controller::defaultAction() — Method in class Controller
This is the default action handler used if a method doesn't exist. It will process the controller object with the template returned by {@link getViewer()}.
- Controller::disableBasicAuth() — Method in class Controller
Call this to disable site-wide basic authentication for a specific controller. This must be called before Controller::init(). That is, you must call it in your controller's init method before it calls parent::init().
- Director — Class in namespace SilverStripe\Control
Director is responsible for processing URLs, and providing environment information.
- $ Director#default_base_url — Property in class Director
Base url to populate if cannot be determined otherwise.
- Email::debug() — Method in class Email
Debugging help
- $ HTTP#disable_http_cache — Property in class HTTP
- HTTPRequest::detect_method() — Method in class HTTPRequest
Gets the "real" HTTP method for a request.
- $ HTTPCacheControlMiddleware#defaultState — Property in class HTTPCacheControlMiddleware
Set default state
- $ HTTPCacheControlMiddleware#defaultForcingLevel — Property in class HTTPCacheControlMiddleware
Default forcing level
- HTTPCacheControlMiddleware::disableCache() — Method in class HTTPCacheControlMiddleware
Simple way to set cache control header to a non-cacheable state.
- RSSFeed::Description() — Method in class RSSFeed
Get the description of this feed
- RSSFeed_Entry::Description() — Method in class RSSFeed_Entry
Get the description of this entry
- Session::destroy() — Method in class Session
Destroy this session
- DefaultCacheFactory — Class in namespace SilverStripe\Core\Cache
Returns the most performant combination of caches available on the system:
PhpFilesCache
(PHP 7 with opcache enabled)ApcuCache
(requires APC) with aFilesystemCache
fallback (for larger cache volumes)FilesystemCache
if none of the above is available
- ClassInfo::dataClassesFor() — Method in class ClassInfo
Returns an array of the current class and all its ancestors and children which require a DB table.
- DeployFlushDiscoverer — Class in namespace SilverStripe\Core\Startup
Checks whether a filesystem resource has been changed since the manifest generation
- $ BulkLoader#duplicateChecks — Property in class BulkLoader
Specifies how to determine duplicates based on one or more provided fields in the imported data, matching to properties on the used {@link DataObject} class.
- $ BulkLoader#deleteExistingRecords — Property in class BulkLoader
- BulkLoader_Result::DeletedCount() — Method in class BulkLoader_Result
- BulkLoader_Result::Deleted() — Method in class BulkLoader_Result
- CliDebugView::debugVariable() — Method in class CliDebugView
Similar to renderVariable() but respects debug() method on object if available
- CliDebugView::debugVariableText() — Method in class CliDebugView
Get debug text for this object
- $ CsvBulkLoader#delimiter — Property in class CsvBulkLoader
Delimiter character (Default: comma).
- Debug — Class in namespace SilverStripe\Dev
Supports debugging and core error handling.
- Debug::dump() — Method in class Debug
Quick dump of a variable.
- DebugView — Class in namespace SilverStripe\Dev
A basic HTML wrapper for stylish rendering of a developement info view.
- DebugView::debugVariable() — Method in class DebugView
Similar to renderVariable() but respects debug() method on object if available
- DebugView::debugVariableText() — Method in class DebugView
Get debug text for this object
- Deprecation — Class in namespace SilverStripe\Dev
Handles raising an notice when accessing a deprecated method
- Deprecation::dump_settings() — Method in class Deprecation
Method for when testing. Dump all the current version settings to a variable for later passing to restore
- DevBuildController — Class in namespace SilverStripe\Dev
- DevConfirmationController — Class in namespace SilverStripe\Dev
A simple controller using DebugView to wrap up the confirmation form with a template similar to other DevelopmentAdmin endpoints and UIs
- DevelopmentAdmin — Class in namespace SilverStripe\Dev
Base class for development tools.
- $ DevelopmentAdmin#deny_non_cli — Property in class DevelopmentAdmin
Deny all non-cli requests (browser based ones) to dev admin
- $ FixtureBlueprint#dependencies — Property in class FixtureBlueprint
- FixtureFactory::define() — Method in class FixtureFactory
- DatabaseAdapterRegistry — Class in namespace SilverStripe\Dev\Install
This class keeps track of the available database adapters and provides a meaning of registering community built adapters in to the installer process.
- DatabaseConfigurationHelper — Class in namespace SilverStripe\Dev\Install
Interface for database helper classes.
- MigrationTask::down() — Method in class MigrationTask
- ErrorPage::defaultRecordsAllowed() — Method in class ErrorPage
- $ ErrorPageExtension#db — Property in class ErrorPageExtension
- $ ErrorPageExtension#defaults — Property in class ErrorPageExtension
- $ ErrorPageExtension#description — Property in class ErrorPageExtension
- ErrorPageExtension::defaultRecordsAllowed() — Method in class ErrorPageExtension
Default records are allowed by default override on model if needed
- CheckboxField::dataValue() — Method in class CheckboxField
Returns the field value suitable for insertion into the data object.
- CompositeField::debug() — Method in class CompositeField
- CurrencyField::dataValue() — Method in class CurrencyField
Overwrite the datavalue before saving to the db ;-) return 0.00 if no value, or value is non-numeric
- DatalessField — Class in namespace SilverStripe\Forms
Abstract class for all fields without data.
- DateField — Class in namespace SilverStripe\Forms
Form used for editing a date string
- DateField_Disabled — Class in namespace SilverStripe\Forms
Disabled version of {@link DateField}.
- DatetimeField — Class in namespace SilverStripe\Forms
Form field used for editing date time strings.
- DisabledTransformation — Class in namespace SilverStripe\Forms
Transformation that disables all the fields on the form.
- DropdownField — Class in namespace SilverStripe\Forms
Dropdown field, created from a select tag.
- FieldList::dataFields() — Method in class FieldList
Return a sequential set of all fields that have data. This excludes wrapper composite fields as well as heading / help text fields.
- FieldList::dataFieldNames() — Method in class FieldList
Return array of all field names
- FieldList::dataFieldByName() — Method in class FieldList
Returns a named field in a sequential set.
- $ Form#default_classes — Property in class Form
- Form::defaultAction() — Method in class Form
Return the default button that should be clicked when another one isn't available.
- Form::disableDefaultAction() — Method in class Form
Disable the default button.
- Form::disableSecurityToken() — Method in class Form
Disable the requirement of a security token on this form instance. This security protects against CSRF attacks, but you should disable this if you don't want to tie a form to a session - eg a search form.
- Form::debug() — Method in class Form
- $ FormField#default_classes — Property in class FormField
- FormField::dataValue() — Method in class FormField
Returns the field value suitable for insertion into the data object.
- FormField::debug() — Method in class FormField
- GridFieldAddExistingAutocompleter::doSearch() — Method in class GridFieldAddExistingAutocompleter
Returns a json array of a search results that can be used by for example Jquery.ui.autosuggestion
- GridFieldDetailForm_ItemRequest::doSave() — Method in class GridFieldDetailForm_ItemRequest
- GridFieldDetailForm_ItemRequest::doDelete() — Method in class GridFieldDetailForm_ItemRequest
- $ GridFieldPaginator#default_items_per_page — Property in class GridFieldPaginator
Specifies default items per page
- GridState::dataValue() — Method in class GridState
Returns a json encoded string representation of this state.
- $ HTMLEditorConfig#default_config — Property in class HTMLEditorConfig
Name of default config. This will be ignored if $current is assigned a value.
- $ HTMLEditorField#default_rows — Property in class HTMLEditorField
Number of rows
- TinyMCEConfig::disablePlugins() — Method in class TinyMCEConfig
Enable one or several plugins. Will properly handle being passed a plugin that is already disabled
- MoneyField::dataValue() — Method in class MoneyField
Returns the field value suitable for insertion into the data object.
- NullableField::debug() — Method in class NullableField
- NumericField::dataValue() — Method in class NumericField
Get internal database value
- RequiredFields::debug() — Method in class RequiredFields
Debug helper
- DevelopmentAdmin — Class in namespace SilverStripe\GraphQL\Dev
- DebugSchemaState — Class in namespace SilverStripe\GraphQL\Dev\State
- DisableTypeCacheState — Class in namespace SilverStripe\GraphQL\Dev\State
- DevBuildExtension — Class in namespace SilverStripe\GraphQL\Extensions
- DevErrorHandler — Class in namespace SilverStripe\GraphQL\QueryHandler
Throws everything, including notices, so the JSON response doesn't get corruped by E_NOTICE, E_WARN outputs.
- DataObjectModel — Class in namespace SilverStripe\GraphQL\Schema\DataObject
Defines the model that generates types, queries, and mutations based on DataObjects
- DeleteCreator — Class in namespace SilverStripe\GraphQL\Schema\DataObject
Creates a delete operation for a DataObject
- InheritanceUnionBuilder::defaultUnionFormatter() — Method in class InheritanceUnionBuilder
- InterfaceBuilder::defaultInterfaceFormatter() — Method in class InterfaceBuilder
- DBDateArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
- DBDatetimeArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
- DBDecimalArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
- DBFieldArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
Defines a set of arguments that applies to a field that maps to a DBField.
- DBFieldArgsPlugin — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
- DBFloatArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
- DBHTMLTextArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
- DBTextArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
- DBTimeArgs — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\DBFieldArgs
- DBFieldTypes — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin
- DefaultFieldsProvider — Class in namespace SilverStripe\GraphQL\Schema\Interfaces
For models that can provide a default set of fields
- Logger::debug() — Method in class Logger
- $ PaginationPlugin#default_limit — Property in class PaginationPlugin
- DefaultResolver — Class in namespace SilverStripe\GraphQL\Schema\Resolver
Default field resolver for any type
- DefaultResolver::defaultFieldResolver() — Method in class DefaultResolver
Note: this is copied and pasted from Executor::defaultFieldResolver(), but migrated out of thirdparty so it will be easy to update if we need to.
- DefaultResolverStrategy — Class in namespace SilverStripe\GraphQL\Schema\Resolver
A good starting point for a resolver discovery implementation.
- SchemaConfig::discoverResolver() — Method in class SchemaConfig
- $ CodeGenerationStore#dirName — Property in class CodeGenerationStore
- DebugViewFriendlyErrorFormatter — Class in namespace SilverStripe\Logging
Produce a friendly error message
- DetailedErrorFormatter — Class in namespace SilverStripe\Logging
Monolog-compatible error handler that will output a detailed error message to the screen.
- ArrayList::dataClass() — Method in class ArrayList
Return the class of items in this list, by looking at the first item inside it.
- ArrayList::debug() — Method in class ArrayList
- DBConnector — Class in namespace SilverStripe\ORM\Connect
Represents an object responsible for wrapping DB connector api
- $ DBConnector#ddl_operations — Property in class DBConnector
List of operations to treat as DDL
- DBQueryBuilder — Class in namespace SilverStripe\ORM\Connect
Builds a SQL query string from a SQLExpression object
- DBSchemaManager — Class in namespace SilverStripe\ORM\Connect
Represents and handles all schema management for a database
- DBSchemaManager::doesSchemaNeedUpdating() — Method in class DBSchemaManager
Returns true if schema modifications were requested during (but not after) schemaUpdate() call.
- DBSchemaManager::dontRequireTable() — Method in class DBSchemaManager
If the given table exists, move it out of the way by renaming it to obsolete(tablename).
- DBSchemaManager::dontRequireField() — Method in class DBSchemaManager
If the given field exists, move it out of the way by renaming it to obsolete(fieldname).
- DBSchemaManager::dbDataType() — Method in class DBSchemaManager
- DBSchemaManager::databaseList() — Method in class DBSchemaManager
Retrieves the list of all databases the user has access to
- DBSchemaManager::databaseExists() — Method in class DBSchemaManager
Determine if the database with the specified name exists
- DBSchemaManager::dropDatabase() — Method in class DBSchemaManager
Drops a database with the specified name
- DBSchemaManager::date() — Method in class DBSchemaManager
Returns data type for 'date' column
- DBSchemaManager::decimal() — Method in class DBSchemaManager
Returns data type for 'decimal' column
- DBSchemaManager::datetime() — Method in class DBSchemaManager
Returns data type for 'datetime' column
- Database — Class in namespace SilverStripe\ORM\Connect
Abstract database connectivity class.
- Database::datetimeIntervalClause() — Method in class Database
function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime addition
- Database::datetimeDifferenceClause() — Method in class Database
function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime substraction
- Database::databaseExists() — Method in class Database
Determine if the database with the specified name exists
- Database::databaseList() — Method in class Database
Retrieves the list of all databases the user has access to
- Database::dropSelectedDatabase() — Method in class Database
Drop the database that this object is currently connected to.
- DatabaseException — Class in namespace SilverStripe\ORM\Connect
Error class for database exceptions
- MySQLDatabase::datetimeIntervalClause() — Method in class MySQLDatabase
function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime addition
- MySQLDatabase::datetimeDifferenceClause() — Method in class MySQLDatabase
function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime substraction
- MySQLSchemaManager::databaseList() — Method in class MySQLSchemaManager
Retrieves the list of all databases the user has access to
- MySQLSchemaManager::databaseExists() — Method in class MySQLSchemaManager
Determine if the database with the specified name exists
- MySQLSchemaManager::dropDatabase() — Method in class MySQLSchemaManager
Drops a database with the specified name
- MySQLSchemaManager::dbDataType() — Method in class MySQLSchemaManager
- MySQLSchemaManager::date() — Method in class MySQLSchemaManager
Return a date type-formatted string For MySQL, we simply return the word 'date', no other parameters are necessary
- MySQLSchemaManager::decimal() — Method in class MySQLSchemaManager
Return a decimal type-formatted string
- MySQLSchemaManager::datetime() — Method in class MySQLSchemaManager
Return a datetime type-formatted string For MySQL, we simply return the word 'datetime', no other parameters are necessary
- TempDatabase::deleteAll() — Method in class TempDatabase
Clear all temp DBs on this connection
- DB — Class in namespace SilverStripe\ORM
Global database interface, complete with static methods.
- DB::dont_require_table() — Method in class DB
If the given table exists, move it out of the way by renaming it to obsolete(tablename).
- DB::dont_require_field() — Method in class DB
See {@link SS_Database->dontRequireField()}.
- DataExtension — Class in namespace SilverStripe\ORM
An extension that adds additional functionality to a {@link DataObject}.
- DataList — Class in namespace SilverStripe\ORM
Implements a "lazy loading" DataObjectSet.
- DataList::dataClass() — Method in class DataList
Get the dataClass name for this DataList, ie the DataObject ClassName
- DataList::dataQuery() — Method in class DataList
Return a copy of the internal {@link DataQuery} object
- DataList::distinct() — Method in class DataList
Return a new DataList instance with distinct records or not
- DataList::debug() — Method in class DataList
- DataList::dbObject() — Method in class DataList
- DataObject — Class in namespace SilverStripe\ORM
A single database record & abstract class for the data-access-model.
- $ DataObject#default_classname — Property in class DataObject
Allows specification of a default value for the ClassName field.
- $ DataObject#destroyed — Property in class DataObject
- $ DataObject#db — Property in class DataObject
Database field definitions.
- $ DataObject#defaults — Property in class DataObject
Inserts standard column-values when a DataObject is instantiated. Does not insert default records {see $default_records}.
- $ DataObject#default_records — Property in class DataObject
Multidimensional array which inserts default data into the database on a db/build-call as long as the database-table is empty. Please use this only for simple constructs, not for SiteTree-Objects etc. which need special behaviour such as publishing and ParentNodes.
- $ DataObject#default_sort — Property in class DataObject
The default sort expression. This will be inserted in the ORDER BY clause of a SQL query if no other sort expression is provided.
- DataObject::destroy() — Method in class DataObject
Destroy all of this objects dependant objects and local caches.
- DataObject::duplicate() — Method in class DataObject
Create a duplicate of this node. Can duplicate many_many relations
- DataObject::defineMethods() — Method in class DataObject
Adds methods from the extensions.
- DataObject::data() — Method in class DataObject
Returns the associated database record - in this case, the object itself.
- DataObject::doValidate() — Method in class DataObject
Public accessor for {see DataObject::validate()}
- DataObject::delete() — Method in class DataObject
Delete this data object.
- DataObject::delete_by_id() — Method in class DataObject
Delete the record with the given ID.
- DataObject::database_extensions() — Method in class DataObject
This returns an array (if it exists) describing the database extensions that are required, or false if none
- DataObject::debug() — Method in class DataObject
Debugging used by Debug::show()
- DataObject::dbObject() — Method in class DataObject
Return the DBField object that represents the given field.
- DataObject::defaultSearchFilters() — Method in class DataObject
Defines a default list of filters for the search context.
- DataObject::disable_subclass_access() — Method in class DataObject
Temporarily disable subclass access in data object qeur
- DataObjectInterface — Class in namespace SilverStripe\ORM
DataObjectInterface is an interface that other data systems in your application can implement in order to behave in a manner similar to DataObject.
- DataObjectInterface::delete() — Method in class DataObjectInterface
Remove this object from the database. Doesn't do anything if this object isn't in the database.
- DataObjectSchema — Class in namespace SilverStripe\ORM
Provides {@link \SilverStripe\ORM\DataObject} and database schema mapping functionality
- DataObjectSchema::databaseFields() — Method in class DataObjectSchema
Return the complete map of fields to specification on this object, including fixed_fields.
- DataObjectSchema::databaseField() — Method in class DataObjectSchema
Gets a single database field.
- DataObjectSchema::databaseIndexes() — Method in class DataObjectSchema
- DataQuery — Class in namespace SilverStripe\ORM
An object representing a query of data from the DataObject's supporting database.
- DataQuery::dataClass() — Method in class DataQuery
Return the {@link DataObject} class that is being queried.
- DataQuery::disjunctiveGroup() — Method in class DataQuery
Create a disjunctive subgroup.
- DataQuery::distinct() — Method in class DataQuery
Set whether this query should be distinct or not.
- DataQueryManipulator — Class in namespace SilverStripe\ORM
Allows middleware to modily finalised dataquery on a per-instance basis
- DataQuery_SubGroup — Class in namespace SilverStripe\ORM
Represents a subgroup inside a WHERE clause in a {@link DataQuery}
- DatabaseAdmin — Class in namespace SilverStripe\ORM
DatabaseAdmin class
- DatabaseAdmin::doBuild() — Method in class DatabaseAdmin
Updates the database schema, creating tables & fields as necessary.
- DBBigInt — Class in namespace SilverStripe\ORM\FieldType
Represents a signed 8 byte integer field. Do note PHP running as 32-bit might not work with Bigint properly, as it would convert the value to a float when queried from the database since the value is a 64-bit one.
- DBBoolean — Class in namespace SilverStripe\ORM\FieldType
Represents a boolean field.
- DBClassName — Class in namespace SilverStripe\ORM\FieldType
Represents a classname selector, which respects obsolete clasess.
- DBComposite — Class in namespace SilverStripe\ORM\FieldType
Apply this interface to any {@link DBField} that doesn't have a 1-1 mapping with a database field.
- DBComposite::dbObject() — Method in class DBComposite
Get a db object for the named field
- DBCurrency — Class in namespace SilverStripe\ORM\FieldType
Represents a decimal field containing a currency amount.
- DBDate — Class in namespace SilverStripe\ORM\FieldType
Represents a date field.
- DBDate::DayOfWeek() — Method in class DBDate
Returns the day of the week
- DBDate::DayOfMonth() — Method in class DBDate
Returns the day of the month.
- DBDatetime — Class in namespace SilverStripe\ORM\FieldType
Represents a date-time field.
- DBDatetime::Date() — Method in class DBDatetime
Returns the standard localised date
- DBDecimal — Class in namespace SilverStripe\ORM\FieldType
Represents a Decimal field.
- DBDouble — Class in namespace SilverStripe\ORM\FieldType
Supports double precision DB types
- DBEnum — Class in namespace SilverStripe\ORM\FieldType
Class Enum represents an enumeration of a set of strings.
- DBField — Class in namespace SilverStripe\ORM\FieldType
Single field in the database.
- $ DBField#default_search_filter_class — Property in class DBField
Subclass of {@link SearchFilter} for usage in {@link defaultSearchFilter()}.
- DBField::defaultSearchFilter() — Method in class DBField
- DBField::debug() — Method in class DBField
- DBFloat — Class in namespace SilverStripe\ORM\FieldType
Represents a floating point field.
- DBForeignKey — Class in namespace SilverStripe\ORM\FieldType
A special type Int field used for foreign keys in has_one relationships.
- $ DBForeignKey#dropdown_field_threshold — Property in class DBForeignKey
This represents the number of related objects to show in a dropdown before it reverts to a NumericField. If you are tweaking this value, you should also consider constructing your form field manually rather than allowing it to be scaffolded
- DBHTMLText — Class in namespace SilverStripe\ORM\FieldType
Represents a large text field that contains HTML content.
- DBHTMLVarchar — Class in namespace SilverStripe\ORM\FieldType
Represents a short text field that is intended to contain HTML content.
- DBIndexable — Class in namespace SilverStripe\ORM\FieldType
Classes that implement the DBIndexable interface will provide options to set various index types and index contents, which will be processed by {@link \SilverStripe\ORM\DataObjectSchema}
- DBInt — Class in namespace SilverStripe\ORM\FieldType
Represents a signed 32 bit integer field.
- DBLocale — Class in namespace SilverStripe\ORM\FieldType
Locale database field, mainly used in {@link Translatable} extension.
- DBMoney — Class in namespace SilverStripe\ORM\FieldType
Provides storage of a localised money object in currency and amount components.
- DBMultiEnum — Class in namespace SilverStripe\ORM\FieldType
Represents an multi-select enumeration field.
- DBPercentage — Class in namespace SilverStripe\ORM\FieldType
Represents a decimal field from 0-1 containing a percentage value.
- DBPolymorphicForeignKey — Class in namespace SilverStripe\ORM\FieldType
A special ForeignKey class that handles relations with arbitrary class types
- DBPrimaryKey — Class in namespace SilverStripe\ORM\FieldType
A special type Int field used for primary keys.
- DBString — Class in namespace SilverStripe\ORM\FieldType
An abstract base class for the string field types (i.e. Varchar and Text)
- DBText — Class in namespace SilverStripe\ORM\FieldType
Represents a variable-length string of up to 16 megabytes, designed to store raw text
- DBTime — Class in namespace SilverStripe\ORM\FieldType
Represents a column in the database with the type 'Time'.
- DBVarchar — Class in namespace SilverStripe\ORM\FieldType
Class Varchar represents a variable-length string of up to 255 characters, designed to store raw text
- DBYear — Class in namespace SilverStripe\ORM\FieldType
Represents a single year field.
- ListDecorator::debug() — Method in class ListDecorator
- Relation::dbObject() — Method in class Relation
Return the DBField object that represents the given field on the related class.
- Relation::dataClass() — Method in class Relation
- UnsavedRelationList::dataClass() — Method in class UnsavedRelationList
Get the dataClass name for this relation, ie the DataObject ClassName
- UnsavedRelationList::dbObject() — Method in class UnsavedRelationList
Return the DBField object that represents the given field on the related class.
- Report::description() — Method in class Report
Return the description of this report.
- Report::dataClass() — Method in class Report
Return the data class for this report
- ReportWrapper::description() — Method in class ReportWrapper
Return the description of this report.
- Form::doRefuse() — Method in class Form
The form refusal handler. Cleans up the confirmation storage and returns the failure redirection (kept in the storage)
- Form::doConfirm() — Method in class Form
The form confirmation handler. Checks all the items in the storage has been confirmed and marks them as such. Returns a redirect when all the storage items has been verified and marked as confirmed.
- DefaultAdminService — Class in namespace SilverStripe\Security
Provides access to the default admin
- DefaultPermissionChecker — Class in namespace SilverStripe\Security
Allows objects to enforce permissions for the "root" level, where permissions can not be tied to a particular database record.
- $ Group#Description — Property in class Group
Description of the group
- Group::DirectMembers() — Method in class Group
Return only the members directly added to this group
- $ GroupCsvBulkLoader#duplicateChecks — Property in class GroupCsvBulkLoader
- $ Member#DateFormat — Property in class Member
- Member::default_admin() — Method in class Member
Get the default admin record if it exists, or creates it otherwise if enabled
- Member::DirectGroups() — Method in class Member
- ChangePasswordHandler::doChangePassword() — Method in class ChangePasswordHandler
Change the password
- LoginHandler::doLogin() — Method in class LoginHandler
Login form handler method
- LogoutHandler::doLogOut() — Method in class LogoutHandler
- $ MemberCsvBulkLoader#duplicateChecks — Property in class MemberCsvBulkLoader
- $ PasswordExpirationMiddleware#default_redirect — Property in class PasswordExpirationMiddleware
Where users with expired passwords get redirected by default when login form didn't register a custom one with {see SilverStripe\Security\AuthenticationMiddleware::setRedirect}
- Permission::deny() — Method in class Permission
Deny the given permission code/arg to the given group
- $ RememberLoginHash#device_expiry_days — Property in class RememberLoginHash
Number of days the device ID will be valid for
- $ RememberLoginHash#DeviceID — Property in class RememberLoginHash
- $ Security#default_message_set — Property in class Security
Default message set used in permission failures.
- $ Security#default_login_dest — Property in class Security
- $ Security#default_reset_password_dest — Property in class Security
- Security::default_admin_username() — Method in class Security
Get default admin username
- Security::default_admin_password() — Method in class Security
Get default admin password
- Security::database_is_ready() — Method in class Security
Checks the database is in a state to perform security checks.
- SecurityToken::disable() — Method in class SecurityToken
Globally disable the token (override with {@link NullSecurityToken}) implementation. Note: Does not apply for
- ArchiveRestoreAction::doRestore() — Method in class ArchiveRestoreAction
Restore the record to its original place or top level if that's not possible
- DataObjectVersionFormFactory — Class in namespace SilverStripe\VersionedAdmin\Forms
- DiffField — Class in namespace SilverStripe\VersionedAdmin\Forms
This form field is both a field object in it's own right, and a decorator for another field type.
- DiffTransformation — Class in namespace SilverStripe\VersionedAdmin\Forms
- $ HistoryViewerField#default_page_size — Property in class HistoryViewerField
The default pagination page size
- ProxyCacheAdapter::delete() — Method in class ProxyCacheAdapter
{@inheritdoc}
- ProxyCacheAdapter::deleteMultiple() — Method in class ProxyCacheAdapter
{@inheritdoc}
- DataDifferencer — Class in namespace SilverStripe\Versioned
Utility class to render views of the differences between two data objects (or two versions of the same data object).
- DataDifferencer::diffedData() — Method in class DataDifferencer
Get a DataObject with altered values replaced with HTML diff strings, incorporating and
tags.- DataObjectScaffolderExtension — Class in namespace SilverStripe\Versioned\GraphQL\Extensions
- DeleteExtension — Class in namespace SilverStripe\Versioned\GraphQL\Extensions
Extends the see Delete CRUD scaffolder to unpublish any items first
- RecursivePublishable::deleteFromChangeSets() — Method in class RecursivePublishable
Remove this item from any changesets
- $ Versioned#draft_site_secured — Property in class Versioned
Default config for $is_draft_site_secured
- $ Versioned#db — Property in class Versioned
- Versioned::doArchive() — Method in class Versioned
Removes the record from both live and stage
- Versioned::doUnpublish() — Method in class Versioned
Removes this record from the live site
- Versioned::doRevertToLive() — Method in class Versioned
Revert the draft changes: replace the draft content with the content on live
- Versioned::deleteFromStage() — Method in class Versioned
Delete this record from the given stage
- Versioned::doRollbackTo() — Method in class Versioned
Roll the draft version of this record to match the published record.
- VersionedGridFieldItemRequest::doArchive() — Method in class VersionedGridFieldItemRequest
Archive this versioned record
- VersionedGridFieldItemRequest::doPublish() — Method in class VersionedGridFieldItemRequest
Publish this versioned record
- VersionedGridFieldItemRequest::doUnpublish() — Method in class VersionedGridFieldItemRequest
Delete this record from the live site
- Diff — Class in namespace SilverStripe\View\Parsers
Class representing a 'diff' between two sequences of strings.
- $ URLSegmentFilter#default_use_transliterator — Property in class URLSegmentFilter
- $ URLSegmentFilter#default_replacements — Property in class URLSegmentFilter
- $ URLSegmentFilter#default_allow_multibyte — Property in class URLSegmentFilter
Doesn't try to replace or transliterate non-ASCII filters.
- $ Requirements#disable_flush_combined — Property in class Requirements
Flag whether combined files should be deleted on flush.
- Requirements::delete_all_combined_files() — Method in class Requirements
Deletes all generated combined files in the configured combined files directory, but doesn't delete the directory itself
- Requirements::debug() — Method in class Requirements
Output debugging information
- $ Requirements_Backend#default_combined_files_folder — Property in class Requirements_Backend
Configures the default prefix for combined files.
- Requirements_Backend::deleteAllCombinedFiles() — Method in class Requirements_Backend
Clears all combined files
- Requirements_Backend::debug() — Method in class Requirements_Backend
Output debugging information.
- SSTemplateParser::DollarMarkedLookup_STR() — Method in class SSTemplateParser
- SSViewer::dontRewriteHashlinks() — Method in class SSViewer
Call this to disable rewriting of links. This is useful in Ajax applications.
- $ ViewableData#default_cast — Property in class ViewableData
The default object to cast scalar fields to if casting information is not specified, and casting to an object is required.
- ViewableData::defineMethods() — Method in class ViewableData
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
- ViewableData::Debug() — Method in class ViewableData
Return debug information about this object that can be rendered into a template
- $ i18n#default_locale — Property in class i18n
- $ i18n#date_format — Property in class i18n
System-wide date format. Will be overruled for CMS UI display by the format defaults inferred from the browser as well as any user-specific locale preferences.
E
- EditorEmailLinkFormFactory — Class in namespace SilverStripe\Admin\Forms
- EditorExternalLinkFormFactory — Class in namespace SilverStripe\Admin\Forms
- $ LeftAndMain#extra_requirements_javascript — Property in class LeftAndMain
Register additional requirements through the {@link Requirements} class.
- $ LeftAndMain#extra_requirements_css — Property in class LeftAndMain
YAML configuration example:
LeftAndMain: extra_requirements_css: mysite/css/mystyle.css: media: screen
- $ LeftAndMain#extra_requirements_themedCss — Property in class LeftAndMain
- LeftAndMain::EditForm() — Method in class LeftAndMain
Retrieves an edit form, either for display, or to process submitted data.
- LeftAndMain::EmptyForm() — Method in class LeftAndMain
Returns a placeholder form, used by {@link getEditForm()} if no record is selected.
- LeftAndMain::EditFormTools() — Method in class LeftAndMain
Renders a panel containing tools which apply to the currently displayed edit form.
- ModalController::EditorExternalLink() — Method in class ModalController
Builds and returns the external link form
- ModalController::EditorEmailLink() — Method in class ModalController
Builds and returns the external link form
- $ RemoteFileFormFactory#enabled — Property in class RemoteFileFormFactory
Allow oembed to be disabled
- EmbedResource — Class in namespace SilverStripe\AssetAdmin\Model
- Embeddable — Class in namespace SilverStripe\AssetAdmin\Model
- File::exists() — Method in class File
A file only exists if the file_exists() and is in the DB as a record
- FlysystemAssetStore::exists() — Method in class FlysystemAssetStore
Determine if a file exists with the given tuple
- Folder::exists() — Method in class Folder
A file only exists if the file_exists() and is in the DB as a record
- ImageManipulation::existingOnly() — Method in class ImageManipulation
Return clone of self which promises to only return existing thumbnails
- ImageManipulation::exists() — Method in class ImageManipulation
Determine if this container has a valid value
- $ InterventionBackend#error_cache_ttl — Property in class InterventionBackend
How long to cache each error type
- AssetContainer::exists() — Method in class AssetContainer
Determine if this container has a valid value
- AssetStore::exists() — Method in class AssetStore
Determine if a file exists with the given tuple
- DBFile::exists() — Method in class DBFile
Composite field defaults to exists only if all fields have values
- $ CMSMain#enable_dynamic_archive_warning_message — Property in class CMSMain
Should the archive warning message be dynamic based on the specific content? This is slow on larger sites and can be disabled.
- CMSMain::ExtraTreeTools() — Method in class CMSMain
- CMSMain::EditForm() — Method in class CMSMain
Retrieves an edit form, either for display, or to process submitted data.
- CMSMain::EmptyForm() — Method in class CMSMain
Returns a placeholder form, used by {@link getEditForm()} if no record is selected.
- InternalLinkModalExtension::editorInternalLink() — Method in class InternalLinkModalExtension
Form for inserting internal link pages
- InternalLinkModalExtension::editorAnchorLink() — Method in class InternalLinkModalExtension
- $ RedirectorPage#ExternalURL — Property in class RedirectorPage
URL to redirect to if $RedirectionType is 'External'
- $ SiteTree#enforce_strict_hierarchy — Property in class SiteTree
- $ SiteTree#ExtraMeta — Property in class SiteTree
- SiteTree::ElementName() — Method in class SiteTree
Return a CSS identifier generated from this page's link.
- SiteTree::enableCMSFieldsExtensions() — Method in class SiteTree
Reenables extendCMSFields() being called on getCMSFields() after it has been disabled by disableCMSFieldsExtensions().
- SiteTree::EditorGroups() — Method in class SiteTree
List of groups that can edit this object.
- EmptyPagesReport — Class in namespace SilverStripe\CMS\Reports
- CampaignAdmin::EditForm() — Method in class CampaignAdmin
Retrieves an edit form, either for display, or to process submitted data.
- CachedConfigCollection::exists() — Method in class CachedConfigCollection
Checks to see if a config item exists, or a property on that class
- ConfigCollectionInterface::exists() — Method in class ConfigCollectionInterface
Checks to see if a config item exists, or a property on that class
- MemoryConfigCollection::exists() — Method in class MemoryConfigCollection
Checks to see if a config item exists, or a property on that class
- $ ContentNegotiator#encoding — Property in class ContentNegotiator
- $ ContentNegotiator#enabled — Property in class ContentNegotiator
- ContentNegotiator::enabled_for() — Method in class ContentNegotiator
Returns true if negotiation is enabled for the given response. By default, negotiation is only enabled for pages that have the xml header.
- Email — Class in namespace SilverStripe\Control\Email
Class to support sending emails.
- HTTPApplication::execute() — Method in class HTTPApplication
Safely boot the application and execute the given main action
- HTTPRequestBuilder::extractRequestHeaders() — Method in class HTTPRequestBuilder
Takes a $_SERVER data array and extracts HTTP request headers.
- EnvironmentBypass — Class in namespace SilverStripe\Control\Middleware\ConfirmationMiddleware
Allows a bypass for a list of environment types (e.g. DEV, TEST, LIVE)
- ExecMetricMiddleware — Class in namespace SilverStripe\Control\Middleware
Display execution metrics for the current request if in dev mode and
execmetric
is provided as a request variable.- HTTPCacheControlMiddleware::enableCache() — Method in class HTTPCacheControlMiddleware
Simple way to set cache control header to a cacheable state.
- RSSFeed::Entries() — Method in class RSSFeed
Get the RSS feed entries
- Application::execute() — Method in class Application
Safely boot the application and execute the given main action
- ClassInfo::exists() — Method in class ClassInfo
Returns true if a class or interface name exists.
- ExtensionMiddleware — Class in namespace SilverStripe\Core\Config\Middleware
- Environment — Class in namespace SilverStripe\Core
Consolidates access and modification of PHP global variables and settings.
- EnvironmentLoader — Class in namespace SilverStripe\Core
Loads environment variables from .env files Loosely based on https://github.com/vlucas/phpdotenv/blob/master/src/Loader.php
- Extensible — Class in namespace SilverStripe\Core
Allows an object to have extensions applied to it.
- $ Extensible#extensions — Property in class Extensible
An array of extension names and parameters to be applied to this object upon construction.
- Extensible::extend() — Method in class Extensible
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
- Extension — Class in namespace SilverStripe\Core
Add extension that can be added to an object with {@link Object::add_extension()}.
- ClassManifestVisitor::enterNode() — Method in class ClassManifestVisitor
- ModuleResource::exists() — Method in class ModuleResource
Determine if this resource exists
- CLI::end_colour() — Method in class CLI
Send control codes for returning to normal colour
- ArraySubset::evaluate() — Method in class ArraySubset
Evaluates the constraint for parameter $other
- SSListContains::evaluate() — Method in class SSListContains
Evaluates the constraint for parameter $other
- SSListContainsOnly::evaluate() — Method in class SSListContainsOnly
Evaluates the constraint for parameter $other
- SSListContainsOnlyMatchingItems::evaluate() — Method in class SSListContainsOnlyMatchingItems
Evaluates the constraint for parameter $other
- ViewableDataContains::evaluate() — Method in class ViewableDataContains
Evaluates the constraint for parameter $other
- $ CsvBulkLoader#enclosure — Property in class CsvBulkLoader
Enclosure character (Default: doublequote)
- Debug::endshow() — Method in class Debug
Close out the show dumper.
- DevelopmentAdmin::errors() — Method in class DevelopmentAdmin
- SapphireInfo::EnvironmentType() — Method in class SapphireInfo
- SapphireREPL::error_handler() — Method in class SapphireREPL
- ExtensionTestState — Class in namespace SilverStripe\Dev\State
Manages illegal and required extensions for sapphiretest
- ErrorPage — Class in namespace SilverStripe\ErrorPage
ErrorPage holds the content for the page of an error response.
- ErrorPageController — Class in namespace SilverStripe\ErrorPage
Class ErrorPageController
- ErrorPageControllerExtension — Class in namespace SilverStripe\ErrorPage
Class ErrorPageControllerExtension
- ErrorPageErrorFormatter — Class in namespace SilverStripe\ErrorPage
Class ErrorPageErrorFormatter
- ErrorPageExtension — Class in namespace SilverStripe\ErrorPage
Class ErrorPageExtension
- $ ErrorPageExtension#enable_static_file — Property in class ErrorPageExtension
Allows control over writing directly to the configured
GeneratedAssetStore
.- $ ErrorPageExtension#ErrorCode — Property in class ErrorPageExtension
- ErrorPageFileExtension — Class in namespace SilverStripe\ErrorPage
Class ErrorPageFileExtension
- CompositeField::extraClass() — Method in class CompositeField
Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
- EmailField — Class in namespace SilverStripe\Forms
Text input field with validation for correct email format according to RFC 2822.
- Form::enableSecurityToken() — Method in class Form
Enable {@link SecurityToken} protection for this form instance.
- Form::extraClass() — Method in class Form
Compiles all CSS-classes.
- FormField::extraClass() — Method in class FormField
Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
- GridFieldDetailForm_ItemRequest::edit() — Method in class GridFieldDetailForm_ItemRequest
- $ TinyMCEConfig#editor_css — Property in class TinyMCEConfig
Extra editor.css file paths.
- TinyMCEConfig::enablePlugins() — Method in class TinyMCEConfig
Enable one or several plugins. Will maintain unique list if already enabled plugin is re-passed. If passed in as a map of plugin-name to path, the plugin will be loaded by tinymce.PluginManager.load() instead of through tinyMCE.init().
- Tab::extraClass() — Method in class Tab
Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
- TreeDropdownField::extraClass() — Method in class TreeDropdownField
Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.
- $ DevBuildExtension#enabled — Property in class DevBuildExtension
- $ QueryHandler#errorHandler — Property in class QueryHandler
- AbstractBulkLoader::exclude() — Method in class AbstractBulkLoader
- ExtensionLoader — Class in namespace SilverStripe\GraphQL\Schema\BulkLoader
Loads classes that have a given extension assigned to them.
- ExtensionLoader::exclude() — Method in class ExtensionLoader
- InheritanceLoader::exclude() — Method in class InheritanceLoader
- EndsWithFilter — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter\Filters
A query filter that filters records by the end of a field's contents
- EqualToFilter — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter\Filters
A query filter that filters records by exact match of a keyword
- EmptySchemaException — Class in namespace SilverStripe\GraphQL\Schema\Exception
- Encoder — Class in namespace SilverStripe\GraphQL\Schema\Interfaces
A class that is capable of expressing itself in generated code
- Encoder::encode() — Method in class Encoder
- ExtraTypeProvider — Class in namespace SilverStripe\GraphQL\Schema\Interfaces
For models that provide extra types to the schema
- SchemaStorageInterface::exists() — Method in class SchemaStorageInterface
- Logger::emergency() — Method in class Logger
- Logger::error() — Method in class Logger
- EncodedResolver — Class in namespace SilverStripe\GraphQL\Schema\Resolver
A resolver function that can be expressed in generated PHP code
- EncodedResolver::encode() — Method in class EncodedResolver
- Schema::exists() — Method in class Schema
- Schema::eagerLoad() — Method in class Schema
Some types must be eagerly loaded into the schema if they cannot be discovered through introspection.
- StorableSchema::exists() — Method in class StorableSchema
- CodeGenerationStore::exists() — Method in class CodeGenerationStore
- Encoder — Class in namespace SilverStripe\GraphQL\Schema\Storage
- Encoder::encode() — Method in class Encoder
- EncodedType — Class in namespace SilverStripe\GraphQL\Schema\Type
A type that can be expressed as generated PHP code
- EncodedType::encode() — Method in class EncodedType
- Enum — Class in namespace SilverStripe\GraphQL\Schema\Type
Abstraction for enum types
- Type::exists() — Method in class Type
- ErrorHandler — Class in namespace SilverStripe\Logging
Core error handler for a SilverStripe application
- ArrayList::exists() — Method in class ArrayList
Returns true if this list has items
- ArrayList::each() — Method in class ArrayList
Walks the list using the specified callback
- ArrayList::exclude() — Method in class ArrayList
Exclude the list to not contain items with these charactaristics
- DBConnector::escapeString() — Method in class DBConnector
Given a value escape this for use in a query for the current database connector. Note that this does not quote the value.
- DBSchemaManager::enumValuesForField() — Method in class DBSchemaManager
Returns the values of the given enum field
- DBSchemaManager::enum() — Method in class DBSchemaManager
Returns data type for 'set' column
- Database::escapeString() — Method in class Database
Returns an escaped string. This string won't be quoted, so would be suitable for appending to other quoted strings.
- Database::escapeIdentifier() — Method in class Database
Escapes an identifier (table / database name). Typically the value is simply double quoted. Don't pass in already escaped identifiers in, as this will double escape the value!
- MySQLSchemaManager::enumValuesForField() — Method in class MySQLSchemaManager
Returns the values of the given enum field
- MySQLSchemaManager::enum() — Method in class MySQLSchemaManager
Return a enum type-formatted string
- MySQLiConnector::escapeString() — Method in class MySQLiConnector
Given a value escape this for use in a query for the current database connector. Note that this does not quote the value.
- $ PDOConnector#emulate_prepare — Property in class PDOConnector
Should ATTR_EMULATE_PREPARES flag be used to emulate prepared statements?
- PDOConnector::escapeString() — Method in class PDOConnector
Given a value escape this for use in a query for the current database connector. Note that this does not quote the value.
- PDOConnector::exec() — Method in class PDOConnector
Executes a query that doesn't return a resultset
- PDOStatementHandle::errorCode() — Method in class PDOStatementHandle
Fetch the SQLSTATE associated with the last operation on the statement handle (PDOStatement::errorCode)
- PDOStatementHandle::errorInfo() — Method in class PDOStatementHandle
Fetch extended error information associated with the last operation on the statement handle (PDOStatement::errorInfo)
- PDOStatementHandle::execute() — Method in class PDOStatementHandle
Executes a prepared statement (PDOStatement::execute)
- DataExtension::extraStatics() — Method in class DataExtension
Define extra database fields
- DataList::exclude() — Method in class DataList
Return a copy of this list which does not contain any items that match all params
- DataList::excludeAny() — Method in class DataList
Return a copy of this list which does not contain any items with any of these params
- DataList::each() — Method in class DataList
Walks the list using the specified callback
- DataList::exists() — Method in class DataList
Returns true if this DataList has items
- DataObject::exists() — Method in class DataObject
Returns true if this object "exists", i.e., has a sensible value.
- DataObject::extendedCan() — Method in class DataObject
Process tri-state responses from permission-alterting extensions. The extensions are expected to return one of three values:
- DataObject::enable_subclass_access() — Method in class DataObject
- DataQuery::execute() — Method in class DataQuery
Execute the query and return the result as {@link SS_Query} object.
- DBComposite::exists() — Method in class DBComposite
Composite field defaults to exists only if all fields have values
- DBEnum::enumValues() — Method in class DBEnum
Returns the values of this enum as an array, suitable for insertion into a {@link DropdownField}
- $ DBField#escape_type — Property in class DBField
The escape type for this field when inserted into a template - either "xml" or "raw".
- DBField::exists() — Method in class DBField
Determines if the field has a value which is not considered to be 'null' in a database context.
- DBHTMLText::exists() — Method in class DBHTMLText
(non-PHPdoc)
- DBHTMLVarchar::exists() — Method in class DBHTMLVarchar
(non-PHPdoc)
- DBMoney::exists() — Method in class DBMoney
- DBString::exists() — Method in class DBString
(non-PHPdoc)
- Filterable::exclude() — Method in class Filterable
Return a new instance of this list that excludes any items with these charactaristics
- EndsWithFilter — Class in namespace SilverStripe\ORM\Filters
Matches textual content with a substring match on a text fragment leading to the end of the string.
- ExactMatchFilter — Class in namespace SilverStripe\ORM\Filters
Selects textual content with an exact match between columnname and keyword.
- SearchFilter::exclude() — Method in class SearchFilter
Exclude filter criteria from a SQL query.
- ListDecorator::exists() — Method in class ListDecorator
Return true if this object "exists" i.e. has a sensible value
- ListDecorator::each() — Method in class ListDecorator
Walks the list using the specified callback
- ListDecorator::exclude() — Method in class ListDecorator
Exclude the list to not contain items with these charactaristics
- ManyManyThroughQueryManipulator::extractInheritableQueryParameters() — Method in class ManyManyThroughQueryManipulator
Calculate the query parameters that should be inherited from the base many_many to the nested has_many list.
- SQLExpression::execute() — Method in class SQLExpression
Execute this query.
- SQLSelect::expressionForField() — Method in class SQLSelect
Return the SQL expression for the given field alias.
- SS_List::each() — Method in class SS_List
Walks the list using the specified callback
- FulltextSearchable::enable() — Method in class FulltextSearchable
Enable the default configuration of MySQL full-text searching on the given data classes.
- $ Report#excluded_reports — Property in class Report
Reports which should not be collected and returned in get_reports
- Report::extendedCan() — Method in class Report
Helper to assist with permission extension
- $ BasicAuth#entire_site_protected — Property in class BasicAuth
- $ BasicAuth#entire_site_protected_code — Property in class BasicAuth
- $ BasicAuth#entire_site_protected_message — Property in class BasicAuth
- CMSSecurity::enabled() — Method in class CMSSecurity
Determine if CMSSecurity is enabled
- InheritedPermissionsExtension::EditorGroups() — Method in class InheritedPermissionsExtension
- $ LoginAttempt#Email — Property in class LoginAttempt
Email address used for login attempt. @deprecated 3.0.0:5.0.0
- $ LoginAttempt#EmailHashed — Property in class LoginAttempt
sha1 hashed Email address used for login attempt
- $ Member#Email — Property in class Member
- Member::encryptWithUserSettings() — Method in class Member
Utility for generating secure password hashes for this member.
- $ PasswordEncryptor#encryptors — Property in class PasswordEncryptor
- PasswordEncryptor::encrypt() — Method in class PasswordEncryptor
Return a string value stored in the {@link Member->Password} property.
- PasswordEncryptor_Blowfish::encrypt() — Method in class PasswordEncryptor_Blowfish
Return a string value stored in the {@link Member->Password} property.
- PasswordEncryptor_Blowfish::encryptX() — Method in class PasswordEncryptor_Blowfish
- PasswordEncryptor_Blowfish::encryptY() — Method in class PasswordEncryptor_Blowfish
- PasswordEncryptor_Blowfish::encryptA() — Method in class PasswordEncryptor_Blowfish
- PasswordEncryptor_LegacyPHPHash::encrypt() — Method in class PasswordEncryptor_LegacyPHPHash
Return a string value stored in the {@link Member->Password} property.
- PasswordEncryptor_MySQLOldPassword::encrypt() — Method in class PasswordEncryptor_MySQLOldPassword
Return a string value stored in the {@link Member->Password} property.
- PasswordEncryptor_MySQLPassword::encrypt() — Method in class PasswordEncryptor_MySQLPassword
Return a string value stored in the {@link Member->Password} property.
- PasswordEncryptor_None::encrypt() — Method in class PasswordEncryptor_None
Return a string value stored in the {@link Member->Password} property.
- PasswordEncryptor_PHPHash::encrypt() — Method in class PasswordEncryptor_PHPHash
Return a string value stored in the {@link Member->Password} property.
- $ RememberLoginHash#ExpiryDate — Property in class RememberLoginHash
- Security::encrypt_password() — Method in class Security
Encrypt a password according to the current password encryption settings.
- SecurityToken::enable() — Method in class SecurityToken
Globally enable tokens that have been previously disabled through {@link disable}.
- SiteConfig::EditorGroups() — Method in class SiteConfig
List of groups that can edit SiteConfig.
- VersionableExtension::extendWithSuffix() — Method in class VersionableExtension
Modify table name with suffix.
- Versioned::extendWithSuffix() — Method in class Versioned
- EmbedResource — Class in namespace SilverStripe\View\Embed
Encapsulation of an embed tag, linking to an external media source.
- Embeddable — Class in namespace SilverStripe\View\Embed
Abstract interface for an embeddable resource
- $ ShortcodeParser#error_behavior — Property in class ShortcodeParser
- ShortcodeParser::extractTags() — Method in class ShortcodeParser
Look through a string that contains shortcode tags and pull out the locations and details of those tags
- SSViewer::exists() — Method in class SSViewer
- SSViewer::execute_template() — Method in class SSViewer
Execute the given template, passing it the given data.
- SSViewer::execute_string() — Method in class SSViewer
Execute the evaluated string, passing it the given data.
- SSViewer_BasicIteratorSupport::Even() — Method in class SSViewer_BasicIteratorSupport
Return true if this object is an even item in the set.
- SSViewer_BasicIteratorSupport::EvenOdd() — Method in class SSViewer_BasicIteratorSupport
Return 'even' or 'odd' if this object is in an even or odd position in the set respectively.
- EmbedShortcodeProvider — Class in namespace SilverStripe\View\Shortcodes
Provider for the [embed] shortcode tag used by the embedding service in the HTML Editor field.
- EmbedShortcodeProvider::embedForTemplate() — Method in class EmbedShortcodeProvider
- ViewableData::exists() — Method in class ViewableData
Return true if this object "exists" i.e. has a sensible value
- ViewableData::escapeTypeForField() — Method in class ViewableData
Return the string-format type for the given field.
- i18n::encode_plurals() — Method in class i18n
Convert CLDR array plural form to
|
pipe-delimited string.
F
- $ LeftAndMain#frame_options — Property in class LeftAndMain
Value of X-Frame-Options header
- AssetAdmin::fileEditForm() — Method in class AssetAdmin
Get file edit form
- AssetAdmin::fileInsertForm() — Method in class AssetAdmin
Get file insert media form
- AssetAdmin::fileEditorLinkForm() — Method in class AssetAdmin
Get the file insert link form
- AssetAdmin::fileSelectForm() — Method in class AssetAdmin
Get form for selecting a file
- AssetAdmin::fileHistoryForm() — Method in class AssetAdmin
Get file history form
- AssetAdmin::folderCreateForm() — Method in class AssetAdmin
- AssetAdmin::fileSearchForm() — Method in class AssetAdmin
Scaffold a search form.
- FileFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms
- FileHistoryFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms
- FileSearchFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms
Scaffolds a form for searching files
- FolderCreateFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms
- FolderFormFactory — Class in namespace SilverStripe\AssetAdmin\Forms
Empty form factory, because the defaults from AssetFormFactory was enough
- $ RemoteFileFormFactory#fileurl_scheme_whitelist — Property in class RemoteFileFormFactory
Force whitelist for resource protocols to the given list.
- $ RemoteFileFormFactory#fileurl_scheme_blacklist — Property in class RemoteFileFormFactory
Blacklist of resources. Takes priority over whitelists if both are provided.
- $ RemoteFileFormFactory#fileurl_domain_whitelist — Property in class RemoteFileFormFactory
Force whitelist for resource domains to the given list
- $ RemoteFileFormFactory#fileurl_domain_blacklist — Property in class RemoteFileFormFactory
Blacklist of domains. For example, live sites should probably include 'localhost' and other protected urls.
- $ RemoteFileFormFactory#fileurl_port_whitelist — Property in class RemoteFileFormFactory
Whitelist of ports allowed.
- $ RemoteFileFormFactory#fileurl_port_blacklist — Property in class RemoteFileFormFactory
Blacklist of ports allowed.
- FileFilterInputTypeCreator — Class in namespace SilverStripe\AssetAdmin\GraphQL
- FileFilterInputTypeCreator::fields() — Method in class FileFilterInputTypeCreator
- FileFilterInputTypeCreator::filterList() — Method in class FileFilterInputTypeCreator
Caution: Does NOT enforce canView permissions
- FileInputTypeCreator — Class in namespace SilverStripe\AssetAdmin\GraphQL
- FileInputTypeCreator::fields() — Method in class FileInputTypeCreator
- FileInterfaceTypeCreator — Class in namespace SilverStripe\AssetAdmin\GraphQL
- FileInterfaceTypeCreator::fields() — Method in class FileInterfaceTypeCreator
- FileTypeCreator — Class in namespace SilverStripe\AssetAdmin\GraphQL
- FileTypeCreator::fields() — Method in class FileTypeCreator
- FileUsageType — Class in namespace SilverStripe\AssetAdmin\GraphQL
Define the return type for ReadFileUsageQueryCreator. File usage is return as an array of object with an 'id' property and 'inUseCount' property.
- FileUsageType::fields() — Method in class FileUsageType
- FolderInputTypeCreator — Class in namespace SilverStripe\AssetAdmin\GraphQL
- FolderInputTypeCreator::fields() — Method in class FolderInputTypeCreator
- FolderTypeCreator — Class in namespace SilverStripe\AssetAdmin\GraphQL
- FolderTypeCreator::fields() — Method in class FolderTypeCreator
- PublicationNoticeType::fields() — Method in class PublicationNoticeType
- FileMigrationHelper — Class in namespace SilverStripe\Assets\Dev\Tasks
Service to help migrate File dataobjects to the new APL.
- NormaliseAccessMigrationHelper::findBadFiles() — Method in class NormaliseAccessMigrationHelper
Loop through all the files and find the ones that aren't stored in the correct store.
- NormaliseAccessMigrationHelper::fix() — Method in class NormaliseAccessMigrationHelper
Make sure all versions of the povided file are stored in the correct asset store.
- File — Class in namespace SilverStripe\Assets
This class handles the representation of a file on the filesystem within the framework.
- $ File#file_types — Property in class File
A list of file extensions and a description of what type of file they represent
- $ File#Filename — Property in class File
Full filename of this file
- $ File#File — Property in class File
asset stored behind this File record
- File::find() — Method in class File
Find a File object by the given filename.
- File::format_size() — Method in class File
Formats a file size (eg: (int)42 becomes string '42 bytes')
- File::forTemplate() — Method in class File
Return a html5 tag of the appropriate for this file (normally img or a)
- File::flushCache() — Method in class File
Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.
- FileDefaultPermissions — Class in namespace SilverStripe\Assets
Permissions for root files with Can*Type = Inherit
- FileFinder — Class in namespace SilverStripe\Assets
A utility class that finds any files matching a set of rules that are present within a directory tree.
- FileFinder::find() — Method in class FileFinder
Finds all files matching the options within a directory. The search is performed depth first.
- FileNameFilter — Class in namespace SilverStripe\Assets
Filter certain characters from file name, for nicer (more SEO-friendly) URLs as well as better filesystem compatibility.
- FileNameFilter::filter() — Method in class FileNameFilter
Depending on the applied replacement rules, this method might result in an empty string. In this case, {@link getDefaultName()} will be used to return a randomly generated file name, while retaining its extension.
- Filesystem — Class in namespace SilverStripe\Assets
A collection of static methods for manipulating the filesystem.
- $ Filesystem#file_create_mask — Property in class Filesystem
- $ Filesystem#folder_create_mask — Property in class Filesystem
- Filesystem::fixfiles() — Method in class Filesystem
Cleanup function to reset all the Filename fields. Visit File/fixfiles to call.
- Filesystem::folderModTime() — Method in class Filesystem
Return the most recent modification time of anything in the folder.
- $ AssetAdapter#file_permissions — Property in class AssetAdapter
Config compatible permissions configuration
- AssetAdapter::flush() — Method in class AssetAdapter
Force flush and regeneration of server files
- FlysystemAssetStore — Class in namespace SilverStripe\Assets\Flysystem
Asset store based on flysystem Filesystem as a backend
- $ FlysystemAssetStore#file_response_headers — Property in class FlysystemAssetStore
Custom headers to add to all custom file responses
- FlysystemAssetStore::flush() — Method in class FlysystemAssetStore
Ensure each adapter re-generates its own server configuration files
- Folder — Class in namespace SilverStripe\Assets
Represents a logical folder, which may be used to organise assets stored in the configured backend.
- Folder::find_or_make() — Method in class Folder
Find the given folder or create it as a database record
- FolderNameFilter — Class in namespace SilverStripe\Assets
Filter certain characters from file name, for nicer (more SEO-friendly) URLs as well as better filesystem compatibility.
- $ ImageManipulation#force_resample — Property in class ImageManipulation
Force all images to resample in all cases Off by default, as this can be resource intensive to apply to multiple images simultaneously.
- ImageManipulation::Fit() — Method in class ImageManipulation
Scale image proportionally to fit within the specified bounds
- ImageManipulation::FitMax() — Method in class ImageManipulation
Proportionally scale down this image if it is wider or taller than the specified dimensions.
- ImageManipulation::FillMax() — Method in class ImageManipulation
Crop this image to the aspect ratio defined by the specified width and height, then scale down the image to those dimensions if it exceeds them.
- ImageManipulation::Fill() — Method in class ImageManipulation
Resize and crop image to fill specified dimensions.
- $ InterventionBackend#flush_enabled — Property in class InterventionBackend
Is cache flushing enabled?
- InterventionBackend::flush() — Method in class InterventionBackend
This function is triggered early in the request if the "flush" query parameter has been set. Each class that implements Flushable implements this function which looks after it's own specific flushing functionality.
- FileLink — Class in namespace SilverStripe\Assets\Shortcodes
Represents a link between a dataobject parent and a file shortcode in a HTML content area
- FileLinkTracking — Class in namespace SilverStripe\Assets\Shortcodes
Adds tracking of links in any HTMLText fields which reference SiteTree or File items.
- FileLinkTracking::FileTracking() — Method in class FileLinkTracking
List of files linked on this dataobject
- FileLinkTrackingParser — Class in namespace SilverStripe\Assets\Shortcodes
A helper object for extracting information about links.
- FileShortcodeProvider — Class in namespace SilverStripe\Assets\Shortcodes
Provides shortcodes for File dataobject
- FileShortcodeProvider::find_shortcode_record() — Method in class FileShortcodeProvider
Find the record to use for a given shortcode.
- FileShortcodeProvider::flush() — Method in class FileShortcodeProvider
- $ DBFile#Filename — Property in class DBFile
Name of the file, including directory
- CMSMain::flush() — Method in class CMSMain
Clear the cache on ?flush
- CMSMain::flushMemberCache() — Method in class CMSMain
Flush the hints cache for a specific member
- OldPageRedirector::find_old_page() — Method in class OldPageRedirector
Attempt to find an old/renamed page from some given the URL as an array
- SiteTreeURLSegmentField::Field() — Method in class SiteTreeURLSegmentField
Returns the form field.
- SiteTree::flushCache() — Method in class SiteTree
Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.
- SiteTree::flushMemberCache() — Method in class SiteTree
Flushes the member specific cache for creatable children
- SiteTree::fieldLabels() — Method in class SiteTree
- SiteTree::flush() — Method in class SiteTree
Clear the creatableChildren cache on flush
- RemoveOrphanedPagesTask::Form() — Method in class RemoveOrphanedPagesTask
- AddToCampaignHandler::Form() — Method in class AddToCampaignHandler
Builds a Form that mirrors the parent editForm, but with an extra field to collect the ChangeSet ID
- CampaignAdminList::FieldHolder() — Method in class CampaignAdminList
Placeholder for react-only custom form field
- Cookie::force_expiry() — Method in class Cookie
- CookieJar::forceExpiry() — Method in class CookieJar
Force the expiry of a cookie by name
- Cookie_Backend::forceExpiry() — Method in class Cookie_Backend
Force the expiry of a cookie by name
- Director::fileExists() — Method in class Director
Returns true if the given file exists. Filename should be relative to the site root.
- Director::forceSSL() — Method in class Director
Force the site to run on SSL.
- Director::forceWWW() — Method in class Director
Force a redirect to a domain starting with "www."
- Email::findPlainPart() — Method in class Email
- HTTP::filename2url() — Method in class HTTP
Turns a local system filename into a URL by comparing it to the script filename.
- HTTP::findByTagAndAttribute() — Method in class HTTP
Search for all tags with a specific attribute, then return the value of that attribute in a flat array.
- FlushMiddleware — Class in namespace SilverStripe\Control\Middleware
Triggers a call to flush() on all implementors of Flushable.
- FlushScheduler — Class in namespace SilverStripe\Control\Middleware\URLSpecialsMiddleware
Schedule flush operation for a following request
- Session::finalize() — Method in class Session
Set user agent key
- FilesystemCacheFactory — Class in namespace SilverStripe\Core\Cache
- MemberCacheFlusher::flushMemberCache() — Method in class MemberCacheFlusher
- Config::forClass() — Method in class Config
Get an accessor that returns results by class by default.
- Config_ForClass::forClass() — Method in class Config_ForClass
- Flushable — Class in namespace SilverStripe\Core
Provides an interface for classes to implement their own flushing functionality whenever flush=1 is requested.
- Flushable::flush() — Method in class Flushable
This function is triggered early in the request if the "flush" query parameter has been set. Each class that implements Flushable implements this function which looks after it's own specific flushing functionality.
- Factory — Class in namespace SilverStripe\Core\Injector
A factory which is used for creating service instances.
- FlushDiscoverer — Class in namespace SilverStripe\Core\Startup
Public interface for startup flush discoverers
- Backtrace::filtered_backtrace() — Method in class Backtrace
Return debug_backtrace() results with functions filtered specific to the debugging system, and not the trace.
- Backtrace::filter_backtrace() — Method in class Backtrace
Filter a backtrace so that it doesn't show the calls to the debugging system, which is useless information.
- Backtrace::full_func_name() — Method in class Backtrace
Return the full function name. If showArgs is set to true, a string representation of the arguments will be shown
- CsvBulkLoader::findExistingObject() — Method in class CsvBulkLoader
Find an existing objects based on one or more uniqueness columns specified via {@link self::$duplicateChecks}.
- FixtureBlueprint — Class in namespace SilverStripe\Dev
A blueprint on how to create instances of a certain {@link DataObject} subclass.
- FixtureFactory — Class in namespace SilverStripe\Dev
Manages a set of database fixtures for {@link DataObject} records as well as raw database table rows.
- FunctionalTest — Class in namespace SilverStripe\Dev
SilverStripe-specific testing object designed to support functional testing of your web app. It simulates get/post requests, form submission, and can validate resulting HTML, looking up content by CSS selector.
- FunctionalTest::findAttribute() — Method in class FunctionalTest
Find an attribute in a SimpleXMLElement object by name.
- SapphireTest::findEmail() — Method in class SapphireTest
Search for an email that was sent.
- FixtureTestState — Class in namespace SilverStripe\Dev\State
- FlushableTestState — Class in namespace SilverStripe\Dev\State
Clears flushable / resettable objects
- FixFolderPermissionsHelper — Class in namespace SilverStripe\Dev\Tasks
Files imported from SS3 might end up with broken permissions if there is a case conflict.
- TestMailer::findEmail() — Method in class TestMailer
Search for an email that was sent.
- TestSession::followRedirection() — Method in class TestSession
If the last request was a 3xx response, then follow the redirection
- CheckboxSetField::Field() — Method in class CheckboxSetField
- CompositeField::FieldList() — Method in class CompositeField
Returns all the sub-fields, suitable for <% loop FieldList %>
- CompositeField::fieldByName() — Method in class CompositeField
- CompositeField::fieldPosition() — Method in class CompositeField
Find the numerical position of a field within the children collection. Doesn't work recursively.
- ConfirmedPasswordField::Field() — Method in class ConfirmedPasswordField
- CurrencyField_Disabled::Field() — Method in class CurrencyField_Disabled
Overloaded to display the correctly formatted value for this data type
- CurrencyField_Readonly::Field() — Method in class CurrencyField_Readonly
Overloaded to display the correctly formatted value for this data type
- DatalessField::FieldHolder() — Method in class DatalessField
Returns the field's representation in the form.
- DateField_Disabled::Field() — Method in class DateField_Disabled
Returns the form field.
- DatetimeField::frontendToInternal() — Method in class DatetimeField
Convert frontend date to the internal representation (ISO 8601).
- DropdownField::Field() — Method in class DropdownField
- FieldGroup — Class in namespace SilverStripe\Forms
Lets you include a nested group of fields inside a template.
- FieldList — Class in namespace SilverStripe\Forms
A list designed to hold form field instances.
- FieldList::flattenFields() — Method in class FieldList
Return a flattened list of all fields
- FieldList::findTab() — Method in class FieldList
Returns the specified tab object, if it exists
- FieldList::findOrMakeTab() — Method in class FieldList
Returns the specified tab object, creating it if necessary.
- FieldList::fieldByName() — Method in class FieldList
Returns a named field.
- FieldList::fieldPosition() — Method in class FieldList
Find the numerical position of a field within the children collection. Doesn't work recursively.
- FieldList::forTemplate() — Method in class FieldList
Default template rendering of a FieldList will concatenate all FieldHolder values.
- FileField — Class in namespace SilverStripe\Forms
Represents a file type which can be added to a form.
- FileField::Field() — Method in class FileField
- FileHandleField — Class in namespace SilverStripe\Forms
- FileUploadReceiver — Class in namespace SilverStripe\Forms
Provides operations for reading and writing uploaded files to/from {see File} dataobject instances.
- Form — Class in namespace SilverStripe\Forms
Base class for all forms.
- Form::Fields() — Method in class Form
Return the form's fields - used by the templates
- Form::FormAttributes() — Method in class Form
- Form::FormHttpMethod() — Method in class Form
Returns the real HTTP method for the form: GET, POST, PUT, DELETE or HEAD.
- Form::FormMethod() — Method in class Form
Returns the form method to be used in the
- Form::FormAction() — Method in class Form
Return the form's action attribute.
- Form::FormName() — Method in class Form
Returns the name of the form.
- Form::FieldMap() — Method in class Form
Returns an object where there is a method with the same name as each data field on the form.
- Form::forTemplate() — Method in class Form
Return a rendered version of this form.
- Form::forAjaxTemplate() — Method in class Form
Return a rendered version of this form, suitable for ajax post-back.
- Form::formHtmlContent() — Method in class Form
Returns an HTML rendition of this form, without the
- FormAction — Class in namespace SilverStripe\Forms
The action buttons are
<input type="submit">
as well as- FormAction::Field() — Method in class FormAction
- FormAction::FieldHolder() — Method in class FormAction
- FormFactory — Class in namespace SilverStripe\Forms
A service which can generate a form
- FormField — Class in namespace SilverStripe\Forms
Represents a field in a form.
- FormField::Field() — Method in class FormField
Returns the form field.
- FormField::FieldHolder() — Method in class FormField
Returns a "field holder" for this field.
- FormField::forTemplate() — Method in class FormField
This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.
- FormMessage — Class in namespace SilverStripe\Forms
Form component which contains a castable message
- FormMessageBootstrapExtension — Class in namespace SilverStripe\Forms
Will convert a SilverStripe message type into a Bootstrap alert type
- FormRequestHandler — Class in namespace SilverStripe\Forms
- FormRequestHandler::forTemplate() — Method in class FormRequestHandler
- FormScaffolder — Class in namespace SilverStripe\Forms
- $ FormScaffolder#fieldClasses — Property in class FormScaffolder
- FormTemplateHelper — Class in namespace SilverStripe\Forms
A helper class for managing {@link Form} and {@link FormField} HTML template output.
- FormTransformation — Class in namespace SilverStripe\Forms
This class represents "transformations" of a form - such as making it printable or making it readonly.
- Form_FieldMap — Class in namespace SilverStripe\Forms
- GridField::FieldHolder() — Method in class GridField
Returns the whole gridfield rendered with all the attached components.
- GridField::Field() — Method in class GridField
- $ GridFieldDataColumns#fieldCasting — Property in class GridFieldDataColumns
- $ GridFieldDataColumns#fieldFormatting — Property in class GridFieldDataColumns
- $ GridFieldFilterHeader#force_legacy — Property in class GridFieldFilterHeader
Forces all filter components to revert to displaying the legacy table header style rather than the react driven search box
- $ GridFieldSortableHeader#fieldSorting — Property in class GridFieldSortableHeader
- HTMLEditorField::Field() — Method in class HTMLEditorField
Returns the form field.
- TinyMCECombinedGenerator::flush() — Method in class TinyMCECombinedGenerator
This function is triggered early in the request if the "flush" query parameter has been set. Each class that implements Flushable implements this function which looks after it's own specific flushing functionality.
- HTMLReadonlyField::Field() — Method in class HTMLReadonlyField
Returns the form field.
- HiddenField::FieldHolder() — Method in class HiddenField
- ListboxField::Field() — Method in class ListboxField
Returns a select tag containing all the appropriate option tags
- LiteralField::FieldHolder() — Method in class LiteralField
- LiteralField::Field() — Method in class LiteralField
- LookupField::Field() — Method in class LookupField
Returns a readonly span containing the correct value.
- NullableField::Field() — Method in class NullableField
- OptionsetField::Field() — Method in class OptionsetField
Returns the form field.
- PrintableTransformation_TabSet::FieldHolder() — Method in class PrintableTransformation_TabSet
Returns a tab-strip and the associated tabs.
- RequiredFields::fieldIsRequired() — Method in class RequiredFields
Returns true if the named field is "required".
- FormSchema — Class in namespace SilverStripe\Forms\Schema
Represents a {@link Form} as structured data which allows a frontend library to render it.
- SelectionGroup::FieldSet() — Method in class SelectionGroup
- SelectionGroup::FieldList() — Method in class SelectionGroup
Returns all the sub-fields, suitable for <% loop FieldList %>
- SelectionGroup::FieldHolder() — Method in class SelectionGroup
Returns a "field holder" for this field.
- SingleLookupField::Field() — Method in class SingleLookupField
Returns a readonly span containing the correct value.
- Tab::Fields() — Method in class Tab
Get child fields
- TabSet::FieldHolder() — Method in class TabSet
Returns a tab-strip and the associated tabs.
- ToggleCompositeField::FieldHolder() — Method in class ToggleCompositeField
- TreeDropdownField::filterMarking() — Method in class TreeDropdownField
Marking public function for the tree, which combines different filters sensibly.
- TreeDropdownField_Readonly::Field() — Method in class TreeDropdownField_Readonly
Returns the form field.
- TreeMultiselectField::Field() — Method in class TreeMultiselectField
We overwrite the field attribute to add our hidden fields, as this formfield can contain multiple values.
- TreeMultiselectField_Readonly::Field() — Method in class TreeMultiselectField_Readonly
We overwrite the field attribute to add our hidden fields, as this formfield can contain multiple values.
- Validator::fieldIsRequired() — Method in class Validator
Returns whether the field in question is required. This will usually display '*' next to the field. The base implementation always returns false.
- FileProvider — Class in namespace SilverStripe\GraphQL\PersistedQuery
Class FileProvider
- QueryHandler::formatError() — Method in class QueryHandler
More verbose error display defaults.
- FilepathLoader — Class in namespace SilverStripe\GraphQL\Schema\BulkLoader
Loads classes by fuzzy match (glob), relative to the root e.g.
src/*.model.php
- FieldAccessor — Class in namespace SilverStripe\GraphQL\Schema\DataObject
A utility class that handles an assortment of issues related to field access on DataObjects, particularly with case insensitivity.
- $ FieldAccessor#field_formatter — Property in class FieldAccessor
A function that makes an object property a field name
- FieldAccessor::formatField() — Method in class FieldAccessor
- FieldReconciler — Class in namespace SilverStripe\GraphQL\Schema\DataObject
- InheritanceBuilder::fillAncestry() — Method in class InheritanceBuilder
- InheritanceBuilder::fillDescendants() — Method in class InheritanceBuilder
- FirstResult — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin
- FirstResult::firstResult() — Method in class FirstResult
- FieldFilterInterface — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter
Defines the interface used by all read filters for operations
- FieldFilterRegistry — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter
- FilterRegistryInterface — Class in namespace SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter
Filters for queries are registered as services and retrieved by identifiers.
- QueryFilter::filter() — Method in class QueryFilter
- Field — Class in namespace SilverStripe\GraphQL\Schema\Field
An abstraction of a field that appears on a Type abstraction
- FieldPlugin — Class in namespace SilverStripe\GraphQL\Schema\Interfaces
A plugin that applies to a Field abstraction
- $ AbstractQueryFilterPlugin#field_name — Property in class AbstractQueryFilterPlugin
- $ AbstractQuerySortPlugin#field_name — Property in class AbstractQuerySortPlugin
- $ SortPlugin#field_name — Property in class SortPlugin
- Schema::findOrMakeType() — Method in class Schema
- Schema::findOrMakeModel() — Method in class Schema
- SchemaTranscribeHandler::fire() — Method in class SchemaTranscribeHandler
- AbstractTypeRegistry::Float() — Method in class AbstractTypeRegistry
- DebugViewFriendlyErrorFormatter::format() — Method in class DebugViewFriendlyErrorFormatter
- DebugViewFriendlyErrorFormatter::formatBatch() — Method in class DebugViewFriendlyErrorFormatter
- DetailedErrorFormatter::format() — Method in class DetailedErrorFormatter
- DetailedErrorFormatter::formatBatch() — Method in class DetailedErrorFormatter
- ArrayLib::filter_keys() — Method in class ArrayLib
Filter an array by keys (useful for only allowing certain form-input to be saved).
- ArrayLib::flatten() — Method in class ArrayLib
Takes an multi dimension array and returns the flattened version.
- ArrayList::first() — Method in class ArrayList
Returns the first item in the list
- ArrayList::find() — Method in class ArrayList
Find the first item of this list where the given key = value
- ArrayList::filter() — Method in class ArrayList
Filter the list to include items with these charactaristics
- ArrayList::filterAny() — Method in class ArrayList
Return a copy of this list which contains items matching any of these charactaristics.
- ArrayList::filterByCallback() — Method in class ArrayList
- DBSchemaManager::fixTableCase() — Method in class DBSchemaManager
Ensure the given table has the correct case
- DBSchemaManager::fieldList() — Method in class DBSchemaManager
Get a list of all the fields for the given table.
- DBSchemaManager::float() — Method in class DBSchemaManager
Returns data type for 'float' column
- Database::formattedDatetimeClause() — Method in class Database
function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime in a certain format
- MySQLDatabase::formattedDatetimeClause() — Method in class MySQLDatabase
function to return an SQL datetime expression that can be used with the adapter in use used for querying a datetime in a certain format
- MySQLSchemaManager::fieldList() — Method in class MySQLSchemaManager
Get a list of all the fields for the given table.
- MySQLSchemaManager::float() — Method in class MySQLSchemaManager
Return a float type-formatted string For MySQL, we simply return the word 'date', no other parameters are necessary
- PDOConnector::flushStatements() — Method in class PDOConnector
Flush all prepared statements
- Query::first() — Method in class Query
- DB::field_list() — Method in class DB
Get a list of all the fields for the given table.
- DataList::filter() — Method in class DataList
Return a copy of this list which only includes items with these charactaristics
- DataList::filterAny() — Method in class DataList
Return a copy of this list which contains items matching any of these charactaristics.
- DataList::filterByCallback() — Method in class DataList
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
- DataList::first() — Method in class DataList
Returns the first item in this DataList
- DataList::find() — Method in class DataList
Find the first DataObject of this DataList where the given key = value
- $ DataObject#fixed_fields — Property in class DataObject
Base fields which are not defined in static $db
- $ DataObject#field_labels — Property in class DataObject
User defined labels for searchable_fields, used to override default display in the search form.
- DataObject::forceChange() — Method in class DataObject
Forces the record to think that all its data has changed.
- DataObject::findCascadeDeletes() — Method in class DataObject
Find all objects that will be cascade deleted if this object is deleted
- DataObject::flushCache() — Method in class DataObject
Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.
- DataObject::flush_and_destroy_cache() — Method in class DataObject
Flush the get_one global cache and destroy associated objects.
- DataObject::fieldLabels() — Method in class DataObject
Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.
- DataObject::fieldLabel() — Method in class DataObject
Get a human-readable label for a single field, see {@link fieldLabels()} for more details.
- DataObject::findRelatedObjects() — Method in class DataObject
Find objects in the given relationships, merging them into the given list
- DataObjectSchema::fieldSpecs() — Method in class DataObjectSchema
Get all DB field specifications for a class, including ancestors and composite fields.
- DataObjectSchema::fieldSpec() — Method in class DataObjectSchema
Get specifications for a single class field
- DataQuery::firstRow() — Method in class DataQuery
Return the first row that would be returned by this full DataQuery Note that this will issue a separate SELECT ... LIMIT 1 query.
- DBDate::Full() — Method in class DBDate
Returns the date in the localised full format
- DBDate::Format() — Method in class DBDate
Return the date using a particular formatting string. Use {o} to include an ordinal representation for the day of the month ("1st", "2nd", "3rd" etc)
- DBDate::FormatFromSettings() — Method in class DBDate
Return a date formatted as per a CMS user's settings.
- DBDatetime::FormatFromSettings() — Method in class DBDatetime
Return a date and time formatted as per a CMS user's settings.
- DBEnum::flushCache() — Method in class DBEnum
Clear all cached enum values.
- DBEnum::formField() — Method in class DBEnum
Return a dropdown field suitable for editing this field.
- DBField::forTemplate() — Method in class DBField
Determine 'default' casting for this field.
- DBHTMLText::forTemplate() — Method in class DBHTMLText
- DBHTMLVarchar::forTemplate() — Method in class DBHTMLVarchar
- DBInt::Formatted() — Method in class DBInt
Returns the number, with commas added as appropriate, eg “1,000”.
- DBMultiEnum::formField() — Method in class DBMultiEnum
Return a {@link CheckboxSetField} suitable for editing this field
- DBString::forTemplate() — Method in class DBString
- DBText::FirstSentence() — Method in class DBText
Return the first string that finishes with a period (.) in this text.
- DBText::FirstParagraph() — Method in class DBText
Get first paragraph
- DBTime::Format() — Method in class DBTime
Return the time using a particular formatting string.
- DBTime::FormatFromSettings() — Method in class DBTime
Return a time formatted as per a CMS user's settings.
- Filterable — Class in namespace SilverStripe\ORM
Additional interface for {@link SS_List} classes that are filterable.
- Filterable::filter() — Method in class Filterable
Return a new instance of this list that only includes items with these charactaristics
- Filterable::filterAny() — Method in class Filterable
Return a copy of this list which contains items matching any of these charactaristics.
- Filterable::filterByCallback() — Method in class Filterable
Return a new instance of this list that excludes any items with these charactaristics Filter this List by a callback function. The function will be passed each record of the List in turn, and must return true for the record to be included. Returns the filtered list.
- FulltextFilter — Class in namespace SilverStripe\ORM\Filters
Filters by full-text matching on the given field.
- Hierarchy::flushCache() — Method in class Hierarchy
Flush all Hierarchy caches:
- Children (instance)
- NumChildren (instance)
- ListDecorator::first() — Method in class ListDecorator
Returns the first item in the list.
- ListDecorator::forTemplate() — Method in class ListDecorator
- ListDecorator::find() — Method in class ListDecorator
Returns the first item in the list where the key field is equal to the value.
- ListDecorator::filter() — Method in class ListDecorator
Filter the list to include items with these charactaristics
- ListDecorator::filterAny() — Method in class ListDecorator
Return a copy of this list which contains items matching any of these charactaristics.
- ListDecorator::filterByCallback() — Method in class ListDecorator
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
- PaginatedList::FirstItem() — Method in class PaginatedList
Returns the number of the first item being displayed on the current page. This is useful for things like "displaying 10-20".
- PaginatedList::FirstLink() — Method in class PaginatedList
Returns a link to the first page.
- SQLConditionalExpression::filtersOnID() — Method in class SQLConditionalExpression
Checks whether this query is for a specific ID in a table
- SQLConditionalExpression::filtersOnFK() — Method in class SQLConditionalExpression
Checks whether this query is filtering on a foreign key, ie finding a has_many relationship
- SQLSelect::firstRow() — Method in class SQLSelect
Returns a query that returns only the first row of this query
- Relation::forForeignID() — Method in class Relation
- RelationList::forForeignID() — Method in class RelationList
Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.
- SS_List::first() — Method in class SS_List
Returns the first item in the list.
- SS_List::find() — Method in class SS_List
Returns the first item in the list where the key field is equal to the value.
- FulltextSearchable — Class in namespace SilverStripe\ORM\Search
Provides a simple search engine for your site based on the MySQL FULLTEXT index.
- UnsavedRelationList::first() — Method in class UnsavedRelationList
Returns the first item in the list
- UnsavedRelationList::forForeignID() — Method in class UnsavedRelationList
Returns a copy of this list with the relationship linked to the given foreign ID.
- SideReportView::forTemplate() — Method in class SideReportView
- Form — Class in namespace SilverStripe\Security\Confirmation
Basic confirmation form implementation.
- Handler::Form() — Method in class Handler
Returns an instance of Confirmation\Form initialized with the proper storage id taken from URL
- DefaultAdminService::findOrCreateDefaultAdmin() — Method in class DefaultAdminService
- DefaultAdminService::findOrCreateAdmin() — Method in class DefaultAdminService
Find or create a Member with admin permissions
- Group::fieldLabels() — Method in class Group
- InheritedPermissionFlusher::flush() — Method in class InheritedPermissionFlusher
Flush all MemberCacheFlusher services
- InheritedPermissionFlusher::flushCache() — Method in class InheritedPermissionFlusher
Flushes all registered MemberCacheFlusher services
- InheritedPermissions::flushMemberCache() — Method in class InheritedPermissions
Clear the cache for this instance only
- LoginAttempt::fieldLabels() — Method in class LoginAttempt
- $ Member#FirstName — Property in class Member
- $ Member#FailedLoginCount — Property in class Member
- Member::fieldLabels() — Method in class Member
- LostPasswordHandler::forgotPassword() — Method in class LostPasswordHandler
Forgot password form handler method.
- Member_GroupSet::foreignIDFilter() — Method in class Member_GroupSet
Link this group set to a specific member.
- Member_GroupSet::foreignIDWriteFilter() — Method in class Member_GroupSet
- PermissionCheckboxSetField::Field() — Method in class PermissionCheckboxSetField
- PermissionRole::fieldLabels() — Method in class PermissionRole
Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.
- $ RememberLoginHash#force_single_token — Property in class RememberLoginHash
If true, user can only use auto login on one device. A user can still login from multiple devices, but previous tokens from other devices will become invalid.
- $ Security#frame_options — Property in class Security
Value of X-Frame-Options header
- Security::findAnAdministrator() — Method in class Security
Return an existing member with administrator privileges, or create one of necessary.
- Security::force_database_is_ready() — Method in class Security
For the database_is_ready call to return a certain value - used for testing
- FileArchiveExtension — Class in namespace SilverStripe\VersionedAdmin\Extensions
Adds a archive view for Files
- ChangeSet::fieldLabels() — Method in class ChangeSet
- ChangeSetItem::findReferenced() — Method in class ChangeSetItem
Get all implicit objects for this change
- CopyToStageInputType::fields() — Method in class CopyToStageInputType
- VersionedInputType::fields() — Method in class VersionedInputType
- ReadingMode::fromDataQueryParams() — Method in class ReadingMode
Converts dataquery params to original reading mode.
- ReadingMode::fromQueryString() — Method in class ReadingMode
Convert querystring arguments to reading mode.
- RecursivePublishable::findOwned() — Method in class RecursivePublishable
Find all objects owned by the current object.
- RecursivePublishable::findOwners() — Method in class RecursivePublishable
Find objects which own this object.
- RecursivePublishable::findOwnersRecursive() — Method in class RecursivePublishable
Find objects which own this object.
- Versioned::flushCache() — Method in class Versioned
- HTMLValue::forTemplate() — Method in class HTMLValue
- SQLFormatter::formatPlain() — Method in class SQLFormatter
- SQLFormatter::formatHTML() — Method in class SQLFormatter
- URLSegmentFilter::filter() — Method in class URLSegmentFilter
Note: Depending on the applied replacement rules, this method might result in an empty string.
- Requirements::flush() — Method in class Requirements
Triggered early in the request when a flush is requested
- SSViewer::flush() — Method in class SSViewer
Triggered early in the request when someone requests a flush.
- SSViewer::fromString() — Method in class SSViewer
Create a template from a string instead of a .ss file
- SSViewer::flush_template_cache() — Method in class SSViewer
Clears all parsed template files in the cache folder.
- SSViewer::flush_cacheblock_cache() — Method in class SSViewer
Clears all partial cache blocks.
- SSViewer_BasicIteratorSupport::First() — Method in class SSViewer_BasicIteratorSupport
Returns true if this object is the first in a set.
- SSViewer_BasicIteratorSupport::FirstLast() — Method in class SSViewer_BasicIteratorSupport
Returns 'first' or 'last' if this is the first or last object in the set.
- SSViewer_BasicIteratorSupport::FromEnd() — Method in class SSViewer_BasicIteratorSupport
Return the position of this item from the last item in the list. The position of the final item is $endIndex, which defaults to 1.
- ThemeResourceLoader::findTemplate() — Method in class ThemeResourceLoader
Attempts to find possible candidate templates from a set of template names from modules, current theme directory and finally the application folder.
- ThemeResourceLoader::findThemedCSS() — Method in class ThemeResourceLoader
Resolve themed CSS path
- ThemeResourceLoader::findThemedJavascript() — Method in class ThemeResourceLoader
Resolve themed javascript path
- ThemeResourceLoader::findThemedResource() — Method in class ThemeResourceLoader
Resolve a themed resource
- ThemeResourceLoader::flush() — Method in class ThemeResourceLoader
Flush any cached data
- ViewableData_Debugger::forTemplate() — Method in class ViewableData_Debugger
Return debugging information, as XHTML. If a field name is passed, it will show debugging information on that field, otherwise it will show information on all methods and fields.
- FlushInvalidatedResource — Class in namespace SilverStripe\i18n\Messages\Symfony
Some arbitrary resource which expires when flush is invoked.
- FlushInvalidatedResource::flush() — Method in class FlushInvalidatedResource
This function is triggered early in the request if the "flush" query parameter has been set. Each class that implements Flushable implements this function which looks after it's own specific flushing functionality.
G
- AdminRootController::get_admin_route() — Method in class AdminRootController
Convenience function to return the admin route config.
- AdminRootController::get_template_global_variables() — Method in class AdminRootController
- CMSBatchAction::getActionTitle() — Method in class CMSBatchAction
The the text to show in the dropdown for this action
- CMSBatchAction::getParameterFields() — Method in class CMSBatchAction
- CMSMenu::get_menu_item() — Method in class CMSMenu
Get a single menu item by its code value.
- CMSMenu::get_menu_code() — Method in class CMSMenu
Get menu code for class
- CMSMenu::get_menu_items() — Method in class CMSMenu
Get all menu entries.
- CMSMenu::get_viewable_menu_items() — Method in class CMSMenu
Get all menu items that the passed member can view.
- CMSMenu::get_cms_classes() — Method in class CMSMenu
A utility funciton to retrieve subclasses of a given class that are instantiable (ie, not abstract) and have a valid menu title.
- CMSMenu::getIterator() — Method in class CMSMenu
IteratorAggregate Interface Method. Iterates over the menu items.
- CMSMenuItem::getAttributesHTML() — Method in class CMSMenuItem
- CMSProfileController::getEditForm() — Method in class CMSProfileController
Calls {@link SiteTree->getCMSFields()} by default to determine the form fields to display.
- GridFieldPrintButtonExtension — Class in namespace SilverStripe\Admin\Forms
- LinkFormFactory::getForm() — Method in class LinkFormFactory
- LinkFormFactory::getRequiredContext() — Method in class LinkFormFactory
Return list of mandatory context keys
- UsedOnTable::getSchemaDataDefaults() — Method in class UsedOnTable
- UsedOnTable::getRecord() — Method in class UsedOnTable
- UsedOnTable::getAttributes() — Method in class UsedOnTable
Attributes to be given for this field type
- GroupImportForm — Class in namespace SilverStripe\Admin
Imports {@link Group} records by CSV upload, as defined in {@link GroupCsvBulkLoader}.
- LeftAndMain::getCombinedClientConfig() — Method in class LeftAndMain
Gets the combined configuration of all LeftAndMain subclasses required by the client app.
- LeftAndMain::getClientConfig() — Method in class LeftAndMain
Returns configuration required by the client app.
- LeftAndMain::getFormSchema() — Method in class LeftAndMain
Get form schema helper
- LeftAndMain::getRequiredPermissions() — Method in class LeftAndMain
Get list of required permissions
- LeftAndMain::getResponseNegotiator() — Method in class LeftAndMain
Caution: Volatile API.
- LeftAndMain::getTemplatesWithSuffix() — Method in class LeftAndMain
Return appropriate template(s) for this class, with the given suffix using {@link SSViewer::get_templates_by_class()}
- LeftAndMain::getRecord() — Method in class LeftAndMain
Get dataobject from the current ID
- LeftAndMain::getNewItem() — Method in class LeftAndMain
Create new item.
- LeftAndMain::getEditForm() — Method in class LeftAndMain
Calls {@link SiteTree->getCMSFields()} by default to determine the form fields to display.
- LeftAndMain::getSilverStripeNavigator() — Method in class LeftAndMain
Used for preview controls, mainly links which switch between different states of the page.
- LeftAndMain::getHelpLinks() — Method in class LeftAndMain
Returns help_links in a format readable by a template
- LeftAndMain::getApplicationName() — Method in class LeftAndMain
Get the application name.
- LeftAndMain::getVersionProvider() — Method in class LeftAndMain
Get the SilverStripe version provider
- LeftAndMain_SearchFilter::getChildrenMethod() — Method in class LeftAndMain_SearchFilter
Method on {@link Hierarchy} objects which is used to traverse into children relationships.
- LeftAndMain_SearchFilter::getNumChildrenMethod() — Method in class LeftAndMain_SearchFilter
Method on {@link Hierarchy} objects which is used find the number of children for a parent page
- LeftAndMain_SearchFilter::getPageClasses() — Method in class LeftAndMain_SearchFilter
Given a page, determine any additional CSS classes to apply to the tree node
- MemberImportForm::getGroup() — Method in class MemberImportForm
- ModalController::getRequest() — Method in class ModalController
Returns the HTTPRequest object that this controller is using.
- ModalController::getController() — Method in class ModalController
- ModalController::getName() — Method in class ModalController
Get urlsegment
- ModelAdmin::getEditForm() — Method in class ModelAdmin
Produces an edit form that includes a default {@link \SilverStripe\Forms\GridField\GridField} for the currently active {@link \SilverStripe\ORM\DataObject}. The GridField will show data from the currently active
modelClass
only (see {@link self::init()}).- ModelAdmin::getExportFields() — Method in class ModelAdmin
Define which fields are used in the {@link getEditForm} GridField export.
- ModelAdmin::getSearchContext() — Method in class ModelAdmin
- ModelAdmin::getList() — Method in class ModelAdmin
You can override how ModelAdmin returns DataObjects by either overloading this method, or defining an extension to ModelAdmin that implements the
updateList
method (and takes a {@link \SilverStripe\ORM\DataList} as the first argument).- ModelAdmin::getModelClass() — Method in class ModelAdmin
The model managed by this instance.
- ModelAdmin::getManagedModels() — Method in class ModelAdmin
- ModelAdmin::getModelImporters() — Method in class ModelAdmin
Returns all importers defined in {@link self::$model_importers}.
- SecurityAdmin::groups() — Method in class SecurityAdmin
Shortcut action for setting the correct active tab.
- SecurityAdmin::getEditForm() — Method in class SecurityAdmin
Calls {@link SiteTree->getCMSFields()} by default to determine the form fields to display.
- SecurityAdmin::groupimport() — Method in class SecurityAdmin
- SecurityAdmin::GroupImportForm() — Method in class SecurityAdmin
- DeleteAssets::getActionTitle() — Method in class DeleteAssets
The the text to show in the dropdown for this action
- AssetAdmin::getClientConfig() — Method in class AssetAdmin
Returns configuration required by the client app.
- AssetAdmin::getFileEditLink() — Method in class AssetAdmin
Given a file return the CMS link to edit it
- AssetAdmin::getFormFactory() — Method in class AssetAdmin
Build a form scaffolder for this model
- AssetAdmin::getFileEditForm() — Method in class AssetAdmin
The form is used to generate a form schema, as well as an intermediary object to process data through API endpoints.
- AssetAdmin::getFileInsertForm() — Method in class AssetAdmin
The form is used to generate a form schema, as well as an intermediary object to process data through API endpoints.
- AssetAdmin::getFileEditorLinkForm() — Method in class AssetAdmin
The form used to generate a form schema, since it's used directly on API endpoints, it does not have any form actions.
- AssetAdmin::getMoveForm() — Method in class AssetAdmin
Get form for moving files/folders to a new location
- AssetAdmin::getFileSelectForm() — Method in class AssetAdmin
Get form for selecting a file
- AssetAdmin::getFileHistoryForm() — Method in class AssetAdmin
- AssetAdmin::getObjectFromData() — Method in class AssetAdmin
Build the array containing the all attributes the AssetAdmin client interact with.
- AssetAdmin::getMinimalistObjectFromData() — Method in class AssetAdmin
Build the array containing the minimal attributes needed to render an UploadFieldItem.
- AssetAdmin::generateThumbnails() — Method in class AssetAdmin
Generate thumbnails and provide links for a given file
- AssetAdmin::getAddToCampaignForm() — Method in class AssetAdmin
- AssetAdmin::getFolderCreateForm() — Method in class AssetAdmin
Returns the form to be used for creating a new folder
- AssetAdmin::getFileSearchform() — Method in class AssetAdmin
Allow search form to be accessible to schema
- AssetAdmin::getThumbnailGenerator() — Method in class AssetAdmin
- AssetAdminFile::getInsertWidth() — Method in class AssetAdminFile
Calculate width to insert into html area
- AssetAdminFile::getInsertHeight() — Method in class AssetAdminFile
Calculate width to insert into html area
- AssetAdminFile::getFilesInUse() — Method in class AssetAdminFile
Get the list of all nested files in use
- RemoteFileModalExtension::getOwner() — Method in class RemoteFileModalExtension
- AssetFormFactory::getForm() — Method in class AssetFormFactory
- AssetFormFactory::getRequiredContext() — Method in class AssetFormFactory
Return list of mandatory context keys
- FileFormFactory::getRequiredContext() — Method in class FileFormFactory
- FileHistoryFormFactory::getForm() — Method in class FileHistoryFormFactory
- FileHistoryFormFactory::getRequiredContext() — Method in class FileHistoryFormFactory
- FileSearchFormFactory::getForm() — Method in class FileSearchFormFactory
Generates the form
- FileSearchFormFactory::getRequiredContext() — Method in class FileSearchFormFactory
Return list of mandatory context keys
- FolderCreateFormFactory::getRequiredContext() — Method in class FolderCreateFormFactory
Return list of mandatory context keys
- FolderCreateFormFactory::getFormFields() — Method in class FolderCreateFormFactory
- HistoryListField::getSchemaStateDefaults() — Method in class HistoryListField
Gets the defaults for $schemaState.
- HistoryListField::getRecord() — Method in class HistoryListField
- ImageFormFactory::getForm() — Method in class ImageFormFactory
- MoveFormFactory::getForm() — Method in class MoveFormFactory
Generates the form
- MoveFormFactory::getRequiredContext() — Method in class MoveFormFactory
Return list of mandatory context keys
- PreviewImageField::getSchemaDataDefaults() — Method in class PreviewImageField
Gets the defaults for $schemaData.
- PreviewImageField::getSchemaStateDefaults() — Method in class PreviewImageField
Gets the defaults for $schemaState.
- PreviewImageField::getRecord() — Method in class PreviewImageField
- RemoteFileFormFactory::getForm() — Method in class RemoteFileFormFactory
- RemoteFileFormFactory::getRequiredContext() — Method in class RemoteFileFormFactory
Return list of mandatory context keys
- UploadField::getSchemaDataDefaults() — Method in class UploadField
Gets the defaults for $schemaData.
- UploadField::getSchemaStateDefaults() — Method in class UploadField
Gets the defaults for $schemaState.
- UploadField::getIsMultiUpload() — Method in class UploadField
Check if allowed to upload more than one file
- UploadField::getAllowedMaxFileNumber() — Method in class UploadField
Gets the number of files allowed for this field
- UploadField::getAllowedMaxFileSize() — Method in class UploadField
Returns the max allowed filesize
- UploadField::getAttributes() — Method in class UploadField
Allows customization through an 'updateAttributes' hook on the base class.
- UploadField::getUploadEnabled() — Method in class UploadField
Check if uploading files is enabled
- UploadField::getAttachEnabled() — Method in class UploadField
Check if attaching files is enabled
- FileTypeCreator::getThumbnailGenerator() — Method in class FileTypeCreator
- FolderTypeCreator::getChildrenConnection() — Method in class FolderTypeCreator
- Notice::getType() — Method in class Notice
- Notice::getIDs() — Method in class Notice
- Notice::getMessage() — Method in class Notice
- ImageThumbnailHelper::getMaxImageFileSize() — Method in class ImageThumbnailHelper
Get the maximum file size for which thumbnails will be generated. Set to
0
to disable the limit.- ThumbnailGenerator::generateThumbnailLink() — Method in class ThumbnailGenerator
Generate thumbnail and return the "src" property for this thumbnail
- ThumbnailGenerator::generateThumbnail() — Method in class ThumbnailGenerator
Generate thumbnail object
- ThumbnailGenerator::generateLink() — Method in class ThumbnailGenerator
Generate "src" property for this thumbnail.
- ThumbnailGenerator::getGenerates() — Method in class ThumbnailGenerator
- AssetManipulationList::getPublicAssets() — Method in class AssetManipulationList
Get all public assets
- AssetManipulationList::getProtectedAssets() — Method in class AssetManipulationList
Get protected assets
- AssetManipulationList::getDeletedAssets() — Method in class AssetManipulationList
Get deleted assets
- TagsToShortcodeHelper::getNewContent() — Method in class TagsToShortcodeHelper
- TestAssetStore::getLocalPath() — Method in class TestAssetStore
Helper method to get local filesystem path for this file
- TestAssetStore::getFileID() — Method in class TestAssetStore
- TestAssetStore::getOriginalFilename() — Method in class TestAssetStore
- TestAssetStore::getFilesystemFor() — Method in class TestAssetStore
- TestAssetStore::getDefaultConflictResolution() — Method in class TestAssetStore
- VersionedFilesMigrator::getFinder() — Method in class VersionedFilesMigrator
- VersionedFilesMigrator::getLog() — Method in class VersionedFilesMigrator
- File::get_shortcodes() — Method in class File
- File::getTreeTitle() — Method in class File
- File::getCMSFields() — Method in class File
List of basic content editable file fields.
- File::getStatusTitle() — Method in class File
Get title for current file status
- File::get_app_category() — Method in class File
Returns a category based on the file extension.
- File::get_category_extensions() — Method in class File
For a category or list of categories, get the list of file extensions
- File::getAbsoluteURL() — Method in class File
Gets the URL of this file
- File::getURL() — Method in class File
Gets the URL of this file
- File::getSourceURL() — Method in class File
Get URL, but without resampling.
- File::generateFilename() — Method in class File
Get expected value of Filename tuple value. Will be used to trigger a file move on draft stage.
- File::getExtension() — Method in class File
Returns the file extension
- File::get_file_extension() — Method in class File
Gets the extension of a filepath or filename, by stripping away everything before the last "dot".
- File::get_icon_for_extension() — Method in class File
Given an extension, determine the icon that should be used
- File::getFileType() — Method in class File
Return the type of file for the given extension on the current file name.
- File::get_file_type() — Method in class File
Get descriptive type of file based on filename
- File::getSize() — Method in class File
Returns the size of the file type in an appropriate format.
- File::getAbsoluteSize() — Method in class File
Return file size in bytes.
- File::get_class_for_file_extension() — Method in class File
Maps a {@link File} subclass to a specific extension.
- File::getMetaData() — Method in class File
Get metadata for this file
- File::getMimeType() — Method in class File
Get mime type
- File::getStream() — Method in class File
- File::getString() — Method in class File
- File::getIsImage() — Method in class File
Determine if a valid non-empty image exists behind this asset
- File::getFilename() — Method in class File
Get value of filename
- File::getHash() — Method in class File
Get value of hash
- File::getVariant() — Method in class File
Get value of variant
- File::getTag() — Method in class File
Return a html5 tag of the appropriate for this file (normally img or a)
- File::getVisibility() — Method in class File
Determine visibility of the given file
- File::grantFile() — Method in class File
Ensures that access to the specified protected file is granted for the current user.
- File::getPermissionChecker() — Method in class File
- File::getAllowedExtensions() — Method in class File
Get the list of globally allowed file extensions for file uploads.
- FileFinder::getOption() — Method in class FileFinder
Returns an option value set on this instance.
- FileNameFilter::getReplacements() — Method in class FileNameFilter
- FileNameFilter::getTransliterator() — Method in class FileNameFilter
- FileNameFilter::getDefaultName() — Method in class FileNameFilter
- FlysystemAssetStore::getPublicFilesystem() — Method in class FlysystemAssetStore
Get the currently assigned flysystem backend
- FlysystemAssetStore::getProtectedFilesystem() — Method in class FlysystemAssetStore
Get filesystem to use for non-public files
- FlysystemAssetStore::getCapabilities() — Method in class FlysystemAssetStore
Return list of feature capabilities of this backend as an array.
- FlysystemAssetStore::getVisibility() — Method in class FlysystemAssetStore
Determine visibility of the given file
- FlysystemAssetStore::getAsStream() — Method in class FlysystemAssetStore
Get a stream for this file
- FlysystemAssetStore::getAsString() — Method in class FlysystemAssetStore
Get contents of a given file
- FlysystemAssetStore::getAsURL() — Method in class FlysystemAssetStore
Get the url for the file
- FlysystemAssetStore::grant() — Method in class FlysystemAssetStore
Ensures that access to the specified protected file is granted for the current user.
- FlysystemAssetStore::getMetadata() — Method in class FlysystemAssetStore
Get metadata for this file, if available
- FlysystemAssetStore::getMimeType() — Method in class FlysystemAssetStore
Get mime type of this file
- FlysystemAssetStore::getResponseFor() — Method in class FlysystemAssetStore
Generate a custom HTTP response for a request to a given asset, identified by a path.
- GeneratedAssets — Class in namespace SilverStripe\Assets\Flysystem
Simple Flysystem implementation of GeneratedAssetHandler for storing generated content
- GeneratedAssets::getFilesystem() — Method in class GeneratedAssets
Get the asset backend
- GeneratedAssets::getContentURL() — Method in class GeneratedAssets
Returns a URL to a generated asset, if one is available.
- GeneratedAssets::getContent() — Method in class GeneratedAssets
Returns the content for a generated asset, if one is available.
- ProtectedAdapter::getProtectedUrl() — Method in class ProtectedAdapter
Provide downloadable url that is restricted to granted users
- ProtectedAssetAdapter::getProtectedUrl() — Method in class ProtectedAssetAdapter
Provide secure downloadable
- PublicAdapter::getPublicUrl() — Method in class PublicAdapter
Provide downloadable url that is open to the public
- PublicAssetAdapter::getPublicUrl() — Method in class PublicAssetAdapter
Provide downloadable url
- Folder::getIcon() — Method in class Folder
Return the relative URL of an icon for this file type
- Folder::getTitle() — Method in class Folder
Get the folder title
- Folder::getSize() — Method in class Folder
A folder doesn't have a (meaningful) file size.
- Folder::getTreeTitle() — Method in class Folder
- Folder::getFilename() — Method in class Folder
Get value of filename
- Folder::getURL() — Method in class Folder
Folders do not have public URLs
- Folder::getAbsoluteURL() — Method in class Folder
Folders do not have public URLs
- Image::getIsImage() — Method in class Image
Determine if a valid non-empty image exists behind this asset
- ImageManipulation::getAllowGeneration() — Method in class ImageManipulation
Check if resizes are allowed
- ImageManipulation::getString() — Method in class ImageManipulation
- ImageManipulation::getStream() — Method in class ImageManipulation
- ImageManipulation::getURL() — Method in class ImageManipulation
- ImageManipulation::getAbsoluteURL() — Method in class ImageManipulation
- ImageManipulation::getMetaData() — Method in class ImageManipulation
Get metadata for this file
- ImageManipulation::getMimeType() — Method in class ImageManipulation
Get mime type
- ImageManipulation::getAbsoluteSize() — Method in class ImageManipulation
Return file size in bytes.
- ImageManipulation::getFilename() — Method in class ImageManipulation
Get value of filename
- ImageManipulation::getHash() — Method in class ImageManipulation
Get value of hash
- ImageManipulation::getVariant() — Method in class ImageManipulation
Get value of variant
- ImageManipulation::getIsImage() — Method in class ImageManipulation
Determine if a valid non-empty image exists behind this asset
- ImageManipulation::getIcon() — Method in class ImageManipulation
Return the relative URL of an icon for the file type, based on the {@link appCategory()} value.
- ImageManipulation::getImageBackend() — Method in class ImageManipulation
Get Image_Backend instance for this image
- ImageManipulation::getWidth() — Method in class ImageManipulation
Get the width of this image.
- ImageManipulation::getHeight() — Method in class ImageManipulation
Get the height of this image.
- ImageManipulation::getOrientation() — Method in class ImageManipulation
Get the orientation of this image.
- Image_Backend::getWidth() — Method in class Image_Backend
- Image_Backend::getHeight() — Method in class Image_Backend
- Image_Backend::getImageResource() — Method in class Image_Backend
Get the currently assigned image resource
- InterventionBackend::getTempPath() — Method in class InterventionBackend
- InterventionBackend::getCache() — Method in class InterventionBackend
- InterventionBackend::getAssetContainer() — Method in class InterventionBackend
- InterventionBackend::getImageManager() — Method in class InterventionBackend
- InterventionBackend::getImageResource() — Method in class InterventionBackend
Get the currently assigned image resource, or generates one if not yet assigned.
- InterventionBackend::getQuality() — Method in class InterventionBackend
- InterventionBackend::getWidth() — Method in class InterventionBackend
- InterventionBackend::getHeight() — Method in class InterventionBackend
- FileLinkTracking::getFileParser() — Method in class FileLinkTracking
FileParser for link tracking
- FileShortcodeProvider::get_shortcodes() — Method in class FileShortcodeProvider
Gets the list of shortcodes provided by this handler
- FileShortcodeProvider::getCacheKey() — Method in class FileShortcodeProvider
Generates a cachekey with the given parameters
- FileShortcodeProvider::getCache() — Method in class FileShortcodeProvider
Gets the cache used by this provider
- ImageShortcodeProvider::get_shortcodes() — Method in class ImageShortcodeProvider
Gets the list of shortcodes provided by this handler
- ImageShortcodeProvider::getCache() — Method in class ImageShortcodeProvider
Gets the cache used by this provider
- AssetContainer::getString() — Method in class AssetContainer
- AssetContainer::getStream() — Method in class AssetContainer
- AssetContainer::getURL() — Method in class AssetContainer
- AssetContainer::getAbsoluteURL() — Method in class AssetContainer
- AssetContainer::getMetaData() — Method in class AssetContainer
Get metadata for this file
- AssetContainer::getMimeType() — Method in class AssetContainer
Get mime type
- AssetContainer::getAbsoluteSize() — Method in class AssetContainer
Return file size in bytes.
- AssetContainer::getIsImage() — Method in class AssetContainer
Determine if a valid non-empty image exists behind this asset
- AssetContainer::getVisibility() — Method in class AssetContainer
Determine visibility of the given file
- AssetContainer::getFilename() — Method in class AssetContainer
Get value of filename
- AssetContainer::getHash() — Method in class AssetContainer
Get value of hash
- AssetContainer::getVariant() — Method in class AssetContainer
Get value of variant
- AssetContainer::grantFile() — Method in class AssetContainer
Ensures that access to the specified protected file is granted for the current user.
- AssetNameGenerator::getMaxTries() — Method in class AssetNameGenerator
Number of attempts allowed
- AssetStore::getCapabilities() — Method in class AssetStore
Return list of feature capabilities of this backend as an array.
- AssetStore::getAsString() — Method in class AssetStore
Get contents of a given file
- AssetStore::getAsStream() — Method in class AssetStore
Get a stream for this file
- AssetStore::getAsURL() — Method in class AssetStore
Get the url for the file
- AssetStore::getMetadata() — Method in class AssetStore
Get metadata for this file, if available
- AssetStore::getMimeType() — Method in class AssetStore
Get mime type of this file
- AssetStore::getVisibility() — Method in class AssetStore
Determine visibility of the given file
- AssetStore::grant() — Method in class AssetStore
Ensures that access to the specified protected file is granted for the current user.
- AssetStoreRouter::getResponseFor() — Method in class AssetStoreRouter
Generate a custom HTTP response for a request to a given asset, identified by a path.
- DBFile::getIsImage() — Method in class DBFile
Determine if a valid non-empty image exists behind this asset, which is a format compatible with image manipulations
- DBFile::getTag() — Method in class DBFile
Return a html5 tag of the appropriate for this file (normally img or a)
- DBFile::getFrontendTemplate() — Method in class DBFile
Determine the template to render as on the frontend
- DBFile::getBasename() — Method in class DBFile
Get trailing part of filename
- DBFile::getExtension() — Method in class DBFile
Get file extension
- DBFile::getTitle() — Method in class DBFile
Alt title for this
- DBFile::getStream() — Method in class DBFile
- DBFile::getString() — Method in class DBFile
- DBFile::getURL() — Method in class DBFile
- DBFile::getSourceURL() — Method in class DBFile
Get URL, but without resampling.
- DBFile::getAbsoluteURL() — Method in class DBFile
Get the absolute URL to this resource
- DBFile::getMetaData() — Method in class DBFile
Get metadata for this file
- DBFile::getMimeType() — Method in class DBFile
Get mime type
- DBFile::getValue() — Method in class DBFile
Returns the value of this field.
- DBFile::getVisibility() — Method in class DBFile
Determine visibility of the given file
- DBFile::getFilename() — Method in class DBFile
Get value of filename
- DBFile::getHash() — Method in class DBFile
Get value of hash
- DBFile::getVariant() — Method in class DBFile
Get value of variant
- DBFile::getAbsoluteSize() — Method in class DBFile
Return file size in bytes.
- DBFile::getAllowedCategories() — Method in class DBFile
Get list of allowed file categories
- DBFile::getSize() — Method in class DBFile
Returns the size of the file type in an appropriate format.
- DBFile::grantFile() — Method in class DBFile
Ensures that access to the specified protected file is granted for the current user.
- DefaultAssetNameGenerator::getMaxTries() — Method in class DefaultAssetNameGenerator
Number of attempts allowed
- GeneratedAssetHandler — Class in namespace SilverStripe\Assets\Storage
Interface to define a handler for persistent generated files
- GeneratedAssetHandler::getContentURL() — Method in class GeneratedAssetHandler
Returns a URL to a generated asset, if one is available.
- GeneratedAssetHandler::getContent() — Method in class GeneratedAssetHandler
Returns the content for a generated asset, if one is available.
- ProtectedFileController::getRouteHandler() — Method in class ProtectedFileController
- Upload::getValidator() — Method in class Upload
Get current validator
- Upload::getReplaceFile() — Method in class Upload
- Upload::getFile() — Method in class Upload
Get file-object, either generated from {load()}, or manually set.
- Upload::getErrors() — Method in class Upload
Return all errors that occurred while processing so far (mostly set by {loadUploaded()})
- Upload::getDefaultVisibility() — Method in class Upload
Get default visibility for uploaded files. {see AssetStore} One of the values of AssetStore::VISIBILITY_* constants
- Upload_Validator::getErrors() — Method in class Upload_Validator
Return all errors that occurred while validating the temporary file.
- Upload_Validator::getLargestAllowedMaxFileSize() — Method in class Upload_Validator
Returns the largest maximum filesize allowed across all extensions
- Upload_Validator::getAllowedMaxFileSize() — Method in class Upload_Validator
Get maximum file size for all or specified file extension.
- Upload_Validator::getAllowedExtensions() — Method in class Upload_Validator
- Upload_Validator::getFileExtension() — Method in class Upload_Validator
Return the extension of the uploaded file, in lowercase Returns an empty string for files without an extension
- CMSBatchAction_Archive::getActionTitle() — Method in class CMSBatchAction_Archive
The the text to show in the dropdown for this action
- CMSBatchAction_Publish::getActionTitle() — Method in class CMSBatchAction_Publish
The the text to show in the dropdown for this action
- CMSBatchAction_Restore::getActionTitle() — Method in class CMSBatchAction_Restore
The the text to show in the dropdown for this action
- CMSBatchAction_Unpublish::getActionTitle() — Method in class CMSBatchAction_Unpublish
The the text to show in the dropdown for this action
- CMSMain::getResponseNegotiator() — Method in class CMSMain
Caution: Volatile API.
- CMSMain::getTabIdentifier() — Method in class CMSMain
Return the active tab identifier for the CMS. Used by templates to decide which tab to give the active state.
- CMSMain::getHintsCache() — Method in class CMSMain
- CMSMain::getSiteTreeFor() — Method in class CMSMain
Get a site tree HTML listing which displays the nodes under the given criteria.
- CMSMain::getTreeNodeClasses() — Method in class CMSMain
Get extra CSS classes for a page's tree node
- CMSMain::getsubtree() — Method in class CMSMain
Get a subtree underneath the request param 'ID'.
- CMSMain::getSearchContext() — Method in class CMSMain
This provides information required to generate the search form and can be modified on extensions through updateSearchContext
- CMSMain::getSearchFieldSchema() — Method in class CMSMain
Returns the search form schema for the current model
- CMSMain::getSearchForm() — Method in class CMSMain
Returns a Form for page searching for use in templates.
- CMSMain::getBreadcrumbsBackLink() — Method in class CMSMain
Get "back" url for breadcrumbs
- CMSMain::getRecord() — Method in class CMSMain
Get a database record to be managed by the CMS.
- CMSMain::getEditForm() — Method in class CMSMain
- CMSMain::getList() — Method in class CMSMain
Returns the pages meet a certain criteria as {see CMSSiteTreeFilter} or the subpages of a parent page defaulting to no filter and show all pages in first level.
- CMSMain::getNewItem() — Method in class CMSMain
- CMSPageEditController::getClientConfig() — Method in class CMSPageEditController
Returns configuration required by the client app.
- CMSPageEditController::getAddToCampaignForm() — Method in class CMSPageEditController
- CMSPageSettingsController::getEditForm() — Method in class CMSPageSettingsController
- CMSPageSettingsController::getTabIdentifier() — Method in class CMSPageSettingsController
Return the active tab identifier for the CMS. Used by templates to decide which tab to give the active state.
- CMSSiteTreeFilter::get_all_filters() — Method in class CMSSiteTreeFilter
Returns a sorted array of all implementators of CMSSiteTreeFilter, suitable for use in a dropdown.
- CMSSiteTreeFilter::getChildrenMethod() — Method in class CMSSiteTreeFilter
Method on {@link Hierarchy} objects which is used to traverse into children relationships.
- CMSSiteTreeFilter::getNumChildrenMethod() — Method in class CMSSiteTreeFilter
Method on {@link Hierarchy} objects which is used find the number of children for a parent page
- CMSSiteTreeFilter::getPageClasses() — Method in class CMSSiteTreeFilter
Given a page, determine any additional CSS classes to apply to the tree node
- CMSSiteTreeFilter::getFilteredPages() — Method in class CMSSiteTreeFilter
Gets the list of filtered pages
- CMSSiteTreeFilter_ChangedPages::getFilteredPages() — Method in class CMSSiteTreeFilter_ChangedPages
Gets the list of filtered pages
- CMSSiteTreeFilter_DeletedPages::getFilteredPages() — Method in class CMSSiteTreeFilter_DeletedPages
Gets the list of filtered pages
- CMSSiteTreeFilter_PublishedPages::getFilteredPages() — Method in class CMSSiteTreeFilter_PublishedPages
Filters out all pages who's status who's status that doesn't exist on live
- CMSSiteTreeFilter_Search::getFilteredPages() — Method in class CMSSiteTreeFilter_Search
Retun an array of maps containing the keys, 'ID' and 'ParentID' for each page to be displayed in the search.
- CMSSiteTreeFilter_StatusDeletedPages::getFilteredPages() — Method in class CMSSiteTreeFilter_StatusDeletedPages
Filters out all pages who's status is set to "Deleted".
- CMSSiteTreeFilter_StatusDraftPages::getFilteredPages() — Method in class CMSSiteTreeFilter_StatusDraftPages
Filters out all pages who's status is set to "Draft".
- CMSSiteTreeFilter_StatusRemovedFromDraftPages::getFilteredPages() — Method in class CMSSiteTreeFilter_StatusRemovedFromDraftPages
Filters out all pages who's status is set to "Removed from draft".
- ContentController::getMenu() — Method in class ContentController
Returns a fixed navigation menu of the given level.
- ContentController::getViewer() — Method in class ContentController
Return an SSViewer object to render the template for the current page.
- LeftAndMainPageIconsExtension::generatePageIconsCss() — Method in class LeftAndMainPageIconsExtension
Include CSS for page icons. We're not using the JSTree 'types' option because it causes too much performance overhead just to add some icons.
- ModelAsController::getNestedController() — Method in class ModelAsController
- RootURLController::get_homepage_link() — Method in class RootURLController
Get the full form (e.g. /home/) relative link to the home page for the current HTTP_HOST value. Note that the link is trimmed of leading and trailing slashes before returning to ensure consistency.
- SilverStripeNavigator::getItems() — Method in class SilverStripeNavigator
- SilverStripeNavigator::getRecord() — Method in class SilverStripeNavigator
- SilverStripeNavigator::get_for_record() — Method in class SilverStripeNavigator
- SilverStripeNavigatorItem::getHTML() — Method in class SilverStripeNavigatorItem
- SilverStripeNavigatorItem::getTitle() — Method in class SilverStripeNavigatorItem
- SilverStripeNavigatorItem::getName() — Method in class SilverStripeNavigatorItem
Machine-friendly name.
- SilverStripeNavigatorItem::getLink() — Method in class SilverStripeNavigatorItem
Optional link to a specific view of this record.
- SilverStripeNavigatorItem::getMessage() — Method in class SilverStripeNavigatorItem
- SilverStripeNavigatorItem::getRecord() — Method in class SilverStripeNavigatorItem
- SilverStripeNavigatorItem::getPriority() — Method in class SilverStripeNavigatorItem
- SilverStripeNavigatorItem_ArchiveLink::getHTML() — Method in class SilverStripeNavigatorItem_ArchiveLink
- SilverStripeNavigatorItem_ArchiveLink::getTitle() — Method in class SilverStripeNavigatorItem_ArchiveLink
- SilverStripeNavigatorItem_ArchiveLink::getMessage() — Method in class SilverStripeNavigatorItem_ArchiveLink
- SilverStripeNavigatorItem_ArchiveLink::getLink() — Method in class SilverStripeNavigatorItem_ArchiveLink
Optional link to a specific view of this record.
- SilverStripeNavigatorItem_CMSLink::getHTML() — Method in class SilverStripeNavigatorItem_CMSLink
- SilverStripeNavigatorItem_CMSLink::getTitle() — Method in class SilverStripeNavigatorItem_CMSLink
- SilverStripeNavigatorItem_CMSLink::getLink() — Method in class SilverStripeNavigatorItem_CMSLink
Optional link to a specific view of this record.
- SilverStripeNavigatorItem_LiveLink::getHTML() — Method in class SilverStripeNavigatorItem_LiveLink
- SilverStripeNavigatorItem_LiveLink::getTitle() — Method in class SilverStripeNavigatorItem_LiveLink
- SilverStripeNavigatorItem_LiveLink::getMessage() — Method in class SilverStripeNavigatorItem_LiveLink
- SilverStripeNavigatorItem_LiveLink::getLink() — Method in class SilverStripeNavigatorItem_LiveLink
Optional link to a specific view of this record.
- SilverStripeNavigatorItem_StageLink::getHTML() — Method in class SilverStripeNavigatorItem_StageLink
- SilverStripeNavigatorItem_StageLink::getTitle() — Method in class SilverStripeNavigatorItem_StageLink
- SilverStripeNavigatorItem_StageLink::getMessage() — Method in class SilverStripeNavigatorItem_StageLink
- SilverStripeNavigatorItem_StageLink::getLink() — Method in class SilverStripeNavigatorItem_StageLink
Optional link to a specific view of this record.
- AnchorLinkFormFactory::getRequiredContext() — Method in class AnchorLinkFormFactory
Return list of mandatory context keys
- AnchorSelectorField::getSchemaDataDefaults() — Method in class AnchorSelectorField
Gets the defaults for $schemaData.
- InternalLinkModalExtension::getOwner() — Method in class InternalLinkModalExtension
- SiteTreeURLSegmentField::getAttributes() — Method in class SiteTreeURLSegmentField
- SiteTreeURLSegmentField::getPage() — Method in class SiteTreeURLSegmentField
- SiteTreeURLSegmentField::getHelpText() — Method in class SiteTreeURLSegmentField
- SiteTreeURLSegmentField::getURLPrefix() — Method in class SiteTreeURLSegmentField
- SiteTreeURLSegmentField::getURLSuffix() — Method in class SiteTreeURLSegmentField
- SiteTreeURLSegmentField::getDefaultURL() — Method in class SiteTreeURLSegmentField
- SiteTreeURLSegmentField::getURL() — Method in class SiteTreeURLSegmentField
- RedirectorPage::getCMSFields() — Method in class RedirectorPage
- RedirectorPageController::getContent() — Method in class RedirectorPageController
If we ever get this far, it means that the redirection failed.
- SiteTree::get_by_link() — Method in class SiteTree
Fetches the {@link SiteTree} object that maps to a link.
- SiteTree::getMimeType() — Method in class SiteTree
To determine preview mechanism (e.g. embedded / iframe)
- SiteTree::getAbsoluteLiveLink() — Method in class SiteTree
Get the absolute URL for this page on the Live site.
- SiteTree::getBreadcrumbItems() — Method in class SiteTree
Returns a list of breadcrumbs for the current page.
- SiteTree::getParent() — Method in class SiteTree
Get the parent of this page.
- SiteTree::getCreatableChildrenCache() — Method in class SiteTree
- SiteTree::getSiteConfig() — Method in class SiteTree
Stub method to get the site config, unless the current class can provide an alternate.
- SiteTree::getPermissionChecker() — Method in class SiteTree
- SiteTree::generateURLSegment() — Method in class SiteTree
Generate a URL segment based on the title provided.
- SiteTree::getStageURLSegment() — Method in class SiteTree
Gets the URL segment for the latest draft version of this page.
- SiteTree::getLiveURLSegment() — Method in class SiteTree
Gets the URL segment for the currently published version of this page.
- SiteTree::getCMSFields() — Method in class SiteTree
Returns a FieldList with which to create the main editing form.
- SiteTree::getSettingsFields() — Method in class SiteTree
Returns fields related to configuration aspects on this record, e.g. access control. See {@link getCMSFields()} for content-related fields.
- SiteTree::getCMSActions() — Method in class SiteTree
Get the actions available in the CMS for this page - eg Save, Publish.
- SiteTree::getMenuTitle() — Method in class SiteTree
Get the title for use in menus for this page. If the MenuTitle field is set it returns that, else it returns the Title field.
- SiteTree::getStatusFlags() — Method in class SiteTree
A flag provides the user with additional data about the current page status, for example a "removed from draft" status. Each page can have more than one status flag. Returns a map of a unique key to a (localized) title for the flag. The unique key can be reused as a CSS class. Use the 'updateStatusFlags' extension point to customize the flags.
- SiteTree::getIconClass() — Method in class SiteTree
Returns the CSS class used for the page icon in the site tree.
- SiteTree::getTreeTitle() — Method in class SiteTree
getTreeTitle will return three html DOM elements, an empty with the class 'jstree-pageicon' in front, following by a wrapping around its MenuTitle, then following by a indicating its publication status.
- SiteTree::getPageLevel() — Method in class SiteTree
Gets the depth of this page in the sitetree, where 1 is the root level
- SiteTree::getControllerName() — Method in class SiteTree
Find the controller name by our convention of {$ModelClass}Controller Can be overriden by config variable
- SiteTree::getPageIconURL() — Method in class SiteTree
Generate link to this page's icon
- SiteTree::getParentType() — Method in class SiteTree
Returns 'root' if the current page has no parent, or 'subpage' otherwise
- SiteTree::getAnchorsOnPage() — Method in class SiteTree
- SiteTreeFolderExtension::getUnusedFilesListFilter() — Method in class SiteTreeFolderExtension
Looks for files used in system and create where clause which contains all ID's of files.
- SiteTreeLinkTracking::getParser() — Method in class SiteTreeLinkTracking
Parser for link tracking
- VirtualPage::getVirtualFields() — Method in class VirtualPage
Generates the array of fields required for the page type.
- VirtualPage::getNonVirtualisedFields() — Method in class VirtualPage
List of fields or properties to never virtualise
- VirtualPage::getCMSFields() — Method in class VirtualPage
Generate the CMS fields from the fields from the original page.
- VirtualPage::getSettingsFields() — Method in class VirtualPage
- VirtualPage::getViewerTemplates() — Method in class VirtualPage
Use the target page's class name for fetching templates - as we need to take on its appearance
- VirtualPage::getField() — Method in class VirtualPage
- VirtualPage::getControllerName() — Method in class VirtualPage
{@inheritdoc}
- BrokenFilesReport::group() — Method in class BrokenFilesReport
- BrokenFilesReport::getParameterFields() — Method in class BrokenFilesReport
- BrokenRedirectorPagesReport::group() — Method in class BrokenRedirectorPagesReport
- BrokenRedirectorPagesReport::getParameterFields() — Method in class BrokenRedirectorPagesReport
- BrokenVirtualPagesReport::group() — Method in class BrokenVirtualPagesReport
- BrokenVirtualPagesReport::getParameterFields() — Method in class BrokenVirtualPagesReport
- EmptyPagesReport::group() — Method in class EmptyPagesReport
- RecentlyEditedReport::group() — Method in class RecentlyEditedReport
- SearchForm::getClassesToSearch() — Method in class SearchForm
Get the classes to search
- SearchForm::getResults() — Method in class SearchForm
Return dataObjectSet of the results using current request to get info from form.
- SearchForm::getSearchQuery() — Method in class SearchForm
Get the search query for display in a "You searched for ..." sentence.
- SearchForm::getPageLength() — Method in class SearchForm
- RemoveOrphanedPagesTask::getOrphanedPages() — Method in class RemoveOrphanedPagesTask
Gets all orphans from "Stage" and "Live" stages.
- CampaignAdmin::getClientConfig() — Method in class CampaignAdmin
Returns configuration required by the client app.
- CampaignAdmin::getEditForm() — Method in class CampaignAdmin
Calls {@link SiteTree->getCMSFields()} by default to determine the form fields to display.
- CampaignAdmin::getCampaignEditForm() — Method in class CampaignAdmin
- CampaignAdmin::getCampaignCreateForm() — Method in class CampaignAdmin
Build create form
- CampaignAdminList::getSchemaDataDefaults() — Method in class CampaignAdminList
Gets the defaults for $schemaData.
- CachedConfigCollection::getNestFactory() — Method in class CachedConfigCollection
Get callback for nesting the inner collection
- CachedConfigCollection::get() — Method in class CachedConfigCollection
Fetches value for a class, or a property on that class
- CachedConfigCollection::getAll() — Method in class CachedConfigCollection
Get complete config (excludes middleware)
- CachedConfigCollection::getMetadata() — Method in class CachedConfigCollection
Returns the entire metadata
- CachedConfigCollection::getHistory() — Method in class CachedConfigCollection
- CachedConfigCollection::getCollection() — Method in class CachedConfigCollection
Get or build collection
- CachedConfigCollection::getCollectionCreator() — Method in class CachedConfigCollection
- CachedConfigCollection::getCache() — Method in class CachedConfigCollection
- CachedConfigCollection::getFlush() — Method in class CachedConfigCollection
- ConfigCollectionInterface::get() — Method in class ConfigCollectionInterface
Fetches value for a class, or a property on that class
- ConfigCollectionInterface::getMetadata() — Method in class ConfigCollectionInterface
Returns the entire metadata
- ConfigCollectionInterface::getHistory() — Method in class ConfigCollectionInterface
- ConfigCollectionInterface::getMiddlewares() — Method in class ConfigCollectionInterface
- ConfigCollectionInterface::getAll() — Method in class ConfigCollectionInterface
Get complete config (excludes middleware)
- DeltaConfigCollection::getDeltaMiddleware() — Method in class DeltaConfigCollection
Get middleware for handling deltas
- DeltaConfigCollection::getMiddlewares() — Method in class DeltaConfigCollection
- DeltaConfigCollection::getDeltas() — Method in class DeltaConfigCollection
Get deltas for the given class
- MemoryConfigCollection::get() — Method in class MemoryConfigCollection
Fetches value for a class, or a property on that class
- MemoryConfigCollection::getAll() — Method in class MemoryConfigCollection
Get complete config (excludes middleware-applied config)
- MemoryConfigCollection::getMetadata() — Method in class MemoryConfigCollection
Returns the entire metadata
- MemoryConfigCollection::getHistory() — Method in class MemoryConfigCollection
- DeltaMiddleware::getCollection() — Method in class DeltaMiddleware
- DeltaMiddleware::getClassConfig() — Method in class DeltaMiddleware
Get config for a class
- Middleware::getClassConfig() — Method in class Middleware
Get config for a class
- MiddlewareAware::getMiddlewares() — Method in class MiddlewareAware
- MiddlewareCommon::getDisableFlag() — Method in class MiddlewareCommon
Get flag to use to disable this middleware
- PrivateStaticTransformer::getClasses() — Method in class PrivateStaticTransformer
- ContentNegotiator::getEnabled() — Method in class ContentNegotiator
Gets the current enabled status, if it is not set this will fallback to config
- Controller::getURLParams() — Method in class Controller
Returns the parameters extracted from the URL by the {@link Director}.
- Controller::getResponse() — Method in class Controller
Returns the HTTPResponse object that this controller is building up. Can be used to set the status code and headers.
- Controller::getAction() — Method in class Controller
Returns the action that is being executed on this controller.
- Controller::getViewer() — Method in class Controller
Return the viewer identified being the default handler for this Controller/Action combination.
- Controller::get_template_global_variables() — Method in class Controller
- Cookie::get_inst() — Method in class Cookie
Fetch the current instance of the cookie backend.
- Cookie::get() — Method in class Cookie
Get the cookie value by name. Returns null if not set.
- Cookie::get_all() — Method in class Cookie
Get all the cookies.
- CookieJar::get() — Method in class CookieJar
Get the cookie value by name
- CookieJar::getAll() — Method in class CookieJar
Get all the cookies
- Cookie_Backend::get() — Method in class Cookie_Backend
Get the cookie value by name
- Cookie_Backend::getAll() — Method in class Cookie_Backend
Get all the cookies
- Director::get_current_page() — Method in class Director
Return the {@link SiteTree} object that is currently being viewed. If there is no SiteTree object to return, then this will return the current controller.
- Director::getAbsFile() — Method in class Director
Given a filesystem reference relative to the site root, return the full file-system path.
- Director::get_environment_type() — Method in class Director
Can also be checked with {@link Director::isDev()}, {@link Director::isTest()}, and {@link Director::isLive()}.
- Director::get_template_global_variables() — Method in class Director
Returns an array of strings of the method names of methods on the call that should be exposed as global variables in the templates.
- Email::getSendAllEmailsTo() — Method in class Email
Get send_all_emails_to
- Email::getCCAllEmailsTo() — Method in class Email
Get cc_all_emails_to
- Email::getBCCAllEmailsTo() — Method in class Email
Get bcc_all_emails_to
- Email::getSendAllEmailsFrom() — Method in class Email
Get send_all_emails_from
- Email::getSwiftMessage() — Method in class Email
- Email::getFrom() — Method in class Email
- Email::getSender() — Method in class Email
- Email::getReturnPath() — Method in class Email
- Email::getTo() — Method in class Email
- Email::getCC() — Method in class Email
- Email::getBCC() — Method in class Email
- Email::getReplyTo() — Method in class Email
- Email::getSubject() — Method in class Email
- Email::getPriority() — Method in class Email
- Email::getData() — Method in class Email
- Email::getBody() — Method in class Email
- Email::getHTMLTemplate() — Method in class Email
- Email::getPlainTemplate() — Method in class Email
Get the template to render the plain part with
- Email::getFailedRecipients() — Method in class Email
- Email::generatePlainPartFromBody() — Method in class Email
Automatically adds a plain part to the email generated from the current Body
- SwiftMailer::getSwiftMailer() — Method in class SwiftMailer
- HTTP::getLinksIn() — Method in class HTTP
- HTTP::getImagesIn() — Method in class HTTP
- HTTP::get_mime_type() — Method in class HTTP
Get the MIME type based on a file's extension. If the finfo class exists in PHP, and the file exists relative to the project root, then use that extension, otherwise fallback to a list of commonly known MIME types.
- HTTP::gmt_date() — Method in class HTTP
Return an {@link http://www.faqs.org/rfcs/rfc2822 RFC 2822} date in the GMT timezone (a timestamp is always in GMT: the number of seconds since January 1 1970 00:00:00 GMT)
- HTTP::get_cache_age() — Method in class HTTP
Return static variable cache_age in second
- HTTPApplication::getFlushDiscoverer() — Method in class HTTPApplication
Returns the current flush discoverer
- HTTPApplication::getKernel() — Method in class HTTPApplication
Get the kernel for this application
- HTTPRequest::getBody() — Method in class HTTPRequest
- HTTPRequest::getVars() — Method in class HTTPRequest
- HTTPRequest::getVar() — Method in class HTTPRequest
- HTTPRequest::getExtension() — Method in class HTTPRequest
Returns a possible file extension found in parsing the URL as denoted by a "."-character near the end of the URL.
- HTTPRequest::getHeaders() — Method in class HTTPRequest
- HTTPRequest::getHeader() — Method in class HTTPRequest
Remove an existing HTTP header
- HTTPRequest::getURL() — Method in class HTTPRequest
Returns the URL used to generate the page
- HTTPRequest::getHost() — Method in class HTTPRequest
- HTTPRequest::getIP() — Method in class HTTPRequest
Returns the client IP address which originated this request.
- HTTPRequest::getAcceptMimetypes() — Method in class HTTPRequest
Returns all mimetypes from the HTTP "Accept" header as an array.
- HTTPRequest::getScheme() — Method in class HTTPRequest
Return the URL scheme (e.g. "http" or "https").
- HTTPRequest::getSession() — Method in class HTTPRequest
- HTTPResponse::getProtocolVersion() — Method in class HTTPResponse
- HTTPResponse::getStatusCode() — Method in class HTTPResponse
- HTTPResponse::getStatusDescription() — Method in class HTTPResponse
- HTTPResponse::getBody() — Method in class HTTPResponse
- HTTPResponse::getHeader() — Method in class HTTPResponse
Return the HTTP header of the give