SiteTree
class SiteTree extends DataObject implements PermissionProvider, i18nEntityProvider, CMSPreviewable, Resettable, Flushable, MemberCacheFlusher mixin Hierarchy mixin Versioned mixin RecursivePublishable mixin SiteTreeLinkTracking mixin FileLinkTracking mixin InheritedPermissionsExtension (View source)
Basic data-object representing all pages within the site tree. All page types that live within the hierarchy should inherit from this. In addition, it contains a number of static methods for querying the site tree and working with draft and published states.
URLs
A page is identified during request handling via its "URLSegment" database column. As pages can be nested, the full path of a URL might contain multiple segments. Each segment is stored in its filtered representation (through URLSegmentFilter}). The full path is constructed via {@link Link()}, {@link RelativeLink() and AbsoluteLink(). You can allow these segments to contain multibyte characters through URLSegmentFilter::$default_allow_multibyte.
Traits
Allows an object to have extensions applied to it.
A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Allows an object to declare a set of custom methods
Constants
| CHANGE_NONE |
Represents a field that hasn't changed (before === after, thus before == after) |
| CHANGE_STRICT |
Represents a field that has changed type, although not the loosely defined value. (before !== after && before == after) E.g. change 1 to true or "true" to true, but not true to 0. Value changes are by nature also considered strict changes. |
| CHANGE_VALUE |
Represents a field that has changed the loosely defined value
(before != after, thus, before !== after))
E.g. change false to true, but not false to 0 |
| CREATE_OBJECT |
Value for 2nd argument to constructor, indicating that a new record is being created
Setters will be called on fields passed, and defaults will be populated |
| CREATE_SINGLETON |
Value for 2nd argument to constructor, indicating that a record is a singleton representing the whole type,
e.g. to call requireTable() in dev/build
Defaults will not be populated and data passed will be ignored |
| CREATE_HYDRATED |
Value for 2nd argument to constructor, indicating that a record is being hydrated from the database
Setter methods are not called, and population via private static $defaults will not occur. |
| CREATE_MEMORY_HYDRATED |
Value for 2nd argument to constructor, indicating that a record is being hydrated from memory. This can be used
to initialised a record that doesn't yet have an ID. Setter methods are not called, and population via private
static $defaults will not occur. |
Config options
| extensions | |||
| unextendable_classes | array | Classes that cannot be extended |
from Extensible |
| casting | |||
| default_cast | string | The default object to cast scalar fields to if casting information is not specified, and casting to an object is required. |
from ViewableData |
| casting_cache | array | from ViewableData | |
| require_sudo_mode | bool | Config of whether the model requires sudo mode to be active in order to be modified in admin Sudo mode is a security feature that requires the user to re-enter their password before making changes to the database. |
from ViewableData |
| singular_name | string | Human-readable singular name. |
from DataObject |
| plural_name | string | Human-readable plural name |
from DataObject |
| class_description | string|null | Description of the class. |
from DataObject |
| api_access | from DataObject | ||
| default_classname | string | Default value for SiteTree.ClassName enum {DBClassName::getDefault} |
|
| validation_enabled | bool | Should dataobjects be validated before they are written? |
from DataObject |
| fixed_fields | array | Base fields which are not defined in static $db |
from DataObject |
| table_name | |||
| scaffold_cms_fields_settings | array | Settings used by the FormScaffolder that scaffolds fields for getCMSFields() |
from DataObject |
| cascade_deletes | |||
| cascade_duplicates | array | List of relations that should be cascade duplicate. |
from DataObject |
| subclass_access | from DataObject | ||
| db | |||
| create_table_options | array | Specify custom options for a CREATE TABLE call. |
from DataObject |
| indexes | |||
| defaults | |||
| default_records | array | 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. |
from DataObject |
| has_one | array | One-to-zero relationship definition. This is a map of component name to data type. In order to turn this into a true one-to-one relationship you can add a DataObject::$belongs_to relationship on the child class. |
from DataObject |
| belongs_to | array | A meta-relationship that allows you to define the reverse side of a DataObject::$has_one. |
from DataObject |
| has_many | |||
| many_many | array | many-many relationship definitions. |
from DataObject |
| many_many_extraFields | array | Extra fields to include on the connecting many-many table. |
from DataObject |
| belongs_many_many | array | The inverse side of a many-many relationship. |
from DataObject |
| default_sort | |||
| searchable_fields | |||
| general_search_field_name | string | Name of the field which is used as a stand-in for searching across all searchable fields. |
from DataObject |
| general_search_field_filter | string | The search filter to use when searching with the general search field. |
from DataObject |
| general_search_split_terms | bool | If true, the search phrase is split into individual terms, and checks all searchable fields for each search term. |
from DataObject |
| field_labels | |||
| summary_fields | array | Provides a default list of fields to be used by a 'summary' view of this object. |
from DataObject |
| allowed_children | array | Indicates what kind of children this page type can have. |
|
| show_stage_link | bool | Determines if the Draft Preview panel will appear when in the CMS admin |
|
| show_live_link | bool | Determines if the Live Preview panel will appear when in the CMS admin |
|
| default_child | string | The default child class for this page. |
|
| default_parent | string | The default parent class for this page. |
|
| can_be_root | bool | Controls whether a page can be in the root of the site tree. |
|
| need_permission | array | List of permission codes a user can have to allow a user to create a page of this type. |
|
| hide_ancestor | string | If you extend a class, and don't want to be able to select the old class in the cms, set this to the old class name. Eg, if you extended Product to make ImprovedProduct, then you would set $hide_ancestor to Product. |
|
| hide_pagetypes | array | Any fully qualified class names added to this array will be hidden in the CMS when selecting page types, e.g. for creating a new page or changing the type of an existing page. |
|
| controller_name | string | 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 |
|
| cms_edit_owner | string | The class of the LeftAndMain controller where this class is managed. |
|
| namespace_map | string | You can define the a map of Page namespaces to Controller namespaces here This will apply after the magic of appending Controller, and in order Must be applied to SiteTree config e.g. |
|
| owned_by | |||
| versioning | |||
| fields_ignored_by_versioning | string[] | Fields which, if changed on their own, won't cause a new version/live record to be created |
|
| can_create | bool | If this is false, the class cannot be created in the CMS by regular content authors, only by ADMINs. |
|
| icon | string | Icon to use in the CMS page tree. This should be the full filename, relative to the webroot. |
|
| icon_class | string | Class attached to page icons in the CMS page tree. Also supports font-icon set. |
|
| nested_urls | |||
| create_default_pages | |||
| runCMSFieldsExtensions | This controls whether of not extendCMSFields() is called by getCMSFields. |
||
| enforce_strict_hierarchy | bool | Deleting this page also deletes all its children when set to true. |
|
| meta_generator | string | The value used for the meta generator tag. Leave blank to omit the tag. |
|
| show_meta_generator_version | bool | Whether to display the version portion of the meta generator tag Set to false if it's viewed as a concern. |
|
| base_plural_name | string | Plural form for SiteTree / Page classes. Not inherited by subclasses. |
|
| base_singular_name | string | Plural form for SiteTree / Page classes. Not inherited by subclasses. |
|
| description | string | Description of the class functionality, typically shown to a user when selecting which page type to create. Translated through provideI18nEntities(). |
|
| base_description | string | Description for Page and SiteTree classes, but not inherited by subclasses. |
|
| base_class_description | string | Description for Page and SiteTree classes, but not inherited by subclasses. |
|
| dependencies | array |
Properties
| protected static | array | $extra_methods | Custom method sources |
from CustomMethods |
| protected | array | $extra_method_registers | Name of methods to invoke by defineMethods for this instance |
from CustomMethods |
| protected static | array | $built_in_methods | Non-custom public methods. |
from CustomMethods |
| protected | Extension[] | $extension_instances | from Extensible | |
| protected | callable[][] | $beforeExtendCallbacks | List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | callable[][] | $afterExtendCallbacks | List of callbacks to call after extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | ViewableData | $failover | A failover object to attempt to get data from if it is not present on this object. |
from ViewableData |
| protected | ViewableData | $customisedObject | from ViewableData | |
| protected | array | $record | Data stored in this objects database record. An array indexed by fieldname. |
from DataObject |
| protected | DataObject | $joinRecord | If selected through a many_many through relation, this is the instance of the through record |
from DataObject |
| protected | array | $original | The database record (in the same format as $record), before any changes. |
from DataObject |
| protected | bool | $brokenOnDelete | Used by onBeforeDelete() to ensure child classes call parent::onBeforeDelete() |
from DataObject |
| protected | bool | $brokenOnWrite | Used by onBeforeWrite() to ensure child classes call parent::onBeforeWrite() |
from DataObject |
| protected static | array | $_cache_get_one | Static caches used by relevant functions. |
from DataObject |
| protected static | array | $_cache_field_labels | Cache of field labels |
from DataObject |
| protected | DataObject[] | $components | Non-static relationship cache, indexed by component name. |
from DataObject |
| protected | UnsavedRelationList[] | $unsavedRelations | Non-static cache of has_many and many_many relations that can't be written until this object is saved. |
from DataObject |
| protected | array | $sourceQueryParams | from DataObject | |
| int | $ID | ID of the DataObject, 0 if the DataObject doesn't exist in database. |
from DataObject | |
| int | $OldID | ID of object, if deleted |
from DataObject | |
| string | $Title | |||
| string | $ClassName | Class name of the DataObject |
from DataObject | |
| string | $LastEdited | Date and time of DataObject's last modification. |
from DataObject | |
| string | $Created | Date and time of DataObject creation. |
from DataObject | |
| string | $ObsoleteClassName | If ClassName no longer exists this will be set to the legacy value |
from DataObject | |
| protected static deprecated | array | $_allowedChildren | Used as a cache for |
|
| protected deprecated | $_cache_statusFlags | |||
| protected deprecated | CacheInterface | $creatableChildrenCache | ||
| string | $URLSegment | |||
| string | $MenuTitle | |||
| string | $Content | HTML content of the page. |
||
| string | $MetaDescription | |||
| string | $ExtraMeta | |||
| string | $ReportClass | |||
| int | $Sort | Integer value denoting the sort order. |
||
| bool | $ShowInMenus | |||
| bool | $ShowInSearch | |||
| bool | $HasBrokenFile | True if this page has a broken file shortcode |
||
| bool | $HasBrokenLink | True if this page has a broken page shortcode |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Adds any methods from Extension instances attached to this object.
Register an callback to invoke that defines extra methods
Return TRUE if a method exists on this object
Determines if a custom method with this name is defined.
Get meta-data details on a named method
Return the names of all the methods available on this object
Get all public built in methods for this class
Find all methods on the given object.
Add all the methods from an object property.
Add all the methods from an object property (which is an Extension) to this object.
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
Add callback as a method.
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
Adds any methods from Extension instances attached to this object.
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
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
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Construct a new DataObject.
Check if a field exists on this object or its failover.
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
Set a failover object to attempt to get data from if it is not present on this object.
Returns true if the given field exists in a database column on any of
the objects tables and optionally look up a dynamic getter with
get
Set the value of the field Called by __set() and any setFieldName() methods you might create.
Whether the model requires sudo mode to be active in order to be modified in admin
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
Returns true if this object "exists", i.e., has a sensible value.
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.
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:
- a template name (e.g. Page)
- an array of possible template names - the first valid one will be used
- an SSViewer instance
Store a value in the field cache
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
Returns true if the given method/parameter has a value (Uses the DBField::hasValue if the parameter is a database field)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
Return a single-item iterator so you can iterate over the fields of a single record.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Create a duplicate of this node. Can duplicate many_many relations
Copies the given relations from this object to the destination
Duplicates a single many_many relation from one object to another.
Duplicates a single many_many relation from one object to another.
Duplicates a single has_one relation from one object to another.
Duplicates a single belongs_to relation from one object to another.
Return obsolete class name, if this is no longer a valid class
Set the ClassName attribute. $class is also updated.
Create a new instance of a different class from this object's record.
Returns TRUE if all values (other than "ID") are considered empty (by weak boolean comparison).
Pluralise this item given a specific count.
Get the translated user friendly singular name of this DataObject same as singular_name() but runs it through the translating function
Get the translated user friendly plural name of this DataObject Same as plural_name but runs it through the translation function Translation string is in the form: $this->class.PLURALNAME Example: Page.PLURALNAME
Standard implementation of a title/label for a specific record. Tries to find properties 'Title' or 'Name', and falls back to the 'ID'. Useful to provide user-friendly identification of a record, e.g. in errormessages or UI-selections.
Returns the associated database record - in this case, the object itself.
Return all currently fetched database fields.
Update a number of fields on this object, given a map of the desired changes.
Pass changes as a map, and try to get automatic casting for these fields.
Merges data and relations from another object of same class, without conflict resolution. Allows to specify which dataset takes priority in case its not empty.
Forces the record to think that all its data has changed.
Find all objects that will be cascade deleted if this object is deleted
Load the default values in from the DataObject::$defaults array.
Detects and updates all changes made to this object
Writes a subset of changes for a specific table to the given manipulation
Ensures that a blank base record exists with the basic fixed fields for this dataobject
Generate and write the database manipulation for all changed fields
Writes all changes to this object to the database.
Write the cached components to the database. Cached components could refer to two different instances of the same record.
Delete the record with the given ID.
Get the class ancestry, including the current class name.
Return a unary component object from a one to one relationship, as a DataObject.
No description
Returns a one-to-many relation as a HasManyList
Find the foreign class of a relation on this DataObject, regardless of the relation type.
Given a relation name, determine the relation type
Given a relation declared on a remote class, generate a substitute component for the opposite side of the relation.
Returns a many-to-many component, as a ManyManyList.
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.
Gets the class of a one-to-many relationship. If no $component is specified then an array of all the one-to-many relationships and their classes will be returned.
Return the many-to-many extra fields specification.
This returns an array (if it exists) describing the database extensions that are required, or false if none
Generates a SearchContext to be used for building and processing a generic search form for properties on this object.
Name of the field which is used as a stand-in for searching across all searchable fields.
Determine which properties on the DataObject are searchable, and map them to their default FormField representations. Used for scaffolding a searchform for ModelAdmin.
Scaffold a simple edit form for all properties on this dataobject, based on default FormField} mapping in {@link DBField::scaffoldFormField().
Scaffold a form field for selecting records of this model type in a has_one relation.
Scaffold a form field for selecting records of this model type in a has_many relation.
Scaffold a form field for selecting records of this model type in a many_many relation.
Allows user code to hook into DataObject::getCMSFields prior to updateCMSFields being called on extensions
Allows user code to hook into DataObject::getCMSFields after updateCMSFields being called on extensions
Get the actions available in the CMS for this page - eg Save, Publish.
When extending this class and overriding this method, you will need to instantiate the CompositeValidator by calling parent::getCMSCompositeValidator(). This will ensure that the appropriate extension point is also invoked.
Used for simple frontend forms without relation editing or TabSet} behaviour. Uses {@link scaffoldFormFields() by default. To customize, either overload this method in your subclass, or extend it by DataExtension->updateFrontEndFields().
Loads all the stub fields that an initial lazy load didn't load fully.
Return the fields that have changed since the last write.
Uses getChangedFields() to determine if fields have been changed since loading them from the database.
Set the value of the field, using a casting object.
Returns true if the given field exists as a database column
Process tri-state responses from permission-alterting extensions. The extensions are expected to return one of three values:
Return the DBField object that represents the given field.
Traverses to a DBField referenced by relationships between data objects.
Traverses to a field referenced by relationships between data objects, returning the value The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
Temporary hack to return an association name, based on class, to get around the mangle of having to deal with reverse lookup of relationships to determine autogenerated foreign keys.
Return all objects matching the filter sub-classes are automatically selected and included
Return the first item matching the given query.
Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.
Flush the get_one global cache and destroy associated objects.
Return the given element, searching by ID.
Get list of parameters that should be inherited to relations on this object
Invoked after every database build is complete (including after table creation and default record population).
Get the default searchable fields for this object, as defined in the $searchable_fields list. If searchable fields are not defined on the data object, uses a default selection of summary fields.
Get a human-readable label for a single field, see fieldLabels() for more details.
Defines a default list of filters for the search context.
Overloaded to also provide entities for 'Page' class which is usually located in custom code, hence textcollector picks it up for the wrong folder.
If selected through a many_many through relation, this is the instance of the joined record
Find objects in the given relationships, merging them into the given list
Helper method to merge owned/owning items into a list.
Generate a unique key for data object the unique key uses the DataObject::getUniqueKeyComponents() extension point so unique key modifiers such as versioned or fluent are covered i.e. same data object in different stages or different locales will produce different unique key
Merge single object into a list, but ensures that existing objects are not re-added.
Fetches the SiteTree object that maps to a link.
Return a subclass map of SiteTree that shouldn't be hidden through SiteTree::$hide_pagetypes
Replace a "[sitetree_link id=n]" shortcode with a link to the page with the corresponding ID.
Return the link for this SiteTree} object, with the {@link Director::baseURL() included.
Get the absolute URL for this page, including protocol and host.
Base link used for previewing. Defaults to absolute URL, in order to account for domain changes, e.g. on multi site setups. Does not contain hints about the stage, see SilverStripeNavigator for details.
Return the link for this SiteTree object relative to the SilverStripe root.
Get the absolute URL for this page on the Live site.
Returns true if this is the currently active page being used to handle this request.
Check if this page is in the currently active section (e.g. it is either current or one of its children is currently being viewed).
Check if the parent of this page has been removed (or made otherwise unavailable), and is still referenced by this child. Any such orphaned page may still require access via the CMS, but should not be shown as accessible to external users.
Return "link" or "current" depending on if this is the SiteTree::isCurrent() current page.
Return "link" or "section" depending on if this is the SiteTree::isSeciton() current section.
Return "link", "current" or "section" depending on if this page is the current page, or not on the current page but in the current section.
Duplicates each child of this node recursively and returns the top-level duplicate node.
Duplicate this node and its children as a child of the node with the given ID
Return a breadcrumb trail to this page. Excludes "hidden" pages (with ShowInMenus=0) by default.
Returns a list of breadcrumbs for the current page.
Return a string of the form "parent - page" or "grandparent - parent - page" using page titles
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.
Stub method to get the site config, unless the current class can provide an alternate.
Collate selected descendants of this page.
Return attributes for various meta tags, plus a title tag, in a keyed array.
Return the title, description, keywords and language metatags.
Returns the object that contains the content that a user would associate with this page.
Flushes the member specific cache for creatable children
Returns true if this object has a URLSegment value that does not conflict with any other objects. This method checks for:
- A page with the same URLSegment that has a conflict
- Conflicts with actions on the parent page
- A conflict caused by a root page having the same URLSegment as a class name
Gets the URL segment for the currently published version of this page.
Returns the pages that depend on this page. This includes virtual pages, pages that link to it, etc.
Returns fields related to configuration aspects on this record, e.g. access control. See getCMSFields() for content-related fields.
Determine if this page references a parent which is archived, and not available in stage
Restore the content in the active copy of this SiteTree page to the stage site.
Check if this page is new - that is, if it has yet to have been written to the database.
Get the class dropdown used in the CMS to change the class of a page. This returns the list of options in the dropdown as a Map from class name to singular name. Filters by SiteTree->canCreate(), as well as SiteTree::$needs_permission.
Returns an array of the class names of classes that are allowed to be children of this class.
Gets a list of the page types that can be created under this specific page, including font icons
Returns the class name of the default class for the parent of this page.
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.
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.
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.
Returns the page in the current page stack of the given level. Level(1) will return the main menu item that we're currently inside, etc.
Find the controller name by our convention of {$ModelClass}Controller Can be overriden by config variable
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.
Reenables extendCMSFields() being called on getCMSFields() after it has been disabled by disableCMSFieldsExtensions().
Return a map of permission codes to add to the dropdown shown in the Security section of the CMS.
Returns 'root' if the current page has no parent, or 'subpage' otherwise
Details
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()
protected
defineMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
protected
registerExtraMethodCallback(string $name, callable $callback)
Register an callback to invoke that defines extra methods
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
protected bool
hasCustomMethod($method)
Determines if a custom method with this name is defined.
protected array
getExtraMethodConfig(string $method)
Get meta-data details on a named method
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
static protected array
findBuiltInMethods(string|object $class = null)
Get all public built in methods for this class
protected array
findMethodsFrom(object $object)
Find all methods on the given object.
protected
addMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property.
protected
removeMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
addWrapperMethod(string $method, string $wrap)
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
protected
addCallbackMethod(string $method, callable $callback)
Add callback as a method.
protected
beforeExtending(string $method, callable $callback)
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
protected
afterExtending(string $method, callable $callback)
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
protected
defineExtensionMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
No description
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
array
invokeWithExtensions(string $method, mixed ...$arguments)
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
array
extend(string $method, mixed ...$arguments)
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
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during __construct()} in {@link defineMethods().
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See get_extensions() to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
__construct(array $record = [], int|bool $creationType = DataObject::CREATE_OBJECT, array $queryParams = [])
Construct a new DataObject.
bool
__isset(string $property)
Check if a field exists on this object or its failover.
Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
ViewableData|null
getFailover()
Get the current failover object if set
bool
hasField(string $field)
Returns true if the given field exists in a database column on any of
the objects tables and optionally look up a dynamic getter with
get
mixed
getField(string $field)
Gets the value of a field.
Called by __get() and any getFieldName() methods you might create.
$this
setField(string $fieldName, mixed $val)
Set the value of the field Called by __set() and any setFieldName() methods you might create.
mixed
getDynamicData(string $field)
No description
ViewableData
setDynamicData(string $field, mixed $value)
No description
bool
hasDynamicData(string $field)
No description
bool
getRequireSudoMode()
Whether the model requires sudo mode to be active in order to be modified in admin
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
bool
exists()
Returns true if this object "exists", i.e., has a sensible value.
The default behaviour for a DataObject is to return true if the object exists in the database, you can override this in subclasses.
string
__toString()
No description
ViewableData
getCustomisedObj()
No description
setCustomisedObj(ViewableData $object)
No description
string
castingHelper(string $field)
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.
string
castingClass(string $field)
deprecated
deprecated
Get the class name a field on this object will be casted to.
string
escapeTypeForField(string $field)
deprecated
deprecated
Return the string-format type for the given field.
DBHTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:
- a template name (e.g. Page)
- an array of possible template names - the first valid one will be used
- an SSViewer instance
protected string
objCacheName(string $fieldName, array $arguments)
deprecated
deprecated
Generate the cache name for a field
protected mixed
objCacheGet(string $key)
Get a cached value from the field cache
protected $this
objCacheSet(string $key, mixed $value)
Store a value in the field cache
protected $this
objCacheClear()
Clear object cache
object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
object|DBField
cachedCall(string $fieldName, array $arguments = [], string $identifier = null)
deprecated
deprecated
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
bool
hasValue(string $field, array $arguments = null, bool $cache = true)
Returns true if the given method/parameter has a value (Uses the DBField::hasValue if the parameter is a database field)
string
XML_val(string $field, array $arguments = [], bool $cache = false)
deprecated
deprecated
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
array
getXMLValues(array $fields)
deprecated
deprecated
Get an array of XML-escaped values by field name
Traversable
getIterator()
deprecated
deprecated
Return a single-item iterator so you can iterate over the fields of a single record.
This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
string
CSSClasses(string $stopAtClass = ViewableData::class)
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
static DataObjectSchema
getSchema()
Get schema object
destroy()
Destroy all of this objects dependent objects and local caches.
You'll need to call this to get the memory of an object that has components or extensions freed.
DataObject
duplicate(bool $doWrite = true, array|null $relations = null)
Create a duplicate of this node. Can duplicate many_many relations
Will default to cascade_duplicates if null.
Set to 'false' to force none.
Set to specific array of names to duplicate to override these.
Note: If using versioned, this will additionally failover to owns config.
protected
duplicateRelations(DataObject $sourceObject, DataObject $destinationObject, array $relations)
Copies the given relations from this object to the destination
protected
duplicateManyManyRelation(DataObject $sourceObject, DataObject $destinationObject, string $relation)
Duplicates a single many_many relation from one object to another.
protected
duplicateHasManyRelation(DataObject $sourceObject, DataObject $destinationObject, string $relation)
Duplicates a single many_many relation from one object to another.
protected
duplicateHasOneRelation(DataObject $sourceObject, DataObject $destinationObject, string $relation)
Duplicates a single has_one relation from one object to another.
Note: Child object will be force written.
protected
duplicateBelongsToRelation(DataObject $sourceObject, DataObject $destinationObject, string $relation)
Duplicates a single belongs_to relation from one object to another.
Note: This will force a write on both parent / child objects.
string
getObsoleteClassName()
Return obsolete class name, if this is no longer a valid class
string
getClassName()
Gets name of this class
$this
setClassName(string $className)
Set the ClassName attribute. $class is also updated.
Warning: This will produce an inconsistent record, as the object instance will not automatically switch to the new subclass. Please use newClassInstance() for this purpose, or destroy and reinstanciate the record.
T
newClassInstance(T> $newClassName)
Create a new instance of a different class from this object's record.
This is useful when dynamically changing the type of an instance. Specifically, it ensures that the instance of the class is a match for the className of the record. Don't set the DataObject->class} or {@link DataObject->ClassName property manually before calling this method, as it will confuse change detection.
If the new class is different to the original class, defaults are populated again because this will only occur automatically on instantiation of a DataObject if there is no record, or the record has no ID. In this case, we do have an ID but we still need to repopulate the defaults.
bool
isEmpty()
Returns TRUE if all values (other than "ID") are considered empty (by weak boolean comparison).
string
i18n_pluralise(string $count)
Pluralise this item given a specific count.
E.g. "0 Pages", "1 File", "3 Images"
string
singular_name()
Default singular name for page / sitetree
string
i18n_singular_name()
Get the translated user friendly singular name of this DataObject same as singular_name() but runs it through the translating function
Translating string is in the form: $this->class.SINGULARNAME Example: Page.SINGULARNAME
string
plural_name()
Default plural name for page / sitetree
string
i18n_plural_name()
Get the translated user friendly plural name of this DataObject Same as plural_name but runs it through the translation function Translation string is in the form: $this->class.PLURALNAME Example: Page.PLURALNAME
null|string
classDescription()
Get description for this page type
null|string
i18n_classDescription()
Get localised description for this class
string
getTitle()
Standard implementation of a title/label for a specific record. Tries to find properties 'Title' or 'Name', and falls back to the 'ID'. Useful to provide user-friendly identification of a record, e.g. in errormessages or UI-selections.
Overload this method to have a more specialized implementation, e.g. for an Address record this could be:
function getTitle() {
return "{$this->StreetNumber} {$this->StreetName} {$this->City}";
}
DataObject
data()
Returns the associated database record - in this case, the object itself.
This is included so that you can call $dataOrController->data() and get a DataObject all the time.
array
toMap()
Convert this object to a map.
Note that it has the following quirks:
- custom getters, including those that adjust the result of database fields, won't be executed
- NULL values won't be returned.
array
getQueriedDatabaseFields()
Return all currently fetched database fields.
This function is similar to toMap() but doesn't trigger the lazy-loading of all unfetched fields. Obviously, this makes it a lot faster.
DataObject
update(array $data)
Update a number of fields on this object, given a map of the desired changes.
The field names can be simple names, or you can use a dot syntax to access $has_one relations. For example, array("Author.FirstName" => "Jim") will set $this->Author()->FirstName to "Jim".
Doesn't write the main object, but if you use the dot syntax, it will write() the related objects that it alters.
When using this method with user supplied data, it's very important to whitelist the allowed keys.
DataObject
castedUpdate(array $data)
Pass changes as a map, and try to get automatic casting for these fields.
Doesn't write to the database. To write the data, use the write() method.
bool
merge(DataObject $rightObj, string $priority = 'right', bool $includeRelations = true, bool $overwriteWithEmpty = false)
Merges data and relations from another object of same class, without conflict resolution. Allows to specify which dataset takes priority in case its not empty.
has_one-relations are just transferred with priority 'right'. has_many and many_many-relations are added regardless of priority.
Caution: has_many/many_many relations are moved rather than duplicated, meaning they are not connected to the merged object any longer. Caution: Just saves updated has_many/many_many relations to the database, doesn't write the updated object itself (just writes the object-properties). Caution: Does not delete the merged object. Caution: Does now overwrite Created date on the original object.
$this
forceChange()
Forces the record to think that all its data has changed.
Doesn't write to the database. Force-change preserved until next write. Existing CHANGE_VALUE or CHANGE_STRICT values are preserved.
ValidationResult
validate()
Validate the current object.
By default, there is no validation - objects are always valid! However, you can overload this method in your DataObject sub-classes to specify custom validation, or use the hook through DataExtension.
Invalid objects won't be able to be written - a warning will be thrown and no write will occur. onBeforeWrite() and onAfterWrite() won't get called either.
It is expected that you call validate() in your own application to test that an object is valid before attempting a write, and respond appropriately if it isn't.
protected
onBeforeWrite()
Event handler called before writing to the database.
You can overload this to clean up or otherwise process data before writing it to the database. Don't forget to call parent::onBeforeWrite(), though!
This called after $this->validate(), so you can be sure that your data is valid.
protected
onAfterWrite()
Event handler called after writing to the database.
You can overload this to act upon changes made to the data after it is written. $this->changed will have a record database. Don't forget to call parent::onAfterWrite(), though!
DataObject>
findCascadeDeletes(bool $recursive = true, ArrayList $list = null)
Find all objects that will be cascade deleted if this object is deleted
Notes:
- If this object is versioned, objects will only be searched in the same stage as the given record.
- This will only be useful prior to deletion, as post-deletion this record will no longer exist.
onBeforeDelete()
Event handler called before deleting from the database.
You can overload this to clean up or otherwise process data before delete this record. Don't forget to call parent::onBeforeDelete(), though!
onAfterDelete()
No description
DataObject
populateDefaults()
Load the default values in from the DataObject::$defaults array.
Will traverse the defaults of the current class and all its parent classes. Called by the constructor when creating new records.
protected ValidationException
validateWrite()
Determine validation of this object prior to write
protected
preWrite()
Prepare an object prior to write
protected bool
updateChanges(bool $forceChanges = false)
Detects and updates all changes made to this object
protected
prepareManipulationTable(string $baseTable, string $now, bool $isNewRecord, array $manipulation, string $class)
Writes a subset of changes for a specific table to the given manipulation
protected
writeBaseRecord(string $baseTable, string $now)
Ensures that a blank base record exists with the basic fixed fields for this dataobject
Does nothing if an ID is already assigned for this record
protected
writeManipulation(string $baseTable, string $now, bool $isNewRecord)
Generate and write the database manipulation for all changed fields
write(bool $showDebug = false, bool $forceInsert = false, bool $forceWrite = false, bool|array $writeComponents = false)
Writes all changes to this object to the database.
- It will insert a record whenever ID isn't set, otherwise update.
- All relevant tables will be updated.
- $this->onBeforeWrite() gets called beforehand.
- Extensions such as Versioned will amend the database-write to ensure that a version is saved.
writeRelations()
Writes cached relation lists to the database, if possible
DataObject
writeComponents(bool $recursive = false, array $skip = [])
Write the cached components to the database. Cached components could refer to two different instances of the same record.
delete()
Delete this data object.
$this->onBeforeDelete() gets called. Note that in Versioned objects, both Stage and Live will be deleted.
static
delete_by_id(string $className, int $id)
Delete the record with the given ID.
array
getClassAncestry()
Get the class ancestry, including the current class name.
The ancestry will be returned as an array of class names, where the 0th element will be the class that inherits directly from DataObject, and the last element will be the current class.
DataObject
getComponent(string $componentName)
Return a unary component object from a one to one relationship, as a DataObject.
If no component is available, an 'empty component' will be returned for non-polymorphic relations, or for polymorphic relations with a class set.
$this
setComponent(string $componentName, DataObject|null $item)
Assign an item to the given component
void
setEagerLoadedData(string $eagerLoadRelation, DataObject $eagerLoadedData)
No description
HasManyList|UnsavedRelationList
getComponents(string $componentName, int|array $id = null)
Returns a one-to-many relation as a HasManyList
string
getRelationClass(string $relationName)
Find the foreign class of a relation on this DataObject, regardless of the relation type.
string
getRelationType(string $component)
Given a relation name, determine the relation type
DataList|DataObject
inferReciprocalComponent(string $remoteClass, string $remoteRelation)
Given a relation declared on a remote class, generate a substitute component for the opposite side of the relation.
Notes on behaviour:
- This can still be used on components that are defined on both sides, but do not need to be.
- All has_ones on remote class will be treated as local has_many, even if they are belongs_to
- Polymorphic relationships do not have two natural endpoints (only on one side) and thus attempting to infer them will return nothing.
- Cannot be used on unsaved objects.
ManyManyList|UnsavedRelationList
getManyManyComponents(string $componentName, int|array $id = null)
Returns a many-to-many component, as a ManyManyList.
array
hasOne()
Return the class of a all has_one relations.
string|array
belongsTo(bool $classOnly = true)
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.
string|array|false
hasMany(bool $classOnly = true)
Gets the class of a one-to-many relationship. If no $component is specified then an array of all the one-to-many relationships and their classes will be returned.
array|null
manyManyExtraFields()
Return the many-to-many extra fields specification.
If you don't specify a component name, it returns all extra fields for all components available.
array|null
manyMany()
Return information about a many-to-many component.
The return value is an array of (parentclass, childclass). If $component is null, then all many-many components are returned.
array|false
database_extensions(string $class)
This returns an array (if it exists) describing the database extensions that are required, or false if none
This is experimental, and is currently only a Postgres-specific enhancement.
SearchContext<static>
getDefaultSearchContext()
Generates a SearchContext to be used for building and processing a generic search form for properties on this object.
string
getGeneralSearchFieldName()
Name of the field which is used as a stand-in for searching across all searchable fields.
If this is a blank string, general search functionality is disabled and the general search field falls back to using the first field in the searchable fields array.
FieldList
scaffoldSearchFields(array $_params = null)
Determine which properties on the DataObject are searchable, and map them to their default FormField representations. Used for scaffolding a searchform for ModelAdmin.
Some additional logic is included for switching field labels, based on how generic or specific the field type is.
Used by SearchContext.
FieldList
scaffoldFormFields(array $_params = null)
Scaffold a simple edit form for all properties on this dataobject, based on default FormField} mapping in {@link DBField::scaffoldFormField().
Field labels/titles will be auto generated from DataObject::fieldLabels().
FormField
scaffoldFormFieldForHasOne(string $fieldName, string|null $fieldTitle, string $relationName, DataObject $ownerRecord)
Scaffold a form field for selecting records of this model type in a has_one relation.
FormField
scaffoldFormFieldForHasMany(string $relationName, string|null $fieldTitle, DataObject $ownerRecord, bool $includeInOwnTab)
Scaffold a form field for selecting records of this model type in a has_many relation.
FormField
scaffoldFormFieldForManyMany(string $relationName, string|null $fieldTitle, DataObject $ownerRecord, bool $includeInOwnTab)
Scaffold a form field for selecting records of this model type in a many_many relation.
protected
beforeUpdateCMSFields(callable $callback)
Allows user code to hook into DataObject::getCMSFields prior to updateCMSFields being called on extensions
protected
afterUpdateCMSFields(callable $callback)
Allows user code to hook into DataObject::getCMSFields after updateCMSFields being called on extensions
FieldList
getCMSFields()
Returns a FieldList with which to create the main editing form.
You can override this in your child classes to add extra fields - first get the parent fields using parent::getCMSFields(), then use addFieldToTab() on the FieldList.
See getSettingsFields() for a different set of fields concerned with configuration aspects on the record, e.g. access control.
FieldList
getCMSActions()
Get the actions available in the CMS for this page - eg Save, Publish.
Frontend scripts and styles know how to handle the following FormFields:
- top-level FormActions appear as standalone buttons
- top-level CompositeField with FormActions within appear as grouped buttons
- TabSet & Tabs appear as a drop ups
- FormActions within the Tab are restyled as links
- major actions can provide alternate states for richer presentation (see ssui.button widget extension)
CompositeValidator
getCMSCompositeValidator()
When extending this class and overriding this method, you will need to instantiate the CompositeValidator by calling parent::getCMSCompositeValidator(). This will ensure that the appropriate extension point is also invoked.
You can also update the CompositeValidator by creating an Extension and implementing the updateCMSCompositeValidator(CompositeValidator $compositeValidator) method.
FieldList
getFrontEndFields(array $params = null)
Used for simple frontend forms without relation editing or TabSet} behaviour. Uses {@link scaffoldFormFields() by default. To customize, either overload this method in your subclass, or extend it by DataExtension->updateFrontEndFields().
protected bool
loadLazyFields(string $class = null)
Loads all the stub fields that an initial lazy load didn't load fully.
array
getChangedFields(bool|array $databaseFieldsOnly = false, int $changeLevel = DataObject::CHANGE_STRICT)
Return the fields that have changed since the last write.
The change level affects what the functions defines as "changed":
- Level CHANGE_STRICT (integer 1) will return strict changes, even !== ones.
- Level CHANGE_VALUE (integer 2) is more lenient, it will only return real data changes, for example a change from 0 to null would not be included.
Example return:
array(
'Title' = array('before' => 'Home', 'after' => 'Home-Changed', 'level' => DataObject::CHANGE_VALUE)
)
bool
isChanged(string $fieldName = null, int $changeLevel = DataObject::CHANGE_STRICT)
Uses getChangedFields() to determine if fields have been changed since loading them from the database.
$this
setCastedField(string $fieldName, mixed $value)
Set the value of the field, using a casting object.
This is useful when you aren't sure that a date is in SQL format, for example. setCastedField() can also be used, by forms, to set related data. For example, uploaded images can be saved into the Image table.
bool
hasDatabaseField(string $field)
Returns true if the given field exists as a database column
bool
can(string $perm, Member $member = null, array $context = [])
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.
Slightly altered from parent behaviour in DataObject->can():
- Checks for existence of a method named "can<$perm>()" on the object
- Calls decorators and only returns for FALSE "vetoes"
- Falls back to Permission::check()
- Does NOT check for many-many relations named "Can<$perm>"
bool|null
extendedCan(string $methodName, Member|int $member, array $context = [])
Process tri-state responses from permission-alterting extensions. The extensions are expected to return one of three values:
- false: Disallow this permission, regardless of what other extensions say
- true: Allow this permission, as long as no other extensions return false
- NULL: Don't affect the outcome
This method itself returns a tri-state value, and is designed to be used like this:
$extended = $this->extendedCan('canDoSomething', $member);
if ($extended !== null) return $extended;
else return $normalValue;
bool
canView(Member $member = null)
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.
Denies permission if any of the following conditions is true:
- canView() on any extension returns false
- "CanViewType" directive is set to "Inherit" and any parent page return false for canView()
- "CanViewType" directive is set to "LoggedInUsers" and no user is logged in
- "CanViewType" directive is set to "OnlyTheseUsers" and user is not in the given groups
bool
canEdit(Member $member = null)
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.
Denies permission if any of the following conditions is true:
- canEdit() on any extension returns false
- canView() return false
- "CanEditType" directive is set to "Inherit" and any parent page return false for canEdit()
- "CanEditType" directive is set to "LoggedInUsers" and no user is logged in or doesn't have the CMS_Access_CMSMAIN permission code
- "CanEditType" directive is set to "OnlyTheseUsers" and user is not in the given groups
bool
canDelete(Member $member = null)
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.
Denies permission if any of the following conditions is true:
- canDelete() returns false on any extension
- canEdit() returns false
- any descendant page returns false for canDelete()
bool
canCreate(Member $member = null, array $context = [])
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.
By default, permission to create at the root level is based on the SiteConfig configuration, and permission to create beneath a parent is based on the ability to edit that parent page.
Use canAddChildren() to control behaviour of creating children under this page.
string
debug()
Debugging used by Debug::show()
DBField
dbObject(string $fieldName)
Return the DBField object that represents the given field.
This works similarly to obj() with 2 key differences:
- it still returns an object even when the field has no value.
- it only matches fields and not methods
- it matches foreign keys generated by has_one relationships, eg, "ParentID"
mixed
relObject(string $fieldPath)
Traverses to a DBField referenced by relationships between data objects.
The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName).
If a relation is blank, this will return null instead. If a relation name is invalid (e.g. non-relation on a parent) this can throw a LogicException.
mixed
relField(string $fieldName)
Traverses to a field referenced by relationships between data objects, returning the value The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
string
getReverseAssociation(string $className)
Temporary hack to return an association name, based on class, to get around the mangle of having to deal with reverse lookup of relationships to determine autogenerated foreign keys.
static DataList<static>
get(string $callerClass = null, string|array $filter = "", string|array|null $sort = "", string $join = "", string|array $limit = null, string $containerClass = DataList::class)
Return all objects matching the filter sub-classes are automatically selected and included
static DataObject|null
get_one(string|null $callerClass = null, string|array $filter = "", bool $cache = true, string|array|null $sort = "")
Return the first item matching the given query.
The object returned is cached, unlike DataObject::get()->first() DataList::first() and DataObject::get()->last() DataList::last()
The filter argument supports parameterised queries (see SQLSelect::addWhere() for syntax examples). Because of that (and differently from e.g. DataList::filter()) you need to manually escape the field names:
$member = DataObject::get_one('Member', [ '"FirstName"' => 'John' ]);
DataObject
flushCache(bool $persistent = true)
Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.
static
flush_and_destroy_cache()
Flush the get_one global cache and destroy associated objects.
static
reset()
Clear the permissions cache for SiteTree
static DataObject|null
get_by_id(string|int $classOrID, int|bool $idOrCache = null, bool $cache = true)
Return the given element, searching by ID.
This can be called either via DataObject::get_by_id(MyClass::class, $id)
or MyClass::get_by_id($id)
The object returned is cached, unlike DataObject::get()->byID() DataList::byID()
string
baseTable()
Get the name of the base table for this object
DataObject>
baseClass()
Get the base class for this object
array
getSourceQueryParams()
No description
array
getInheritableQueryParams()
Get list of parameters that should be inherited to relations on this object
setSourceQueryParams(array $array)
No description
setSourceQueryParam(string $key, string $value)
No description
string
getSourceQueryParam(string $key)
No description
requireTable()
Check the database schema and update it as necessary.
requireDefaultRecords()
Add default records to database.
This function is called whenever the database is built, after the database tables have all been created. Overload this to add default records when the database is built, but make sure you call parent::requireDefaultRecords().
onAfterBuild()
Invoked after every database build is complete (including after table creation and default record population).
See DatabaseAdmin::doBuild() for context.
array
searchableFields()
Get the default searchable fields for this object, as defined in the $searchable_fields list. If searchable fields are not defined on the data object, uses a default selection of summary fields.
array
fieldLabels(bool $includerelations = true)
No description
string
fieldLabel(string $name)
Get a human-readable label for a single field, see fieldLabels() for more details.
array
summaryFields()
Get the default summary fields for this object.
array
defaultSearchFilters()
Defines a default list of filters for the search context.
If a filter class mapping is defined on the data object, it is constructed here. Otherwise, the default filter specified in DBField is used.
bool
isInDB()
No description
static
disable_subclass_access()
deprecated
deprecated
Temporarily disable subclass access in data object qeur
static
enable_subclass_access()
deprecated
deprecated
No description
array
provideI18nEntities()
Overloaded to also provide entities for 'Page' class which is usually located in custom code, hence textcollector picks it up for the wrong folder.
DataObject
getJoin()
If selected through a many_many through relation, this is the instance of the joined record
$this
setJoin(DataObject $object, string $alias = null)
Set joining object
DataObject>
findRelatedObjects(string $source, bool $recursive = true, ArrayList $list = null)
Find objects in the given relationships, merging them into the given list
DataObject>
mergeRelatedObjects(ArrayList $list, DataObject>|DataObject|null $items)
Helper method to merge owned/owning items into a list.
Items already present in the list will be skipped.
string
getUniqueKey()
Generate a unique key for data object the unique key uses the DataObject::getUniqueKeyComponents() extension point so unique key modifiers such as versioned or fluent are covered i.e. same data object in different stages or different locales will produce different unique key
recommended use:
- when you need unique key for caching purposes
- when you need unique id on the front end (for example JavaScript needs to target specific element)
protected
mergeRelatedObject(ArrayList $list, ArrayList $added, DataObject $item)
Merge single object into a list, but ensures that existing objects are not re-added.
static SiteTree|null
get_by_link(string $link, bool $cache = true)
Fetches the SiteTree object that maps to a link.
If you have enabled SiteTree::config()->nested_urls on this site, then you can use a nested link such as "about-us/staff/", and this function will traverse down the URL chain and grab the appropriate link.
Note that if no model can be found, this method will fall over to a extended alternateGetByLink method provided by a extension attached to SiteTree
static array
page_type_classes()
deprecated
deprecated
Return a subclass map of SiteTree that shouldn't be hidden through SiteTree::$hide_pagetypes
static string
link_shortcode_handler(array $arguments, string $content = null, ShortcodeParser $parser = null)
Replace a "[sitetree_link id=n]" shortcode with a link to the page with the corresponding ID.
string
Link(string $action = null)
Return the link for this SiteTree} object, with the {@link Director::baseURL() included.
string
AbsoluteLink(string $action = null)
Get the absolute URL for this page, including protocol and host.
string
PreviewLink(string $action = null)
Base link used for previewing. Defaults to absolute URL, in order to account for domain changes, e.g. on multi site setups. Does not contain hints about the stage, see SilverStripeNavigator for details.
string
getMimeType()
To determine preview mechanism (e.g. embedded / iframe)
string
RelativeLink(string $action = null)
Return the link for this SiteTree object relative to the SilverStripe root.
By default, if this page is the current home page, and there is no action specified then this will return a link to the root of the site. However, if you set the $action parameter to TRUE then the link will not be rewritten and returned in its full form.
string
getAbsoluteLiveLink(bool $includeStageEqualsLive = true)
Get the absolute URL for this page on the Live site.
string
CMSEditLink()
Generates a link to edit this page in the CMS.
Implemented here to satisfy the CMSPreviewable interface, but data is intended to be loaded via Extension
string
ElementName()
Return a CSS identifier generated from this page's link.
bool
isCurrent()
Returns true if this is the currently active page being used to handle this request.
bool
isSection()
Check if this page is in the currently active section (e.g. it is either current or one of its children is currently being viewed).
bool
isOrphaned()
Check if the parent of this page has been removed (or made otherwise unavailable), and is still referenced by this child. Any such orphaned page may still require access via the CMS, but should not be shown as accessible to external users.
string
LinkOrCurrent()
Return "link" or "current" depending on if this is the SiteTree::isCurrent() current page.
string
LinkOrSection()
Return "link" or "section" depending on if this is the SiteTree::isSeciton() current section.
string
LinkingMode()
Return "link", "current" or "section" depending on if this page is the current page, or not on the current page but in the current section.
bool
InSection(string $sectionName)
Check if this page is in the given current section.
onBeforeDuplicate(SiteTree $original, bool $doWrite)
Reset Sort on duped page
SiteTree
duplicateWithChildren()
Duplicates each child of this node recursively and returns the top-level duplicate node.
duplicateAsChild(int $id)
Duplicate this node and its children as a child of the node with the given ID
string
Breadcrumbs(int $maxDepth = 20, bool $unlinked = false, bool|string $stopAtPageType = false, bool $showHidden = false, string $delimiter = '»')
Return a breadcrumb trail to this page. Excludes "hidden" pages (with ShowInMenus=0) by default.
SiteTree>
getBreadcrumbItems(int $maxDepth = 20, bool|string $stopAtPageType = false, bool $showHidden = false)
Returns a list of breadcrumbs for the current page.
setParent(SiteTree|int $item)
Make this page a child of another page.
If the parent page does not exist, resolve it to a valid ID before updating this page's reference.
SiteTree
getParent()
Get the parent of this page.
$this
setCreatableChildrenCache(CacheInterface $cache)
deprecated
deprecated
No description
CacheInterface
getCreatableChildrenCache()
deprecated
deprecated
No description
string
NestedTitle(int $level = 2, string $separator = " - ")
Return a string of the form "parent - page" or "grandparent - parent - page" using page titles
bool
canAddChildren(Member|int $member = null)
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.
Denies permission if any of the following conditions is true:
- alternateCanAddChildren() on a extension returns false
- canEdit() is not granted
- There are no classes defined in $allowed_children
bool
canPublish(Member $member = null)
Check if this page can be published
SiteConfig
getSiteConfig()
Stub method to get the site config, unless the current class can provide an alternate.
static PermissionChecker
getPermissionChecker()
deprecated
deprecated
No description
bool
collateDescendants(string $condition, array $collator)
Collate selected descendants of this page.
$condition will be evaluated on each descendant, and if it is succeeds, that item will be added to the $collator array.
array
MetaComponents()
Return attributes for various meta tags, plus a title tag, in a keyed array.
Array structure corresponds to arguments for HTML::create_tag(). Example:
$tags['description'] = [ // html tag type, if omitted defaults to 'meta' 'tag' => 'meta', // attributes of html tag 'attributes' => [ 'name' => 'description', 'content' => $this->customMetaDescription(), ], // content of html tag. (True meta tags don't contain content) 'content' => null ];
VersionProvider
getVersionProvider()
No description
void
setVersionProvider(VersionProvider $versionProvider)
No description
string
MetaTags(bool $includeTitle = true)
Return the title, description, keywords and language metatags.