class DMSUploadField extends UploadField (View source)

Field for uploading files into a DMSDocument. Replacing the existing file.

Not ideally suited for the purpose, as the base implementation assumes to operate on a File record. We only use this as a temporary container, which gets deleted as soon as the actual DMSDocument is created.

NOTE: this Field will call write() on the supplied record

Properties

public string $class from  SS_Object
protected array $extension_instances from  SS_Object
protected $beforeExtendCallbacks

List of callbacks to call prior to extensions having extend called on them, each grouped by methodName.

from  SS_Object
protected $afterExtendCallbacks

List of callbacks to call after extensions having extend called on them, each grouped by methodName.

from  SS_Object
protected ViewableData $failover

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

from  ViewableData
protected ViewableData $customisedObject from  ViewableData
protected SS_HTTPRequest $request from  RequestHandler
protected $model

The DataModel for this request

from  RequestHandler
protected bool $brokenOnConstruct

This variable records whether RequestHandler::construct() was called or not. Useful for checking if subclasses have called parent::construct()

from  RequestHandler
protected Form $form from  FormField
protected string $name from  FormField
protected null|string $title from  FormField
protected mixed $value from  FormField
protected string $message from  FormField
protected string $messageType from  FormField
protected string $extraClass from  FormField
protected string $description

Adds a title attribute to the markup.

from  FormField
protected array $extraClasses

Extra CSS classes for the FormField container.

from  FormField
public bool $dontEscape from  FormField
protected string $rightTitle

Right-aligned, contextual label for the field.

from  FormField
protected string $leftTitle

Left-aligned, contextual label for the field.

from  FormField
protected FieldList $containerFieldList

Stores a reference to the FieldList that contains this object.

from  FormField
protected bool $readonly from  FormField
protected bool $disabled from  FormField
protected string $customValidationMessage

Custom validation message for the field.

from  FormField
protected string $template

Name of the template used to render this form field. If not set, then will look up the class ancestry for the first matching template where the template name equals the class name.

from  FormField
protected string $fieldHolderTemplate

Name of the template used to render this form field. If not set, then will look up the class ancestry for the first matching template where the template name equals the class name.

from  FormField
protected string $smallFieldHolderTemplate from  FormField
protected array $attributes

All attributes on the form field (not the field holder).

from  FormField
public bool $relationAutoSetting

Flag to automatically determine and save a has_one-relationship on the saved record (e.g. a "Player" has_one "PlayerImage" would trigger saving the ID of newly created file into "PlayerImageID" on the record).

from  FileField
protected Upload $upload

Upload object (needed for validation and actually moving the temporary file created by PHP).

from  FileField
protected string $folderName

The temporary folder name to store files in during upload

protected string $templateFileButtons

Template to use for the file button widget

from  UploadField
protected string $templateFileEdit

Template to use for the edit form

from  UploadField
protected DataObject $record

Parent data record. Will be infered from parent form or controller if blank.

from  UploadField
protected SS_List $items

Items loaded into this field. May be a RelationList, or any other SS_List

from  UploadField
protected array $ufConfig

Config for this field used in the front-end javascript (will be merged into the config of the javascript file upload plugin).

from  UploadField
protected string $displayFolderName from  UploadField
protected FieldList|string $fileEditFields

FieldList $fields or string $name (of a method on File to provide a fields) for the EditForm

from  UploadField
protected FieldList|string $fileEditActions

FieldList $actions or string $name (of a method on File to provide a actions) for the EditForm

from  UploadField
protected RequiredFields|string $fileEditValidator

Validator (eg RequiredFields) or string $name (of a method on File to provide a Validator) for the EditForm

from  UploadField

Methods

public static 
config()

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

protected
beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

protected
afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

public static 
create()

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

public static 
singleton()

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

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

public static 
parse_class_spec($classSpec)

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

public static 
strong_create()

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

public 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 Object::create()

public 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

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

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Return TRUE if a class has a specified extension.

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

Add an extension to a specific class.

public static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

public static 
get_extra_config_sources($class = null)

No description

public
__construct(string $name, null|string $title = null, SS_List $items = null)

Construct a new UploadField instance

public
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

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

public
defineMethods()

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

protected
array
findMethodsFromExtension(object $extension)

No description

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

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

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

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

protected
addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

protected
createMethod(string $method, string $code)

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

public
stat($name, $uncached = false)

No description

public
set_stat($name, $value)

No description

public
uninherited($name)

No description

public
bool
exists()

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

public
string
parentClass()

No description

public
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

public
string
__toString()

No description

public
mixed
invokeWithExtensions(string $method, mixed $argument = null)

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

public
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

public
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

public
bool
hasExtension(string $extension)

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

public
array
getExtensionInstances()

Get all extension instances for this specific object instance.

public
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

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

Clears the cache for the given cacheToFile call

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

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

protected
saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

protected
string
sanitiseCachename(string $name)

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

