class PermissionCheckboxSetField extends FormField

Shows a categorized list of available permissions (through {@link Permission::get_codes()}).

Permissions which are assigned to a given {@link Group} record (either directly, inherited from parent groups, or through a {@link PermissionRole}) will be checked automatically. All checkboxes for "inherited" permissions will be readonly.

The field can gets its assignment data either from {@link Group} or {@link PermissionRole} records.

Traits

Form component which contains a castable message
Allows an object to have extensions applied to it.
A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Allows an object to declare a set of custom methods

Constants

SCHEMA_DATA_TYPE_STRING

SCHEMA_DATA_TYPE_HIDDEN

SCHEMA_DATA_TYPE_TEXT

SCHEMA_DATA_TYPE_HTML

SCHEMA_DATA_TYPE_INTEGER

SCHEMA_DATA_TYPE_DECIMAL

SCHEMA_DATA_TYPE_MULTISELECT

SCHEMA_DATA_TYPE_SINGLESELECT

SCHEMA_DATA_TYPE_DATE

SCHEMA_DATA_TYPE_DATETIME

SCHEMA_DATA_TYPE_TIME

SCHEMA_DATA_TYPE_BOOLEAN

SCHEMA_DATA_TYPE_CUSTOM

SCHEMA_DATA_TYPE_STRUCTURAL

Methods

mixed
__call(string $method, array $arguments)

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

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

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

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

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

Get extra config sources for this class

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

Return TRUE if a class has a specified extension.

array
invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

bool
hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

getExtensionInstances()

Get all extension instances for this specific object instance.

static Injectable
create(array $args)

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

static Injectable
singleton(string $class = null)

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

static Config_ForClass
config()

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

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

__construct(string $name, null|string $title, String $managedClass, String $filterField, Group|SS_List $records = null)

No description

bool
__isset(string $property)

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

mixed
__get(string $property)

Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.

__set(string $property, mixed $value)

Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.

setFailover(ViewableData $failover)

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

getFailover()

Get the current failover object if set

bool
hasField(string $field)

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

mixed
getField(string $field)

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

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

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

defineMethods()

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

customise(array|ViewableData $data)

Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.

bool
exists()

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

string
__toString()

No description

getCustomisedObj()

No description

setCustomisedObj(ViewableData $object)

No description

string
castingHelper(string $field)

Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.

from FormField
string
castingClass(string $field)

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

string
escapeTypeForField(string $field)

Return the string-format type for the given field.

renderWith(string|array|SSViewer $template, array $customFields = null)

Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance

Object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)

Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.

Object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)

A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.

bool
hasValue(string $field, array $arguments = [], bool $cache = true)

Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.

string
XML_val(string $field, array $arguments = [], bool $cache = false)

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

array
getXMLValues(array $fields)

Get an array of XML-escaped values by field name

getIterator()

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

array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Me()

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

string
ThemeDir() deprecated

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

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

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

Debug()

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

handleRequest(HTTPRequest $request)

Handles URL requests.

array|null
allowedActions(string $limitToClass = null)

Get a array of allowed actions defined on this controller, any parent classes or extensions.

bool
hasAction(string $action)

Checks if this request handler has a specific action, even if the current user cannot access it.

bool
checkAccessAction(string $action)

Check that the given action is allowed to be called from a URL.

httpError(int $errorCode, string $errorMessage = null)

