class UploadField extends FileField (View source)

Field for uploading single or multiple files of all types, including images.

Features (some might not be available to old browsers):

  • File Drag&Drop support
  • Progressbar
  • Image thumbnail/file icons even before upload finished
  • Saving into relations on form submit
  • Edit file
  • allowedExtensions is by default File::$allowed_extensions
  • maxFileSize the value of min(upload_max_filesize, post_max_size) from php.ini

<>Usage

Properties

static private array $extensions

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

from  SS_Object
string $class from  SS_Object
static private array $casting from  FormField
static private string $default_cast

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

from  ViewableData
static private string|null $url_segment

Optional url_segment for this request handler

from  RequestHandler
static private $url_handlers

The default URL handling rules. This specifies that the next component of the URL corresponds to a method to be called on this RequestHandlingData object.

from  RequestHandler
static private $allowed_actions

Define a list of action handling methods that are allowed to be called directly by URLs.

from  RequestHandler
static private bool $require_allowed_actions from  RequestHandler
static private array $default_classes from  FormField
bool $dontEscape from  FormField
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

Methods

static Config_ForClass|null
config()

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

static SS_Object
create()

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

static SS_Object
singleton()

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

static 
create_from_string($classSpec, $firstArg = null)

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

static 
parse_class_spec($classSpec)

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

static SS_Object
strong_create()

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

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

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

static string
getCustomClass(string $class)

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

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

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

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Return TRUE if a class has a specified extension.

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

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

static 
get_extra_config_sources($class = null)

No description

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

Construct a new UploadField instance

mixed
__call(string $method, array $arguments)

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

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

stat($name, $uncached = false)

No description

set_stat($name, $value)

No description

uninherited($name)

No description

bool
exists()

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

string
parentClass()

No description

bool
is_a(string $class)

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

string
__toString()

No description

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

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

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

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

getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

bool
hasExtension(string $extension)

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

array
getExtensionInstances()

Get all extension instances for this specific object instance.

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

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

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

Clears the cache for the given cacheToFile call

static string
castingObjectCreator(string $fieldSchema)

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

static array
castingObjectCreatorPair(string $fieldSchema)

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

bool
__isset(string $property)

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

mixed
__get(string $property)

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

__set(string $property, mixed $value)

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

setFailover(ViewableData $failover)

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

getFailover()

Get the current failover object if set

bool
hasField(string $field)

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

mixed
getField(string $field)

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

setField(string $field, mixed $value)

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

defineMethods()

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

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

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

customise(array|ViewableData $data)

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

setCustomisedObj(ViewableData $object)

No description

array
castingHelperPair(string $field)

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

string
castingHelper(string $field)

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

string
castingClass(string $field)

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

string
escapeTypeForField(string $field)

Return the string-format type for the given field.

buildCastingCache(reference $cache)

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

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

Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:

  • a template name (e.g. Page)
  • an array of possible template names - the first valid one will be used
  • an SSViewer instance

obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

array
getXMLValues($fields)

Get an array of XML-escaped values by field name

getIterator()

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

Me()

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

string
ThemeDir(string $subtheme = false)

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

string
CSSClasses(string $stopAtClass = 'ViewableData')

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

Debug()

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

setDataModel($model)

Set the DataModel for this request.

handleRequest(SS_HTTPRequest $request, DataModel $model)

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.

