class HTMLText extends Text

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.

Properties

string $class from Object
protected array $extension_instances from Object
protected array[callable] $beforeExtendCallbacks List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. from Object
protected array[callable] $afterExtendCallbacks List of callbacks to call after extensions having extend called on them, each grouped by methodName. from Object
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 $value from DBField
protected $tableName from DBField
protected $name from DBField
protected $arrayValue from DBField
protected $defaultVal from DBField
protected boolean $nullifyEmpty from StringField
protected $processShortcodes
protected $whitelist

Methods

static Config_ForClass|null
config()

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

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

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

from Object
static Object
create()

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

from Object
static Object
singleton()

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

from Object
static 
create_from_string($classSpec, $firstArg = null)

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

from Object
static 
parse_class_spec($classSpec)

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

from Object
static Object
strong_create()

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

from Object
static 
useCustomClass(string $oldClass, string $newClass, bool $strong = false)

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

from Object
static string
getCustomClass(string $class)

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

from Object
static any
static_lookup($class, $name, null $default = null)

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

from Object
static 
get_static($class, $name, $uncached = false) deprecated

No description

from Object
static 
set_static($class, $name, $value) deprecated

No description

from Object
static 
uninherited_static($class, $name, $uncached = false) deprecated

No description

from Object
static 
combined_static($class, $name, $ceiling = false) deprecated

No description

from Object
static 
addStaticVars($class, $properties, $replace = false) deprecated

No description

from Object
static 
add_static_var($class, $name, $value, $replace = false) deprecated

No description

from Object
static 
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

Return TRUE if a class has a specified extension.

from Object
static 
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

from Object
static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

from Object
static 
get_extra_config_sources($class = null)

No description

from Object
__construct($name = null, $options = array())

Construct a string type field with a set of optional parameters.

mixed
__call(string $method, array $arguments)

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

from Object
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

from Object
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

from Object
defineMethods()

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

array
findMethodsFromExtension(object $extension)

No description

from Object
addMethodsFrom(string $property, string|int $index = null)

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

from Object
removeMethodsFrom(string $property, string|int $index = null)

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

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

from Object
createMethod(string $method, string $code)

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

from Object
stat($name, $uncached = false)

No description

from Object
set_stat($name, $value)

No description

from Object
uninherited($name)

No description

from Object
bool
exists()

Returns true if the field has meaningful content.

string
parentClass()

No description

from Object
bool
is_a(string $class)

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

from Object
string
__toString()

No description

