DBClassName
class DBClassName extends DBEnum (View source)
Represents a classname selector, which respects obsolete clasess.
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
Config options
| extensions | array | An array of extension names and parameters to be applied to this object upon construction. |
from Extensible |
| unextendable_classes | array | Classes that cannot be extended |
from Extensible |
| casting | array | from DBString | |
| default_cast | string | The default object to cast scalar fields to if casting information is not specified, and casting to an object is required. |
from ViewableData |
| casting_cache | array | from ViewableData | |
| escape_type | string | The escape type for this field when inserted into a template - either "xml" or "raw". |
from DBField |
| default_search_filter_class | from DBEnum | ||
| index |
Properties
| protected static | array | $extra_methods | Custom method sources |
from CustomMethods |
| protected | array | $extra_method_registers | Name of methods to invoke by defineMethods for this instance |
from CustomMethods |
| protected static | array | $built_in_methods | Non-custom methods |
from CustomMethods |
| protected | Extension[] | $extension_instances | from Extensible | |
| protected | callable[][] | $beforeExtendCallbacks | List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | callable[][] | $afterExtendCallbacks | List of callbacks to call after extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | ViewableData | $failover | A failover object to attempt to get data from if it is not present on this object. |
from ViewableData |
| protected | ViewableData | $customisedObject | from ViewableData | |
| protected | mixed | $value | Raw value of this field |
from DBField |
| protected | string | $tableName | Table this field belongs to |
from DBField |
| protected | string | $name | Name of this field |
from DBField |
| protected | array | $arrayValue | Used for generating DB schema. {DBSchemaManager} |
from DBField |
| protected | array | $options | Optional parameters for this field |
from DBField |
| protected | $defaultVal | from DBField | ||
| protected | array | $enum | List of enum values |
from DBEnum |
| protected | string|null | $default | Default value |
from DBEnum |
| protected static | array | $enum_cache | Internal cache for obsolete enum values. The top level keys are the table, each of which contains nested arrays with keys mapped to field names. The values of the lowest level array are the enum values |
from DBEnum |
| protected | string|null | $baseClass | Base classname of class to enumerate. |
|
| protected | DataObject|null | $record | Parent object |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Adds any methods from Extension instances attached to this object.
Register an callback to invoke that defines extra methods
Return TRUE if a method exists on this object
Get meta-data details on a named method
Return the names of all the methods available on this object
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.
Adds any methods from Extension instances attached to this object.
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Create a new DBClassName field
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.
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.
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
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.
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.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Create a DBField object that's not bound to any particular field.
Set the value of this field in various formats.
Set default value to use at the DB level
Update the optional parameters for this field.
Return the desired index type to use. Will return false if the field instance should not be indexed.
Return the transformed value ready to be sent to the database. This value will be escaped automatically by the prepared query processor, so it should not be escaped or quoted at all.
Prepare the current field for usage in a database-manipulation (works on a manipulation reference).
Add custom query parameters for this field, mostly SELECT statements for multi-value fields.
Returns the value to be set in the database to blank this field.
Returns a FormField instance used as a default for form scaffolding.
Returns the index specifications for the field instance, for example:
Set whether this field stores empty strings rather than converting them to null.
Get whether this field stores empty strings rather than converting them to null
Limit this field's content by a number of characters.
Limit this field's content by a number of characters and truncate the field to the closest complete word. All HTML tags are stripped from the field.
Limit this field's content by a number of words.
Converts the current value for this StringField to lowercase.
Converts the current value for this StringField to uppercase.
Get the default string to indicate that a string was cut off.
Return a dropdown field suitable for editing this field.
Returns the values of this enum as an array, suitable for insertion into a DropdownField
Get the list of enum values, including obsolete values still present in the database
Clear all cached classname specs. It's necessary to clear all cached subclassed names for any classes if a new class manifest is generated.
Get the base name of the current class Useful as a non-fully qualified CSS Class name in templates.
Details
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()
protected
defineMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
protected
registerExtraMethodCallback(string $name, callable $callback)
Register an callback to invoke that defines extra methods
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
protected array
getExtraMethodConfig(string $method)
Get meta-data details on a named method
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
protected array
findMethodsFromExtension(object $extension)
deprecated
deprecated
No description
protected
addMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
removeMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
addWrapperMethod(string $method, string $wrap)
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
protected
addCallbackMethod(string $method, callable $callback)
Add callback as a method.
protected
beforeExtending(string $method, callable $callback)
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
protected
afterExtending(string $method, callable $callback)
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
protected
constructExtensions()
deprecated
deprecated
No description
protected
defineExtensionMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
No description
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
array
invokeWithExtensions(string $method, mixed $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 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
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during __construct()} in {@link defineMethods().
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See get_extensions() to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
stat(string $name)
deprecated
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
deprecated
Update the config value for a given property
__construct(string $name = null, string|null $baseClass = null, array $options = [])
Create a new DBClassName field
bool
__isset(string $property)
Check if a field exists on this object or its failover.
Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
ViewableData|null
getFailover()
Get the current failover object if set
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
bool
exists()
(non-PHPdoc)
string
__toString()
No description
ViewableData
getCustomisedObj()
No description
setCustomisedObj(ViewableData $object)
No description
string
castingHelper(string $field)
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
string
castingClass(string $field)
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.
DBHTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:
- a template name (e.g. Page)
- an array of possible template names - the first valid one will be used
- an SSViewer instance
protected string
objCacheName(string $fieldName, array $arguments)
Generate the cache name for a field
protected mixed
objCacheGet(string $key)
Get a cached value from the field cache
protected $this
objCacheSet(string $key, mixed $value)
Store a value in the field cache
protected $this
objCacheClear()
Clear object cache
object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
bool
hasValue(string $field, array $arguments = [], bool $cache = true)
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.
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
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.
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
string
ThemeDir()
deprecated
deprecated
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.
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".
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
static DBField
create_field(string $spec, mixed $value, string $name = null, mixed ...$args)
Create a DBField object that's not bound to any particular field.
Useful for accessing the classes behaviour for other parts of your code.
$this
setName(string $name)
Set the name of this field.
The name should never be altered, but it if was never given a name in the first place you can set a name.
If you try an alter the name a warning will be thrown.
string
getName()
Returns the name of this field.
mixed
getValue()
Returns the value of this field.
$this
setValue(mixed $value, DataObject|array $record = null, bool $markChanged = true)
Set the value of this field in various formats.
Used by DataObject->getField()}, {@link DataObject->setCastedField() DataObject->dbObject()} and {@link DataObject->write().
As this method is used both for initializing the field after construction, and actually changing its values, it needs a $markChanged parameter.
mixed
getDefaultValue()
Get default value assigned at the DB level
$this
setDefaultValue(mixed $defaultValue)
Set default value to use at the DB level
$this
setOptions(array $options = [])
Update the optional parameters for this field.
array
getOptions()
Get optional parameters for this field
$this
setIndexType(string|bool $type)
Set the desired index type to use
string|bool
getIndexType()
Return the desired index type to use. Will return false if the field instance should not be indexed.
mixed
prepValueForDB(mixed $value)
Return the transformed value ready to be sent to the database. This value will be escaped automatically by the prepared query processor, so it should not be escaped or quoted at all.
writeToManipulation(array $manipulation)
Prepare the current field for usage in a database-manipulation (works on a manipulation reference).
Make value safe for insertion into a SQL SET statement by applying addslashes() - can also be used to apply special SQL-commands to the raw value (e.g. for GIS functionality). {\SilverStripe\ORM\FieldType\prepValueForDB}
addToQuery(SQLSelect $query)
Add custom query parameters for this field, mostly SELECT statements for multi-value fields.
By default, the ORM layer does a
SELECT
$this
setTable(string $tableName)
Assign this DBField to a table
string|null
getTable()
Get the table this field belongs to, if assigned
string
forTemplate()
No description
string
HTMLATT()
Gets the value appropriate for a HTML attribute string
string
URLATT()
urlencode this string
string
RAWURLATT()
rawurlencode this string
string
ATT()
Gets the value appropriate for a HTML attribute string
mixed
RAW()
Gets the raw value for this field.
Note: Skips processors implemented via forTemplate()
string
JS()
Gets javascript string literal value
string
JSON()
Return JSON encoded value
string
HTML()
Alias for {XML()}
string
XML()
XML encode this value
string
CDATA()
Safely escape for XML string
mixed
nullValue()
Returns the value to be set in the database to blank this field.
Usually it's a choice between null, 0, and ''
saveInto(DataObject $dataObject)
Saves this field to the given data object.
FormField
scaffoldFormField(string $title = null, array $params = null)
Returns a FormField instance used as a default for form scaffolding.
Used by SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()
FormField
scaffoldSearchField(string $title = null)
No description
SearchFilter
defaultSearchFilter(string $name = null)
No description
requireField()
No description
debug()
No description
array
getArrayValue()
No description
$this
setArrayValue(array $value)
No description
string|array
getSchemaValue()
Get formfield schema value
array
getIndexSpecs()
Returns the index specifications for the field instance, for example:
[
'type' => 'unique',
'columns' => ['FieldName']
]
bool
scalarValueOnly()
Whether or not this DBField only accepts scalar values.
Composite DBFields can override this method and return false so they can accept arrays of values.
$this
setNullifyEmpty($value)
Set whether this field stores empty strings rather than converting them to null.
bool
getNullifyEmpty()
Get whether this field stores empty strings rather than converting them to null
string
LimitCharacters(int $limit = 20, string|false $add = false)
Limit this field's content by a number of characters.
This makes use of strip_tags() to avoid malforming the HTML tags in the string of text.
string
LimitCharactersToClosestWord(int $limit = 20, string|false $add = false)
Limit this field's content by a number of characters and truncate the field to the closest complete word. All HTML tags are stripped from the field.
string
LimitWordCount(int $numWords = 26, false $add = false)
Limit this field's content by a number of words.
string
LowerCase()
Converts the current value for this StringField to lowercase.
string
UpperCase()
Converts the current value for this StringField to uppercase.
string
Plain()
Plain text version of this string
string
defaultEllipsis()
Get the default string to indicate that a string was cut off.
in
DBEnum at line 46
static
flushCache()
Clear all cached enum values.
DropdownField
formField(string $title = null, string $name = null, bool $hasEmpty = false, string $value = '', string $emptyString = null)
Return a dropdown field suitable for editing this field.
array
enumValues(bool $hasEmpty = false)
Returns the values of this enum as an array, suitable for insertion into a DropdownField
array
getEnum()
Get list of classnames that should be selectable
array
getEnumObsolete()
Get the list of enum values, including obsolete values still present in the database
If table or name are not set, or if it is not a valid field on the given table, then only known enum values are returned.
Values cached in this method can be cleared via DBEnum::flushCache();
$this
setEnum(string|array $enum)
Set enum options
string|null
getDefault()
Get default vwalue
$this
setDefault(string $default)
Set default value
static
clear_classname_cache()
deprecated
deprecated
Clear all cached classname specs. It's necessary to clear all cached subclassed names for any classes if a new class manifest is generated.
string
getBaseClass()
Get the base dataclass for the list of subclasses
string|null
getShortName()
Get the base name of the current class Useful as a non-fully qualified CSS Class name in templates.
$this
setBaseClass(string $baseClass)
Assign the base class