class DBHTMLText extends DBText (View source)

Represents a large text field that contains HTML content.

This behaves similarly to {@link Text}, but the template processor won't escape any HTML content within it.

Options can be specified in a $db config via one of the following:

  • "HTMLFragment(['shortcodes' => true, 'whitelist' => 'meta,link'])"
  • "HTMLFragment(['whitelist' => 'meta,link'])"
  • "HTMLFragment(['shortcodes' => true])". "HTMLText" is also a synonym for this.
  • "HTMLFragment(['shortcodes' => true])"

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

Properties

static private array $extensions

An array of extension names and parameters to be applied to this object upon construction.

from  Extensible
static private array $casting

An array of objects to cast certain fields to. This is set up as an array in the format:

from  ViewableData
static private string $default_cast

The default object to cast scalar fields to if casting information is not specified, and casting to an object is required.

from  ViewableData
static private string $escape_type

The escape type for this field when inserted into a template - either "xml" or "raw".

from  DBField
static private string $default_search_filter_class

Subclass of {@link SearchFilter} for usage in {@link defaultSearchFilter()}.

from  DBField
static private string|bool $index

The type of index to use for this field. Can either be a string (one of the DBIndexable type options) or a boolean. When a boolean is given, false will not index the field, and true will use the default index type.

from  DBField

Methods

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

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