public 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);".

public 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 castingObjectCreator for more information about the constructor.

public
bool
__isset(string $property)

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

public
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 ViewableData::getField(), then fall back on a failover object.

public
__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 ViewableData::setField() method.

public
setFailover(ViewableData $failover)

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

public
getFailover()

Get the current failover object if set

public
bool
hasField(string $field)

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

public
mixed
getField(string $field)

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

public
setField(string $field, mixed $value)

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

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

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

public
customise(array|ViewableData $data)

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

public
getCustomisedObj()

No description

public
setCustomisedObj(ViewableData $object)

No description

public
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 ViewableData::castingHelper() for information on casting helpers).

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

public
string
castingClass(string $field)

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

public
string
escapeTypeForField(string $field)

Return the string-format type for the given field.

public
buildCastingCache(reference $cache)

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

public
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

protected
objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

protected
mixed
objCacheGet(string $key)

Get a cached value from the field cache

protected
objCacheSet(string $key, mixed $value)

Store a value in the field cache

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

public
cachedCall(string $field, array $arguments = null, string $identifier = null)

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

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

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

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

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

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

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

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

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

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

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

public
array
getXMLValues($fields)

Get an array of XML-escaped values by field name

public
getIterator()

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

public
Me()

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

public
string
ThemeDir(string $subtheme = false)

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

public
string
CSSClasses(string $stopAtClass = 'ViewableData')

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

public
Debug()

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

public
setDataModel($model)

Set the DataModel for this request.

public
handleRequest(SS_HTTPRequest $request, DataModel $model)

Handles URL requests.

protected
findAction($request)

No description

protected
handleAction($request, $action)

Given a request, and an action name, call that action name on this RequestHandler

public
array|null
allowedActions(string $limitToClass = null)

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

public
bool
hasAction(string $action)

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

protected
definingClassForAction($actionOrigCasing)

Return the class that defines the given action, so that we know where to check allowed_actions.

public
checkAccessAction($action)

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

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

Throws a HTTP error response encased in a SS_HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.

public
getRequest()

Returns the SS_HTTPRequest object that this controller is using.

public
setRequest($request)

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

public
string
Link(string $action = null)

Return a link to this field.

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

public static 
string
create_tag(string $tag, array $attributes, null|string $content = null)

Construct and return HTML tag.

protected
setupDefaultClasses()

Set up the default classes for the form. This is done on construct so that the default classes can be removed after instantiation

public
string
ID()

Returns the HTML ID of the field.

public
string
HolderID()

Returns the HTML ID for the form field holder element.

public
getTemplateHelper()

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

public
string
getName()

Returns the field name.

public
string
Message()

Returns the field message, used by form validation.

public
string
MessageType()

Returns the field message type.

public
mixed
Value()

Returns the field value.

public
saveInto(DataObjectInterface $record)

Method to save this form field into the given DataObject.

public
mixed
dataValue()

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

public
string
Title()

Returns the field label - used by templates.

public
$this
setTitle(string $title)

No description

public
string
RightTitle()

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

public
$this
setRightTitle(string $rightTitle)

No description

public
string
LeftTitle()

No description

public
$this
setLeftTitle(string $leftTitle)

No description

public
string
extraClass()

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

public
$this
addExtraClass(string $class)

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

public
$this
removeExtraClass(string $class)

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

public
$this
setAttribute(string $name, string $value)

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

public
null|string
getAttribute($name)

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

public
array
getAttributes()

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

public
string
getAttributesHTML(array $attributes = null)

Custom attributes to process. Falls back to getAttributes().

public
string
attrTitle()

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

public
string
attrValue()

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

public
$this
setValue(mixed $value, array|DataObject|SS_List $record = null)

Loads the related record values into this field. UploadField can be uploaded in one of three ways:

public
$this
setName(string $name)

Set the field name.

public
$this
setForm(Form $form)

Set the container form.

public
getForm()

Get the currently used form.

public
bool
securityTokenEnabled()

Return true if security token protection is enabled on the parent Form.

public
$this
setError(string $message, string $messageType)

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

public
$this
setCustomValidationMessage(string $customValidationMessage)

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

public
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 Validator.

public
$this
setTemplate(string $template)

Set name of template (without path or extension).

public
string
getTemplate()

No description

public
string
getFieldHolderTemplate()

No description

public
$this
setFieldHolderTemplate(string $fieldHolderTemplate)

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

public
string
getSmallFieldHolderTemplate()

No description

public
$this
setSmallFieldHolderTemplate(string $smallFieldHolderTemplate)

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

public
string
Field(array $properties = array())

No description

public
string
FieldHolder(array $properties = array())

Returns a "field holder" for this field.

public
string
SmallFieldHolder(array $properties = array())

Returns a restricted field holder used within things like FieldGroups.

public
array
getTemplates()

Returns an array of templates to use for rendering FieldHolder.