from DBField
mixed
invokeWithExtensions(string $method, mixed $argument = 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

from Object
array
extend($method, $a1 = null, $a2 = null, $a3 = null, $a4 = null, $a5 = null, $a6 = null, $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

from Object
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

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

from Object
array
getExtensionInstances()

Get all extension instances for this specific object instance.

from Object
mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

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

from Object
clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

from Object
mixed
loadCache(string $cache, int $lifetime = 3600)

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

from Object
saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

from Object
string
sanitiseCachename(string $name)

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

from Object
static string
castingObjectCreator(string $fieldSchema)

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

static array
castingObjectCreatorPair(string $fieldSchema)

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

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.

setField(string $field, mixed $value)

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

unknown
deprecatedCachedCall($method, $args = null, $identifier = null)

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

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.

getCustomisedObj()

No description

setCustomisedObj(ViewableData $object)

No description

array
castingHelperPair(string $field)

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

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.

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.

buildCastingCache(reference $cache)

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

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

objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

mixed
objCacheGet(string $key)

Get a cached value from the field cache

objCacheSet(string $key, mixed $value)

Store a value in the field cache

obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, 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.

cachedCall(string $field, array $arguments = null, 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 = null, 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.

XML_val($field, $arguments = null, $cache = false)

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

RAW_val($field, $arguments = null, $cache = true)

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

SQL_val($field, $arguments = null, $cache = true)

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

JS_val($field, $arguments = null, $cache = true)

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

ATT_val($field, $arguments = null, $cache = true)

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

array
getXMLValues($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.

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(string $subtheme = false)

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

string
CSSClasses(string $stopAtClass = 'ViewableData')

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 $className, mixed $value, string $name = null, mixed $object = null)

Create a DBField object that's not bound to any particular field.

from DBField
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
setValue(mixed $value, array $record = null)

Set the value on the field.

from DBField
mixed
prepValueForDB($value)

(non-PHPdoc)

writeToManipulation(array $manipulation)

Prepare the current field for usage in a database-manipulation (works on a manipulation reference).

from DBField
addToQuery(SS_Query $query)

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

from DBField
setTable($tableName)

No description

from DBField
string
forTemplate()

No description

HTMLATT()

No description

from DBField
URLATT()

No description

from DBField
RAWURLATT()

No description

from DBField
ATT()

No description

from DBField
RAW()

No description

JS()

No description

from DBField
string
JSON()

Return JSON encoded value

from DBField
HTML()

No description

from DBField
XML()

No description

from DBField
mixed
nullValue()

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

from DBField
saveInto($dataObject)

Saves this field to the given data object.

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

(non-PHPdoc)

scaffoldSearchField(string $title = null, $params = null)

(non-PHPdoc)

defaultSearchFilter($name = false)

No description

from DBField
requireField()

(non-PHPdoc)

from Text
debug()

No description

from DBField
unknown_type
setOptions(array $options = array())

No description

setNullifyEmpty($value)

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

boolean
getNullifyEmpty()

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

string
LimitCharacters(int $limit = 20, string $add = '...')

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

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.

string
LimitWordCount(int $numWords = 26, string $add = '...')

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

string
LimitWordCountXML(int $numWords = 26, string $add = '...')

Limit the number of words of the current field's content. This is XML safe, so characters like & are converted to &

string
LowerCase()

Converts the current value for this StringField to lowercase.

string
UpperCase()

Converts the current value for this StringField to uppercase.

string
NoHTML()

Return the value of the field stripped of html tags.

string
AbsoluteLinks()

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

LimitSentences(int $sentCount = 2)

Limit sentences, can be controlled by passing an integer.

from Text
FirstSentence()

Returns the first sentence from the first paragraph. If it can't figure out what the first paragraph is (or there isn't one), it returns the same as Summary()

Summary($maxWords = 50, int $flex = 15, string $add = '...')

Create a summary of the content. This will be some section of the first paragraph, limited by $maxWords. All internal tags are stripped out - the return value is a string

BigSummary($maxWords = 50, $plain = true)

Performs the same function as the big summary, but doesn't trim new paragraphs off data.

from Text
FirstParagraph($plain = 1)

Caution: Not XML/HTML-safe - does not respect closing tags.

from Text
string
ContextSummary(int $characters = 500, boolean $string = false, boolean $striphtml = true, boolean $highlight = true, String $prefix = "... ", String $suffix = "...")

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

from Text
string
Parse($parser = "TextParser")

Allows a sub-class of TextParser to be rendered.

from Text
bool
getProcessShortcodes()

Check if shortcodes are enabled

$this
setProcessShortcodes(bool $process)

Set shortcodes on or off by default

string
whitelistContent(string $value)

Filter the given $value string through the whitelist filter

Details

in Object at line 60
static Config_ForClass|null config()

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

....).

Return Value

Config_ForClass|null

in Object at line 85
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.

Parameters

string $method The name of the method to hook into
callable $callback The callback to execute

in Object at line 108
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.

Parameters

string $method The name of the method to hook into
callable $callback The callback to execute

in Object at line 132
static Object create()

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

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

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Return Value

Object

in Object at line 155
static Object singleton()

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

Return Value

Object The singleton instance

in Object at line 190
static create_from_string($classSpec, $firstArg = null)

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

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

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

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

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

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

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

Parameters

$classSpec
$firstArg

in Object at line 215
static parse_class_spec($classSpec)

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

Returns a 2-elemnent array, with classname and arguments

Parameters

$classSpec

in Object at line 341
static Object strong_create()

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

Return Value

Object

in Object at line 361
static useCustomClass(string $oldClass, string $newClass, bool $strong = false)

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

Parameters

string $oldClass the class to replace
string $newClass the class to replace it with
bool $strong allows you to enforce a certain class replacement under all circumstances. This is used in singletons and DB interaction classes

in Object at line 375
static string getCustomClass(string $class)

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

Parameters

string $class the class to check

Return Value

string the class that would be created if you called {@link Object::create()} with the class

in Object at line 396
static any static_lookup($class, $name, null $default = null)

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

Parameters

$class
  • The class to get the static from
$name
  • The property to get from the class
null $default
  • The value to return if property doesn't exist on class

Return Value

any
  • The value of the static property $name on class $class, or $default if that property is not defined

in Object at line 436
static get_static($class, $name, $uncached = false) deprecated

deprecated

Parameters

$class
$name
$uncached

in Object at line 444
static set_static($class, $name, $value) deprecated

deprecated

Parameters

$class
$name
$value

in Object at line 452
static uninherited_static($class, $name, $uncached = false) deprecated

deprecated

Parameters

$class
$name
$uncached

in Object at line 460
static combined_static($class, $name, $ceiling = false) deprecated

deprecated

Parameters

$class
$name
$ceiling

in Object at line 470
static addStaticVars($class, $properties, $replace = false) deprecated

deprecated

Parameters

$class
$properties
$replace

in Object at line 478
static add_static_var($class, $name, $value, $replace = false) deprecated

deprecated

Parameters

$class
$name
$value
$replace

in Object at line 494
static 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))

