ElementChildrenList

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

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

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

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

This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use Object::useCustomClass()

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

Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.

Object::create_from_string("Versioned('Stage','Live')") will return the result of Versioned::create('Stage', 'Live);

It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.

If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.

Object::create_from_string("Varchar(50)", "MyField") will return the result of Vachar::create('MyField', '50');

Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.

Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

Returns a 2-elemnent array, with classname and arguments

Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()

This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()

If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

No description

No description

No description

No description

No description

No description

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

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).

Remove an extension from a class.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.

Add support for removing extensions with parameters

No description

No description

Construct a new DataObject.

Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located

You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()

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

Adds methods from the extensions.

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

No description

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

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

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

Add an extra method using raw PHP code passed as a string

No description

No description

No description

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.

No description

Check if this class is an instance of a specific class, or has that class as one of its parents

No description

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

integrate inheritance rules

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

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during __construct()} in {@link defineMethods().

Get an extension instance attached to this object by name.

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

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 get_extensions() to get all applied extension classes for this class (not the instance).

Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

Clears the cache for the given cacheToFile call

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

Save a piece of cached data to the file system

Strip a file name of special characters so it is suitable for use as a cache file name

Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".

Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See castingObjectCreator for more information about the constructor.

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

Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.

Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.

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

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 __get() and any getFieldName() methods you might create.

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

Method to facilitate deprecation of underscore-prefixed methods automatically being cached.

Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.

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

No description

No description

Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see ViewableData::castingHelper() for information on casting helpers).

The returned array contains two keys:

• className: the class the field would be casted to (e.g. "Varchar")
• castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")

Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.

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

Return the string-format type for the given field.

Save the casting cache for this object (including data from any failovers) into a variable

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

Generate the cache name for a field

Get a cached value from the field cache

Store a value in the field cache

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

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

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

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

Return the value of the field without any escaping being applied.

Return the value of a field in an SQL-safe format.

Return the value of a field in a JavaScript-save format.

Return the value of a field escaped suitable to be inserted into an XML node attribute.

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.

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

Returns when validation on DataObjects is enabled.

Set whether DataObjects should be validated before they are written.

Caution: Validation can contain safeguards against invalid/malicious data, and check permission levels (e.g. on Group). Therefore it is recommended to only disable validation for very specific use cases.

Clear all cached classname specs. It's necessary to clear all cached subclassed names for any classes if a new class manifest is generated.

Determines the specification for the ClassName field for the given class

Return the complete map of fields on this object, including "Created", "LastEdited" and "ClassName".

See custom_database_fields() for a getter that excludes these "base fields".

Get all database columns explicitly defined on a class in DataObject::$db and DataObject::$has_one}. Resolves instances of {@link CompositeDBField into the actual database fields, rather than the name of the field which might not equate a database column.

Does not include "base fields" like "ID", "ClassName", "Created", "LastEdited", see database_fields().

Returns the field class if the given db field on the class is a composite field.

Will check all applicable ancestor classes and aggregate results.

Returns a list of all the composite if the given db field on the class is a composite field.

Will check all applicable ancestor classes and aggregate results.

Set the DataModel

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.

Note: now also duplicates relations.

Copies the many_many and belongs_many_many relations from one object to another instance of the name of object The destinationObject must be written to the database already and have an ID. Writing is performed automatically when adding the new relations.

No description

No description

Set the ClassName attribute. $class is also updated.

Warning: This will produce an inconsistent record, as the object instance will not automatically switch to the new subclass. Please use newClassInstance() for this purpose, or destroy and reinstanciate the record.

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

This is useful when dynamically changing the type of an instance. Specifically, it ensures that the instance of the class is a match for the className of the record. Don't set the DataObject->class} or {@link DataObject->ClassName property manually before calling this method, as it will confuse change detection.

If the new class is different to the original class, defaults are populated again because this will only occur automatically on instantiation of a DataObject if there is no record, or the record has no ID. In this case, we do have an ID but we still need to repopulate the defaults.

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

Only checks for fields listed in custom_database_fields()

Use DBField->hasValue()

Get the user friendly singular name of this DataObject.

If the name is not defined (by redefining $singular_name in the subclass), this returns the class name.

No description

Get the user friendly plural name of this DataObject If the name is not defined (by renaming $plural_name in the subclass), this returns a pluralised version of the class 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

No description

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

update() doesn't write the main object, but if you use the dot syntax, it will write() the related objects that it alters.

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. Only sets fields as changed if they are not already marked as changed.

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 {DataObject::validate()}

Event handler called before writing to the database.

You can overload this to clean up or otherwise process data before writing it to the database. Don't forget to call parent::onBeforeWrite(), though!

This called after $this->validate(), so you can be sure that your data is valid.

Event handler called after writing to the database.

You can overload this to act upon changes made to the data after it is written. $this->changed will have a record database. Don't forget to call parent::onAfterWrite(), though!

Ensure that if there are elements that are virtualised from this element that we move the original element to replace one of the virtual elements But only if it's a delete not an unpublish

No description

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.

Determine validation of this object prior to write

Prepare an object prior to write

Detects and updates all changes made to this object

Writes a subset of changes for a specific table to the given manipulation

Ensures that a blank base record exists with the basic fixed fields for this dataobject

Does nothing if an ID is already assigned for this record

Generate and write the database manipulation for all changed fields

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

Returns a one-to-many relation as a HasManyList

No description

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

Tries to find the database key on another object that is used to store a relationship to this class. If no join field can be found it defaults to 'ParentID'.

If the remote field is polymorphic then $polymorphic is set to true, and the return value is in the form 'Relation' instead of 'RelationID', referencing the composite DBField.

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

Implement query-params

No description

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 data for a specific has_one component.

No description

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.

Return data for a specific belongs_to component.

Return all of the database fields defined in self::$db and all the parent classes.

Doesn't include any fields specified by self::$has_one. Use $this->hasOne() to get these fields

No description

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 data for a specific has_many component.

No description

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 the many-to-many extra fields specification for a specific component.

No description

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 information about a specific many_many component. Returns a numeric array of: array(

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 FormField representations. Used for scaffolding a searchform for ModelAdmin.

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

Used by SearchContext.

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

Field labels/titles will be auto generated from DataObject::fieldLabels().

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

No description

need to be overload by solid dataobject, so that the customised actions of that dataobject, including that dataobject's extensions customised actions could be added to the EditForm.

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

Decide on naming for "website|frontend|site|page" and stick with it in the API

Loads all the stub fields that an initial lazy load didn't load fully.

Return the fields that have changed.

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

Returns the field type of the given field, if it belongs to this class, and not a parent.

Note that the field type will not include constructor arguments in round brackets, only the classname.

Returns the field type of the given field, if it belongs to this class, and not a parent.

Note that the field type will not include constructor arguments in round brackets, only the classname.

Returns true if given class has its own table. Uses the rules for whether the table should exist rather than actually looking in the database.

Returns true if the member is allowed to do the given action.

See extendedCan() for a more versatile tri-state permission control.

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;

No description

No description

No description

No description

Should canCreate be a static method?

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"