public
array
getFieldHolderTemplates()

Returns an array of templates to use for rendering FieldHolder.

public
array
getSmallFieldHolderTemplates()

Returns an array of templates to use for rendering SmallFieldHolder.

public
bool
isComposite()

Returns true if this field is a composite field.

public
bool
hasData()

Returns true if this field has its own data.

public
bool
isReadonly()

No description

public
$this
setReadonly(bool $readonly)

Sets a read-only flag on this FormField.

public
bool
isDisabled()

No description

public
$this
setDisabled(bool $disabled)

Sets a disabled flag on this FormField.

public
performReadonlyTransformation()

Returns a read-only version of this field.

public
performDisabledTransformation()

Return a disabled version of this field.

public
mixed
transform(FormTransformation $transformation)

No description

public
int
hasClass(string $class)

No description

public
string
Type()

Returns the field type.

public
string
createTag(string $tag, array $attributes, null|string $content = null) deprecated

No description

public
bool
validate(Validator $validator)

Validation method for this field, called when the entire form is validated

public
$this
setDescription(string $description)

Describe this field, provide help text for it.

public
string
getDescription()

No description

public
string
debug()

No description

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

public
bool
Required()

No description

public
setContainerFieldList(FieldList $containerFieldList)

Set the FieldList that contains this field.

public
getContainerFieldList()

Get the FieldList that contains this field.

public
null|FieldList
rootFieldList()

No description

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

public
bool
canSubmitValue()

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

public
getValidator()

Get custom validator for this field

public
$this
setValidator(Upload_Validator $validator)

Set custom validator for this field

public
$this
setFolderName(string $folderName)

Set the folder name to store DMS files in

public
string
getFolderName()

Get the folder name for storing the document

public
getUpload()

Retrieves the Upload handler

public
setUpload(Upload $upload)

Sets the upload handler

public
$this
setAllowedExtensions(array $rules)

Limit allowed file extensions. Empty by default, allowing all extensions.

public
$this
setAllowedFileCategories(string $category)

Limit allowed file extensions by specifying categories of file types.

public
array
getAllowedExtensions()

Returns list of extensions allowed by this field, or an empty array if there is no restriction

public
setTemplateFileButtons($template)

Set name of template used for Buttons on each file (replace, edit, remove, delete) (without path or extension)

public
string
getTemplateFileButtons()

No description

public
setTemplateFileEdit($template)

Set name of template used for the edit (inline & popup) of a file file (without path or extension)

public
string
getTemplateFileEdit()

No description

public
bool
canPreviewFolder()

Determine if the target folder for new uploads in is visible the field UI.

public
setCanPreviewFolder(bool|string $canPreviewFolder)

Determine if the target folder for new uploads in is visible the field UI.

public
bool
getOverwriteWarning()

Determine if the field should show a warning when overwriting a file.

public
setOverwriteWarning(bool $overwriteWarning)

Determine if the field should show a warning when overwriting a file.

public
setDisplayFolderName($name)

No description

public
string
getDisplayFolderName()

No description

public
setRecord(DataObject $record)

Force a record to be used as "Parent" for uploaded Files (eg a Page with a has_one to File)

public
getRecord()

Get the record to use as "Parent" for uploaded Files (eg a Page with a has_one to File) If none is set, it will use Form->getRecord() or Form->Controller()->data()

public
setItems(SS_List $items)

Sets the items assigned to this field as an SS_List of File objects.

public
getItems()

Never directly display items uploaded

public
getCustomisedItems()

Retrieves a customised list of all File records to ensure they are properly viewable when rendered in the field template.

public
array
getItemIDs()

Retrieves the list of selected file IDs

protected
customiseFile(File $file)

Customises a file with additional details suitable for rendering in the UploadField.ss template

public
setConfig(string $key, mixed $val)

Assign a front-end config variable for the upload field

public
mixed
getConfig(string $key)

Gets a front-end config variable for the upload field

public
bool
getAutoUpload()

Determine if the field should automatically upload the file.

public
setAutoUpload(bool $autoUpload)

Determine if the field should automatically upload the file

public
int|null
getAllowedMaxFileNumber()

Determine maximum number of files allowed to be attached Defaults to 1 for has_one and null (unlimited) for many_many and has_many relations.

public
setAllowedMaxFileNumber(int|null $allowedMaxFileNumber)

Determine maximum number of files allowed to be attached.

public
bool
canUpload()

Determine if the user has permission to upload.

public
setCanUpload(bool|string $canUpload)

Specify whether the user can upload files.

public
bool
canAttachExisting()

Determine if the user has permission to attach existing files By default returns true if the user has the CMS_ACCESS_AssetAdmin permission

public
bool
isActive()

Returns true if the field is neither readonly nor disabled

public
setCanAttachExisting(bool|string $canAttachExisting)

Specify whether the user can attach existing files String values will be treated as required permission codes

