BulkLoader

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

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

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

Register an callback to invoke that defines extra methods

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

Get meta-data details on a named method

Return the names of all the methods available on this object

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 callback as a method.

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

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

No description

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

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.

Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.

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

Add support for removing extensions with parameters

No description

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

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::class); $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

No description

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

Check if a field exists on this object. This should be overloaded in child classes.

Get the value of a field on this object. This should be overloaded in child classes.

Set a field on this object. This should be overloaded in child classes.

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.

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

This method should be overridden in subclasses to provide more context about the classes state. For example, a DataObject class could return false when it is deleted from the database

No description

No description

No description

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

Generate the cache name for a field

Get a cached value from the field cache

Store a value in the field cache

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

Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.

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

If true, this bulk loader will respect create/edit/delete permissions.

Determine whether this bulk loader should respect create/edit/delete permissions.

No description

Preview a file import (don't write anything to the database).

Useful to analyze the input and give the users a chance to influence it through a UI.

Process every record in the file

Process a single record from the file.

Return a FieldList containing all the options for this form; this doesn't include the actual upload field itself

Return a human-readable name for this object.

It defaults to the class name can be overridden by setting the static variable $title

Get a specification of all available columns and relations on the used model.

Useful for generation of spec documents for technical end users.

Return Format:

[
  'fields' => ['myFieldName'=>'myDescription'],
  'relations' => ['myRelationName'=>'myDescription'],
]

Mix in custom column mappings

Determines if a specific field is null.

Can be useful for unusual "empty" flags in the file, e.g. a "(not set)" value. The usual DBField::isNull()} checks apply when writing the {@link DataObject, so this is mainly a customization method.