class SiteTree extends DataObject implements PermissionProvider, i18nEntityProvider, CMSPreviewable, Resettable, Flushable, MemberCacheFlusher

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 {@link URLSegmentFilter}). The full path is constructed via {@link Link()}, {@link RelativeLink()} and {@link AbsoluteLink()}. You can allow these segments to contain multibyte characters through {@link 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

Config options

allowed_children array Indicates what kind of children this page type can have.
default_child string The default child class for this page.
default_classname string Default value for SiteTree.ClassName enum {see DBClassName::getDefault}
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.
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
can_create boolean 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
enforce_strict_hierarchy boolean
meta_generator string The value used for the meta generator tag. Leave blank to omit the tag.
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 {@link provideI18nEntities()}.
base_description string Description for Page and SiteTree classes, but not inherited by subclasses.

Properties

bool $destroyed 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
string $URLSegment
string $MenuTitle
string $Content HTML content of the page.
string $MetaDescription
string $ExtraMeta
string $ShowInMenus
string $ShowInSearch
string $Sort Integer value denoting the sort order.
string $ReportClass
bool $HasBrokenFile True if this page has a broken file shortcode
$HasBrokenLink True if this page has a broken page shortcode

Methods

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

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

static bool
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

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, boolean $strict = false)

Return TRUE if a class has a specified extension.

array
invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

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|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 {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

getExtensionInstances()

Get all extension instances for this specific object instance.

static Injectable
create(array $args)

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

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

__construct(array|null $record = null, boolean $isSingleton = false, array $queryParams = array())

Construct a new DataObject.

bool
__isset(string $property)

Check if a field exists on this object or its failover.

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 {@link 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 {@link ViewableData::setField()} method.

setFailover(ViewableData $failover)

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

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.

$this
setField(string $fieldName, mixed $val)

Set the value of the field Called by {@link __set()} and any setFieldName() methods you might create.

defineMethods()

Adds methods from the extensions.

customise(array|ViewableData $data)

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.

bool
exists()

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

string
__toString()

No description

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)

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

string
escapeTypeForField(string $field)

Return the string-format type for the given field.

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

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 $field, array $arguments = [], string $identifier = null)

A simple wrapper around {@link 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)

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)

Get an array of XML-escaped values by field name

getIterator()

Return a single-item iterator so you can iterate over the fields of a single record.

array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Me()

When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

string
ThemeDir() deprecated

Return the directory if the current active theme (relative to the site root).

string
CSSClasses(string $stopAtClass = self::class)

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

Debug()

Return debug information about this object that can be rendered into a template

getSchema()

Get schema object

destroy()

Destroy all of this objects dependant objects and local caches.

duplicate(bool $doWrite = true, array|null|false $relations = null)

Create a duplicate of this node. Can duplicate many_many relations

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. {@link $class} is also updated.

newClassInstance(string $newClassName)

Create a new instance of a different class from this object's record.

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

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

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

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.

data()

Returns the associated database record - in this case, the object itself.

array
toMap()

Convert this object to a map.

array
getQueriedDatabaseFields()

Return all currently fetched database fields.

update(array $data)

Update a number of fields on this object, given a map of the desired changes.

castedUpdate(array $data)

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

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

$this
forceChange()

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

validate()

Validate the current object.

doValidate()

Public accessor for {see DataObject::validate()}

findCascadeDeletes(bool $recursive = true, ArrayList $list = null)

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

populateDefaults()

Load the default values in from the self::$defaults array.

write(boolean $showDebug = false, boolean $forceInsert = false, boolean $forceWrite = false, boolean $writeComponents = false)

Writes all changes to this object to the database.

writeRelations()

Writes cached relation lists to the database, if possible

writeComponents(bool $recursive = false)

Write the cached components to the database. Cached components could refer to two different instances of the same record.

delete()

Delete this data object.

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.

getComponent(string $componentName)

Return a unary component object from a one to one relationship, as a DataObject.

$this
setComponent(string $componentName, DataObject|null $item)

Assign an item to the given component

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

inferReciprocalComponent(string $remoteClass, string $remoteRelation)

Given a relation declared on a remote class, generate a substitute component for the opposite side of the relation.

getManyManyComponents(string $componentName, int|array $id = null)

Returns a many-to-many component, as a ManyManyList.

string|array
hasOne()

Return the class of a one-to-one component. If $component is null, return all of the one-to-one components and their classes. If the selected has_one is a polymorphic field then 'DataObject' will be returned for the type.

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.

array|null
manyMany()

Return information about a many-to-many component.

array|false
database_extensions(string $class)

This returns an array (if it exists) describing the database extensions that are required, or false if none

getDefaultSearchContext()

Generates a SearchContext to be used for building and processing a generic search form for properties on this object.

scaffoldSearchFields(array $_params = null)

Determine which properties on the DataObject are searchable, and map them to their default {@link FormField} representations. Used for scaffolding a searchform for {@link ModelAdmin}.

scaffoldFormFields(array $_params = null)

Scaffold a simple edit form for all properties on this dataobject, based on default {@link FormField} mapping in {@link DBField::scaffoldFormField()}.

getCMSFields()

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

getCMSActions()

Get the actions available in the CMS for this page - eg Save, Publish.

getFrontEndFields(array $params = null)

Used for simple frontend forms without relation editing or {@link TabSet} behaviour. Uses {@link scaffoldFormFields()} by default. To customize, either overload this method in your subclass, or extend it by {@link DataExtension->updateFrontEndFields()}.

array
getChangedFields(boolean|array $databaseFieldsOnly = false, int $changeLevel = self::CHANGE_STRICT)

Return the fields that have changed since the last write.

boolean
isChanged(string $fieldName = null, int $changeLevel = self::CHANGE_STRICT)