checkAccessAction($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 SS_HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.

getRequest()

Returns the SS_HTTPRequest object that this controller is using.

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

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.

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

Construct and return HTML tag.

string
ID()

Returns the HTML ID of the field.

string
HolderID()

Returns the HTML ID for the form field holder element.

getTemplateHelper()

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

string
getName()

Returns the field name.

string
Message()

Returns the field message, used by form validation.

string
MessageType()

Returns the field message type.

mixed
Value()

Returns the field value.

saveInto(DataObjectInterface $record)

Method to save this form field into the given {@link DataObject}.

mixed
dataValue()

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

string
Title()

Returns the field label - used by templates.

$this
setTitle(string $title)

No description

string
RightTitle()

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

$this
setRightTitle(string $rightTitle)

No description

string
LeftTitle()

No description

$this
setLeftTitle(string $leftTitle)

No description

string
extraClass()

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

$this
addExtraClass(string $class)

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

$this
removeExtraClass(string $class)

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

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

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

null|string
getAttribute($name)

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

array
getAttributes()

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

string
getAttributesHTML(array $attributes = null)

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

string
attrTitle()

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

string
attrValue()

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

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

$this
setName(string $name)

Set the field name.

$this
setForm(Form $form)

Set the container form.

getForm()

Get the currently used form.

bool
securityTokenEnabled()

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

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

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

$this
setCustomValidationMessage(string $customValidationMessage)

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

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

$this
setTemplate(string $template)

Set name of template (without path or extension).

string
getTemplate()

No description

string
getFieldHolderTemplate()

No description

$this
setFieldHolderTemplate(string $fieldHolderTemplate)

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

string
getSmallFieldHolderTemplate()

No description

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

string
Field(array $properties = array())

No description

string
FieldHolder(array $properties = array())

Returns a "field holder" for this field.

string
SmallFieldHolder(array $properties = array())

Returns a restricted field holder used within things like FieldGroups.

array
getTemplates()

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

array
getFieldHolderTemplates()

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

array
getSmallFieldHolderTemplates()

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

bool
isComposite()

Returns true if this field is a composite field.

bool
hasData()

Returns true if this field has its own data.

bool
isReadonly()

No description

$this
setReadonly(bool $readonly)

Sets a read-only flag on this FormField.

bool
isDisabled()

No description

$this
setDisabled(bool $disabled)

Sets a disabled flag on this FormField.

performReadonlyTransformation()

Returns a read-only version of this field.

performDisabledTransformation()

Return a disabled version of this field.

mixed
transform(FormTransformation $transformation)

No description

int
hasClass(string $class)

No description

string
Type()

Returns the field type.

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

No description

bool
validate(Validator $validator)

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

$this
setDescription(string $description)

Describe this field, provide help text for it.

string
getDescription()

No description

string
debug()

No description

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.

bool
Required()

No description

setContainerFieldList(FieldList $containerFieldList)

Set the FieldList that contains this field.

getContainerFieldList()

Get the FieldList that contains this field.

null|FieldList
rootFieldList()

No description

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.

bool
canSubmitValue()

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

getValidator()

Get custom validator for this field

$this
setValidator(Upload_Validator $validator)

Set custom validator for this field

$this
setFolderName(string $folderName)

Sets the upload folder name

string
getFolderName()

Gets the upload folder name

getUpload()

Retrieves the Upload handler

setUpload(Upload $upload)

Sets the upload handler

$this
setAllowedExtensions(array $rules)

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

$this
setAllowedFileCategories(string $category)

Limit allowed file extensions by specifying categories of file types.

array
getAllowedExtensions()

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

setTemplateFileButtons($template)

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

string
getTemplateFileButtons()

No description

setTemplateFileEdit($template)

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

string
getTemplateFileEdit()

No description

bool
canPreviewFolder()

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

setCanPreviewFolder(bool|string $canPreviewFolder)

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

bool
getOverwriteWarning()

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

setOverwriteWarning(bool $overwriteWarning)

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

setDisplayFolderName($name)

No description

string
getDisplayFolderName()

No description

setRecord(DataObject $record)

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

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

setItems(SS_List $items)

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

getItems()

Retrieves the current list of files

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

setConfig(string $key, mixed $val)

Assign a front-end config variable for the upload field

mixed
getConfig(string $key)

Gets a front-end config variable for the upload field

bool
getAutoUpload()

Determine if the field should automatically upload the file.

setAutoUpload(bool $autoUpload)

Determine if the field should automatically upload the file

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.

setAllowedMaxFileNumber(int|null $allowedMaxFileNumber)

Determine maximum number of files allowed to be attached.

bool
canUpload()

Determine if the user has permission to upload.

setCanUpload(bool|string $canUpload)

Specify whether the user can upload files.

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

bool
isActive()

Returns true if the field is neither readonly nor disabled

setCanAttachExisting(bool|string $canAttachExisting)

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

int
getPreviewMaxWidth()

Gets thumbnail width. Defaults to 80

setPreviewMaxWidth(int $previewMaxWidth)

No description

int
getPreviewMaxHeight()

Gets thumbnail height. Defaults to 60

setPreviewMaxHeight(int $previewMaxHeight)

No description

getUploadTemplateName()

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

setUploadTemplateName(string $uploadTemplateName)

No description

getDownloadTemplateName()

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

Uploadfield
setDownloadTemplateName(string $downloadTemplateName)

No description

getFileEditFields(File $file)

FieldList $fields for the EditForm

Uploadfield
setFileEditFields($fileEditFields)

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

getFileEditActions(File $file)

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

Uploadfield
setFileEditActions($fileEditActions)

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

getFileEditValidator(File $file)

Determines the validator to use for the edit form

Uploadfield
setFileEditValidator($fileEditValidator)

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

getItemHandler(int $itemID)

No description

upload(SS_HTTPRequest $request)

Action to handle upload of a single file

attach(SS_HTTPRequest $request)

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

fileexists(SS_HTTPRequest $request)

Determines if a specified file exists

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.

Details

static Config_ForClass|null config()

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

Return Value

Config_ForClass|null

static SS_Object create()

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

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

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

Return Value

SS_Object

static SS_Object singleton()

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

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

Return Value

SS_Object

The singleton instance

static create_from_string($classSpec, $firstArg = null)

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

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

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

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

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

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

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

Parameters

$classSpec
$firstArg

static parse_class_spec($classSpec)

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

Returns a 2-elemnent array, with classname and arguments

Parameters

$classSpec

static SS_Object strong_create()

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

Return Value

SS_Object

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

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

Parameters

string $oldClass

the class to replace

string $newClass

the class to replace it with

bool $strong

allows you to enforce a certain class replacement under all circumstances. This is used in singletons and DB interaction classes

static string getCustomClass(string $class)

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

Parameters

string $class

the class to check

Return Value

string

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

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

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

Parameters

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

Return Value

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

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

deprecated

Parameters

$class
$name
$uncached

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

deprecated

Parameters

$class
$name
$value

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

deprecated

Parameters

$class
$name
$uncached

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

deprecated

Parameters

$class
$name
$ceiling

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

deprecated

Parameters

$class
$properties
$replace

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

deprecated

Parameters

$class
$name
$value
$replace

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

Return TRUE if a class has a specified extension.

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

Parameters

string $classOrExtension

if 1 argument supplied, the class name of the extension to check for; if 2 supplied, the class name to test

string $requiredExtension

used only if 2 arguments supplied

bool $strict

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

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

Add an extension to a specific class.

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

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

Parameters

string $classOrExtension

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

string $extension

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

See also

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

static remove_extension(string $extension)

Remove an extension from a class.

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

Parameters

string $extension

Classname of an {@link Extension} subclass, without parameters

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

Parameters

string $class
bool $includeArgumentString

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

Return Value

array

Numeric array of either {@link DataExtension} classnames, or eval'ed classname strings with constructor arguments.

static get_extra_config_sources($class = null)

Parameters

$class

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

Parameters

string $method
array $arguments

Return Value

mixed

bool hasMethod(string $method)

Return TRUE if a method exists on this object

This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions

Parameters

string $method

Return Value

bool

array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom

include methods added dynamically at runtime

Return Value

array

stat($name, $uncached = false)

Parameters

$name
$uncached

See also

SS_Object::get_static

set_stat($name, $value)

Parameters

$name
$value

See also

SS_Object::set_static

uninherited($name)

Parameters

$name

See also

SS_Object::uninherited_static

bool exists()

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

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

Return Value

bool

string parentClass()

Return Value

string

this classes parent class

bool is_a(string $class)

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

Parameters

string $class

Return Value

bool

string __toString()

Return Value

string

the class name

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

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

Parameters

string $method

the method name to call

mixed $argument

a single argument to pass

Return Value

mixed

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

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

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during {@link __construct()} in {@link defineMethods()}.

Parameters

string $method

the name of the method to call on each extension

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

Return Value

array

Extension getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

bool hasExtension(string $extension)

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

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension

Classname of an {@link Extension} subclass without parameters

Return Value

bool

array getExtensionInstances()

Get all extension instances for this specific object instance.

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

Return Value

array

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

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

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

Parameters

string $method

the method name to cache

int $lifetime

the cache lifetime in seconds

string $ID

custom cache ID to use

array $arguments

an optional array of arguments

Return Value

mixed

the cached data

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

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

static string castingObjectCreator(string $fieldSchema)

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

Parameters

string $fieldSchema

The field spec

Return Value

string

static array castingObjectCreatorPair(string $fieldSchema)

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

Parameters

string $fieldSchema

Return Value

array

bool __isset(string $property)

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

Parameters

string $property

Return Value

bool

mixed __get(string $property)

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

Parameters

string $property

Return Value

mixed

__set(string $property, mixed $value)

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

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

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

Parameters

string $field

Return Value

bool

mixed getField(string $field)

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

Parameters

string $field

Return Value

mixed

setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

defineMethods()

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

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

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

Parameters

$method
$args
string $identifier

an optional custom cache identifier

Return Value

unknown

ViewableData_Customised customise(array|ViewableData $data)

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

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

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

ViewableData getCustomisedObj()

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

array castingHelperPair(string $field)

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

The returned array contains two keys:

  • className: the class the field would be casted to (e.g. "Varchar")
  • castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")

Parameters

string $field

Return Value

array

string castingHelper(string $field)

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

Parameters

string $field

Return Value

string

string castingClass(string $field)

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

Parameters

string $field

Return Value

string

string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string

'xml'|'raw'

buildCastingCache(reference $cache)

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

Parameters

reference $cache

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

Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:

  • a template name (e.g. Page)
  • an array of possible template names - the first valid one will be used
  • an SSViewer instance

Parameters

string|array|SSViewer $template

the template to render into

array $customFields

fields to customise() the object with before rendering

Return Value

HTMLText

obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)

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