static bool
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

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.

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 {@link 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

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

getExtensionInstances()

Get all extension instances for this specific object instance.

static Injectable
create(array ...$args)

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

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

static Config_ForClass
config()

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

mixed
stat(string $name) 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

Update the config value for a given property

__construct(string $name = null, array $options = [])

Set the default value for "nullify empty"

from  DBString
bool
__isset(string $property)

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

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.

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

setFailover(ViewableData $failover)

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

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.

defineMethods()

Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.

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.

bool
exists()

(non-PHPdoc)

string
__toString()

No description

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

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

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 {@link 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

getIterator()

Return a single-item iterator so you can iterate over the fields of a single record.

array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

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

Return the directory if the current active theme (relative to the site root).

string
CSSClasses(string $stopAtClass = self::class)

Get part of the current classes ancestry to be used as a CSS class.

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.

from  DBField
$this
setName(string $name)

Set the name of this field.

from  DBField
string
getName()

Returns the name of this field.

from  DBField
mixed
getValue()

Returns the value of this field.

from  DBField
$this
setValue(mixed $value, DataObject|array $record = null, bool $markChanged = true)

Set the value of this field in various formats.

from  DBField
mixed
getDefaultValue()

Get default value assigned at the DB level

from  DBField
$this
setDefaultValue(mixed $defaultValue)

Set default value to use at the DB level

from  DBField
$this
setOptions(array $options = [])

No description

array
getOptions()

Get optional parameters for this field

from  DBField
$this
setIndexType(string|bool $type)

Set the desired index type to use

from  DBField
string|bool
getIndexType()

Return the desired index type to use. Will return false if the field instance should not be indexed.

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

from  DBField
addToQuery(SQLSelect $query)

Add custom query parameters for this field, mostly SELECT statements for multi-value fields.

from  DBField
$this
setTable(string $tableName)

Assign this DBField to a table

from  DBField
string|null
getTable()

Get the table this field belongs to, if assigned

from  DBField
string
forTemplate()

No description

string
HTMLATT()

Gets the value appropriate for a HTML attribute string

from  DBField
string
URLATT()

urlencode this string

from  DBField
string
RAWURLATT()

rawurlencode this string

from  DBField
string
ATT()

Gets the value appropriate for a HTML attribute string

from  DBField
mixed
RAW()

Gets the raw value for this field.

string
JS()

Gets javascript string literal value

from  DBField
string
JSON()

Return JSON encoded value

from  DBField
string
HTML()

Alias for {see XML()}

from  DBField
string
XML()

XML encode this value

from  DBField
string
CDATA()

Safely escape for XML string

mixed
nullValue()

Returns the value to be set in the database to blank this field.

from  DBField
saveInto(DataObject $dataObject)

Saves this field to the given data object.

from  DBField
scaffoldFormField(string $title = null, array $params = null)

Returns a FormField instance used as a default for form scaffolding.

scaffoldSearchField(string $title = null)

Returns a FormField instance used as a default for searchform scaffolding.

defaultSearchFilter(string $name = null)

No description

from  DBField
requireField()

(non-PHPdoc)

from  DBText
debug()

No description

from  DBField
array
getArrayValue()

No description

from  DBField
$this
setArrayValue(array $value)

No description

from  DBField
string|array
getSchemaValue()

Get formfield schema value

array
getIndexSpecs()

Returns the index specifications for the field instance, for example:

from  DBField
bool
scalarValueOnly()

Whether or not this DBField only accepts scalar values.

from  DBField
$this
setNullifyEmpty($value)

Set whether this field stores empty strings rather than converting them to null.

from  DBString
bool
getNullifyEmpty()

Get whether this field stores empty strings rather than converting them to null

from  DBString
string
LimitCharacters(int $limit = 20, string|false $add = false)

Limit this field's content by a number of characters.

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

from  DBString
string
LimitWordCount(int $numWords = 26, false $add = false)

Limit this field's content by a number of words.

from  DBString
string
LowerCase()

Converts the current value for this StringField to lowercase.

from  DBString
string
UpperCase()

Converts the current value for this StringField to uppercase.

from  DBString
string
Plain()

Get plain-text version

string
defaultEllipsis()

Get the default string to indicate that a string was cut off.

from  DBString
string
LimitSentences(int $maxSentences = 2)

Limit sentences, can be controlled by passing an integer.

from  DBText
string
FirstSentence()

Return the first string that finishes with a period (.) in this text.

from  DBText
string
Summary(int $maxWords = 50, string|false $add = false)

Builds a basic summary, up to a maximum number of words

from  DBText
string
FirstParagraph()

Get first paragraph

from  DBText
string
ContextSummary(int $characters = 500, string $keywords = null, bool $highlight = true, string|false $prefix = false, string|false $suffix = false)

Perform context searching to give some context to searches, optionally highlighting the search term.

from  DBText
bool
getProcessShortcodes()

Check if shortcodes are enabled

$this
setProcessShortcodes(bool $process)

Set shortcodes on or off by default

array
getWhitelist()

List of html properties to whitelist

$this
setWhitelist(array $whitelist)

Set list of html properties to whitelist

string
AbsoluteLinks()

Return the value of the field with relative links converted to absolute urls (with placeholders parsed).

string
whitelistContent(string $value)

Filter the given $value string through the whitelist filter

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 {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

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

Parameters

string $method

Return Value

bool

array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom

include methods added dynamically at runtime

Return Value

array

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

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of {@link Object}

string $extension

Subclass of {@link Extension} with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool

Flag if the extension was added

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

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.

Parameters

string $extension

class name of an {@link Extension} subclass, without parameters

static array get_extensions(string $class = null, bool $includeArgumentString = false)

Parameters

string $class

If omitted, will get extensions for the current class

bool $includeArgumentString

Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array

Numeric array of either {@link DataExtension} class names, or eval'ed class name strings with constructor arguments.

static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

string $class

Name of class. If left null will return for the current class

Return Value

array|null

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

Parameters

string $classOrExtension

Class to check extension for, or the extension name to check if the second argument is null.

string $requiredExtension

If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.

bool $strict

if the extension has to match the required extension and not be a subclass

Return Value

bool

Flag if the extension exists

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 {@link Extensions}, and then attempts to merge all results into an array

Parameters

string $method

the method name to call

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

List of results with nulls filtered out

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 {@link __construct()} in {@link defineMethods()}.

Parameters

string $method

the name of the method to call on each extension

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

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()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension

Classname of an {@link Extension} subclass without parameters

Return Value

bool

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.

Return Value

Extension[]

Map of {@link DataExtension} instances, keyed by classname.

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

Parameters

array ...$args

Return Value

Injectable

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

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

static Config_ForClass config()

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

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct(string $name = null, array $options = [])

Set the default value for "nullify empty"

{@inheritDoc}

Parameters

string $name
array $options

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.

Parameters

string $property

Return Value

bool

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.

Parameters

string $property

Return Value

mixed

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

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

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

Parameters

string $field

Return Value

bool

mixed getField(string $field)

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

Parameters

string $field

Return Value

mixed

$this setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

Return Value

$this

defineMethods()

Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.

Exceptions

LogicException

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.

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

bool exists()

(non-PHPdoc)

Return Value

bool

string __toString()

Return Value

string

the class name

ViewableData getCustomisedObj()

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

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.

Parameters

string $field

Return Value

string

Casting helper As a constructor pattern, and may include arguments.

Exceptions

Exception

string castingClass(string $field)

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

Parameters

string $field

Return Value

string

string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string

'xml'|'raw'

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

Parameters

string|array|SSViewer $template

the template to render into

array $customFields

fields to customise() the object with before rendering

Return Value

DBHTMLText

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.

Parameters

string $fieldName
array $arguments
bool $cache

Cache this object

string $cacheName

a custom cache name

Return Value

object|DBField

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.

Parameters

string $field
array $arguments
string $identifier

an optional custom cache identifier

Return Value

object|DBField

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

string

array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields

an array of field names

Return Value

array

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.

Return Value

ArrayIterator

array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

ViewableData Me()

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

Return Value

ViewableData

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.

Return Value

string

URL to the current theme

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

Parameters

string $stopAtClass

the class to stop at (default: ViewableData)

Return Value

string

ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

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.

Parameters

string $spec

Class specification to construct. May include both service name and additional constructor arguments in the same format as DataObject.db config.

mixed $value

value of field

string $name

Name of field

mixed ...$args

Additional arguments to pass to constructor if not using args in service $spec Note: Will raise a warning if using both

Return Value

DBField

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

Parameters

string $name

Return Value

$this

string getName()

Returns the name of this field.

Return Value

string

mixed getValue()

Returns the value of this field.

Return Value

mixed

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

Parameters

mixed $value
DataObject|array $record

An array or object that this field is part of

bool $markChanged

Indicate whether this field should be marked changed. Set to FALSE if you are initializing this field after construction, rather than setting a new value.

Return Value

$this

mixed getDefaultValue()

Get default value assigned at the DB level

Return Value

mixed

$this setDefaultValue(mixed $defaultValue)

Set default value to use at the DB level

Parameters

mixed $defaultValue

Return Value

$this

$this setOptions(array $options = [])

Parameters

array $options

Array of options

Return Value

$this

array getOptions()

Get optional parameters for this field

Return Value

array

$this setIndexType(string|bool $type)

Set the desired index type to use

Parameters

string|bool $type

Either of the types listed in {@link SilverStripe\ORM\FieldType\DBIndexable}, or boolean true to indicate that the default index type should be used.

Return Value

$this

Exceptions

InvalidArgumentException

If $type is not one of TYPE_INDEX, TYPE_UNIQUE or TYPE_FULLTEXT

string|bool getIndexType()

Return the desired index type to use. Will return false if the field instance should not be indexed.

Return Value

string|bool

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.

Parameters

mixed $value

The value to check

Return Value

mixed

The raw value, or escaped parameterised details

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 \SilverStripe\ORM\FieldType\prepValueForDB}

Parameters

array $manipulation

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 .* which gets you the default representations of all columns.

Parameters

SQLSelect $query

$this setTable(string $tableName)

Assign this DBField to a table

Parameters

string $tableName

Return Value

$this

string|null getTable()

Get the table this field belongs to, if assigned

Return Value

string|null

string forTemplate()

Return Value

string

string HTMLATT()

Gets the value appropriate for a HTML attribute string

Return Value

string

string URLATT()

urlencode this string

Return Value

string

string RAWURLATT()

rawurlencode this string

Return Value

string

string ATT()

Gets the value appropriate for a HTML attribute string

Return Value

string

mixed RAW()

Gets the raw value for this field.

Note: Skips processors implemented via forTemplate()

Return Value

mixed

string JS()

Gets javascript string literal value

Return Value

string

string JSON()

Return JSON encoded value

Return Value

string

string HTML()

Alias for {see XML()}

Return Value

string

string XML()

XML encode this value

Return Value

string

string CDATA()

Safely escape for XML string

Return Value

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

Return Value

mixed

saveInto(DataObject $dataObject)

Saves this field to the given data object.

Parameters

DataObject $dataObject

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

Parameters

string $title

Optional. Localized title of the generated instance

array $params

Return Value

FormField

FormField scaffoldSearchField(string $title = null)

Returns a FormField instance used as a default for searchform scaffolding.

Used by {@link SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()}.

Parameters

string $title

Optional. Localized title of the generated instance

Return Value

FormField

SearchFilter defaultSearchFilter(string $name = null)

Parameters

string $name

Override name of this field

Return Value

SearchFilter

requireField()

(non-PHPdoc)

debug()

array getArrayValue()

Return Value

array

$this setArrayValue(array $value)

Parameters

array $value

Return Value

$this

string|array getSchemaValue()

Get formfield schema value

Return Value

string|array

Encoded string for use in formschema response

array getIndexSpecs()

Returns the index specifications for the field instance, for example:

[ 'type' => 'unique', 'columns' => ['FieldName'] ]

Return Value

array

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.

Return Value

bool

$this setNullifyEmpty($value)

Set whether this field stores empty strings rather than converting them to null.

Parameters

$value

boolean True if empty strings are to be converted to null

Return Value

$this

bool getNullifyEmpty()

Get whether this field stores empty strings rather than converting them to null

Return Value

bool

True if empty strings are to be converted 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.

Parameters

int $limit

Number of characters to limit by

string|false $add

Ellipsis to add to the end of truncated string

Return Value

string

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.

Parameters

int $limit

Number of characters to limit by

string|false $add

Ellipsis to add to the end of truncated string

Return Value

string

Plain text value with limited characters

string LimitWordCount(int $numWords = 26, false $add = false)

Limit this field's content by a number of words.

Parameters

int $numWords

Number of words to limit by.

false $add

Ellipsis to add to the end of truncated string.

Return Value

string

string LowerCase()

Converts the current value for this StringField to lowercase.

Return Value

string

Text with lowercase (HTML for some subclasses)

string UpperCase()

Converts the current value for this StringField to uppercase.

Return Value

string

Text with uppercase (HTML for some subclasses)

string Plain()

Get plain-text version

Return Value

string

Plain text

string defaultEllipsis()

Get the default string to indicate that a string was cut off.

Return Value

string

string LimitSentences(int $maxSentences = 2)

Limit sentences, can be controlled by passing an integer.

Parameters

int $maxSentences

The amount of sentences you want.

Return Value

string

string FirstSentence()

Return the first string that finishes with a period (.) in this text.

Return Value

string

string Summary(int $maxWords = 50, string|false $add = false)

Builds a basic summary, up to a maximum number of words

Parameters

int $maxWords
string|false $add

Return Value

string

string FirstParagraph()

Get first paragraph

Return Value

string

string ContextSummary(int $characters = 500, string $keywords = null, bool $highlight = true, string|false $prefix = false, string|false $suffix = false)

Perform context searching to give some context to searches, optionally highlighting the search term.

Parameters

int $characters

Number of characters in the summary

string $keywords

Supplied string ("keywords"). Will fall back to 'Search' querystring arg.

bool $highlight

Add a highlight element around search query?

string|false $prefix

Prefix text

string|false $suffix

Suffix text

Return Value

string

HTML string with context

bool getProcessShortcodes()

Check if shortcodes are enabled

Return Value

bool

$this setProcessShortcodes(bool $process)

Set shortcodes on or off by default

Parameters

bool $process

Return Value

$this

array getWhitelist()

List of html properties to whitelist

Return Value

array

$this setWhitelist(array $whitelist)

Set list of html properties to whitelist

Parameters

array $whitelist

Return Value

$this

Return the value of the field with relative links converted to absolute urls (with placeholders parsed).

Return Value

string

string whitelistContent(string $value)

Filter the given $value string through the whitelist filter

Parameters

string $value

Input html content

Return Value

string

Value with all non-whitelisted content stripped (if applicable)