public
int
getPreviewMaxWidth()

Gets thumbnail width. Defaults to 80

public
setPreviewMaxWidth(int $previewMaxWidth)

No description

public
int
getPreviewMaxHeight()

Gets thumbnail height. Defaults to 60

public
setPreviewMaxHeight(int $previewMaxHeight)

No description

public
getUploadTemplateName()

javascript template used to display uploading files Defaults to 'ss-uploadfield-uploadtemplate'

public
setUploadTemplateName(string $uploadTemplateName)

No description

public
getDownloadTemplateName()

javascript template used to display already uploaded files Defaults to 'ss-downloadfield-downloadtemplate'

public
Uploadfield
setDownloadTemplateName(string $downloadTemplateName)

No description

public
getFileEditFields(File $file)

FieldList $fields for the EditForm

public
Uploadfield
setFileEditFields($fileEditFields)

FieldList $fields or string $name (of a method on File to provide a fields) for the EditForm

public
getFileEditActions(File $file)

FieldList $actions or string $name (of a method on File to provide a actions) for the EditForm

public
Uploadfield
setFileEditActions($fileEditActions)

FieldList $actions or string $name (of a method on File to provide a actions) for the EditForm

public
getFileEditValidator(File $file)

Determines the validator to use for the edit form

public
Uploadfield
setFileEditValidator($fileEditValidator)

Validator (eg RequiredFields) or string $name (of a method on File to provide a Validator) for the EditForm

protected
string
getThumbnailURLForFile(File $file)

No description

public
handleItem(SS_HTTPRequest $request)

No description

public
getItemHandler(int $itemID)

No description

public
handleSelect(SS_HTTPRequest $request)

No description

protected
array
extractUploadedFileData(array $postVars)

Given an array of post variables, extract all temporary file data into an array

protected
saveTemporaryFile(array $tmpFile, string $error = null)

Loads the temporary file data into a File object

protected
array
encodeFileAttributes(File $file)

Safely encodes the File object with all standard fields required by the front end

public
upload(SS_HTTPRequest $request)

Action to handle upload of a single file

public
attach(SS_HTTPRequest $request)

Retrieves details for files that this field wishes to attache to the client-side form

protected
bool
checkFileExists(string $originalFile)

Check if file exists, both checking filtered filename and exact filename

public
fileexists(SS_HTTPRequest $request)

Determines if a specified file exists

public
string
getRelationAutosetClass($default = 'File')

Gets the foreign class that needs to be created, or 'File' as default if there is no relationship, or it cannot be determined.

protected
attachFile($file)

Override the default behaviour of the UploadField and take the uploaded file (uploaded to assets) and add it into the DMS storage, deleting the old/uploaded file.

public
getDMSFileEditFields(File $file)

FieldList $fields for the EditForm

public
getDMSFileEditActions(File $file)

FieldList $actions or string $name (of a method on File to provide a actions) for the EditForm

public
getDMSFileEditValidator(File $file)

Determines the validator to use for the edit form

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

protected beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

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 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 Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using 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 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 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

No description

Parameters

$class
$name
$uncached

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

deprecated

No description

Parameters

$class
$name
$value

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

deprecated

No description

Parameters

$class
$name
$uncached

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

deprecated

No description

Parameters

$class
$name
$ceiling

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

deprecated

No description

Parameters

$class
$properties
$replace

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

deprecated

No description

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 Object::$extensions array. See 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 singleton()).

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of Object

string $extension

Subclass of 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 Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.

Add support for removing extensions with parameters

Parameters

string $extension

Classname of an Extension subclass, without parameters

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

No description

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

static get_extra_config_sources($class = null)

No description

Parameters

$class

__construct(string $name, null|string $title = null, SS_List $items = null)

Construct a new UploadField instance

Parameters

string $name

The internal field name, passed to forms.

null|string $title

The human-readable field label.

SS_List $items

If no items are defined, the field will try to auto-detect an existing relation on @link $record}, with the same name as the field name.

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

defineMethods()

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

protected array findMethodsFromExtension(object $extension)

No description

Parameters

object $extension

Return Value

array

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

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

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

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

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

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

protected addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

Parameters

string $method

the method name to wrap

string $wrap

the method name to wrap to

protected createMethod(string $method, string $code)

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

Parameters

string $method

the method name

string $code

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

stat($name, $uncached = false)

No description

Parameters

$name
$uncached

See also

SS_Object::get_static

set_stat($name, $value)

No description

Parameters

$name
$value

See also

SS_Object::set_static

uninherited($name)

No description

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 DataObject class could return false when it is deleted from the database

Return Value

bool

string parentClass()

No description

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

No description

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

integrate inheritance rules

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 __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 $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method 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 Extension subclass without parameters

Return Value

bool

array getExtensionInstances()

Get all extension instances for this specific object instance.

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

Return Value

array

Map of 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

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

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

Parameters