Parameters

string $fieldName
array $arguments
bool $forceReturnedObject

if TRUE, the value will ALWAYS be casted to an object before being returned, even if there is no explicit casting information

bool $cache

Cache this object

string $cacheName

a custom cache name

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

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

Parameters

string $field
array $arguments
string $identifier

an optional custom cache identifier

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

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

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

array getXMLValues($fields)

Get an array of XML-escaped values by field name

Parameters

$fields

Return Value

array

ArrayIterator getIterator()

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

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

Return Value

ArrayIterator

ViewableData Me()

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

Return Value

ViewableData

string ThemeDir(string $subtheme = false)

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

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

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

Parameters

string $subtheme

the subtheme path to get

Return Value

string

string CSSClasses(string $stopAtClass = 'ViewableData')

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

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

Parameters

string $stopAtClass

the class to stop at (default: ViewableData)

Return Value

string

ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

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

SS_HTTPRequest $request

The {@link SS_HTTPRequest} object that is reponsible for distributing URL parsing

DataModel $model

Return Value

SS_HTTPResponse|RequestHandler|string|array

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

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

$action

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

Throws a HTTP error response encased in a {@link SS_HTTPResponse_Exception}, which is later caught in {@link 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 {@link NullHTTPRequest} object unless {@link handleAction()} or {@link handleRequest()} have been called, which adds a reference to an actual {@link SS_HTTPRequest} object.

setRequest($request)

Typically the request is set through {@link handleAction()} or {@link 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

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

string getName()

Returns the field name.

Return Value

string

string Message()

Returns the field message, used by form validation.

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

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)

Parameters

string $rightTitle

Return Value

$this

string LeftTitle()

Return Value

string

$this setLeftTitle(string $leftTitle)

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

null|string getAttribute($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

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

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 {@link 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 {@link 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 {@link Field()} method on the subclass for support.

Parameters

string $template

Return Value

$this

string getTemplate()

Return Value

string

string getFieldHolderTemplate()

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

string getSmallFieldHolderTemplate()

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

string Field(array $properties = array())

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 {@link FieldHolder}.

Return Value

array

array getFieldHolderTemplates()

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

Return Value

array

array getSmallFieldHolderTemplates()

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

Return Value

array

bool isComposite()

Returns true if this field is a composite field.

To create composite field types, you should subclass {@link 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()

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

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 {@link setDisabled()}.

Return Value

FormField

mixed transform(FormTransformation $transformation)

Parameters

FormTransformation $transformation

Return Value

mixed

int hasClass(string $class)

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

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

Return Value

string

string debug()

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

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

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

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)

Sets the upload folder name

Parameters

string $folderName

Return Value

$this

string getFolderName()

Gets the upload folder name

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 {@link File::$allowed_extensions} to get a good standard set of extensions that are typically not harmful in a webserver context. See {@link 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 {@link 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()

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

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)

Parameters

$name

string getDisplayFolderName()

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

Retrieves the current list of files

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

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)

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)

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)

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)

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

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

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

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

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

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

UploadField_ItemHandler handleItem(SS_HTTPRequest $request)

Parameters

SS_HTTPRequest $request

Return Value

UploadField_ItemHandler

UploadField_ItemHandler getItemHandler(int $itemID)

Parameters

int $itemID

Return Value

UploadField_ItemHandler

UploadField_ItemHandler handleSelect(SS_HTTPRequest $request)

Parameters

SS_HTTPRequest $request

Return Value

UploadField_ItemHandler

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

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.