Throws a HTTP error response encased in a {@link HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.

getRequest()

Returns the HTTPRequest object that this controller is using.

$this
setRequest(HTTPRequest $request)

Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.

string
Link(string $action = null)

Return a link to this field

from FormField
redirect(string $url, int $code = 302)

Redirect to the given URL.

string
getBackURL()

Safely get the value of the BackURL param, if provided via querystring / posted var

string
getReferer()

Get referer

redirectBack()

Redirect back. Uses either the HTTP-Referer or a manually set request-variable called "BackURL".

string
getMessage()

Returns the field message, used by form validation.

string
getMessageType()

Returns the field message type.

string
getMessageCast()

Casting type for this message. Will be 'text' or 'html'

$this
setMessage(string $message, string $messageType = ValidationResult::TYPE_ERROR, string $messageCast = ValidationResult::CAST_TEXT)

Sets the error message to be displayed on the form field.

array|null
getSchemaMessage()

Get form schema encoded message

static string
name_to_label(string $fieldName)

Takes a field name and converts camelcase to spaced words. Also resolves combined field names with dot syntax to spaced words.

from FormField
string
ID()

Returns the HTML ID of the field.

from FormField
string
HolderID()

Returns the HTML ID for the form field holder element.

from FormField
getTemplateHelper()

Returns the current {@link FormTemplateHelper} on either the parent Form or the global helper set through the {@link Injector} layout.

from FormField
string
getName()

Returns the field name.

from FormField
string
getInputType()

Returns the field input name.

from FormField
mixed
Value()

Returns the field value.

from FormField
saveInto(DataObjectInterface $record)

Update the permission set associated with $record DataObject

mixed
dataValue()

Returns the field value suitable for insertion into the data object.

from FormField
string
Title()

Returns the field label - used by templates.

from FormField
$this
setTitle(string $title)

Set the title of this formfield.

from FormField
string
RightTitle()

Gets the contextual label than can be used for additional field description.

from FormField
$this
setRightTitle(string|DBField $rightTitle)

Sets the right title for this formfield

from FormField
string
LeftTitle()

No description

from FormField
$this
setLeftTitle(string $leftTitle)

No description

from FormField
string
extraClass()

Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.

from FormField
$this
addExtraClass(string $class)

Add one or more CSS-classes to the FormField container.

from FormField
$this
removeExtraClass(string $class)

Remove one or more CSS-classes from the FormField container.

from FormField
$this
setAttribute(string $name, string $value)

Set an HTML attribute on the field element, mostly an input tag.

from FormField
string
getAttribute(string $name)

Get an HTML attribute defined by the field, or added through {@link setAttribute()}.

from FormField
array
getAttributes()

Allows customization through an 'updateAttributes' hook on the base class.

from FormField
string
getAttributesHTML(array $attributes = null)

Custom attributes to process. Falls back to {@link getAttributes()}.

from FormField
string
attrTitle()

Returns a version of a title suitable for insertion into an HTML attribute.

from FormField
string
attrValue()

Returns a version of a title suitable for insertion into an HTML attribute.

from FormField
$this
setValue(mixed $value, array|DataObject $data = null)

Set the field value.

from FormField
$this
setSubmittedValue(mixed $value, array|DataObject $data = null)

Set value assigned from a submitted form postback.

from FormField
$this
setName(string $name)

Set the field name.

from FormField
$this
setInputType(string $type)

Set the field input type.

from FormField
$this
setForm(Form $form)

Set the container form.

from FormField
getForm()

Get the currently used form.

from FormField
bool
securityTokenEnabled()

Return true if security token protection is enabled on the parent {@link Form}.

from FormField
$this
setCustomValidationMessage(string $customValidationMessage)

Set the custom error message to show instead of the default format.

from FormField
string
getCustomValidationMessage()

Get the custom error message for this form field. If a custom message has not been defined then just return blank. The default error is defined on {@link Validator}.

from FormField
$this
setTemplate(string $template)

Set name of template (without path or extension).

from FormField
string
getTemplate()

No description

from FormField
string
getFieldHolderTemplate()

No description

from FormField
$this
setFieldHolderTemplate(string $fieldHolderTemplate)

Set name of template (without path or extension) for the holder, which in turn is responsible for rendering {@link Field()}.

from FormField
string
getSmallFieldHolderTemplate()

No description

from FormField
$this
setSmallFieldHolderTemplate(string $smallFieldHolderTemplate)

Set name of template (without path or extension) for the small holder, which in turn is responsible for rendering {@link Field()}.

from FormField
Field(array $properties = array())

No description

FieldHolder(array $properties = array())

Returns a "field holder" for this field.

from FormField
string
SmallFieldHolder(array $properties = array())

Returns a restricted field holder used within things like FieldGroups.

from FormField
array
getTemplates()

Returns an array of templates to use for rendering {@link FieldHolder}.

from FormField
array
getFieldHolderTemplates()

Returns an array of templates to use for rendering {@link FieldHolder}.

from FormField
array
getSmallFieldHolderTemplates()

Returns an array of templates to use for rendering {@link SmallFieldHolder}.

from FormField
bool
isComposite()

Returns true if this field is a composite field.

from FormField
bool
hasData()

Returns true if this field has its own data.

from FormField
bool
isReadonly()

No description

from FormField
$this
setReadonly(bool $readonly)

Sets a read-only flag on this FormField.

from FormField
bool
isDisabled()

No description

from FormField
$this
setDisabled(bool $disabled)

Sets a disabled flag on this FormField.

from FormField
bool
isAutofocus()

No description

from FormField
$this
setAutofocus(bool $autofocus)

Sets a autofocus flag on this FormField.

from FormField
performDisabledTransformation()

Return a disabled version of this field.

from FormField
mixed
transform(FormTransformation $transformation)

No description

from FormField
bool
hasClass(string $class)

Returns whether the current field has the given class added

from FormField
string
Type()

Returns the field type.

from FormField
bool
validate(Validator $validator)

Abstract method each {@link FormField} subclass must implement, determines whether the field is valid or not based on the value.

from FormField
$this
setDescription(string $description)

Describe this field, provide help text for it.

from FormField
string
getDescription()

No description

from FormField
string
debug()

No description

from FormField
string
forTemplate()

This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.

from FormField
bool
Required()

No description

from FormField
$this
setContainerFieldList(FieldList $containerFieldList)

Set the FieldList that contains this field.

from FormField
getContainerFieldList()

Get the FieldList that contains this field.

from FormField
null|FieldList
rootFieldList()

No description

from FormField
castedCopy(mixed $classOrCopy)

Returns another instance of this field, but "cast" to a different class. The logic tries to retain all of the instance properties, and may be overloaded by subclasses to set additional ones.

from FormField
bool
canSubmitValue()

Determine if the value of this formfield accepts front-end submitted values and is saveable.

from FormField
setSchemaComponent(string $componentType)

Sets the component type the FormField will be rendered as on the front-end.

from FormField
string
getSchemaComponent()

Gets the type of front-end component the FormField will be rendered as.

from FormField
setSchemaData(array $schemaData = [])

Sets the schema data used for rendering the field on the front-end.

from FormField
array
getSchemaData()

Gets the schema data used to render the FormField on the front-end.

from FormField
string
getSchemaDataType()

No description

from FormField
array
getSchemaDataDefaults()

Gets the defaults for $schemaData.

from FormField
setSchemaState(array $schemaState = [])

Sets the schema data used for rendering the field on the front-end.

from FormField
array
getSchemaState()

Gets the schema state used to render the FormField on the front-end.

from FormField
array
getSchemaStateDefaults()

Gets the defaults for $schemaState.

from FormField
array
getSchemaValidation()

Return list of validation rules. Each rule is a key value pair.

from FormField
setHiddenPermissions(array $codes)

No description

array
getHiddenPermissions()

No description

Details

in CustomMethods at line 47
mixed __call(string $method, array $arguments)

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

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

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

in CustomMethods at line 146
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 CustomMethods at line 176
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 Extensible at line 172
static bool add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).

