DBEnum
class DBEnum extends DBString
Class Enum represents an enumeration of a set of strings.
See {@link DropdownField} for a {@link FormField} to select enum values.
Traits
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on 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 {@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
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.
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 Enum field, which is a value within a defined set, with an optional default.
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 {@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.
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.
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
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.
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.
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.
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 a FormField instance used as a default for form scaffolding.
No description
No description
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.
Clear all cached enum values.
Return a dropdown field suitable for editing this field.
Returns the values of this enum as an array, suitable for insertion into a {@link DropdownField}
Get list of enum values
Get the list of enum values, including obsolete values still present in the database
Set enum options
Get default vwalue
Set default value
Details
in CustomMethods at line 50
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in CustomMethods at line 144
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
in CustomMethods at line 172
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in Extensible at line 163
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).
in Extensible at line 224
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.
in Extensible at line 264
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 298
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
in Extensible at line 359
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
in Extensible at line 395
array
invokeWithExtensions(string $method, mixed $arguments)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in Extensible at line 424
array
extend(string $method, mixed $arguments)
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()}.
in Extensible at line 465
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in Extensible at line 494
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
in Extensible at line 508
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See {@link get_extensions()} to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
in Injectable at line 26
static Injectable
create(array $args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();
in Injectable at line 43
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
in Configurable at line 20
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in Configurable at line 32
mixed
stat(string $name)
deprecated
deprecated 5.0 Use ->config()->get() instead
Get inherited config value
in Configurable at line 44
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
in Configurable at line 57
$this
set_stat(string $name, mixed $value)
deprecated
deprecated 5.0 Use ->config()->set() instead
Update the config value for a given property
at line 69
__construct(string $name = null, string|array $enum = null, string|int|null $default, array $options = [])
Create a new Enum field, which is a value within a defined set, with an optional default.
Example field specification strings:
"MyField" => "Enum('Val1, Val2, Val3')" // First item 'Val1' is default implicitly
"MyField" => "Enum('Val1, Val2, Val3', 'Val2')" // 'Val2' is default explicitly
"MyField" => "Enum('Val1, Val2, Val3', null)" // Force empty (no) default
"MyField" => "Enum(array('Val1', 'Val2', 'Val3'), 'Val1')" // Supports array notation as well
in ViewableData at line 106
bool
__isset(string $property)
Check if a field exists on this object or its failover.
Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.
in ViewableData at line 129
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
in ViewableData at line 152
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
in ViewableData at line 167
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
in ViewableData at line 183
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 194
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
in ViewableData at line 205
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
in ViewableData at line 217
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
in ViewableData at line 232
defineMethods()
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
in ViewableData at line 258
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
in DBString at line 87
bool
exists()
(non-PHPdoc)
in DBField at line 610
string
__toString()
in ViewableData at line 297
ViewableData
getCustomisedObj()
in ViewableData at line 305
setCustomisedObj(ViewableData $object)
in ViewableData at line 320
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.
in ViewableData at line 352
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
in ViewableData at line 365
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 389
DBHTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
in ViewableData at line 471
Object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
in ViewableData at line 516
Object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
in ViewableData at line 530
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.
in ViewableData at line 545
string
XML_val(string $field, array $arguments = [], bool $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
in ViewableData at line 558
array
getXMLValues(array $fields)
Get an array of XML-escaped values by field name
in ViewableData at line 579
ArrayIterator
getIterator()
Return a single-item iterator so you can iterate over the fields of a single record.
This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.
in ViewableData at line 592
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
in ViewableData at line 603
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
in ViewableData at line 620
string
ThemeDir()
deprecated
deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead
Return the directory if the current active theme (relative to the site root).
This method is useful for things such as accessing theme images from your template without hardcoding the theme
page - e.g. 
.
This method should only be used when a theme is currently active. However, it will fall over to the current project directory.
in ViewableData at line 647
string
CSSClasses(string $stopAtClass = self::class)
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
in ViewableData at line 676
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in DBField at line 164
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.
in DBField at line 192
$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.
in DBField at line 209
string
getName()
Returns the name of this field.
in DBField at line 219
mixed
getValue()
Returns the value of this field.
in DBField at line 240
$this
setValue(mixed $value, DataObject|array $record = null, bool $markChanged = true)
Set the value of this field in various formats.
Used by {@link DataObject->getField()}, {@link DataObject->setCastedField()} {@link 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 {@link $markChanged} parameter.
in DBField at line 251
mixed
getDefaultValue()
Get default value assigned at the DB level
in DBField at line 262
$this
setDefaultValue(mixed $defaultValue)
Set default value to use at the DB level
in DBString at line 45
$this
setOptions(array $options = [])
Update the optional parameters for this field.
in DBField at line 285
array
getOptions()
Get optional parameters for this field
in DBField at line 290
$this
setIndexType($type)
Set the desired index type to use
in DBField at line 304
string|bool
getIndexType()
Return the desired index type to use. Will return false if the field instance should not be indexed.
in DBString at line 94
mixed
prepValueForDB($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.
in DBField at line 366
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). {see prepValueForDB}
in DBField at line 383
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
in DBField at line 393
$this
setTable(string $tableName)
Assign this DBField to a table
in DBField at line 404
string|null
getTable()
Get the table this field belongs to, if assigned
in DBString at line 111
string
forTemplate()
in DBField at line 425
string
HTMLATT()
Gets the value appropriate for a HTML attribute string
in DBField at line 435
string
URLATT()
urlencode this string
in DBField at line 445
string
RAWURLATT()
rawurlencode this string
in DBField at line 455
string
ATT()
Gets the value appropriate for a HTML attribute string
in DBField at line 466
mixed
RAW()
Gets the raw value for this field.
Note: Skips processors implemented via forTemplate()
in DBField at line 476
string
JS()
Gets javascript string literal value
in DBField at line 486
string
JSON()
Return JSON encoded value
in DBField at line 496
string
HTML()
Alias for {see XML()}
in DBField at line 506
string
XML()
XML encode this value
in DBField at line 516
string
CDATA()
Safely escape for XML string
in DBField at line 527
mixed
nullValue()
Returns the value to be set in the database to blank this field.
Usually it's a choice between null, 0, and ''
in DBField at line 537
saveInto(DataObject $dataObject)
Saves this field to the given data object.
at line 151
FormField
scaffoldFormField(string $title = null, array $params = null)
Returns a FormField instance used as a default for form scaffolding.
Used by {@link SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()}
at line 161
FormField
scaffoldSearchField(string $title = null)
in DBField at line 587
SearchFilter
defaultSearchFilter(string $name = null)
at line 100
requireField()
in DBField at line 599
debug()
in DBField at line 618
array
getArrayValue()
in DBField at line 627
$this
setArrayValue(array $value)
in DBField at line 638
string|array
getSchemaValue()
Get formfield schema value
in DBField at line 643
array
getIndexSpecs()
Returns the index specifications for the field instance, for example:
[
'type' => 'unique',
'columns' => ['FieldName']
]
in DBField at line 661
boolean
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.
in DBString at line 66
$this
setNullifyEmpty($value)
Set whether this field stores empty strings rather than converting them to null.
in DBString at line 78
boolean
getNullifyEmpty()
Get whether this field stores empty strings rather than converting them to null
in DBString at line 125
string
LimitCharacters(int $limit = 20, string $add = '...')
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.
in DBString at line 143
string
LimitCharactersToClosestWord(int $limit = 20, string $add = '...')
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.
in DBString at line 173
string
LimitWordCount(int $numWords = 26, string $add = '...')
Limit this field's content by a number of words.
in DBString at line 191
string
LowerCase()
Converts the current value for this StringField to lowercase.
in DBString at line 201
string
UpperCase()
Converts the current value for this StringField to uppercase.
in DBString at line 211
string
Plain()
Plain text version of this string
at line 45
static
flushCache()
Clear all cached enum values.
at line 133
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.
at line 175
array
enumValues(boolean $hasEmpty = false)
Returns the values of this enum as an array, suitable for insertion into a {@link DropdownField}
at line 187
array
getEnum()
Get list of enum values
at line 203
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();
at line 240
$this
setEnum(string|array $enum)
Set enum options
at line 258
string|null
getDefault()
Get default vwalue
at line 269
$this
setDefault(string $default)
Set default value