UploadField

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

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

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

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.

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

Returns a 2-elemnent array, with classname and arguments

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

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

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

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.

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

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

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.

Construct a new UploadField instance

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

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

Return the names of all the methods available on this object

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

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

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

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

Get an extension instance attached to this object by name.

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.

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

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

Clears the cache for the given cacheToFile call

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

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.

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

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

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

Get the current failover object if set

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

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

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

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

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

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.

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

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

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

Return the string-format type for the given field.

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

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

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

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

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.

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

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

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

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

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

Get an array of XML-escaped values by field name

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.

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

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.

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

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

Set the DataModel for this request.

Handles URL requests.

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

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

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.

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.

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

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

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.

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.

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

Return a link to this field.

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'

Construct and return HTML tag.

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.

Returns the HTML ID for the form field holder element.

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.

Returns the field name.

Returns the field message, used by form validation.

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

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.

Returns the field value.

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

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

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

Returns the field label - used by templates.

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

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

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.

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

Multiple class names should be space delimited.

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

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.

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

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

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.

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.

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

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

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

Set the field name.

Set the container form.

This is called automatically when fields are added to forms.

Get the currently used form.

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

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

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

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

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

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

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.

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.

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.

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.

Returns a restricted field holder used within things like FieldGroups.

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

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

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

Returns true if this field is a composite field.

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

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.

Sets a read-only flag on this FormField.

Use performReadonlyTransformation() to transform this instance.

Setting this to false has no effect on the field.

Sets a disabled flag on this FormField.

Use performDisabledTransformation() to transform this instance.

Setting this to false has no effect on the field.

Returns a read-only version of this field.

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

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.

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

Describe this field, provide help text for it.

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

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

Set the FieldList that contains this field.

Get the FieldList that contains this field.

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.

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

Get custom validator for this field

Set custom validator for this field

Sets the upload folder name

Gets the upload folder name

Retrieves the Upload handler

Sets the upload handler

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.

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

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

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

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

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

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

Disable to keep the internal filesystem structure hidden from users.

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)

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)

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

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

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.

Retrieves the current list of files

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

Retrieves the list of selected file IDs

Assign a front-end config variable for the upload field

Gets a front-end config variable for the upload field

Determine if the field should automatically upload the file.

Determine if the field should automatically upload the file

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.

Determine maximum number of files allowed to be attached.

Determine if the user has permission to upload.

Specify whether the user can upload files.

String values will be treated as required permission codes

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

Returns true if the field is neither readonly nor disabled

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

Gets thumbnail width. Defaults to 80

Gets thumbnail height. Defaults to 60

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

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

FieldList $fields for the EditForm

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

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

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

Determines the validator to use for the edit form

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

Action to handle upload of a single file

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

Determines if a specified file exists

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