Parameters

string $classOrExtension Class that should be extended - has to be a subclass of {@link Object}
string $extension Subclass of {@link Extension} with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool Flag if the extension was added

See also

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

in Extensible at line 236
static remove_extension(string $extension)

Remove an extension from a class.

Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.

Parameters

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

in Extensible at line 278
static array get_extensions(string $class = null, bool $includeArgumentString = false)

Parameters

string $class If omitted, will get extensions for the current class
bool $includeArgumentString Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

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

in Extensible at line 312
static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

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

Return Value

array|null

in Extensible at line 373
static bool has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

Return TRUE if a class has a specified extension.

This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

Parameters

string $classOrExtension Class to check extension for, or the extension name to check if the second argument is null.
string $requiredExtension If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.
boolean $strict if the extension has to match the required extension and not be a subclass

Return Value

bool Flag if the extension exists

in Extensible at line 415
array invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

Parameters

string $method the method name to call
mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array List of results with nulls filtered out

in Extensible at line 450
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

in Extensible at line 497
Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

in Extensible at line 526
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 Extensible at line 540
Extension[] getExtensionInstances()

Get all extension instances for this specific object instance.

See {@link get_extensions()} to get all applied extension classes for this class (not the instance).

This method also provides lazy-population of the extension_instances property.

Return Value

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

in Injectable at line 26
static Injectable create(array $args)

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

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

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

Parameters

array $args

Return Value

Injectable

in Injectable at line 43
static Injectable singleton(string $class = null)

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

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

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

Return Value

Injectable The singleton instance

in Configurable at line 20
static Config_ForClass config()

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

....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

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

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$this set_stat(string $name, mixed $value) deprecated

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

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

at line 51
__construct(string $name, null|string $title, String $managedClass, String $filterField, Group|SS_List $records = null)

Parameters

