class Email extends ViewableData (View source)

Class to support sending emails.

Properties

static private array $extensions

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

from  SS_Object
string $class from  SS_Object
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 $admin_email

This will be set in the config on a site-by-site basis

static private string $send_all_emails_to

Send every email generated by the Email class to the given address.

static private string $send_all_emails_from

Send every email generated by the Email class from the given address.

static private string $bcc_all_emails_to
static private string $cc_all_emails_to

Methods

static Config_ForClass|null
config()

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

static SS_Object
create()

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

static SS_Object
singleton()

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

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

static 
parse_class_spec($classSpec)

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

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

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

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

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.

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static 
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)

Return TRUE if a class has a specified extension.

static 
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, bool $includeArgumentString = false)

No description

static 
get_extra_config_sources($class = null)

No description

__construct(string|null $from = null, string|null $to = null, string|null $subject = null, string|null $body = null, string|null $bounceHandlerURL = null, string|null $cc = null, string|null $bcc = null)

Create a new email.

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

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

stat($name, $uncached = false)

No description

set_stat($name, $value)

No description

uninherited($name)

No description

bool
exists()

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

string
parentClass()

No description

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

string
__toString()

No description

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

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

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.

array
getExtensionInstances()

Get all extension instances for this specific object instance.

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

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

Clears the cache for the given cacheToFile call

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.

defineMethods()

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

