SiteTree

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

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

Return the names of all the methods available on this object

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

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.

Get extra config sources for this class

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

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

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

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

Get an extension instance attached to this object by name.

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.

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.

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

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

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

....).

Get inherited config value

Gets the uninherited value for the given config option

Update the config value for a given property

Construct a new DataObject.

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.

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

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

Get the current failover object if set

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

Gets the value of a field.

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

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

Adds methods from the extensions.

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

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.

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

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

Return the string-format type for the given field.

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

Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.

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

Returns true if the given method/parameter has a value (Uses the DBField::hasValue if the parameter is a database field)

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

Get an array of XML-escaped values by field name

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.

Find appropriate templates for SSViewer to use to render this object

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

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.

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

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

Get schema object

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.

Create a duplicate of this node. Can duplicate many_many relations

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

Gets name of this class

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.

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.

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

Pluralise this item given a specific count.

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

Default singular name for page / sitetree

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

Default plural name for page / sitetree

Get the translated user friendly plural name of this DataObject Same as plural_name but runs it through the translation function Translation string is in the form: $this->class.PLURALNAME Example: Page.PLURALNAME

Standard implementation of a title/label for a specific record. Tries to find properties 'Title' or 'Name', and falls back to the 'ID'. Useful to provide user-friendly identification of a record, e.g. in errormessages or UI-selections.

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}"; }

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.

Convert this object to a map.

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

Writes cached relation lists to the database, if possible

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

Delete this data object.

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

Delete the record with the given ID.

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

Assign an item to the given component

Returns a one-to-many relation as a HasManyList

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

Given a relation name, determine the relation type

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

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.

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

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.

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

Gets the class of a one-to-many relationship. If no $component is specified then an array of all the one-to-many relationships and their classes will be returned.

Return the many-to-many extra fields specification.

If you don't specify a component name, it returns all extra fields for all components available.

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.

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.

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

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

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

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.

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)

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

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

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

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.

Returns true if the given field exists as a database column

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

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;

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

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

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

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.

Debugging used by Debug::show()

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"

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.

Traverses to a field referenced by relationships between data objects, returning the value The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)

Temporary hack to return an association name, based on class, to get around the mangle of having to deal with reverse lookup of relationships to determine autogenerated foreign keys.

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

Return the first item matching the given query.

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

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

Flush the get_one global cache and destroy associated objects.

Clear the permissions cache for SiteTree

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)

Get the name of the base table for this object

Get the base class for this object

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

Check the database schema and update it as necessary.

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

Get the default searchable fields for this object, as defined in the $searchable_fields list. If searchable fields are not defined on the data object, uses a default selection of summary fields.

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

Get the default summary fields for this object.

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.

Temporarily disable subclass access in data object qeur

Overloaded to also provide entities for 'Page' class which is usually located in custom code, hence textcollector picks it up for the wrong folder.

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

Set joining object

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

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

Items already present in the list will be skipped.

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}

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

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

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

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

Base link used for previewing. Defaults to absolute URL, in order to account for domain changes, e.g. on multi site setups. Does not contain hints about the stage, see {@link SilverStripeNavigator} for details.

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

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.

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

Generates a link to edit this page in the CMS.

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

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

Check if this page is in the currently active section (e.g. it is either current or one of its children is currently being viewed).

Check if the parent of this page has been removed (or made otherwise unavailable), and is still referenced by this child. Any such orphaned page may still require access via the CMS, but should not be shown as accessible to external users.

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

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

Return "link", "current" or "section" depending on if this page is the current page, or not on the current page but in the current section.

Check if this page is in the given current section.

Reset Sort on duped page

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

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

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

Returns a list of breadcrumbs for the current page.

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.

Get the parent of this page.

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

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

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}

Check if this page can be published

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

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.

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 the title, description, keywords and language metatags.