string $name The internal field name, passed to forms.
null|string $title The human-readable field label.
String $managedClass
String $filterField
Group|SS_List $records One or more {@link Group} or {@link PermissionRole} records used to determine permission checkboxes. Caution: saveInto() can only be used with a single record, all inherited permissions will be marked readonly. Setting multiple groups only makes sense in a readonly context. (Optional)

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

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

Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.

Parameters

string $property

Return Value

bool

in ViewableData at line 129
mixed __get(string $property)

Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.

Parameters

string $property

Return Value

mixed

in ViewableData at line 152
__set(string $property, mixed $value)

Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.

Parameters

string $property
mixed $value

in ViewableData at line 167
setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

in ViewableData at line 183
ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

in ViewableData at line 194
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 205
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 217
$this setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

Return Value

$this

in ViewableData at line 232
defineMethods()

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

Exceptions

LogicException

in ViewableData at line 258
ViewableData_Customised customise(array|ViewableData $data)

Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.

Note that any fields you specify will take precedence over the fields on this object.

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

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

in ViewableData at line 289
string __toString()

Return Value

string the class name

in ViewableData at line 297
ViewableData getCustomisedObj()

Return Value

ViewableData

in ViewableData at line 305
setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

in FormField at line 876
string castingHelper(string $field)

Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.

Parameters

string $field

Return Value

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

Exceptions

Exception

in ViewableData at line 352
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 365
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 389
DBHTMLText renderWith(string|array|SSViewer $template, array $customFields = null)

Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance

Parameters

string|array|SSViewer $template the template to render into
array $customFields fields to customise() the object with before rendering

Return Value

DBHTMLText

in ViewableData at line 471
Object|DBField obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)

Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.

Parameters

string $fieldName
array $arguments
bool $cache Cache this object
string $cacheName a custom cache name

Return Value

Object|DBField

in ViewableData at line 516
Object|DBField cachedCall(string $field, array $arguments = [], string $identifier = null)

A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.

Parameters

string $field
array $arguments
string $identifier an optional custom cache identifier

Return Value

Object|DBField

in ViewableData at line 530
bool hasValue(string $field, array $arguments = [], bool $cache = true)

Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

in ViewableData at line 545
string XML_val(string $field, array $arguments = [], bool $cache = false)

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

Parameters

string $field
array $arguments
bool $cache

Return Value

string

in ViewableData at line 558
array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields an array of field names

Return Value

array

in ViewableData at line 579
ArrayIterator getIterator()

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

This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.

Return Value

ArrayIterator

in ViewableData at line 592
array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

in ViewableData at line 603
ViewableData Me()

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

Return Value

ViewableData

in ViewableData at line 620
string ThemeDir() deprecated

deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead

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

This method is useful for things such as accessing theme images from your template without hardcoding the theme page - e.g. .

This method should only be used when a theme is currently active. However, it will fall over to the current project directory.

Return Value

string URL to the current theme

in ViewableData at line 647
string CSSClasses(string $stopAtClass = self::class)

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

This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".

Parameters

string $stopAtClass the class to stop at (default: ViewableData)

Return Value

string

in ViewableData at line 676
ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

in RequestHandler at line 149
HTTPResponse|RequestHandler|string|array handleRequest(HTTPRequest $request)

Handles URL requests.

  • ViewableData::handleRequest() iterates through each rule in {@link self::$url_handlers}.
    • If the rule matches, the named method will be called.
    • If there is still more URL to be processed, then handleRequest() is called on the object that that method returns.

Once all of the URL has been processed, the final result is returned. However, if the final result is an array, this array is interpreted as being additional template data to customise the 2nd to last result with, rather than an object in its own right. This is most frequently used when a Controller's action will return an array of data with which to customise the controller.

Parameters

HTTPRequest $request The object that is reponsible for distributing URL parsing

Return Value

HTTPResponse|RequestHandler|string|array

in RequestHandler at line 345
array|null allowedActions(string $limitToClass = null)

Get a array of allowed actions defined on this controller, any parent classes or extensions.

Caution: Since 3.1, allowed_actions definitions only apply to methods on the controller they're defined on, so it is recommended to use the $class argument when invoking this method.

Parameters

string $limitToClass

Return Value

array|null

in RequestHandler at line 382
bool hasAction(string $action)

Checks if this request handler has a specific action, even if the current user cannot access it.

Includes class ancestry and extensions in the checks.

Parameters

string $action

Return Value