string $cache

the cache name

int $lifetime

the lifetime (in seconds) of the cache before it is invalid

Return Value

mixed

protected saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

Parameters

string $cache

the cache name

mixed $data

data to save (must be serializable)

protected string sanitiseCachename(string $name)

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

Parameters

string $name

Return Value

string

the name with all special cahracters replaced with underscores

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

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

No description

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

No description

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

protected objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName

Name of field

array $arguments

List of optional arguments given

protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key

Cache key

Return Value

mixed

protected objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key

Cache key

mixed $value

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

setDataModel($model)

Set the DataModel for this request.

Parameters

$model

SS_HTTPResponse|RequestHandler|string|array handleRequest(SS_HTTPRequest $request, DataModel $model)

Handles URL requests.

  • ViewableData::handleRequest() iterates through each rule in 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

SS_HTTPRequest $request

The SS_HTTPRequest object that is reponsible for distributing URL parsing

DataModel $model

Return Value

SS_HTTPResponse|RequestHandler|string|array

protected findAction($request)

No description

Parameters

$request

protected SS_HTTPResponse handleAction($request, $action)

Given a request, and an action name, call that action name on this RequestHandler

Must not raise SS_HTTPResponse_Exceptions - instead it should return

Parameters

$request
$action

Return Value

SS_HTTPResponse

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

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

protected definingClassForAction($actionOrigCasing)

Return the class that defines the given action, so that we know where to check allowed_actions.

Parameters

$actionOrigCasing

checkAccessAction($action)

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

It will interrogate self::$allowed_actions to determine this.

Parameters

$action

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

Throws a HTTP error response encased in a SS_HTTPResponse_Exception, which is later caught in RequestHandler::handleAction() and returned to the user.

Parameters

int $errorCode
string $errorMessage

Plaintext error message

SS_HTTPRequest|NullHTTPRequest getRequest()

Returns the SS_HTTPRequest object that this controller is using.

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

setRequest($request)

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

Parameters

$request

Return a link to this field.

Parameters

string $action

Return Value

string

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

static string create_tag(string $tag, array $attributes, null|string $content = null)

Construct and return HTML tag.

Parameters

string $tag
array $attributes
null|string $content

Return Value

string

protected setupDefaultClasses()

Set up the default classes for the form. This is done on construct so that the default classes can be removed after instantiation

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

string HolderID()

Returns the HTML ID for the form field holder element.

Return Value

string

FormTemplateHelper getTemplateHelper()

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

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

Return Value

FormTemplateHelper

string getName()

Returns the field name.

Return Value

string

string Message()

Returns the field message, used by form validation.

Use setError() to set this property.

Return Value

string

string MessageType()

Returns the field message type.

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

Use setError() to set this property.

Return Value

string

mixed Value()

Returns the field value.

Return Value

mixed

saveInto(DataObjectInterface $record)

Method to save this form field into the given DataObject.

By default, makes use of $this->dataValue()

Parameters

DataObjectInterface $record

DataObject to save data into

mixed dataValue()

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

Return Value

mixed

string Title()

Returns the field label - used by templates.

Return Value

string

$this setTitle(string $title)

No description

Parameters

string $title

Return Value

$this

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.

$this setRightTitle(string $rightTitle)

No description

Parameters

string $rightTitle

Return Value

$this

string LeftTitle()

No description

Return Value

string

$this setLeftTitle(string $leftTitle)

No description

Parameters

string $leftTitle

Return Value

$this

string extraClass()

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

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

Return Value

string

$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

$this removeExtraClass(string $class)

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

Parameters

string $class

Return Value

$this

$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': addExtraClass()
  • 'title': setDescription()
  • 'value': setValue
  • 'name': 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

null|string getAttribute($name)

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

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

Parameters

$name

Return Value

null|string

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

string getAttributesHTML(array $attributes = null)

Custom attributes to process. Falls back to getAttributes().

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

Parameters

array $attributes

Return Value

string

string attrTitle()

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

Return Value

string

string attrValue()

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

Return Value

string

$this setValue(mixed $value, array|DataObject|SS_List $record = null)

Loads the related record values into this field. UploadField can be uploaded in one of three ways:

  • By passing in a list of file IDs in the $value parameter (an array with a single key 'Files', with the value being the actual array of IDs).
    • By passing in an explicit list of File objects in the $record parameter, and leaving $value blank.
    • By passing in a dataobject in the $record parameter, from which file objects will be extracting using the field name as the relation field.

Each of these methods will update both the items (list of File objects) and the field value (list of file ID values).

Parameters

mixed $value
array|DataObject|SS_List $record

Full source record, either as a DataObject, SS_List of items, or an array of submitted form data

Return Value

$this

$this setName(string $name)

Set the field name.

Parameters

string $name

Return Value

$this

$this setForm(Form $form)

Set the container form.

This is called automatically when fields are added to forms.