unknown
deprecatedCachedCall($method, $args = null, string $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.

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

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 Mailer
mailer()

Get the mailer.

static 
set_mailer(Mailer $mailer) deprecated

No description

$this
attachFileFromString(string $data, string $attachedFilename, string|null $mimeType = null)

Attach a file based on provided raw data.

setBounceHandlerURL($bounceHandlerURL) deprecated

No description

$this
attachFile(string $filename, string|null $attachedFilename = null, string|null $mimeType = null)

Attach the specified file to this email message.

string|null
Subject()

No description

string|null
Body()

No description

string|null
To()

No description

string|null
From()

No description

string|null
Cc()

No description

string|null
Bcc()

No description

$this
setSubject(string $val)

No description

$this
setBody(string $val)

No description

$this
setTo(string $val)

No description

$this
setFrom(string $val)

No description

$this
setCc(string $val)

No description

$this
setBcc(string $val)

No description

$this
setReplyTo(string $val)

Set the "Reply-To" header with an email address.

$this
replyTo(string $email) deprecated

No description

$this
addCustomHeader(string $headerName, string $headerValue)

Add a custom header to this email message. Useful for implementing all those cool features that we didn't think of.

string
BaseURL()

No description

string
debug()

Get an HTML string for debugging purposes.

$this
setTemplate(string $template)

Set template name (without *.ss extension).

string
getTemplate()

No description

bool
IsEmail()

Used by {@link SSViewer} templates to detect if we're rendering an email template rather than a page template

$this
populateTemplate(array|ViewableData $data)

Populate this email template with values. This may be called many times.

static bool
validEmailAddress(string $address) deprecated

No description

mixed
sendPlain(string $messageID = null)

Send the email in plaintext.

mixed
send(string $messageID = null)

Send an email with HTML content.

static 
setAdminEmail(string $newEmail) deprecated

Used as a default sender address in the {@link Email} class unless overwritten. Also shown to users on live environments as a contact address on system error pages.

static string
getAdminEmail() deprecated

No description

static 
send_all_emails_to($emailAddress) deprecated

Send every email generated by the Email class to the given address.

static 
cc_all_emails_to($emailAddress) deprecated

CC every email generated by the Email class to the given address.

static 
bcc_all_emails_to($emailAddress) deprecated

BCC every email generated by the Email class to the given address.

static bool
is_valid_address(string $email)

Validates the email address to get as close to RFC 822 compliant as possible.

static string
obfuscate(string $email, string $method = 'visible')

Encode an email-address to help protect it from spam bots. At the moment only simple string substitutions, which are not 100% safe from email harvesting.

Details

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

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

SS_Object

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

SS_Object

The singleton instance

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

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

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

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

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

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

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

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

deprecated

Parameters

$class
$name
$uncached

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

deprecated

Parameters

$class
$name
$value

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

deprecated

Parameters

$class
$name
$uncached

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

deprecated

Parameters

$class
$name
$ceiling

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

deprecated

Parameters

$class
$properties
$replace

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

deprecated

Parameters

$class
$name
$value
$replace

static 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

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

bool $strict

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

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

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

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.

static get_extra_config_sources($class = null)

Parameters

$class

__construct(string|null $from = null, string|null $to = null, string|null $subject = null, string|null $body = null, string|null $bounceHandlerURL = null, string|null $cc = null, string|null $bcc = null)

Create a new email.

Parameters

string|null $from
string|null $to
string|null $subject
string|null $body
string|null $bounceHandlerURL
string|null $cc
string|null $bcc

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

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

stat($name, $uncached = false)

Parameters

$name
$uncached

See also

SS_Object::get_static

set_stat($name, $value)

Parameters

$name
$value

See also

SS_Object::set_static

uninherited($name)

Parameters

$name

See also

SS_Object::uninherited_static

bool exists()

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

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

Return Value

bool

string parentClass()

Return Value

string

this classes parent class

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

string __toString()

Return Value

string

the class name

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

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 getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

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

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.

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

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

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

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

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

bool __isset(string $property)

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

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

setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

defineMethods()

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

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

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

Parameters

$method
$args
string $identifier

an optional custom cache identifier

Return Value

unknown

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

ViewableData getCustomisedObj()

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

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

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

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'

buildCastingCache(reference $cache)

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

Parameters

reference $cache

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

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

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

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

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

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

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

array getXMLValues($fields)

Get an array of XML-escaped values by field name

Parameters

$fields

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

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

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

ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

static Mailer mailer()

Get the mailer.

Return Value

Mailer

static set_mailer(Mailer $mailer) deprecated

deprecated since version 4.0

Parameters

Mailer $mailer

$this attachFileFromString(string $data, string $attachedFilename, string|null $mimeType = null)

Attach a file based on provided raw data.

Parameters

string $data

The raw file data (not encoded).

string $attachedFilename

Name of the file that should appear once it's sent as a separate attachment.

string|null $mimeType

MIME type to use when attaching file. If not provided, will attempt to infer via HTTP::get_mime_type().

Return Value

$this

setBounceHandlerURL($bounceHandlerURL) deprecated

deprecated since version 4.0

Parameters

$bounceHandlerURL

$this attachFile(string $filename, string|null $attachedFilename = null, string|null $mimeType = null)

Attach the specified file to this email message.

Parameters

string $filename

Relative or full path to file you wish to attach to this email message.

string|null $attachedFilename

Name of the file that should appear once it's sent as a separate attachment.

string|null $mimeType

MIME type to use when attaching file. If not provided, will attempt to infer via HTTP::get_mime_type().

Return Value

$this

string|null Subject()

Return Value

string|null

string|null Body()

Return Value

string|null

string|null To()

Return Value

string|null

string|null From()

Return Value

string|null

string|null Cc()

Return Value

string|null

string|null Bcc()

Return Value

string|null

$this setSubject(string $val)

Parameters

string $val

Return Value

$this

$this setBody(string $val)

Parameters

string $val

Return Value

$this

$this setTo(string $val)

Parameters

string $val

Return Value

$this

$this setFrom(string $val)

Parameters

string $val

Return Value

$this

$this setCc(string $val)

Parameters

string $val

Return Value

$this

$this setBcc(string $val)

Parameters

string $val

Return Value

$this

$this setReplyTo(string $val)

Set the "Reply-To" header with an email address.

Parameters

string $val

The email address of the "Reply-To" header

Return Value

$this

$this replyTo(string $email) deprecated

deprecated 4.0 Use the "setReplyTo" method instead

Parameters

string $email

Return Value

$this

$this addCustomHeader(string $headerName, string $headerValue)

Add a custom header to this email message. Useful for implementing all those cool features that we didn't think of.

IMPORTANT: If the specified header already exists, the provided value will be appended!

Parameters

string $headerName
string $headerValue

Return Value

$this

string BaseURL()

Return Value

string

string debug()

Get an HTML string for debugging purposes.

Return Value

string

$this setTemplate(string $template)

Set template name (without *.ss extension).

Parameters

string $template

Return Value

$this

string getTemplate()

Return Value

string

bool IsEmail()

Used by {@link SSViewer} templates to detect if we're rendering an email template rather than a page template

Return Value

bool

$this populateTemplate(array|ViewableData $data)

Populate this email template with values. This may be called many times.

Parameters

array|ViewableData $data

Return Value

$this

static bool validEmailAddress(string $address) deprecated

deprecated 4.0 Use the "is_valid_address" method instead

Parameters

string $address

Return Value

bool

mixed sendPlain(string $messageID = null)

Send the email in plaintext.

Parameters

string $messageID

Optional message ID so the message can be identified in bounces etc.

Return Value

mixed

Success of the sending operation from an MTA perspective. Doesn't actually give any indication if the mail has been delivered to the recipient properly). See Mailer->sendPlain() for return type details.

See also

send() for sending emails with HTML content.

mixed send(string $messageID = null)

Send an email with HTML content.

Parameters

string $messageID

Optional message ID so the message can be identified in bounces etc.

Return Value

mixed

Success of the sending operation from an MTA perspective. Doesn't actually give any indication if the mail has been delivered to the recipient properly). See Mailer->sendPlain() for return type details.

See also

sendPlain() for sending plaintext emails only.

static setAdminEmail(string $newEmail) deprecated

deprecated 4.0 Use the "Email.admin_email" config setting instead

Used as a default sender address in the {@link Email} class unless overwritten. Also shown to users on live environments as a contact address on system error pages.

Used by {@link Email->send()}, {@link Email->sendPlain()}, {@link Debug->friendlyError()}.

Parameters

string $newEmail

static string getAdminEmail() deprecated

deprecated 4.0 Use the "Email.admin_email" config setting instead

Return Value

string

static send_all_emails_to($emailAddress) deprecated

deprecated 4.0 Use the "Email.send_all_emails_to" config setting instead

Send every email generated by the Email class to the given address.

It will also add " [addressed to (email), cc to (email), bcc to (email)]" to the end of the subject line This can be used when testing, by putting a command like this in your _config.php file

if(!Director::isLive()) Email::send_all_emails_to("[email protected]")

Parameters

$emailAddress

static cc_all_emails_to($emailAddress) deprecated

deprecated 4.0 Use the "Email.cc_all_emails_to" config setting instead

CC every email generated by the Email class to the given address.

It won't affect the original delivery in the same way that send_all_emails_to does. It just adds a CC header with the given email address. Note that you can only call this once - subsequent calls will overwrite the configuration variable.

This can be used when you have a system that relies heavily on email and you want someone to be checking all correspondence.

if(Director::isLive()) Email::cc_all_emails_to("[email protected]")

Parameters

$emailAddress

static bcc_all_emails_to($emailAddress) deprecated

deprecated 4.0 Use the "Email.bcc_all_emails_to" config setting instead

BCC every email generated by the Email class to the given address.

It won't affect the original delivery in the same way that send_all_emails_to does. It just adds a BCC header with the given email address. Note that you can only call this once - subsequent calls will overwrite the configuration variable.

This can be used when you have a system that relies heavily on email and you want someone to be checking all correspondence.

if(Director::isLive()) Email::cc_all_emails_to("[email protected]")

Parameters

$emailAddress

static bool is_valid_address(string $email)

Validates the email address to get as close to RFC 822 compliant as possible.

Parameters

string $email

Return Value

bool

static string obfuscate(string $email, string $method = 'visible')

Encode an email-address to help protect it from spam bots. At the moment only simple string substitutions, which are not 100% safe from email harvesting.

Parameters

string $email

Email-address

string $method

Method for obfuscating/encoding the address

  • 'direction': Reverse the text and then use CSS to put the text direction back to normal
  • 'visible': Simple string substitution ('@' to '[at]', '.' to '[dot], '-' to [dash])
  • 'hex': Hexadecimal URL-Encoding - useful for mailto: links

Return Value

string