bool

in RequestHandler at line 456
bool checkAccessAction(string $action)

Check that the given action is allowed to be called from a URL.

It will interrogate {@link self::$allowed_actions} to determine this.

Parameters

string $action

Return Value

bool

Exceptions

Exception

in RequestHandler at line 516
httpError(int $errorCode, string $errorMessage = null)

Throws a HTTP error response encased in a {@link HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.

Parameters

int $errorCode
string $errorMessage Plaintext error message

Exceptions

HTTPResponse_Exception

in RequestHandler at line 538
HTTPRequest getRequest()

Returns the HTTPRequest object that this controller is using.

Returns a placeholder {@link NullHTTPRequest} object unless {@link handleAction()} or {@link handleRequest()} have been called, which adds a reference to an actual {@link HTTPRequest} object.

Return Value

HTTPRequest

in RequestHandler at line 550
$this setRequest(HTTPRequest $request)

Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.

Parameters

HTTPRequest $request

Return Value

$this

Return a link to this field

Parameters

string $action Optional action

Return Value

string

Exceptions

LogicException If no form is set yet

in RequestHandler at line 589
HTTPResponse redirect(string $url, int $code = 302)

Redirect to the given URL.

Parameters

string $url
int $code

Return Value

HTTPResponse

in RequestHandler at line 601
string getBackURL()

Safely get the value of the BackURL param, if provided via querystring / posted var

Return Value

string

in RequestHandler at line 642
string getReferer()

Get referer

Return Value

string

in RequestHandler at line 661
HTTPResponse redirectBack()

Redirect back. Uses either the HTTP-Referer or a manually set request-variable called "BackURL".

This variable is needed in scenarios where HTTP-Referer is not sent (e.g when calling a page by location.href in IE). If none of the two variables is available, it will redirect to the base URL (see {@link Director::baseURL()}).

Return Value

HTTPResponse

in FormMessage at line 42
string getMessage()

Returns the field message, used by form validation.

Use {@link setError()} to set this property.

Return Value

string

in FormMessage at line 56
string getMessageType()

Returns the field message type.

Arbitrary value which is mostly used for CSS classes in the rendered HTML, e.g "required".

Use {@link setError()} to set this property.

Return Value

string

in FormMessage at line 66
string getMessageCast()

Casting type for this message. Will be 'text' or 'html'

Return Value

string

in FormMessage at line 81
$this setMessage(string $message, string $messageType = ValidationResult::TYPE_ERROR, string $messageCast = ValidationResult::CAST_TEXT)

Sets the error message to be displayed on the form field.

Allows HTML content, so remember to use Convert::raw2xml().

Parameters

string $message Message string
string $messageType Message type
string $messageCast

Return Value

$this

in FormMessage at line 117
array|null getSchemaMessage()

Get form schema encoded message

Return Value

array|null Message in array format, or null if no message

in FormField at line 305
static string name_to_label(string $fieldName)

Takes a field name and converts camelcase to spaced words. Also resolves combined field names with dot syntax to spaced words.

Examples:

  • 'TotalAmount' will return 'Total amount'
  • 'Organisation.ZipCode' will return 'Organisation zip code'

Parameters

string $fieldName

Return Value

string

in FormField at line 398
string ID()

Returns the HTML ID of the field.

The ID is generated as FormName_FieldName. All Field functions should ensure that this ID is included in the field.

Return Value

string

in FormField at line 408
string HolderID()

Returns the HTML ID for the form field holder element.

Return Value

string

in FormField at line 422
FormTemplateHelper getTemplateHelper()

Returns the current {@link FormTemplateHelper} on either the parent Form or the global helper set through the {@link Injector} layout.

To customize a single {@link FormField}, use {@link setTemplate} and provide a custom template name.

Return Value

FormTemplateHelper

in FormField at line 436
string getName()

Returns the field name.

Return Value

string

in FormField at line 446
string getInputType()

Returns the field input name.

Return Value

string

in FormField at line 457
mixed Value()

Returns the field value.

Return Value

mixed

See also

FormField::setSubmittedValue()

at line 295
saveInto(DataObjectInterface $record)

Update the permission set associated with $record DataObject

Parameters

DataObjectInterface $record DataObject to save data into

in FormField at line 481
mixed dataValue()

Returns the field value suitable for insertion into the data object.

Return Value

mixed

See also

Formfield::setValue()

in FormField at line 491
string Title()

Returns the field label - used by templates.

Return Value

string

in FormField at line 503
$this setTitle(string $title)

Set the title of this formfield.

Note: This expects escaped HTML.

Parameters

string $title Escaped HTML for title

Return Value

$this

in FormField at line 515
string RightTitle()

Gets the contextual label than can be used for additional field description.

Can be shown to the right or under the field in question.

Return Value

string Contextual label text

in FormField at line 526
$this setRightTitle(string|DBField $rightTitle)

Sets the right title for this formfield

Parameters

string|DBField $rightTitle Plain text string, or a DBField with appropriately escaped HTML

Return Value

$this

in FormField at line 535
string LeftTitle()

Return Value

string

in FormField at line 545
$this setLeftTitle(string $leftTitle)

Parameters

string $leftTitle

Return Value

$this

in FormField at line 561
string extraClass()

Compiles all CSS-classes. Optionally includes a "form-group--no-label" class if no title was set on the FormField.

Uses {@link Message()} and {@link MessageType()} to add validation error classes which can be used to style the contained tags.

Return Value

string

in FormField at line 598
$this addExtraClass(string $class)

Add one or more CSS-classes to the FormField container.

Multiple class names should be space delimited.

Parameters

string $class

Return Value

$this

in FormField at line 616
$this removeExtraClass(string $class)

Remove one or more CSS-classes from the FormField container.

Parameters

string $class

Return Value

$this

in FormField at line 646
$this setAttribute(string $name, string $value)

Set an HTML attribute on the field element, mostly an input tag.

Some attributes are best set through more specialized methods, to avoid interfering with built-in behaviour:

  • 'class': {@link addExtraClass()}
  • 'title': {@link setDescription()}
  • 'value': {@link setValue}
  • 'name': {@link setName}

Caution: this doesn't work on most fields which are composed of more than one HTML form field.

Parameters

string $name
string $value

Return Value

$this

in FormField at line 661
string getAttribute(string $name)

Get an HTML attribute defined by the field, or added through {@link setAttribute()}.

Caution: this doesn't work on all fields, see {@link setAttribute()}.

Parameters

string $name

Return Value

string

in FormField at line 679
array getAttributes()

Allows customization through an 'updateAttributes' hook on the base class.

Existing attributes are passed in as the first argument and can be manipulated, but any attributes added through a subclass implementation won't be included.

Return Value

array

in FormField at line 713
string getAttributesHTML(array $attributes = null)

Custom attributes to process. Falls back to {@link getAttributes()}.

If at least one argument is passed as a string, all arguments act as excludes, by name.

Parameters

array $attributes

Return Value

string

in FormField at line 761
string attrTitle()

Returns a version of a title suitable for insertion into an HTML attribute.

Return Value

string

in FormField at line 771
string attrValue()

Returns a version of a title suitable for insertion into an HTML attribute.

Return Value

string

in FormField at line 786
$this setValue(mixed $value, array|DataObject $data = null)

Set the field value.

If a FormField requires specific behaviour for loading content from either the database or a submitted form value they should override setSubmittedValue() instead.

Parameters

mixed $value Either the parent object, or array of source data being loaded
array|DataObject $data {see Form::loadDataFrom}

Return Value

$this

in FormField at line 801
$this setSubmittedValue(mixed $value, array|DataObject $data = null)

Set value assigned from a submitted form postback.

Can be overridden to handle custom behaviour for user-localised data formats.

Parameters

mixed $value
array|DataObject $data

Return Value

$this

in FormField at line 813
$this setName(string $name)

Set the field name.

Parameters

string $name

Return Value

$this

in FormField at line 827
$this setInputType(string $type)

Set the field input type.

Parameters

string $type

Return Value

$this

in FormField at line 843
$this setForm(Form $form)

Set the container form.

This is called automatically when fields are added to forms.

Parameters

Form $form

Return Value

$this

in FormField at line 855
Form getForm()

Get the currently used form.

Return Value

Form

in FormField at line 865
bool securityTokenEnabled()

Return true if security token protection is enabled on the parent {@link Form}.

Return Value

bool

in FormField at line 894
$this setCustomValidationMessage(string $customValidationMessage)

Set the custom error message to show instead of the default format.

Different from setError() as that appends it to the standard error messaging.

Parameters

string $customValidationMessage

Return Value

$this

in FormField at line 907
string getCustomValidationMessage()

Get the custom error message for this form field. If a custom message has not been defined then just return blank. The default error is defined on {@link Validator}.

Return Value

string

in FormField at line 922
$this setTemplate(string $template)

Set name of template (without path or extension).

Caution: Not consistently implemented in all subclasses, please check the {@link Field()} method on the subclass for support.

Parameters

string $template

Return Value

$this

in FormField at line 932
string getTemplate()

Return Value

string

in FormField at line 940
string getFieldHolderTemplate()

Return Value

string

in FormField at line 956
$this setFieldHolderTemplate(string $fieldHolderTemplate)

Set name of template (without path or extension) for the holder, which in turn is responsible for rendering {@link Field()}.

Caution: Not consistently implemented in all subclasses, please check the {@link Field()} method on the subclass for support.

Parameters

string $fieldHolderTemplate

Return Value

$this

in FormField at line 966
string getSmallFieldHolderTemplate()

Return Value

string

in FormField at line 982
$this setSmallFieldHolderTemplate(string $smallFieldHolderTemplate)

Set name of template (without path or extension) for the small holder, which in turn is responsible for rendering {@link Field()}.

Caution: Not consistently implemented in all subclasses, please check the {@link Field()} method on the subclass for support.

Parameters

string $smallFieldHolderTemplate

Return Value

$this

at line 92
DBHTMLText Field(array $properties = array())

Parameters

array $properties

Return Value

DBHTMLText

in FormField at line 1035
DBHTMLText FieldHolder(array $properties = array())

Returns a "field holder" for this field.

Forms are constructed by concatenating a number of these field holders.

The default field holder is a label and a form field inside a div.

Parameters

array $properties

Return Value

DBHTMLText

See also

FieldHolder.ss

in FormField at line 1053
string SmallFieldHolder(array $properties = array())

Returns a restricted field holder used within things like FieldGroups.

Parameters

array $properties

Return Value

string

in FormField at line 1069
array getTemplates()

Returns an array of templates to use for rendering {@link FieldHolder}.

Return Value

array

in FormField at line 1079
array getFieldHolderTemplates()

Returns an array of templates to use for rendering {@link FieldHolder}.

Return Value

array

in FormField at line 1092
array getSmallFieldHolderTemplates()

Returns an array of templates to use for rendering {@link SmallFieldHolder}.

Return Value

array

in FormField at line 1127
bool isComposite()

Returns true if this field is a composite field.

To create composite field types, you should subclass {@link CompositeField}.

Return Value

bool

in FormField at line 1143
bool hasData()

Returns true if this field has its own data.

Some fields, such as titles and composite fields, don't actually have any data. It doesn't make sense for data-focused methods to look at them. By overloading hasData() to return false, you can prevent any data-focused methods from looking at it.

Return Value

bool

See also

FieldList::collateDataFields()

in FormField at line 1151
bool isReadonly()

Return Value

bool

in FormField at line 1167
$this setReadonly(bool $readonly)

Sets a read-only flag on this FormField.

Use performReadonlyTransformation() to transform this instance.

Setting this to false has no effect on the field.

Parameters

bool $readonly

Return Value

$this

in FormField at line 1176
bool isDisabled()

Return Value

bool

in FormField at line 1192
$this setDisabled(bool $disabled)

Sets a disabled flag on this FormField.

Use performDisabledTransformation() to transform this instance.

Setting this to false has no effect on the field.

Parameters

bool $disabled

Return Value

$this

in FormField at line 1202
bool isAutofocus()

Return Value

bool

in FormField at line 1213
$this setAutofocus(bool $autofocus)

Sets a autofocus flag on this FormField.

Parameters

bool $autofocus

Return Value

$this

at line 343
FormField performReadonlyTransformation()

Return Value

FormField

in FormField at line 1247
FormField performDisabledTransformation()

Return a disabled version of this field.

Tries to find a class of the class name of this field suffixed with "_Disabled", failing that, finds a method {@link setDisabled()}.

Return Value

FormField

in FormField at line 1267
mixed transform(FormTransformation $transformation)

Parameters

FormTransformation $transformation

Return Value

mixed

in FormField at line 1279
bool hasClass(string $class)

Returns whether the current field has the given class added

Parameters

string $class

Return Value

bool

in FormField at line 1296
string Type()

Returns the field type.

The field type is the class name with the word Field dropped off the end, all lowercase.

It's handy for assigning HTML classes. Doesn't signify the input type attribute.

Return Value

string

See also

{link getAttributes()}.

in FormField at line 1311
bool validate(Validator $validator)

Abstract method each {@link FormField} subclass must implement, determines whether the field is valid or not based on the value.

Parameters

Validator $validator

Return Value

bool

in FormField at line 1325
$this setDescription(string $description)

Describe this field, provide help text for it.

By default, renders as a span class="description" underneath the form field.

Parameters

string $description

Return Value

$this

in FormField at line 1335
string getDescription()

Return Value

string

in FormField at line 1343
string debug()

Return Value

string

in FormField at line 1362
string forTemplate()

This function is used by the template processor. If you refer to a field as a $ variable, it will return the $Field value.

Return Value

string

in FormField at line 1370
bool Required()

Return Value

bool

in FormField at line 1385
$this setContainerFieldList(FieldList $containerFieldList)

Set the FieldList that contains this field.

Parameters

FieldList $containerFieldList

Return Value

$this

in FormField at line 1396
FieldList getContainerFieldList()

Get the FieldList that contains this field.

Return Value

FieldList

in FormField at line 1404
null|FieldList rootFieldList()

Return Value

null|FieldList

in FormField at line 1434
FormField castedCopy(mixed $classOrCopy)

Returns another instance of this field, but "cast" to a different class. The logic tries to retain all of the instance properties, and may be overloaded by subclasses to set additional ones.

Assumes the standard FormField parameter signature with its name as the only mandatory argument. Mainly geared towards creating *_Readonly or *_Disabled subclasses of the same type, or casting to a {@link ReadonlyField}.

Does not copy custom field templates, since they probably won't apply to the new instance.

Parameters

mixed $classOrCopy Class name for copy, or existing copy instance to update

Return Value

FormField

in FormField at line 1465
bool canSubmitValue()

Determine if the value of this formfield accepts front-end submitted values and is saveable.

Return Value

bool

in FormField at line 1476
FormField setSchemaComponent(string $componentType)

Sets the component type the FormField will be rendered as on the front-end.

Parameters

string $componentType

Return Value

FormField

in FormField at line 1487
string getSchemaComponent()

Gets the type of front-end component the FormField will be rendered as.

Return Value

string

in FormField at line 1503
FormField setSchemaData(array $schemaData = [])

Sets the schema data used for rendering the field on the front-end.

Merges the passed array with the current $schemaData or {@link getSchemaDataDefaults()}. Any passed keys that are not defined in {@link getSchemaDataDefaults()} are ignored. If you want to pass around ad hoc data use the data array e.g. pass ['data' => ['myCustomKey' => 'yolo']].

Parameters

array $schemaData
  • The data to be merged with $this->schemaData.

Return Value

FormField

in FormField at line 1515
array getSchemaData()

Gets the schema data used to render the FormField on the front-end.

Return Value

array

in FormField at line 1526
string getSchemaDataType()

Return Value

string

in FormField at line 1538
array getSchemaDataDefaults()

Gets the defaults for $schemaData.

The keys defined here are immutable, meaning undefined keys passed to {@link setSchemaData()} are ignored. Instead the data array should be used to pass around ad hoc data.

Return Value

array

in FormField at line 1574
FormField setSchemaState(array $schemaState = [])

Sets the schema data used for rendering the field on the front-end.

Merges the passed array with the current $schemaState or {@link getSchemaStateDefaults()}. Any passed keys that are not defined in {@link getSchemaStateDefaults()} are ignored. If you want to pass around ad hoc data use the data array e.g. pass ['data' => ['myCustomKey' => 'yolo']].

Parameters

array $schemaState The data to be merged with $this->schemaData.

Return Value

FormField

in FormField at line 1586
array getSchemaState()

Gets the schema state used to render the FormField on the front-end.

Return Value

array

in FormField at line 1602
array getSchemaStateDefaults()

Gets the defaults for $schemaState.

The keys defined here are immutable, meaning undefined keys passed to {@link setSchemaState()} are ignored. Instead the data array should be used to pass around ad hoc data. Includes validation data if the field is associated to a {@link Form}, and {@link Form->validate()} has been called.

Return Value

array

in FormField at line 1622
array getSchemaValidation()

Return list of validation rules. Each rule is a key value pair.

The key is the rule name. The value is any information the frontend validation handler can understand, or just true to enable.

Return Value

array

at line 75
setHiddenPermissions(array $codes)

Parameters

array $codes

at line 83
array getHiddenPermissions()

Return Value

array