Uses {@link 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.

boolean
hasDatabaseField(string $field)

Returns true if the given field exists as a database column

boolean
can(string $perm, Member $member = null, array $context = array())

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.

boolean|null
extendedCan(string $methodName, Member|int $member, array $context = array())

Process tri-state responses from permission-alterting extensions. The extensions are expected to return one of three values:

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

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

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

boolean
canCreate(Member $member = null, array $context = array())

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.

string
debug()

Debugging used by Debug::show()

dbObject(string $fieldName)

Return the DBField object that represents the given field.

mixed
relObject(string $fieldPath)

Traverses to a DBField referenced by relationships between data objects.

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
get(string $callerClass = null, string|array $filter = "", string|array $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 $callerClass, string|array $filter = "", boolean $cache = true, string $orderby = "")

Return the first item matching the given query.

flushCache(boolean $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
get_by_id(string|int $classOrID, int|bool $idOrCache = null, boolean $cache = true)

Return the given element, searching by ID.

string
baseTable()

Get the name of the base table for this object

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

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(boolean $includerelations = true)

No description

string
fieldLabel(string $name)

Get a human-readable label for a single field, see {@link 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.

boolean
isInDB()

No description

static 
disable_subclass_access()

Temporarily disable subclass access in data object qeur

static 
enable_subclass_access()

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.

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

findRelatedObjects(string $source, bool $recursive = true, ArrayList $list = null)

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

mergeRelatedObjects(ArrayList $list, mixed $items)

Helper method to merge owned/owning items into a list.

static SiteTree
get_by_link(string $link, bool $cache = true)

Fetches the {@link SiteTree} object that maps to a link.

static array
page_type_classes()

Return a subclass map of SiteTree that shouldn't be hidden through {@link SiteTree::$hide_ancestor}

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 {@link 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 {@link SilverStripeNavigator} for details.

string
getMimeType()

To determine preview mechanism (e.g. embedded / iframe)

string
RelativeLink(string $action = null)

Return the link for this {@link SiteTree} object relative to the SilverStripe root.

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.

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 {@link SiteTree::isCurrent()} current page.

string
LinkOrSection()

Return "link" or "section" depending on if this is the {@link 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

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, boolean $unlinked = false, boolean|string $stopAtPageType = false, boolean $showHidden = false, string $delimiter = '»')

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

getBreadcrumbItems(int $maxDepth = 20, boolean|string $stopAtPageType = false, boolean $showHidden = false)

Returns a list of breadcrumbs for the current page.

setParent(SiteTree|int $item)

Make this page a child of another page.

getParent()

Get the parent of this page.

$this
setCreatableChildrenCache(CacheInterface $cache)

No description

CacheInterface
getCreatableChildrenCache()

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.

bool
canPublish(Member $member = null)

Check if this page can be published

getSiteConfig()

Stub method to get the site config, unless the current class can provide an alternate.

getPermissionChecker()

No description

bool
collateDescendants(string $condition, array $collator)

Collate selected descendants of this page.

array
MetaComponents()

Return attributes for various meta tags, plus a title tag, in a keyed array.

string
MetaTags(bool $includeTitle = true)

Return the title, description, keywords and language metatags.

$this
ContentSource()

Returns the object that contains the content that a user would associate with this page.

syncLinkTracking()

Trigger synchronisation of link tracking

onBeforeDelete()

No description

onAfterDelete()

No description

flushMemberCache(array $memberIDs = null)

Flushes the member specific cache for creatable children

bool
validURLSegment()

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

string
generateURLSegment(string $title)

Generate a URL segment based on the title provided.

string
getStageURLSegment()

Gets the URL segment for the latest draft version of this page.

string
getLiveURLSegment()

Gets the URL segment for the currently published version of this page.

BackLinkTracking()

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

DependentPages(bool $includeVirtuals = true)

Returns the pages that depend on this page. This includes virtual pages, pages that link to it, etc.

VirtualPages()

Return all virtual pages that link to this page.

getSettingsFields()

Returns fields related to configuration aspects on this record, e.g. access control. See {@link getCMSFields()} for content-related fields.

onAfterPublish()

No description

onAfterRevertToLive()

Update draft dependant pages

doRestoreToStage()

Restore the content in the active copy of this SiteTree page to the stage site.

bool
isNew()

Check if this page is new - that is, if it has yet to have been written to the database.

string[]
allowedChildren()

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

array
creatableChildren() deprecated

No description

array
creatableChildPages()

Gets a list of the page types that can be created under this specific page, including font icons

string
defaultChild()

Returns the class name of the default class for children of this page.

string
defaultParent()

Returns the class name of the default class for the parent of this page.

string
getMenuTitle()

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.

setMenuTitle(string $value)

Set the menu title for this page.

array
getStatusFlags(bool $cached = true)

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.

string
getIconClass()

Returns the CSS class used for the page icon in the site tree.

string
getTreeTitle()

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.

Level(int $level)

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.

int
getPageLevel()

Gets the depth of this page in the sitetree, where 1 is the root level

string
getControllerName()

Find the controller name by our convention of {$ModelClass}Controller Can be overriden by config variable

string
CMSTreeClasses()

Return the CSS classes to apply to this node in the CMS tree.

static 
disableCMSFieldsExtensions()

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.

static 
enableCMSFieldsExtensions()

Reenables extendCMSFields() being called on getCMSFields() after it has been disabled by disableCMSFieldsExtensions().

providePermissions()

Return a map of permission codes to add to the dropdown shown in the Security section of the CMS.

string
getPageIconURL()

Generate link to this page's icon

string|null
classDescription()

Get description for this page type

string|null
i18n_classDescription()

Get localised description for this page

string
getParentType()

Returns 'root' if the current page has no parent, or 'subpage' otherwise

static 
flush()

Clear the creatableChildren cache on flush

array
getAnchorsOnPage()

No description

ManyManyList
ViewerGroups()

List of groups that can view this object.

ManyManyList
EditorGroups()

List of groups that can edit this object.

SiteTree
Parent()

No description

Details

in CustomMethods at line 47
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 {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

in CustomMethods at line 146
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

Parameters

string $method

Return Value

bool

in CustomMethods at line 176
array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom include methods added dynamically at runtime

Return Value

array

in Extensible at line 172
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 {@link Object::$extensions} array. See {@link 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 {@link singleton()}).

Parameters

string $classOrExtension Class that should be extended - has to be a subclass of {@link Object}
string $extension Subclass of {@link Extension} with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool Flag if the extension was added

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

in Extensible at line 236
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 {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.

Parameters

string $extension class name of an {@link Extension} subclass, without parameters

in Extensible at line 278
static array get_extensions(string $class = null, bool $includeArgumentString = false)

Parameters

string $class If omitted, will get extensions for the current class
bool $includeArgumentString Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array Numeric array of either {@link DataExtension} class names, or eval'ed class name strings with constructor arguments.

in Extensible at line 312
static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

string $class Name of class. If left null will return for the current class

Return Value

array|null

in Extensible at line 373
static bool has_extension(string $classOrExtension, string $requiredExtension = null, boolean $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))

Parameters

string $classOrExtension Class to check extension for, or the extension name to check if the second argument is null.
string $requiredExtension If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.
boolean $strict if the extension has to match the required extension and not be a subclass

Return Value

bool Flag if the extension exists

in Extensible at line 415
array invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

Parameters

string $method the method name to call
mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array List of results with nulls filtered out

in Extensible at line 450
array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

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 {@link __construct()} in {@link defineMethods()}.

Parameters

string $method the name of the method to call on each extension
mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

in Extensible at line 497
Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

in Extensible at line 526
bool hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension Classname of an {@link Extension} subclass without parameters

Return Value

bool

in Extensible at line 540
Extension[] getExtensionInstances()

Get all extension instances for this specific object instance.

See {@link 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.

Return Value

Extension[] Map of {@link DataExtension} instances, keyed by classname.

in Injectable at line 26
static Injectable create(array $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'); $list = SiteTree::get();

Parameters

array $args

Return Value

Injectable

in Injectable at line 43
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).

Parameters

string $class Optional classname to create, if the called class should not be used

Return Value

Injectable The singleton instance

in Configurable at line 20
static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

in DataObject at line 327
__construct(array|null $record = null, boolean $isSingleton = false, array $queryParams = array())

Construct a new DataObject.

Parameters

array|null $record Used internally for rehydrating an object from database content. Bypasses setters on this class, and hence should not be used for populating data on new records.
boolean $isSingleton This this to true if this is a singleton() object, a stub for calling methods. Singletons don't have their defaults set.
array $queryParams List of DataQuery params necessary to lazy load, or load related objects.

in ViewableData at line 106
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.

Parameters

string $property

Return Value

bool

in ViewableData at line 129
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 {@link ViewableData::getField()}, then fall back on a failover object.

Parameters

string $property

Return Value

mixed

in ViewableData at line 152
__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 {@link ViewableData::setField()} method.

Parameters

string $property
mixed $value

in ViewableData at line 167
setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

in ViewableData at line 183
ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

in DataObject at line 2774
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().

Parameters

string $field

Return Value

bool

in DataObject at line 2417
mixed getField(string $field)

Gets the value of a field.

Called by {@link __get()} and any getFieldName() methods you might create.

Parameters

string $field

Return Value

mixed

in DataObject at line 2635
$this setField(string $fieldName, mixed $val)

Set the value of the field Called by {@link __set()} and any setFieldName() methods you might create.

Parameters

string $fieldName Name of the field
mixed $val New field value

Return Value

$this

in DataObject at line 721
defineMethods()

Adds methods from the extensions.

Called by Object::__construct() once per class.

in ViewableData at line 258
ViewableData_Customised customise(array|ViewableData $data)

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.

Note that any fields you specify will take precedence over the fields on this object.

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

in DataObject at line 759
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.

Return Value

bool

in ViewableData at line 289
string __toString()

Return Value

string the class name

in ViewableData at line 297
ViewableData getCustomisedObj()

Return Value

ViewableData

in ViewableData at line 305
setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

in DataObject at line 2745
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.

Parameters

string $field

Return Value

string Casting helper As a constructor pattern, and may include arguments.

Exceptions

Exception

in ViewableData at line 352
string castingClass(string $field)

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

Parameters

string $field

Return Value

string

in ViewableData at line 365
string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string 'xml'|'raw'

in ViewableData at line 389
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

Parameters

string|array|SSViewer $template the template to render into
array $customFields fields to customise() the object with before rendering

Return Value

DBHTMLText

in ViewableData at line 471
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.

Parameters

string $fieldName
array $arguments
bool $cache Cache this object
string $cacheName a custom cache name

Return Value

Object|DBField

in ViewableData at line 516
Object|DBField cachedCall(string $field, array $arguments = [], string $identifier = null)

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

Parameters

string $field
array $arguments
string $identifier an optional custom cache identifier

Return Value

Object|DBField

in DataObject at line 4007
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)

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

in ViewableData at line 545
string XML_val(string $field, array $arguments = [], bool $cache = false)

Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.

Parameters

string $field
array $arguments
bool $cache

Return Value

string

in ViewableData at line 558
array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields an array of field names

Return Value

array

in ViewableData at line 579
ArrayIterator getIterator()

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.

Return Value

ArrayIterator

in DataObject at line 2405
array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

in ViewableData at line 603
ViewableData Me()

When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

Return Value

ViewableData

in ViewableData at line 620
string ThemeDir() deprecated

deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead

Return the directory if the current active theme (relative to the site root).

This method is useful for things such as accessing theme images from your template without hardcoding the theme page - e.g. .

This method should only be used when a theme is currently active. However, it will fall over to the current project directory.

Return Value

string URL to the current theme

in ViewableData at line 647
string CSSClasses(string $stopAtClass = self::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".

Parameters

string $stopAtClass the class to stop at (default: ViewableData)

Return Value

string

in ViewableData at line 676
ViewableData_Debugger Debug()

Return debug information about this object that can be rendered into a template

Return Value

ViewableData_Debugger

in DataObject at line 312
static DataObjectSchema getSchema()

Get schema object

Return Value

DataObjectSchema

in DataObject at line 408
destroy()

Destroy all of this objects dependant objects and local caches.

You'll need to call this to get the memory of an object that has components or extensions freed.

in DataObject at line 425
DataObject duplicate(bool $doWrite = true, array|null|false $relations = null)

Create a duplicate of this node. Can duplicate many_many relations

Parameters

bool $doWrite Perform a write() operation before returning the object. If this is true, it will create the duplicate in the database.
array|null|false $relations List of relations to duplicate. 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.

Return Value

DataObject A duplicate of this node. The exact type will be the type of this node.

in DataObject at line 635
string getObsoleteClassName()

Return obsolete class name, if this is no longer a valid class

Return Value

string

in DataObject at line 649
string getClassName()

Gets name of this class

Return Value

string

in DataObject at line 668
$this setClassName(string $className)

Set the ClassName attribute. {@link $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 {@link newClassInstance()} for this purpose, or destroy and reinstanciate the record.

Parameters

string $className The new ClassName attribute (a subclass of {@link DataObject})

Return Value

$this

in DataObject at line 696
DataObject newClassInstance(string $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 {@link 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.

Parameters

string $newClassName The name of the new class

Return Value

DataObject The new instance of the new class, The exact type will be of the class name provided.

in DataObject at line 770
boolean isEmpty()

Returns TRUE if all values (other than "ID") are considered empty (by weak boolean comparison).

Return Value

boolean

in DataObject at line 798
string i18n_pluralise(string $count)

Pluralise this item given a specific count.

E.g. "0 Pages", "1 File", "3 Images"

Parameters

string $count

Return Value

string

at line 3052
string singular_name()

Default singular name for page / sitetree

Return Value

string User friendly singular name of this DataObject

in DataObject at line 839
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

Return Value

string User friendly translated singular name of this DataObject

at line 3066
string plural_name()

Default plural name for page / sitetree

Return Value

string User friendly plural name of this DataObject

in DataObject at line 874
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

Return Value

string User friendly translated plural name of this DataObject

in DataObject at line 896
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}"; }

Return Value

string

in DataObject at line 915
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.

Return Value

DataObject Associated database record

in DataObject at line 925
array toMap()

Convert this object to a map.

Return Value

array The data as a map.

in DataObject at line 939
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.

Return Value

array The data as a map.

in DataObject at line 959
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.

Parameters

array $data A map of field name to data values to update.

Return Value

DataObject $this

in DataObject at line 1020
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.

Parameters

array $data A map of field name to data values to update.

Return Value

DataObject $this

in DataObject at line 1049
Boolean 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.

Parameters

DataObject $rightObj
string $priority left|right Determines who wins in case of a conflict (optional)
bool $includeRelations Merge any existing relations (optional)
bool $overwriteWithEmpty Overwrite existing left values with empty right values. Only applicable with $priority='right'. (optional)

Return Value

Boolean

in DataObject at line 1130
$this forceChange()

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

Doesn't write to the database. Force-change preseved until next write. Existing CHANGE_VALUE or CHANGE_STRICT values are preserved.

Return Value

$this

at line 1655
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.

Return Value

ValidationResult

in DataObject at line 1174
ValidationResult doValidate()

Public accessor for {see DataObject::validate()}

Return Value

ValidationResult

in DataObject at line 1222
ArrayList 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.

Parameters

bool $recursive True if recursive
ArrayList $list Optional list to add items to

Return Value

ArrayList list of objects

in DataObject at line 1262
DataObject populateDefaults()

Load the default values in from the self::$defaults array.

Will traverse the defaults of the current class and all its parent classes. Called by the constructor when creating new records.

Return Value

DataObject $this

in DataObject at line 1519
write(boolean $showDebug = false, boolean $forceInsert = false, boolean $forceWrite = false, boolean $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 ammend the database-write to ensure that a version is saved.

Parameters

boolean $showDebug Show debugging information
boolean $forceInsert Run INSERT command rather than UPDATE, even if record already exists
boolean $forceWrite Write to database even if there are no changes
boolean $writeComponents Call write() on all associated component instances which were previously retrieved through {@link getComponent()}, {@link getComponents()} or {@link getManyManyComponents()} (Default: false)

Exceptions

ValidationException Exception that can be caught and handled by the calling function

in DataObject at line 1578
writeRelations()

Writes cached relation lists to the database, if possible

in DataObject at line 1600
DataObject writeComponents(bool $recursive = false)

Write the cached components to the database. Cached components could refer to two different instances of the same record.

Parameters

bool $recursive Recursively write components

Return Value

DataObject $this

in DataObject at line 1619
delete()

Delete this data object.

$this->onBeforeDelete() gets called. Note that in Versioned objects, both Stage and Live will be deleted.

in DataObject at line 1663
static delete_by_id(string $className, int $id)

Delete the record with the given ID.

Parameters

string $className The class name of the record to be deleted
int $id ID of record to be deleted

in DataObject at line 1681
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.

Return Value

array Class ancestry

in DataObject at line 1695
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.

Parameters

string $componentName Name of the component

Return Value

DataObject The component object. It's exact type will be that of the component.

Exceptions

Exception

in DataObject at line 1775
$this setComponent(string $componentName, DataObject|null $item)

Assign an item to the given component

Parameters

string $componentName
DataObject|null $item

Return Value

$this

in DataObject at line 1821
HasManyList|UnsavedRelationList getComponents(string $componentName, int|array $id = null)

Returns a one-to-many relation as a HasManyList

Parameters

string $componentName Name of the component
int|array $id Optional ID(s) for parent of this relation, if not the current record

Return Value

HasManyList|UnsavedRelationList The components of the one-to-many relationship.

in DataObject at line 1867
string getRelationClass(string $relationName)

Find the foreign class of a relation on this DataObject, regardless of the relation type.

Parameters

string $relationName Relation name.

Return Value

string Class name, or null if not found.

in DataObject at line 1904
string getRelationType(string $component)

Given a relation name, determine the relation type

Parameters

string $component Name of component

Return Value

string has_one, has_many, many_many, belongs_many_many or belongs_to

in DataObject at line 1934
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.

Parameters

string $remoteClass
string $remoteRelation

Return Value

DataList|DataObject The component, either as a list or single object

Exceptions

BadMethodCallException
InvalidArgumentException

in DataObject at line 2038
ManyManyList|UnsavedRelationList getManyManyComponents(string $componentName, int|array $id = null)

Returns a many-to-many component, as a ManyManyList.

Parameters

string $componentName Name of the many-many component
int|array $id Optional ID for parent of this relation, if not the current record

Return Value

ManyManyList|UnsavedRelationList The set of components

in DataObject at line 2107
string|array hasOne()

Return the class of a one-to-one component. If $component is null, return all of the one-to-one components and their classes. If the selected has_one is a polymorphic field then 'DataObject' will be returned for the type.

Return Value

string|array The class of the one-to-one component, or an array of all one-to-one components and their classes.

in DataObject at line 2120
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.

Parameters

bool $classOnly If this is TRUE, than any has_many relationships in the form "ClassName.Field" will have the field data stripped off. It defaults to TRUE.

Return Value

string|array

in DataObject at line 2138
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.

Parameters

bool $classOnly If this is TRUE, than any has_many relationships in the form "ClassName.Field" will have the field data stripped off. It defaults to TRUE.

Return Value

string|array|false

in DataObject at line 2156
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.

Return Value

array|null

in DataObject at line 2169
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.

Return Value

array|null An array of (parentclass, childclass), or an array of all many-many components

See also

DataObjectSchema::manyManyComponent()

in DataObject at line 2186
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.

Parameters

string $class

Return Value

array|false

in DataObject at line 2202
SearchContext getDefaultSearchContext()

Generates a SearchContext to be used for building and processing a generic search form for properties on this object.

Return Value

SearchContext

in DataObject at line 2226
FieldList scaffoldSearchFields(array $_params = null)

Determine which properties on the DataObject are searchable, and map them to their default {@link FormField} representations. Used for scaffolding a searchform for {@link ModelAdmin}.

Some additional logic is included for switching field labels, based on how generic or specific the field type is.

Used by {@link SearchContext}.

Parameters

array $_params 'fieldClasses': Associative array of field names as keys and FormField classes as values 'restrictFields': Numeric array of a field name whitelist

Return Value

FieldList

in DataObject at line 2301
FieldList scaffoldFormFields(array $_params = null)

Scaffold a simple edit form for all properties on this dataobject, based on default {@link FormField} mapping in {@link DBField::scaffoldFormField()}.

Field labels/titles will be auto generated from {@link DataObject::fieldLabels()}.

Parameters

array $_params Associative array passing through properties to {@link FormScaffolder}.

Return Value

FieldList

at line 1921
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 {@link getSettingsFields()} for a different set of fields concerned with configuration aspects on the record, e.g. access control.

Return Value

FieldList Returns a TabSet for usage within the CMS - don't use for frontend forms.

at line 2309
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)

Return Value

FieldList an Empty FieldList(); need to be overload by solid subclass

in DataObject at line 2397
FieldList getFrontEndFields(array $params = null)

Used for simple frontend forms without relation editing or {@link TabSet} behaviour. Uses {@link scaffoldFormFields()} by default. To customize, either overload this method in your subclass, or extend it by {@link DataExtension->updateFrontEndFields()}.

Parameters

array $params See {@link scaffoldFormFields()}

Return Value

FieldList Always returns a simple field collection without TabSet.

in DataObject at line 2548
array getChangedFields(boolean|array $databaseFieldsOnly = false, int $changeLevel = self::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) )

Parameters

boolean|array $databaseFieldsOnly Filter to determine which fields to return. Set to true to return all database fields, or an array for an explicit filter. false returns all fields.
int $changeLevel The strictness of what is defined as change. Defaults to strict

Return Value

array

in DataObject at line 2616
boolean isChanged(string $fieldName = null, int $changeLevel = self::CHANGE_STRICT)

Uses {@link getChangedFields()} to determine if fields have been changed since loading them from the database.

Parameters

string $fieldName Name of the database field to check, will check for any if not given
int $changeLevel See {@link getChangedFields()}

Return Value

boolean

in DataObject at line 2727
$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.

Parameters

string $fieldName
mixed $value New field value

Return Value

$this

in DataObject at line 2793
boolean hasDatabaseField(string $field)

Returns true if the given field exists as a database column

Parameters

string $field Name of the field

Return Value

boolean

at line 1007
boolean can(string $perm, Member $member = null, array $context = array())

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 {@link 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 {@link Permission::check()} - Does NOT check for many-many relations named "Can<$perm>"

Parameters

string $perm The permission to be checked, such as 'View'.
Member $member The member whose permissions need checking. Defaults to the currently logged in user.
array $context Additional $context to pass to extendedCan()

Return Value

boolean True if the the member is allowed to do the given action

in DataObject at line 2854
boolean|null extendedCan(string $methodName, Member|int $member, array $context = array())

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;

Parameters

string $methodName Method on the same object, e.g. {@link canEdit()}
Member|int $member
array $context Optional context

Return Value

boolean|null

at line 1089
boolean 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

Parameters

Member $member

Return Value

boolean

at line 1285
boolean 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

Parameters

Member $member

Return Value

boolean

at line 1186
boolean 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()

Parameters

Member $member

Return Value

boolean

at line 1230
boolean canCreate(Member $member = null, array $context = array())

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 {@link canAddChildren()} to control behaviour of creating children under this page.

Parameters

Member $member
array $context Additional context-specific data which might affect whether (or where) this object could be created.

Return Value

boolean

in DataObject at line 2930
string debug()

Debugging used by Debug::show()

Return Value

string HTML data representing this object

in DataObject at line 2953
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"

Parameters

string $fieldName Name of the field

Return Value

DBField The field as a DBField object

in DataObject at line 3001
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.

Parameters

string $fieldPath List of paths on this object. All items in this path must be ViewableData implementors

Return Value

mixed DBField of the field on the object or a DataList instance.

Exceptions

LogicException If accessing invalid relations

in DataObject at line 3039
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)

Parameters

string $fieldName string

Return Value

mixed Will return null on a missing value

in DataObject at line 3066
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.

Parameters

string $className

Return Value

string

in DataObject at line 3107
static DataList get(string $callerClass = null, string|array $filter = "", string|array $sort = "", string $join = "", string|array $limit = null, string $containerClass = DataList::class)

Return all objects matching the filter sub-classes are automatically selected and included

Parameters

string $callerClass The class of objects to be returned
string|array $filter A filter to be inserted into the WHERE clause. Supports parameterised queries. See SQLSelect::addWhere() for syntax examples.
string|array $sort A sort expression to be inserted into the ORDER BY clause. If omitted, self::$default_sort will be used.
string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
string|array $limit A limit expression to be inserted into the LIMIT clause.
string $containerClass The container class to return the results in.

Return Value

DataList The objects matching the filter, in the class specified by $containerClass

in DataObject at line 3170
static DataObject|null get_one(string $callerClass, string|array $filter = "", boolean $cache = true, string $orderby = "")

Return the first item matching the given query.

All calls to get_one() are cached.

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' ]);

Parameters

string $callerClass The class of objects to be returned
string|array $filter A filter to be inserted into the WHERE clause.
boolean $cache Use caching
string $orderby A sort expression to be inserted into the ORDER BY clause.

Return Value

DataObject|null The first item matching the query

at line 1629
DataObject flushCache(boolean $persistent = true)

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

Parameters

boolean $persistent When true will also clear persistent data stored in the Cache system. When false will just clear session-local cached data

Return Value

DataObject $this

in DataObject at line 3228
static flush_and_destroy_cache()

Flush the get_one global cache and destroy associated objects.

at line 3164
static reset()

Clear the permissions cache for SiteTree

in DataObject at line 3269
static DataObject get_by_id(string|int $classOrID, int|bool $idOrCache = null, boolean $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)

Parameters

string|int $classOrID The class of the object to be returned, or id if called on target class
int|bool $idOrCache The id of the element, or cache if called on target class
boolean $cache See {@link get_one()}

Return Value

DataObject The element

in DataObject at line 3291
string baseTable()

Get the name of the base table for this object

Return Value

string

in DataObject at line 3301
string baseClass()

Get the base class for this object

Return Value

string

in DataObject at line 3317
array getSourceQueryParams()

Return Value

array

See also

$sourceQueryParams

in DataObject at line 3327
array getInheritableQueryParams()

Get list of parameters that should be inherited to relations on this object

Return Value

array

in DataObject at line 3338
setSourceQueryParams(array $array)

Parameters

array $array

See also

$sourceQueryParams

in DataObject at line 3348
setSourceQueryParam(string $key, string $value)

Parameters

string $key
string $value

See also

$sourceQueryParams

in DataObject at line 3358
string getSourceQueryParam(string $key)

Parameters

string $key

Return Value

string

See also

$sourceQueryParams

in DataObject at line 3373
requireTable()

Check the database schema and update it as necessary.

at line 1490
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().

in DataObject at line 3482
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.

Return Value

array

at line 2257
array fieldLabels(boolean $includerelations = true)

Parameters

boolean $includerelations a boolean value to indicate if the labels returned include relation fields

Return Value

array Array of all element labels

in DataObject at line 3648
string fieldLabel(string $name)

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

Parameters

string $name Name of the field

Return Value

string Label of the field

in DataObject at line 3661
array summaryFields()

Get the default summary fields for this object.

Return Value

array

in DataObject at line 3720
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 {@link DBField} is used.

Return Value

array

in DataObject at line 3741
boolean isInDB()

Return Value

boolean True if the object is in the database

in DataObject at line 3754
static disable_subclass_access()

Temporarily disable subclass access in data object qeur

in DataObject at line 3759
static enable_subclass_access()

at line 3139
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.

Return Value

array Map of keys to default values, which are strings in the default case, and array-form for pluralisations.

in DataObject at line 4023
DataObject getJoin()

If selected through a many_many through relation, this is the instance of the joined record

Return Value

DataObject

in DataObject at line 4035
$this setJoin(DataObject $object, string $alias = null)

Set joining object

Parameters

DataObject $object
string $alias Alias

Return Value

$this

in DataObject at line 4058
ArrayList findRelatedObjects(string $source, bool $recursive = true, ArrayList $list = null)

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

Parameters

string $source Config property to extract relationships from
bool $recursive True if recursive
ArrayList $list If specified, items will be added to this list. If not, a new instance of ArrayList will be constructed and returned

Return Value

ArrayList The list of related objects

in DataObject at line 4107
ArrayList mergeRelatedObjects(ArrayList $list, mixed $items)

Helper method to merge owned/owning items into a list.

Items already present in the list will be skipped.

Parameters

ArrayList $list Items to merge into
mixed $items List of new items to merge

Return Value

ArrayList List of all newly added items that did not already exist in $list

Fetches the {@link SiteTree} object that maps to a link.

If you have enabled {@link 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 {@link SiteTree}

Parameters

string $link The link of the page to search for
bool $cache True (default) to use caching, false to force a fresh search from the database

Return Value

SiteTree

at line 491
static array page_type_classes()

Return a subclass map of SiteTree that shouldn't be hidden through {@link SiteTree::$hide_ancestor}

Return Value

array

Replace a "[sitetree_link id=n]" shortcode with a link to the page with the corresponding ID.

Parameters

array $arguments
string $content
ShortcodeParser $parser

Return Value

string

Return the link for this {@link SiteTree} object, with the {@link Director::baseURL()} included.

Parameters

string $action Optional controller action (method). Note: URI encoding of this parameter is applied automatically through template casting, don't encode the passed parameter. Please use {@link Controller::join_links()} instead to append GET parameters.

Return Value

string

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

Parameters

string $action See {@link Link()}

Return Value

string

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 {@link SilverStripeNavigator} for details.

Parameters

string $action

Return Value

string Link to the end-user view for this record. Example: http://mysite.com/my-record

at line 611
string getMimeType()

To determine preview mechanism (e.g. embedded / iframe)

Return Value

string

Return the link for this {@link 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.

Parameters

string $action See {@link Link()}

Return Value

string

Get the absolute URL for this page on the Live site.

Parameters

bool $includeStageEqualsLive Whether to append the URL with ?stage=Live to force Live mode

Return Value

string

Generates a link to edit this page in the CMS.

Return Value

string Link to the CMS-author view. Should point to a controller subclassing {@link LeftAndMain}. Example: http://mysite.com/admin/edit/6

at line 705
string ElementName()

Return a CSS identifier generated from this page's link.

Return Value

string The URL segment

at line 715
bool isCurrent()

Returns true if this is the currently active page being used to handle this request.

Return Value

bool

at line 733
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).

Return Value

bool

at line 747
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.

Return Value

bool

at line 764
string LinkOrCurrent()

Return "link" or "current" depending on if this is the {@link SiteTree::isCurrent()} current page.

Return Value

string

at line 774
string LinkOrSection()

Return "link" or "section" depending on if this is the {@link SiteTree::isSeciton()} current section.

Return Value

string

at line 785
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.

Return Value

string

at line 802
bool InSection(string $sectionName)

Check if this page is in the given current section.

Parameters

string $sectionName Name of the section to check

Return Value

bool True if we are in the given section

at line 820
onBeforeDuplicate(SiteTree $original, bool $doWrite)

Reset Sort on duped page

Parameters

SiteTree $original
bool $doWrite

at line 830
SiteTree duplicateWithChildren()

Duplicates each child of this node recursively and returns the top-level duplicate node.

Return Value

SiteTree The duplicated object

at line 858
duplicateAsChild(int $id)

Duplicate this node and its children as a child of the node with the given ID

Parameters

int $id ID of the new node's new parent

at line 877
string Breadcrumbs(int $maxDepth = 20, boolean $unlinked = false, boolean|string $stopAtPageType = false, boolean $showHidden = false, string $delimiter = '&raquo;')

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

Parameters

int $maxDepth The maximum depth to traverse.
boolean $unlinked Whether to link page titles.
boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal.
boolean $showHidden Include pages marked with the attribute ShowInMenus = 0
string $delimiter Delimiter character (raw html)

Return Value

string The breadcrumb trail.

at line 898
ArrayList getBreadcrumbItems(int $maxDepth = 20, boolean|string $stopAtPageType = false, boolean $showHidden = false)

Returns a list of breadcrumbs for the current page.

Parameters

int $maxDepth The maximum depth to traverse.
boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal.
boolean $showHidden Include pages marked with the attribute ShowInMenus = 0

Return Value

ArrayList

at line 926
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.

Parameters

SiteTree|int $item Either the parent object, or the parent ID

at line 943
SiteTree getParent()

Get the parent of this page.

Return Value

SiteTree Parent of this page

at line 956
$this setCreatableChildrenCache(CacheInterface $cache)

Parameters

CacheInterface $cache

Return Value

$this

at line 966
CacheInterface getCreatableChildrenCache()

Return Value

CacheInterface $cache

at line 978
string NestedTitle(int $level = 2, string $separator = " - ")

Return a string of the form "parent - page" or "grandparent - parent - page" using page titles

Parameters

int $level The maximum amount of levels to traverse.
string $separator Seperating string

Return Value

string The resulting string

at line 1048
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 {@link $allowed_children}

Parameters

Member|int $member

Return Value

bool True if the current user can add children

at line 1150
bool canPublish(Member $member = null)

Check if this page can be published

Parameters

Member $member

Return Value

bool

at line 1312
SiteConfig getSiteConfig()

Stub method to get the site config, unless the current class can provide an alternate.

Return Value

SiteConfig

at line 1325
static PermissionChecker getPermissionChecker()

Return Value

PermissionChecker

at line 1340
bool collateDescendants(string $condition, array $collator)

Collate selected descendants of this page.

{@link $condition} will be evaluated on each descendant, and if it is succeeds, that item will be added to the $collator array.

Parameters

string $condition The PHP condition to be evaluated. The page will be called $item
array $collator An array, passed by reference, to collect all of the matching descendants.

Return Value

bool

at line 1381
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 ];

Return Value

array

See also

HTML::createTag()

at line 1444
string MetaTags(bool $includeTitle = true)

Return the title, description, keywords and language metatags.

Parameters

bool $includeTitle Show default -tag, set to false for custom templating</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>The XHTML metatags</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_ContentSource"> <div class="location">at line 1479</div> <code> <abbr title="SilverStripe\CMS\Model\$this">$this</abbr> <strong>ContentSource</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the object that contains the content that a user would associate with this page.</p> <p>Ordinarily, this is just the page itself, but for example on RedirectorPages or VirtualPages ContentSource() will return the page that is linked to.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><abbr title="SilverStripe\CMS\Model\$this">$this</abbr></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_syncLinkTracking"> <div class="location">at line 1605</div> <code> <strong>syncLinkTracking</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Trigger synchronisation of link tracking</p> <p>{see SiteTreeLinkTracking::augmentSyncLinkTracking}</p> </div> <div class="tags"> </div> </div> </div> <div class="method-item"> <h3 id="method_onBeforeDelete"> <div class="location">at line 1610</div> <code> <strong>onBeforeDelete</strong>() </code> </h3> <div class="details"> <div class="tags"> </div> </div> </div> <div class="method-item"> <h3 id="method_onAfterDelete"> <div class="location">at line 1623</div> <code> <strong>onAfterDelete</strong>() </code> </h3> <div class="details"> <div class="tags"> </div> </div> </div> <div class="method-item"> <h3 id="method_flushMemberCache"> <div class="location">at line 1640</div> <code> <strong>flushMemberCache</strong>(array $memberIDs = null) </code> </h3> <div class="details"> <div class="method-description"> <p>Flushes the member specific cache for creatable children</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>array</td> <td>$memberIDs</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_validURLSegment"> <div class="location">at line 1706</div> <code> bool <strong>validURLSegment</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>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</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_generateURLSegment"> <div class="location">at line 1756</div> <code> string <strong>generateURLSegment</strong>(string $title) </code> </h3> <div class="details"> <div class="method-description"> <p>Generate a URL segment based on the title provided.</p> <p>If {@link Extension}s wish to alter URL segment generation, they can do so by defining updateURLSegment(&$url, $title). $url will be passed by reference and should be modified. $title will contain the title that was originally used as the source of this generated URL. This lets extensions either start from scratch, or incrementally modify the generated URL.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$title</td> <td>Page title</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>Generated url segment</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getStageURLSegment"> <div class="location">at line 1777</div> <code> string <strong>getStageURLSegment</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Gets the URL segment for the latest draft version of this page.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getLiveURLSegment"> <div class="location">at line 1792</div> <code> string <strong>getLiveURLSegment</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Gets the URL segment for the currently published version of this page.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_BackLinkTracking"> <div class="location">at line 1807</div> <code> <a href="../../../SilverStripe/ORM/ArrayList.html"><abbr title="SilverStripe\ORM\ArrayList">ArrayList</abbr></a>|<a href="../../../SilverStripe/ORM/DataObject.html"><abbr title="SilverStripe\ORM\DataObject">DataObject</abbr></a>[] <strong>BackLinkTracking</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Get the back-link tracking objects that link to this page</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href="../../../SilverStripe/ORM/ArrayList.html"><abbr title="SilverStripe\ORM\ArrayList">ArrayList</abbr></a>|<a href="../../../SilverStripe/ORM/DataObject.html"><abbr title="SilverStripe\ORM\DataObject">DataObject</abbr></a>[]</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_DependentPages"> <div class="location">at line 1849</div> <code> <a href="../../../SilverStripe/ORM/ArrayList.html"><abbr title="SilverStripe\ORM\ArrayList">ArrayList</abbr></a>|<a href="../../../SilverStripe/CMS/Model/SiteTree.html"><abbr title="SilverStripe\CMS\Model\SiteTree">SiteTree</abbr></a>[] <strong>DependentPages</strong>(bool $includeVirtuals = true) </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the pages that depend on this page. This includes virtual pages, pages that link to it, etc.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td>$includeVirtuals</td> <td>Set to false to exlcude virtual pages.</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href="../../../SilverStripe/ORM/ArrayList.html"><abbr title="SilverStripe\ORM\ArrayList">ArrayList</abbr></a>|<a href="../../../SilverStripe/CMS/Model/SiteTree.html"><abbr title="SilverStripe\CMS\Model\SiteTree">SiteTree</abbr></a>[]</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_VirtualPages"> <div class="location">at line 1899</div> <code> <a href="../../../SilverStripe/ORM/DataList.html"><abbr title="SilverStripe\ORM\DataList">DataList</abbr></a> <strong>VirtualPages</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Return all virtual pages that link to this page.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href="../../../SilverStripe/ORM/DataList.html"><abbr title="SilverStripe\ORM\DataList">DataList</abbr></a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getSettingsFields"> <div class="location">at line 2114</div> <code> <a href="../../../SilverStripe/Forms/FieldList.html"><abbr title="SilverStripe\Forms\FieldList">FieldList</abbr></a> <strong>getSettingsFields</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns fields related to configuration aspects on this record, e.g. access control. See {@link getCMSFields()} for content-related fields.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href="../../../SilverStripe/Forms/FieldList.html"><abbr title="SilverStripe\Forms\FieldList">FieldList</abbr></a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_onAfterPublish"> <div class="location">at line 2469</div> <code> <strong>onAfterPublish</strong>() </code> </h3> <div class="details"> <div class="tags"> </div> </div> </div> <div class="method-item"> <h3 id="method_onAfterRevertToLive"> <div class="location">at line 2486</div> <code> <strong>onAfterRevertToLive</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Update draft dependant pages</p> </div> <div class="tags"> </div> </div> </div> <div class="method-item"> <h3 id="method_doRestoreToStage"> <div class="location">at line 2522</div> <code> <a href="../../../SilverStripe/CMS/Model/SiteTree.html"><abbr title="SilverStripe\CMS\Model\SiteTree">SiteTree</abbr></a> <strong>doRestoreToStage</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Restore the content in the active copy of this SiteTree page to the stage site.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href="../../../SilverStripe/CMS/Model/SiteTree.html"><abbr title="SilverStripe\CMS\Model\SiteTree">SiteTree</abbr></a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_isNew"> <div class="location">at line 2550</div> <code> bool <strong>isNew</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Check if this page is new - that is, if it has yet to have been written to the database.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_allowedChildren"> <div class="location">at line 2630</div> <code> string[] <strong>allowedChildren</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns an array of the class names of classes that are allowed to be children of this class.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string[]</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_creatableChildren"> <div class="location">at line 2680</div> <code> array <strong>creatableChildren</strong>() <small><sup><span class="label label-danger">deprecated</span></sup></small></code> </h3> <div class="details"> <p> <small><sup><span class="label label-danger">deprecated</span></sup></small> <tr> <td>5.0</td> <td>use creatableChildPages instead Gets a list of the page types that can be created under this specific page</td> </tr> </p> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_creatableChildPages"> <div class="location">at line 2707</div> <code> array <strong>creatableChildPages</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Gets a list of the page types that can be created under this specific page, including font icons</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_defaultChild"> <div class="location">at line 2741</div> <code> string <strong>defaultChild</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the class name of the default class for children of this page.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_defaultParent"> <div class="location">at line 2759</div> <code> string <strong>defaultParent</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the class name of the default class for the parent of this page.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getMenuTitle"> <div class="location">at line 2770</div> <code> string <strong>getMenuTitle</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>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.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_setMenuTitle"> <div class="location">at line 2785</div> <code> <strong>setMenuTitle</strong>(string $value) </code> </h3> <div class="details"> <div class="method-description"> <p>Set the menu title for this page.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>$value</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getStatusFlags"> <div class="location">at line 2809</div> <code> array <strong>getStatusFlags</strong>(bool $cached = true) </code> </h3> <div class="details"> <div class="method-description"> <p>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.</p> <p>Example (simple): "deletedonlive" => "Deleted"</p> <p>Example (with optional title attribute): "deletedonlive" => array('text' => "Deleted", 'title' => 'This page has been deleted')</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>bool</td> <td>$cached</td> <td>Whether to serve the fields from cache; false regenerate them</td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getIconClass"> <div class="location">at line 2848</div> <code> string <strong>getIconClass</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns the CSS class used for the page icon in the site tree.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getTreeTitle"> <div class="location">at line 2863</div> <code> string <strong>getTreeTitle</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>getTreeTitle will return three <span> html DOM elements, an empty <span> with the class 'jstree-pageicon' in front, following by a <span> wrapping around its MenuTitle, then following by a <span> indicating its publication status.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td>An HTML string ready to be directly used in a template</td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Level"> <div class="location">at line 2896</div> <code> <a href="../../../SilverStripe/CMS/Model/SiteTree.html"><abbr title="SilverStripe\CMS\Model\SiteTree">SiteTree</abbr></a> <strong>Level</strong>(int $level) </code> </h3> <div class="details"> <div class="method-description"> <p>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.</p> </div> <div class="tags"> <h4>Parameters</h4> <table class="table table-condensed"> <tr> <td>int</td> <td>$level</td> <td></td> </tr> </table> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td><a href="../../../SilverStripe/CMS/Model/SiteTree.html"><abbr title="SilverStripe\CMS\Model\SiteTree">SiteTree</abbr></a></td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getPageLevel"> <div class="location">at line 2912</div> <code> int <strong>getPageLevel</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Gets the depth of this page in the sitetree, where 1 is the root level</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>int</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getControllerName"> <div class="location">at line 2926</div> <code> string <strong>getControllerName</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Find the controller name by our convention of {$ModelClass}Controller Can be overriden by config variable</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_CMSTreeClasses"> <div class="location">at line 2967</div> <code> string <strong>CMSTreeClasses</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Return the CSS classes to apply to this node in the CMS tree.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_disableCMSFieldsExtensions"> <div class="location">at line 2997</div> <code> static <strong>disableCMSFieldsExtensions</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>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.</p> </div> <div class="tags"> </div> </div> </div> <div class="method-item"> <h3 id="method_enableCMSFieldsExtensions"> <div class="location">at line 3006</div> <code> static <strong>enableCMSFieldsExtensions</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Reenables extendCMSFields() being called on getCMSFields() after it has been disabled by disableCMSFieldsExtensions().</p> </div> <div class="tags"> </div> </div> </div> <div class="method-item"> <h3 id="method_providePermissions"> <div class="location">at line 3011</div> <code> <strong>providePermissions</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Return a map of permission codes to add to the dropdown shown in the Security section of the CMS.</p> <p>array( 'VIEW_SITE' => 'View the site', );</p> </div> <div class="tags"> </div> </div> </div> <div class="method-item"> <h3 id="method_getPageIconURL"> <div class="location">at line 3080</div> <code> string <strong>getPageIconURL</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Generate link to this page's icon</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_classDescription"> <div class="location">at line 3110</div> <code> string|null <strong>classDescription</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Get description for this page type</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string|null</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_i18n_classDescription"> <div class="location">at line 3124</div> <code> string|null <strong>i18n_classDescription</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Get localised description for this page</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string|null</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_getParentType"> <div class="location">at line 3156</div> <code> string <strong>getParentType</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Returns 'root' if the current page has no parent, or 'subpage' otherwise</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>string</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_flush"> <div class="location">at line 3175</div> <code> static <strong>flush</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>Clear the creatableChildren cache on flush</p> </div> <div class="tags"> </div> </div> </div> <div class="method-item"> <h3 id="method_getAnchorsOnPage"> <div class="location">at line 3245</div> <code> array <strong>getAnchorsOnPage</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>array</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_ViewerGroups"> <div class="location">at line 112</div> <code> ManyManyList <strong>ViewerGroups</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>List of groups that can view this object.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>ManyManyList</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_EditorGroups"> <div class="location">at line 112</div> <code> ManyManyList <strong>EditorGroups</strong>() </code> </h3> <div class="details"> <div class="method-description"> <p>List of groups that can edit this object.</p> </div> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>ManyManyList</td> <td></td> </tr> </table> </div> </div> </div> <div class="method-item"> <h3 id="method_Parent"> <div class="location">at line 112</div> <code> SiteTree <strong>Parent</strong>() </code> </h3> <div class="details"> <div class="tags"> <h4>Return Value</h4> <table class="table table-condensed"> <tr> <td>SiteTree</td> <td></td> </tr> </table> </div> </div> </div> </div> </div> <div id="footer"> Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>. </div> </div> </div> </body> </html>