Parameters

Form $form

Return Value

$this

Form getForm()

Get the currently used form.

Return Value

Form

bool securityTokenEnabled()

Return true if security token protection is enabled on the parent Form.

Return Value

bool

$this setError(string $message, string $messageType)

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

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

Parameters

string $message
string $messageType

Return Value

$this

$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

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

Return Value

string

$this setTemplate(string $template)

Set name of template (without path or extension).

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

Parameters

string $template

Return Value

$this

string getTemplate()

No description

Return Value

string

string getFieldHolderTemplate()

No description

Return Value

string

$this setFieldHolderTemplate(string $fieldHolderTemplate)

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

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

Parameters

string $fieldHolderTemplate

Return Value

$this

string getSmallFieldHolderTemplate()

No description

Return Value

string

$this setSmallFieldHolderTemplate(string $smallFieldHolderTemplate)

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

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

Parameters

string $smallFieldHolderTemplate

Return Value

$this

string Field(array $properties = array())

No description

Parameters

array $properties

Return Value

string

string 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

string

See also

FieldHolder.ss

string SmallFieldHolder(array $properties = array())

Returns a restricted field holder used within things like FieldGroups.

Parameters

array $properties

Return Value

string

array getTemplates()

Returns an array of templates to use for rendering FieldHolder.

Return Value

array

array getFieldHolderTemplates()

Returns an array of templates to use for rendering FieldHolder.

Return Value

array

array getSmallFieldHolderTemplates()

Returns an array of templates to use for rendering SmallFieldHolder.

Return Value

array

bool isComposite()

Returns true if this field is a composite field.

To create composite field types, you should subclass CompositeField.

Return Value

bool

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

bool isReadonly()

No description

Return Value

bool

$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

bool isDisabled()

No description

Return Value

bool

$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

FormField performReadonlyTransformation()

Returns a read-only version of this field.

Return Value

FormField

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

Return Value

FormField

mixed transform(FormTransformation $transformation)

No description

Parameters

FormTransformation $transformation

Return Value

mixed

int hasClass(string $class)

No description

Parameters

string $class

Return Value

int

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

string createTag(string $tag, array $attributes, null|string $content = null) deprecated

deprecated 4.0 Use FormField::create_tag()

No description

Parameters

string $tag
array $attributes
null|string $content

Return Value

string

bool validate(Validator $validator)

Validation method for this field, called when the entire form is validated

Parameters

Validator $validator

Return Value

bool

$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

string getDescription()

No description

Return Value

string

string debug()

No description

Return Value

string

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

bool Required()

No description

Return Value

bool

FieldList setContainerFieldList(FieldList $containerFieldList)

Set the FieldList that contains this field.

Parameters

FieldList $containerFieldList

Return Value

FieldList

FieldList getContainerFieldList()

Get the FieldList that contains this field.

Return Value

FieldList

null|FieldList rootFieldList()

No description

Return Value

null|FieldList

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

bool canSubmitValue()

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

Return Value

bool

Upload_Validator getValidator()

Get custom validator for this field

Return Value

Upload_Validator

$this setValidator(Upload_Validator $validator)

Set custom validator for this field

Parameters

Upload_Validator $validator

Return Value

$this

$this setFolderName(string $folderName)

Set the folder name to store DMS files in

Parameters

string $folderName

Return Value

$this

string getFolderName()

Get the folder name for storing the document

Return Value

string

Upload getUpload()

Retrieves the Upload handler

Return Value

Upload

FileField setUpload(Upload $upload)

Sets the upload handler

Parameters

Upload $upload

Return Value

FileField

Self reference

$this setAllowedExtensions(array $rules)

Limit allowed file extensions. Empty by default, allowing all extensions.

To allow files without an extension, use an empty string. See File::$allowed_extensions to get a good standard set of extensions that are typically not harmful in a webserver context. See setAllowedMaxFileSize() to limit file size by extension.

Parameters

array $rules

List of extensions

Return Value

$this

$this setAllowedFileCategories(string $category)

Limit allowed file extensions by specifying categories of file types.

These may be 'image', 'audio', 'mov', 'zip', 'flash', or 'doc' See File::$allowed_extensions for details of allowed extensions for each of these categories

Parameters

string $category

Category name

Return Value

$this

array getAllowedExtensions()

Returns list of extensions allowed by this field, or an empty array if there is no restriction

Return Value

array

setTemplateFileButtons($template)

Set name of template used for Buttons on each file (replace, edit, remove, delete) (without path or extension)

Parameters

$template

string getTemplateFileButtons()

No description

Return Value

string

setTemplateFileEdit($template)

Set name of template used for the edit (inline & popup) of a file file (without path or extension)

Parameters

$template

string getTemplateFileEdit()

No description

Return Value

string

bool canPreviewFolder()

Determine if the target folder for new uploads in is visible the field UI.

Return Value

bool