Parameters

string $classOrExtension if 1 argument supplied, the class name of the extension to check for; if 2 supplied, the class name to test
string $requiredExtension used only if 2 arguments supplied
boolean $strict if the extension has to match the required extension and not be a subclass

in Object at line 536
static 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')"

See also

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

in Object at line 601
static remove_extension(string $extension)

Remove an extension from a class.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@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 Classname of an {@link Extension} subclass, without parameters

in Object at line 640
static array get_extensions(string $class, bool $includeArgumentString = false)

Parameters

string $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} classnames, or eval'ed classname strings with constructor arguments.

in Object at line 658
static get_extra_config_sources($class = null)

Parameters

$class

at line 59
__construct($name = null, $options = array())

Construct a string type field with a set of optional parameters.

Parameters

$name
$options array An array of options e.g. array('nullifyEmpty'=>false). See {@link StringField::setOptions()} for information on the available options

in Object at line 728
mixed __call(string $method, array $arguments)

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

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

Parameters

string $method
array $arguments

Return Value

mixed

in Object at line 795
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

in Object at line 805
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

in ViewableData at line 206
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 Object at line 846
protected array findMethodsFromExtension(object $extension)

Parameters

object $extension

Return Value

array

in Object at line 867
protected addMethodsFrom(string $property, string|int $index = null)

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

Parameters

string $property the property name
string|int $index an index to use if the property is an array

in Object at line 902
protected removeMethodsFrom(string $property, string|int $index = null)

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

Parameters

string $property the property name
string|int $index an index to use if the property is an array

in Object at line 934
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)

Parameters

string $method the method name to wrap
string $wrap the method name to wrap to

in Object at line 949
protected createMethod(string $method, string $code)

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

Parameters

string $method the method name
string $code the PHP code - arguments will be in an array called $args, while you can access this object by using $obj. Note that you cannot call protected methods, as the method is actually an external function

in Object at line 962
stat($name, $uncached = false)

Parameters

$name
$uncached

See also

Object::get_static()

in Object at line 969
set_stat($name, $value)

Parameters

$name
$value

See also

Object::set_static()

in Object at line 976
uninherited($name)

Parameters

$name

See also

Object::uninherited_static()

at line 260
bool exists()

Returns true if the field has meaningful content.

Excludes null content like

,

,etc

Return Value

bool

in Object at line 997
string parentClass()

Return Value

string this classes parent class

in Object at line 1007
bool is_a(string $class)

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

Parameters

string $class

Return Value

bool

in DBField at line 343
string __toString()

Return Value

string the class name