UploadField setCanPreviewFolder(bool|string $canPreviewFolder)

Determine if the target folder for new uploads in is visible the field UI.

Disable to keep the internal filesystem structure hidden from users.

Parameters

bool|string $canPreviewFolder

Either a boolean flag, or a required permission code

Return Value

UploadField

Self reference

bool getOverwriteWarning()

Determine if the field should show a warning when overwriting a file.

This requires Upload->replaceFile config to be set to true, otherwise files will be renamed instead of overwritten (although the warning will still be displayed)

Return Value

bool

UploadField setOverwriteWarning(bool $overwriteWarning)

Determine if the field should show a warning when overwriting a file.

This requires Upload->replaceFile config to be set to true, otherwise files will be renamed instead of overwritten (although the warning will still be displayed)

Parameters

bool $overwriteWarning

Return Value

UploadField

Self reference

setDisplayFolderName($name)

No description

Parameters

$name

string getDisplayFolderName()

No description

Return Value

string

setRecord(DataObject $record)

Force a record to be used as "Parent" for uploaded Files (eg a Page with a has_one to File)

Parameters

DataObject $record

DataObject getRecord()

Get the record to use as "Parent" for uploaded Files (eg a Page with a has_one to File) If none is set, it will use Form->getRecord() or Form->Controller()->data()

Return Value

DataObject

UploadField setItems(SS_List $items)

Sets the items assigned to this field as an SS_List of File objects.

Calling setItems will also update the value of this field, as well as updating the internal list of File items.

Parameters

SS_List $items

Return Value

UploadField

self reference

SS_List getItems()

Never directly display items uploaded

Return Value

SS_List

getCustomisedItems()

Retrieves a customised list of all File records to ensure they are properly viewable when rendered in the field template.

array getItemIDs()

Retrieves the list of selected file IDs

Return Value

array

protected ViewableData_Customised customiseFile(File $file)

Customises a file with additional details suitable for rendering in the UploadField.ss template

Parameters

File $file

Return Value

ViewableData_Customised

UploadField setConfig(string $key, mixed $val)

Assign a front-end config variable for the upload field

Parameters

string $key
mixed $val

Return Value

UploadField

self reference

See also

https://github.com/blueimp/jQuery-File-Upload/wiki/Options for the list of front end options available

mixed getConfig(string $key)

Gets a front-end config variable for the upload field

Parameters

string $key

Return Value

mixed

See also

https://github.com/blueimp/jQuery-File-Upload/wiki/Options for the list of front end options available

bool getAutoUpload()

Determine if the field should automatically upload the file.

Return Value

bool

UploadField setAutoUpload(bool $autoUpload)

Determine if the field should automatically upload the file

Parameters

bool $autoUpload

Return Value

UploadField

Self reference

int|null getAllowedMaxFileNumber()

Determine maximum number of files allowed to be attached Defaults to 1 for has_one and null (unlimited) for many_many and has_many relations.

Return Value

int|null

Maximum limit, or null for no limit

UploadField setAllowedMaxFileNumber(int|null $allowedMaxFileNumber)

Determine maximum number of files allowed to be attached.

Parameters

int|null $allowedMaxFileNumber

Maximum limit. 0 or null will be treated as unlimited

Return Value

UploadField

Self reference

bool canUpload()

Determine if the user has permission to upload.

Return Value

bool

UploadField setCanUpload(bool|string $canUpload)

Specify whether the user can upload files.

String values will be treated as required permission codes

Parameters

bool|string $canUpload

Either a boolean flag, or a required permission code

Return Value

UploadField

Self reference

bool canAttachExisting()

Determine if the user has permission to attach existing files By default returns true if the user has the CMS_ACCESS_AssetAdmin permission

Return Value

bool

bool isActive()

Returns true if the field is neither readonly nor disabled

Return Value

bool

UploadField setCanAttachExisting(bool|string $canAttachExisting)

Specify whether the user can attach existing files String values will be treated as required permission codes

Parameters

bool|string $canAttachExisting

Either a boolean flag, or a required permission code

Return Value

UploadField

Self reference

int getPreviewMaxWidth()

Gets thumbnail width. Defaults to 80

Return Value

int

UploadField setPreviewMaxWidth(int $previewMaxWidth)

No description

Parameters

int $previewMaxWidth

Return Value

UploadField

Self reference

See also

UploadField::getPreviewMaxWidth

int getPreviewMaxHeight()

Gets thumbnail height. Defaults to 60

Return Value

int

UploadField setPreviewMaxHeight(int $previewMaxHeight)

No description

Parameters

int $previewMaxHeight

Return Value

UploadField

Self reference

See also

UploadField::getPreviewMaxHeight

getUploadTemplateName()

javascript template used to display uploading files Defaults to 'ss-uploadfield-uploadtemplate'

See also

javascript/UploadField_uploadtemplate.js

UploadField setUploadTemplateName(string $uploadTemplateName)

No description

Parameters

string $uploadTemplateName

Return Value

UploadField

Self reference

See also

UploadField::getUploadTemplateName

getDownloadTemplateName()

javascript template used to display already uploaded files Defaults to 'ss-downloadfield-downloadtemplate'

See also

javascript/DownloadField_downloadtemplate.js

Uploadfield setDownloadTemplateName(string $downloadTemplateName)

No description

Parameters

string $downloadTemplateName

Return Value

Uploadfield

Self reference

See also

\Uploadfield::getDownloadTemplateName()

FieldList getFileEditFields(File $file)

FieldList $fields for the EditForm

Parameters

File $file

File context to generate fields for

Return Value

FieldList

List of form fields

Examples

'getCMSFields'

Uploadfield setFileEditFields($fileEditFields)

FieldList $fields or string $name (of a method on File to provide a fields) for the EditForm

Parameters

$fileEditFields

Return Value

Uploadfield

Self reference

Examples

'getCMSFields'

FieldList getFileEditActions(File $file)

FieldList $actions or string $name (of a method on File to provide a actions) for the EditForm

Parameters

File $file

File context to generate form actions for

Return Value

FieldList

Field list containing FormAction

Examples

'getCMSActions'

Uploadfield setFileEditActions($fileEditActions)

FieldList $actions or string $name (of a method on File to provide a actions) for the EditForm

Parameters

$fileEditActions

Return Value

Uploadfield

Self reference

Examples

'getCMSActions'

Validator getFileEditValidator(File $file)

Determines the validator to use for the edit form

Parameters

File $file

File context to generate validator from

Return Value

Validator

Validator object

Examples

'getCMSValidator'

Uploadfield setFileEditValidator($fileEditValidator)

Validator (eg RequiredFields) or string $name (of a method on File to provide a Validator) for the EditForm

Parameters

$fileEditValidator

Return Value

Uploadfield

Self reference

Examples

'getCMSValidator'

protected string getThumbnailURLForFile(File $file)

No description

Parameters

File $file

Return Value

string

UploadField_ItemHandler handleItem(SS_HTTPRequest $request)

No description

Parameters

SS_HTTPRequest $request

Return Value

UploadField_ItemHandler

UploadField_ItemHandler getItemHandler(int $itemID)

No description

Parameters

int $itemID

Return Value

UploadField_ItemHandler

UploadField_ItemHandler handleSelect(SS_HTTPRequest $request)

No description

Parameters

SS_HTTPRequest $request

Return Value

UploadField_ItemHandler

protected array extractUploadedFileData(array $postVars)

Given an array of post variables, extract all temporary file data into an array

Parameters

array $postVars

Array of posted form data

Return Value

array

List of temporary file data

protected File saveTemporaryFile(array $tmpFile, string $error = null)

Loads the temporary file data into a File object

Parameters

array $tmpFile

Temporary file data

string $error

Error message

Return Value

File

File object, or null if error

protected array encodeFileAttributes(File $file)

Safely encodes the File object with all standard fields required by the front end

Parameters

File $file

Return Value

array

Array encoded list of file attributes

SS_HTTPResponse upload(SS_HTTPRequest $request)

Action to handle upload of a single file

Parameters

SS_HTTPRequest $request

Return Value

SS_HTTPResponse

SS_HTTPResponse attach(SS_HTTPRequest $request)

Retrieves details for files that this field wishes to attache to the client-side form

Parameters

SS_HTTPRequest $request

Return Value

SS_HTTPResponse

protected bool checkFileExists(string $originalFile)

Check if file exists, both checking filtered filename and exact filename

Parameters

string $originalFile Filename

Return Value

bool

fileexists(SS_HTTPRequest $request)

Determines if a specified file exists

Parameters

SS_HTTPRequest $request

string getRelationAutosetClass($default = 'File')

Gets the foreign class that needs to be created, or 'File' as default if there is no relationship, or it cannot be determined.

Parameters

$default

Default value to return if no value could be calculated

Return Value

string

Foreign class name.

protected attachFile($file)

Override the default behaviour of the UploadField and take the uploaded file (uploaded to assets) and add it into the DMS storage, deleting the old/uploaded file.

Parameters

$file

FieldList getDMSFileEditFields(File $file)

FieldList $fields for the EditForm

Parameters

File $file

File context to generate fields for

Return Value

FieldList

List of form fields

Examples

'getCMSFields'

FieldList getDMSFileEditActions(File $file)

FieldList $actions or string $name (of a method on File to provide a actions) for the EditForm

Parameters

File $file

File context to generate form actions for

Return Value

FieldList

Field list containing FormAction

Examples

'getCMSActions'

Validator getDMSFileEditValidator(File $file)

Determines the validator to use for the edit form

Parameters

File $file

File context to generate validator from

Return Value

Validator

Validator object

Examples

'getCMSValidator'