in Object at line 1029
mixed invokeWithExtensions(string $method, mixed $argument = 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 $argument a single argument to pass

Return Value

mixed

in Object at line 1051
array extend($method, $a1 = null, $a2 = null, $a3 = null, $a4 = null, $a5 = null, $a6 = null, $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

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

Return Value

array

in Object at line 1090
Extension getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

in Object at line 1108
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

in Object at line 1119
array 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).

Return Value

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

in Object at line 1135
mixed cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

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

Parameters

string $method the method name to cache
int $lifetime the cache lifetime in seconds
string $ID custom cache ID to use
array $arguments an optional array of arguments

Return Value

mixed the cached data

in Object at line 1164
clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

in Object at line 1183
protected mixed loadCache(string $cache, int $lifetime = 3600)

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

Parameters

string $cache the cache name
int $lifetime the lifetime (in seconds) of the cache before it is invalid

Return Value

mixed

in Object at line 1201
protected saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

Parameters

string $cache the cache name
mixed $data data to save (must be serializable)

in Object at line 1212
protected string sanitiseCachename(string $name)

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

Parameters

string $name

Return Value

string the name with all special cahracters replaced with underscores

in ViewableData at line 72
static string castingObjectCreator(string $fieldSchema)

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

Parameters

string $fieldSchema The field spec

Return Value

string

in ViewableData at line 83
static array castingObjectCreatorPair(string $fieldSchema)

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

Parameters

string $fieldSchema

Return Value

array

in ViewableData at line 95
bool __isset(string $property)

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

Parameters

string $property

Return Value

bool

in ViewableData at line 117
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

in ViewableData at line 138
__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

in ViewableData at line 151
setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

in ViewableData at line 166
ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

in ViewableData at line 176
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

in ViewableData at line 186
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

in ViewableData at line 196
setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

in ViewableData at line 236
unknown deprecatedCachedCall($method, $args = null, $identifier = null)

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

Parameters

$method
$args
$identifier

Return Value

unknown

in ViewableData at line 255
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

in ViewableData at line 272
ViewableData getCustomisedObj()

Return Value

ViewableData

in ViewableData at line 279
setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

in ViewableData at line 296
array castingHelperPair(string $field)

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

The returned array contains two keys: - className: the class the field would be casted to (e.g. "Varchar") - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")

Parameters

string $field

Return Value

array

in ViewableData at line 308
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.

Parameters

string $field

Return Value

string

in ViewableData at line 331
string castingClass(string $field)

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

Parameters

string $field

Return Value

string

in ViewableData at line 346
string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string 'xml'|'raw'

in ViewableData at line 357
buildCastingCache(reference $cache)

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

Parameters

reference $cache

in ViewableData at line 394
HTMLText 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

HTMLText

in ViewableData at line 419
protected objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName Name of field
array $arguments List of optional arguments given

in ViewableData at line 431
protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key Cache key

Return Value

mixed

in ViewableData at line 441
protected objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key Cache key
mixed $value

in ViewableData at line 456
obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, 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 $forceReturnedObject if TRUE, the value will ALWAYS be casted to an object before being returned, even if there is no explicit casting information
bool $cache Cache this object
string $cacheName a custom cache name

in ViewableData at line 503
cachedCall(string $field, array $arguments = null, 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

in ViewableData at line 516
bool hasValue(string $field, array $arguments = null, 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

in ViewableData at line 538
XML_val($field, $arguments = null, $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

$field
$arguments
$cache

in ViewableData at line 546
RAW_val($field, $arguments = null, $cache = true)

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

Parameters

$field
$arguments
$cache

in ViewableData at line 553
SQL_val($field, $arguments = null, $cache = true)

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

Parameters

$field
$arguments
$cache

in ViewableData at line 560
JS_val($field, $arguments = null, $cache = true)

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

Parameters

$field
$arguments
$cache

in ViewableData at line 567
ATT_val($field, $arguments = null, $cache = true)

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

Parameters

$field
$arguments
$cache

in ViewableData at line 579
array getXMLValues($fields)

Get an array of XML-escaped values by field name

Parameters

$fields

Return Value

array

in ViewableData at line 599
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

in ViewableData at line 611
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

in ViewableData at line 627
string ThemeDir(string $subtheme = false)

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.

Parameters

string $subtheme the subtheme path to get

Return Value

string

in ViewableData at line 648
string CSSClasses(string $stopAtClass = 'ViewableData')

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

in ViewableData at line 671
ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

in DBField at line 87
static DBField create_field(string $className, mixed $value, string $name = null, mixed $object = null)

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 $className class of field to construct
mixed $value value of field
string $name Name of field
mixed $object Additional parameter to pass to field constructor

Return Value

DBField

in DBField at line 106
DBField 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

DBField

in DBField at line 122
string getName()

Returns the name of this field.

Return Value

string

in DBField at line 131
mixed getValue()

Returns the value of this field.

Return Value

mixed

in DBField at line 143
setValue(mixed $value, array $record = null)

Set the value on the field.

Optionally takes the whole record as an argument, to pick other values.

Parameters

mixed $value
array $record

at line 221
mixed prepValueForDB($value)

(non-PHPdoc)

Parameters

$value mixed The value to check

Return Value

mixed The raw value, or escaped parameterised details

in DBField at line 192
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}

Parameters

array $manipulation

in DBField at line 208
addToQuery(SS_Query $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

SS_Query $query

in DBField at line 212
setTable($tableName)

Parameters

$tableName

at line 217
string forTemplate()

Return Value

string

in DBField at line 223
HTMLATT()

in DBField at line 227
URLATT()

in DBField at line 231
RAWURLATT()

in DBField at line 235
ATT()

at line 200
RAW()

in DBField at line 243
JS()

in DBField at line 251
string JSON()

Return JSON encoded value

Return Value

string

in DBField at line 255
HTML()

in DBField at line 259
XML()

in DBField at line 269
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

in DBField at line 276
saveInto($dataObject)

Saves this field to the given data object.

Parameters

$dataObject

at line 283
FormField scaffoldFormField(string $title = null, $params = null)

(non-PHPdoc)

Parameters

string $title Optional. Localized title of the generated instance
$params

Return Value

FormField

at line 287
FormField scaffoldSearchField(string $title = null, $params = null)

(non-PHPdoc)

Parameters

string $title Optional. Localized title of the generated instance
$params

Return Value

FormField

in DBField at line 322
SearchFilter defaultSearchFilter($name = false)

Parameters

$name

Return Value

SearchFilter

in Text at line 39
requireField()

(non-PHPdoc)

See also

DBField::requireField()

in DBField at line 333
debug()

at line 82
unknown_type setOptions(array $options = array())

Parameters

array $options array of options The options allowed are:

  • "nullifyEmpty" This is a boolean flag. True (the default) means that empty strings are automatically converted to nulls to be stored in the database. Set it to false to ensure that nulls and empty strings are kept intact in the database.

Return Value

unknown_type

in StringField at line 68
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

in StringField at line 78
boolean getNullifyEmpty()

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

Return Value

boolean True if empty strings are to be converted to null

in StringField at line 121
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.

Parameters

int $limit Number of characters to limit by
string $add Ellipsis to add to the end of truncated string

Return Value

string

in StringField at line 144
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.

Parameters

int $limit Number of characters to limit by
string $add Ellipsis to add to the end of truncated string

Return Value

string

in StringField at line 177
string LimitWordCount(int $numWords = 26, string $add = '...')

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

CAUTION: This is not XML safe. Please use {@link LimitWordCountXML()} instead.

Parameters

int $numWords Number of words to limit by.
string $add Ellipsis to add to the end of truncated string.

Return Value

string

in StringField at line 201
string LimitWordCountXML(int $numWords = 26, string $add = '...')

Limit the number of words of the current field's content. This is XML safe, so characters like & are converted to &

Parameters

int $numWords Number of words to limit by.
string $add Ellipsis to add to the end of truncated string.

Return Value

string

in StringField at line 212
string LowerCase()

Converts the current value for this StringField to lowercase.

Return Value

string

in StringField at line 220
string UpperCase()

Converts the current value for this StringField to uppercase.

Return Value

string

in StringField at line 229
string NoHTML()

Return the value of the field stripped of html tags.

Return Value

string

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

Return Value

string

in Text at line 71
LimitSentences(int $sentCount = 2)

Limit sentences, can be controlled by passing an integer.

Parameters

int $sentCount The amount of sentences you want.

at line 183
FirstSentence()

Returns the first sentence from the first paragraph. If it can't figure out what the first paragraph is (or there isn't one), it returns the same as Summary()

This is the HTML aware equivilent to Text#FirstSentence

See also

framework/core/model/fieldtypes/Text#FirstSentence()

at line 113
Summary($maxWords = 50, int $flex = 15, string $add = '...')

Create a summary of the content. This will be some section of the first paragraph, limited by $maxWords. All internal tags are stripped out - the return value is a string

This is sort of the HTML aware equivilent to Text#Summary, although the logic for summarising is not exactly the same

Parameters

$maxWords
int $flex Number of words to search through when looking for a nice cut point
string $add What to add to the end of the summary if we cut at a less-than-ideal cut point

See also

framework/core/model/fieldtypes/Text#Summary($maxWords)

in Text at line 155
BigSummary($maxWords = 50, $plain = true)

Performs the same function as the big summary, but doesn't trim new paragraphs off data.

Caution: Not XML/HTML-safe - does not respect closing tags.

Parameters

$maxWords
$plain

in Text at line 197
FirstParagraph($plain = 1)

Caution: Not XML/HTML-safe - does not respect closing tags.

Parameters

$plain

in Text at line 236
string ContextSummary(int $characters = 500, boolean $string = false, boolean $striphtml = true, boolean $highlight = true, String $prefix = "... ", String $suffix = "...")

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

Parameters

int $characters Number of characters in the summary
boolean $string Supplied string ("keywords")
boolean $striphtml Strip HTML?
boolean $highlight Add a highlight element around search query?
String $prefix prefix text
String $suffix suffix

Return Value

string

in Text at line 287
string Parse($parser = "TextParser")

Allows a sub-class of TextParser to be rendered.

Parameters

$parser

Return Value

string

See also

TextParser for implementation details.

at line 42
bool getProcessShortcodes()

Check if shortcodes are enabled

Return Value

bool

at line 52
$this setProcessShortcodes(bool $process)

Set shortcodes on or off by default

Parameters

bool $process

Return Value

$this

at line 231
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)