class DBFile extends DBComposite implements AssetContainer, Thumbnail (View source)

Represents a file reference stored in a database

Traits

Provides image manipulation functionality.

This trait can be applied to a ViewableData class to add the logic to render attributes in an SS template.

Allows an object to have extensions applied to it.

A class that can be instantiated or replaced via DI

Provides extensions to this object to integrate it with standard config API methods.

Allows an object to declare a set of custom methods

Config options

extensions array

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

from  Extensible
unextendable_classes array

Classes that cannot be extended

from  Extensible
casting
default_cast string

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

from  ViewableData
casting_cache array from  ViewableData
escape_type string

The escape type for this field when inserted into a template - either "xml" or "raw".

from  DBField
default_search_filter_class string

Subclass of SearchFilter} for usage in {@link defaultSearchFilter().

from  DBField
index string|bool

The type of index to use for this field. Can either be a string (one of the DBIndexable type options) or a boolean. When a boolean is given, false will not index the field, and true will use the default index type.

from  DBField
composite_db
force_resample bool

Force all images to resample in all cases Off by default, as this can be resource intensive to apply to multiple images simultaneously.

from  ImageManipulation
strip_thumbnail_width int from  ImageManipulation
strip_thumbnail_height int from  ImageManipulation
cms_thumbnail_width int

The width of an image thumbnail in the CMS.

from  ImageManipulation
cms_thumbnail_height int

The height of an image thumbnail in the CMS.

from  ImageManipulation
asset_preview_width int

The width of an image preview in the Asset section

from  ImageManipulation
asset_preview_height int

The height of an image preview in the Asset section

from  ImageManipulation
supported_images array

List of image mime types supported by the image manipulations API

Properties

protected static array $extra_methods

Custom method sources

from  CustomMethods
protected array $extra_method_registers

Name of methods to invoke by defineMethods for this instance

from  CustomMethods
protected static array $built_in_methods

Non-custom methods

from  CustomMethods
protected Extension[] $extension_instances from  Extensible
protected callable[][] $beforeExtendCallbacks

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

from  Extensible
protected callable[][] $afterExtendCallbacks

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

from  Extensible
protected ViewableData $failover

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

from  ViewableData
protected ViewableData $customisedObject from  ViewableData
protected mixed $value

Raw value of this field

from  DBField
protected string $tableName

Table this field belongs to

from  DBField
protected string $name

Name of this field

from  DBField
protected array $arrayValue

Used for generating DB schema. {DBSchemaManager}

from  DBField
protected array $options

Optional parameters for this field

from  DBField
protected $defaultVal from  DBField
protected $isChanged

Marker as to whether this record has changed Only used when deference to the parent object isn't possible

from  DBComposite
protected array|DataObject $record

Either the parent dataobject link, or a record of saved values for each field

from  DBComposite
protected array $attributes

List of attributes to render on the frontend

from  AttributesHTML
protected Image_Backend $imageBackend from  ImageManipulation
protected bool $allowGeneration

If image resizes are allowed

from  ImageManipulation
protected array $allowedCategories

List of allowed file categories.

string $Hash

SHA of the file

string $Filename

Name of the file, including directory

string $Variant

Variant of the file

Methods

public
mixed
__call(string $method, array $arguments)

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

protected
defineMethods()

Adds any methods from Extension instances attached to this object.

protected
registerExtraMethodCallback(string $name, callable $callback)

Register an callback to invoke that defines extra methods

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

protected
array
getExtraMethodConfig(string $method)

Get meta-data details on a named method

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

protected
array
findMethodsFromExtension(object $extension) deprecated

No description

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

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

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

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

protected
addWrapperMethod(string $method, string $wrap)

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

protected
addCallbackMethod(string $method, callable $callback)

Add callback as a method.

protected
beforeExtending(string $method, callable $callback)

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

protected
afterExtending(string $method, callable $callback)

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

protected
constructExtensions() deprecated

No description

protected
defineExtensionMethods()

Adds any methods from Extension instances attached to this object.

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

Add an extension to a specific class.

public static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

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

Get extra config sources for this class

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

Return TRUE if a class has a specified extension.

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

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

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

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

public
Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

public
bool
hasExtension(string $extension)

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

public
getExtensionInstances()

Get all extension instances for this specific object instance.

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

public static 
config()

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

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

public
__construct(string $name = null, array|string $allowed = [])

Create a new image manipulation

public
bool
__isset(string $property)

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

public
mixed
__get(string $property)

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

public
__set(string $property, mixed $value)

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

public
setFailover(ViewableData $failover)

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

public
getFailover()

Get the current failover object if set

public
bool
hasField(string $field)

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

public
mixed
getField(string $field)

get value of a single composite field

public
$this
setField(string $field, mixed $value, bool $markChanged = true)

Set value of a single composite field

public
customise(array|ViewableData $data)

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

public
bool
exists()

Composite field defaults to exists only if all fields have values

public
string
__toString()

No description

from  DBField
public
getCustomisedObj()

No description

public
setCustomisedObj(ViewableData $object)

No description

public
string
castingHelper(string $field)

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

public
string
castingClass(string $field)

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

public
string
escapeTypeForField(string $field)

Return the string-format type for the given field.

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

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

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

protected
string
objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

protected
mixed
objCacheGet(string $key)

Get a cached value from the field cache

protected
$this
objCacheSet(string $key, mixed $value)

Store a value in the field cache

protected
$this
objCacheClear()

Clear object cache

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

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

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

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

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

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

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

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

public
array
getXMLValues(array $fields)

Get an array of XML-escaped values by field name

public
getIterator()

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

public
array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

public
Me()

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

public
string
ThemeDir() deprecated

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

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

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

public
Debug()

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

public static 
create_field(string $spec, mixed $value, string $name = null, mixed ...$args)

Create a DBField object that's not bound to any particular field.

from  DBField
public
$this
setName(string $name)

Set the name of this field.

from  DBField
public
string
getName()

Returns the name of this field.

from  DBField
public
mixed
getValue()

Returns the value of this field.

public
$this
setValue(mixed $value, DataObject|array $record = null, bool $markChanged = true)

Assign the given value.

public
mixed
getDefaultValue()

Get default value assigned at the DB level

from  DBField
public
$this
setDefaultValue(mixed $defaultValue)

Set default value to use at the DB level

from  DBField
public
$this
setOptions(array $options = [])

Update the optional parameters for this field

from  DBField
public
array
getOptions()

Get optional parameters for this field

from  DBField
public
$this
setIndexType(string|bool $type)

Set the desired index type to use

from  DBField
public
string|bool
getIndexType()

Return the desired index type to use. Will return false if the field instance should not be indexed.

from  DBField
public
mixed
prepValueForDB(mixed $value)

Return the transformed value ready to be sent to the database. This value will be escaped automatically by the prepared query processor, so it should not be escaped or quoted at all.

from  DBField
public
writeToManipulation(array $manipulation)

Write all nested fields into a manipulation

public
addToQuery(SQLSelect $query)

Add all columns which are defined through requireField() and $composite_db, or any additional SQL that is required to get to these columns. Will mostly just write to the SQLSelect->select array.

public
$this
setTable(string $tableName)

Assign this DBField to a table

from  DBField
public
string|null
getTable()

Get the table this field belongs to, if assigned

from  DBField
public
string
forTemplate()

Determine 'default' casting for this field.

from  DBField
public
string
HTMLATT()

Gets the value appropriate for a HTML attribute string

from  DBField
public
string
URLATT()

urlencode this string

from  DBField
public
string
RAWURLATT()

rawurlencode this string

from  DBField
public
string
ATT()

Gets the value appropriate for a HTML attribute string

from  DBField
public
mixed
RAW()

Gets the raw value for this field.

from  DBField
public
string
JS()

Gets javascript string literal value

from  DBField
public
string
JSON()

Return JSON encoded value

from  DBField
public
string
HTML()

Alias for {XML()}

from  DBField
public
string
XML()

Return a html5 tag of the appropriate for this file (normally img or a)

public
string
CDATA()

Safely escape for XML string

from  DBField
public
mixed
nullValue()

Returns the value to be set in the database to blank this field.

from  DBField
public
saveInto(DataObject $dataObject)

Saves this field to the given data object.

public
scaffoldFormField(string $title = null, array $params = null)

Returns a FormField instance used as a default for form scaffolding.

public
scaffoldSearchField(string $title = null)

Returns a FormField instance used as a default for searchform scaffolding.

from  DBField
public
defaultSearchFilter(string $name = null)

No description

from  DBField
public
requireField()

Add the field to the underlying database.

public
debug()

No description

from  DBField
public
array
getArrayValue()

No description

from  DBField
public
$this
setArrayValue(array $value)

No description

from  DBField
public
string|array
getSchemaValue()

Get formfield schema value

from  DBField
public
array
getIndexSpecs()

Returns the index specifications for the field instance, for example:

public
bool
scalarValueOnly()

Whether or not this DBField only accepts scalar values.

public
array
compositeDatabaseFields()

Return array in the format of $composite_db.

public
isChanged()

Returns true if this composite field has changed.

public
bindTo(DataObject $dataObject)

Bind this field to the dataobject, and set the underlying table to that of the owner

public
DBField|null
dbObject(string $field)

Get a db object for the named field

public
$this
setAttribute($name, $value)

Set an HTML attribute

public
mixed|null
getAttribute(string $name)

Retrieve the value of an HTML attribute

protected
array
getDefaultAttributes()

Get the default attributes when rendering this object.

public
array
getAttributes()

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

public
string
getAttributesHTML(array $attributes = null)

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

public
$this
setAllowGeneration(bool $allow)

Set whether image resizes are allowed

public
bool
getAllowGeneration()

Check if resizes are allowed

public
existingOnly()

Return clone of self which promises to only return existing thumbnails

public
string
getString()

No description

public
resource
getStream()

No description

public
string
getURL(bool $grant = true)

No description

public
string
getAbsoluteURL()

Get the absolute URL to this resource

public
array|null
getMetaData()

Get metadata for this file

public
string
getMimeType()

Get mime type

public
int
getAbsoluteSize()

Return file size in bytes.

public
string
getFilename()

Get value of filename

public
string
getHash()

Get value of hash

public
string
getVariant()

Get value of variant

public
bool
getIsImage()

Determine if a valid non-empty image exists behind this asset, which is a format compatible with image manipulations

public
Pad(int $width, int $height, string $backgroundColor = 'FFFFFF', int $transparencyPercent = 0)

Fit image to specified dimensions and fill leftover space with a solid colour (default white). Use in templates with $Pad.

public
Resampled()

Forces the image to be resampled, if possible

public
updateURL(string $url)

Update the url to point to a resampled version if forcing

public
ResizedImage(int $width, int $height)

Generate a resized copy of this image with the given width & height.

public
Fit(int $width, int $height)

Scale image proportionally to fit within the specified bounds

public
FitMax(int $width, int $height)

Proportionally scale down this image if it is wider or taller than the specified dimensions.

public
ScaleWidth(int $width)

Scale image proportionally by width. Use in templates with $ScaleWidth.

public
ScaleMaxWidth(int $width)

Proportionally scale down this image if it is wider than the specified width.

public
ScaleHeight(int $height)

Scale image proportionally by height. Use in templates with $ScaleHeight.

public
ScaleMaxHeight(int $height)

Proportionally scale down this image if it is taller than the specified height.

public
CropWidth(int $width)

Crop image on X axis if it exceeds specified width. Retain height.

public
CropHeight(int $height)

Crop image on Y axis if it exceeds specified height. Retain width.

public
FillMax(int $width, int $height)

Crop this image to the aspect ratio defined by the specified width and height, then scale down the image to those dimensions if it exceeds them.

public
Fill(int $width, int $height)

Resize and crop image to fill specified dimensions.

public
Quality(int $quality)

Set the quality of the resampled image

public
CMSThumbnail()

Default CMS thumbnail

public
StripThumbnail()

Generates a thumbnail for use in the gridfield view

public
PreviewThumbnail()

Get preview for this file

public
Thumbnail(int $width, int $height)

Default thumbnail generation for Images

public
ThumbnailIcon(int $width, int $height)

Thubnail generation for all file types.

public
IconTag()

Get HTML for img containing the icon for this file

public
string
ThumbnailURL(int $width, int $height)

Get URL to thumbnail of the given size.

public
string
getIcon()

Return the relative URL of an icon for the file type, based on the appCategory() value.

public
getImageBackend()

Get Image_Backend instance for this image

public
$this
setImageBackend(Image_Backend $backend)

No description

public
int
getWidth()

Get the width of this image.

public
int
getHeight()

Get the height of this image.

public
int
getOrientation()

Get the orientation of this image.

public
bool
isSize(int $width, int $height)

Determine if this image is of the specified size

public
bool
isWidth(int $width)

Determine if this image is of the specified width

public
bool
isHeight(int $height)

Determine if this image is of the specified width

public
manipulateImage(string $variant, callable $callback)

Wrapper for manipulate that passes in and stores Image_Backend objects instead of tuples

public
manipulate(string $variant, callable $callback)

Generate a new DBFile instance using the given callback if it hasn't been created yet, or return the existing one if it has.

public
string
variantName(string $format, $arg = null)

Name a variant based on a format with arbitrary parameters

public
array|null
variantParts($variantName)

Reverses variantName().

protected
int
castDimension(mixed $value, string $dimension)

Validate a width or size is valid and casts it to integer

public
bool
IsLazyLoaded()

Determine whether the image should be lazy loaded

public
LazyLoad(mixed $lazyLoad)

Set the lazy loading state for this Image

protected
getStore()

No description

public
string
getTag()

Return a html5 tag of the appropriate for this file (normally img or a)

public
string
getFrontendTemplate()

Determine the template to render as on the frontend

public
string
getBasename()

Get trailing part of filename

public
string
getExtension()

Get file extension

public
string
getTitle()

Alt title for this

public
array
setFromLocalFile(string $path, string $filename = null, string $hash = null, string $variant = null, array $config = [])

Assign a local file to the backend.

public
array
setFromStream(resource $stream, string $filename, string $hash = null, string $variant = null, array $config = [])

Assign a stream to the backend

public
array
setFromString(string $data, string $filename, string $hash = null, string $variant = null, array $config = [])

Assign a set of data to the backend

public
string
Link()

Return URL for this image. Alias for getURL()

public
string
AbsoluteLink()

Return absolute URL for this image. Alias for getAbsoluteURL()

public
string
getSourceURL(bool $grant = true)

Get URL, but without resampling.

public
string
getVisibility()

Determine visibility of the given file

public
$this
setOriginal(AssetContainer $original)

Customise this object with an "original" record for getting other customised fields

public
array
getAllowedCategories()

Get list of allowed file categories

public
$this
setAllowedCategories(array|string $categories)

Assign allowed categories

protected
array
getAllowedExtensions()

Gets the list of extensions (if limited) for this field. Empty list means there is no restriction on allowed types.

protected
bool
isValidFilename(string $filename)

Validate that this DBFile accepts this filename as valid

protected
assertFilenameValid(string $filename)

Check filename, and raise a ValidationException if invalid

public
bool
validate(ValidationResult $result, string $filename = null)

Hook to validate this record against a validation result

public
string|false
getSize()

Returns the size of the file type in an appropriate format.

public
bool
deleteFile()

Delete a file (and all variants).

public
publishFile()

Publicly expose the file (and all variants) identified by the given filename and hash {AssetStore::publish}

public
protectFile()

Protect a file (and all variants) from public access, identified by the given filename and hash.

public
grantFile()

Ensures that access to the specified protected file is granted for the current user.

public
revokeFile()

Revoke access to the given file for the current user.

public
bool
canViewFile()

Check if the current user can view the given file.

public
string
renameFile(string $newName)

Rename to new filename, and point to new file

public
string
copyFile(string $newName)

Copy to new filename.

Details

mixed __call(string $method, array $arguments)

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

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

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

protected defineMethods()

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

protected registerExtraMethodCallback(string $name, callable $callback)

Register an callback to invoke that defines extra methods

Parameters

string $name
callable $callback

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

protected array getExtraMethodConfig(string $method)

Get meta-data details on a named method

Parameters

string $method

Return Value

array

List of custom method details, if defined for this method

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

protected array findMethodsFromExtension(object $extension) deprecated

deprecated 4.13.0 Will be replaced by findMethodsFrom() in CMS 5

No description

Parameters

object $extension

Return Value

array

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

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

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

Exceptions

InvalidArgumentException

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

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

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

protected addWrapperMethod(string $method, string $wrap)

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

Parameters

string $method

the method name to wrap

string $wrap

the method name to wrap to

protected addCallbackMethod(string $method, callable $callback)

Add callback as a method.

Parameters

string $method

Name of method

callable $callback

Callback to invoke. Note: $this is passed as first parameter to this callback and then $args as array

protected beforeExtending(string $method, callable $callback)

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

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected afterExtending(string $method, callable $callback)

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

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected constructExtensions() deprecated

deprecated 4.0.0:5.0.0 Extensions and methods are now lazy-loaded

No description

protected defineExtensionMethods()

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

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

Add an extension to a specific class.

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

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

Parameters

string $classOrExtension

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

string $extension

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

Return Value

bool

Flag if the extension was added

See also

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

static remove_extension(string $extension)

Remove an extension from a class.

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

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

Add support for removing extensions with parameters

Parameters

string $extension

class name of an Extension subclass, without parameters

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

No description

Parameters

string $class

If omitted, will get extensions for the current class

bool $includeArgumentString

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

Return Value

array

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

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

Get extra config sources for this class

Parameters

string $class

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

Return Value

array|null

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

Class to check extension for, or the extension name to check if the second argument is null.

string $requiredExtension

If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.

bool $strict

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

Return Value

bool

Flag if the extension exists

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

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

Parameters

string $method

the method name to call

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

Return Value

array

List of results with nulls filtered out

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

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

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

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

Parameters

string $method

the name of the method to call on each extension

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

Return Value

array

Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

bool hasExtension(string $extension)

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

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

Parameters

string $extension

Classname of an Extension subclass without parameters

Return Value

bool

Extension[] getExtensionInstances()

Get all extension instances for this specific object instance.

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

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

Return Value

Extension[]

Map of DataExtension instances, keyed by classname.

static Injectable create(mixed ...$args)

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

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

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

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

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

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

Parameters

string $class

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

Return Value

Injectable

The singleton instance

static Config_ForClass config()

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

Return Value

Config_ForClass

mixed stat(string $name) deprecated

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

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

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

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

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct(string $name = null, array|string $allowed = [])

Create a new image manipulation

Parameters

string $name
array|string $allowed

List of allowed file categories (not extensions), as per File::$app_categories

bool __isset(string $property)

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

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

Parameters

string $property

Return Value

bool

mixed __get(string $property)

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

Parameters

string $property

Return Value

mixed

__set(string $property, mixed $value)

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

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

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

Parameters

string $field

Return Value

bool

mixed getField(string $field)

get value of a single composite field

Parameters

string $field

Return Value

mixed

$this setField(string $field, mixed $value, bool $markChanged = true)

Set value of a single composite field

Parameters

string $field
mixed $value
bool $markChanged

Return Value

$this

ViewableData_Customised customise(array|ViewableData $data)

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

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

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

bool exists()

Composite field defaults to exists only if all fields have values

Return Value

bool

string __toString()

No description

Return Value

string

the class name

ViewableData getCustomisedObj()

No description

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

No description

Parameters

ViewableData $object

string castingHelper(string $field)

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

Parameters

string $field

Return Value

string

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

Exceptions

Exception

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'

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

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

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

Parameters

string|array|SSViewer $template

the template to render into

array $customFields

fields to customise() the object with before rendering

Return Value

DBHTMLText

protected string objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName

Name of field

array $arguments

List of optional arguments given

Return Value

string

protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key

Cache key

Return Value

mixed

protected $this objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key

Cache key

mixed $value

Return Value

$this

protected $this objCacheClear()

Clear object cache

Return Value

$this

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

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

Parameters

string $fieldName
array $arguments
bool $cache

Cache this object

string $cacheName

a custom cache name

Return Value

object|DBField

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

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

Parameters

string $field
array $arguments
string $identifier

an optional custom cache identifier

Return Value

object|DBField

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

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

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

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

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

Parameters

string $field
array $arguments
bool $cache

Return Value

string

array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields

an array of field names

Return Value

array

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

array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

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

deprecated 4.0.1 Use ModuleResourceLoader::resourcePath() or ModuleResourceLoader::resourceURL() instead

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

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

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

Return Value

string

URL to the current theme

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

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

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

Parameters

string $stopAtClass

the class to stop at (default: ViewableData)

Return Value

string

ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

static DBField create_field(string $spec, mixed $value, string $name = null, mixed ...$args)

Create a DBField object that's not bound to any particular field.

Useful for accessing the classes behaviour for other parts of your code.

Parameters

string $spec

Class specification to construct. May include both service name and additional constructor arguments in the same format as DataObject.db config.

mixed $value

value of field

string $name

Name of field

mixed ...$args

Additional arguments to pass to constructor if not using args in service $spec Note: Will raise a warning if using both

Return Value

DBField

$this setName(string $name)

Set the name of this field.

The name should never be altered, but it if was never given a name in the first place you can set a name.

If you try an alter the name a warning will be thrown.

Parameters

string $name

Return Value

$this

string getName()

Returns the name of this field.

Return Value

string

mixed getValue()

Returns the value of this field.

Return Value

mixed

$this setValue(mixed $value, DataObject|array $record = null, bool $markChanged = true)

Assign the given value.

If $record is assigned to a dataobject, this field becomes a loose wrapper over the records on that object instead.

{\SilverStripe\ORM\FieldType\ViewableData::obj}

Parameters

mixed $value
DataObject|array $record

An array or object that this field is part of

bool $markChanged

Indicate whether this field should be marked changed. Set to FALSE if you are initializing this field after construction, rather than setting a new value.

Return Value

$this

mixed getDefaultValue()

Get default value assigned at the DB level

Return Value

mixed

$this setDefaultValue(mixed $defaultValue)

Set default value to use at the DB level

Parameters

mixed $defaultValue

Return Value

$this

$this setOptions(array $options = [])

Update the optional parameters for this field

Parameters

array $options

Array of options

Return Value

$this

array getOptions()

Get optional parameters for this field

Return Value

array

$this setIndexType(string|bool $type)

Set the desired index type to use

Parameters

string|bool $type

Either of the types listed in SilverStripe\ORM\FieldType\DBIndexable, or boolean true to indicate that the default index type should be used.

Return Value

$this

Exceptions

InvalidArgumentException

string|bool getIndexType()

Return the desired index type to use. Will return false if the field instance should not be indexed.

Return Value

string|bool

mixed prepValueForDB(mixed $value)

Return the transformed value ready to be sent to the database. This value will be escaped automatically by the prepared query processor, so it should not be escaped or quoted at all.

Parameters

mixed $value

The value to check

Return Value

mixed

The raw value, or escaped parameterised details

writeToManipulation(array $manipulation)

Write all nested fields into a manipulation

Parameters

array $manipulation

addToQuery(SQLSelect $query)

Add all columns which are defined through requireField() and $composite_db, or any additional SQL that is required to get to these columns. Will mostly just write to the SQLSelect->select array.

Parameters

SQLSelect $query

$this setTable(string $tableName)

Assign this DBField to a table

Parameters

string $tableName

Return Value

$this

string|null getTable()

Get the table this field belongs to, if assigned

Return Value

string|null

string forTemplate()

Determine 'default' casting for this field.

Return Value

string

string HTMLATT()

Gets the value appropriate for a HTML attribute string

Return Value

string

string URLATT()

urlencode this string

Return Value

string

string RAWURLATT()

rawurlencode this string

Return Value

string

string ATT()

Gets the value appropriate for a HTML attribute string

Return Value

string

mixed RAW()

Gets the raw value for this field.

Note: Skips processors implemented via forTemplate()

Return Value

mixed

string JS()

Gets javascript string literal value

Return Value

string

string JSON()

Return JSON encoded value

Return Value

string

string HTML()

Alias for {XML()}

Return Value

string

string XML()

Return a html5 tag of the appropriate for this file (normally img or a)

Return Value

string

string CDATA()

Safely escape for XML string

Return Value

string

mixed nullValue()

Returns the value to be set in the database to blank this field.

Usually it's a choice between null, 0, and ''

Return Value

mixed

saveInto(DataObject $dataObject)

Saves this field to the given data object.

Parameters

DataObject $dataObject

FormField scaffoldFormField(string $title = null, array $params = null)

Returns a FormField instance used as a default for form scaffolding.

Used by SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()

Parameters

string $title

Optional. Localized title of the generated instance

array $params

Return Value

FormField

FormField scaffoldSearchField(string $title = null)

Returns a FormField instance used as a default for searchform scaffolding.

Used by SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields().

Parameters

string $title

Optional. Localized title of the generated instance

Return Value

FormField

SearchFilter defaultSearchFilter(string $name = null)

No description

documentation figure out how we pass configuration parameters to search filters (note: parameter hack now in place to pass in the required full path - using $this->name won't work)

Parameters

string $name

Override name of this field

Return Value

SearchFilter

requireField()

Add the field to the underlying database.

debug()

No description

array getArrayValue()

No description

Return Value

array

$this setArrayValue(array $value)

No description

Parameters

array $value

Return Value

$this

string|array getSchemaValue()

Get formfield schema value

Return Value

string|array

Encoded string for use in formschema response

array getIndexSpecs()

Returns the index specifications for the field instance, for example:

[
    'type' => 'unique',
    'columns' => ['FieldName']
]

Return Value

array

bool scalarValueOnly()

Whether or not this DBField only accepts scalar values.

Composite DBFields can override this method and return false so they can accept arrays of values.

Return Value

bool

array compositeDatabaseFields()

Return array in the format of $composite_db.

Used by DataObject->hasOwnDatabaseField().

Return Value

array

isChanged()

Returns true if this composite field has changed.

For fields bound to a DataObject, this will be cleared when the DataObject is written.

bindTo(DataObject $dataObject)

Bind this field to the dataobject, and set the underlying table to that of the owner

Parameters

DataObject $dataObject

DBField|null dbObject(string $field)

Get a db object for the named field

Parameters

string $field

Field name

Return Value

DBField|null

$this setAttribute($name, $value)

Set an HTML attribute

Parameters

$name
$value

Return Value

$this

mixed|null getAttribute(string $name)

Retrieve the value of an HTML attribute

Parameters

string $name

Return Value

mixed|null

abstract protected array getDefaultAttributes()

Get the default attributes when rendering this object.

Called by getAttributes()

Return Value

array

array getAttributes()

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

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

Return Value

array

string getAttributesHTML(array $attributes = null)

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

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

Parameters

array $attributes

Return Value

string

$this setAllowGeneration(bool $allow)

Set whether image resizes are allowed

Parameters

bool $allow

Return Value

$this

bool getAllowGeneration()

Check if resizes are allowed

Return Value

bool

DBFile existingOnly()

Return clone of self which promises to only return existing thumbnails

Return Value

DBFile

string getString()

No description

Return Value

string

Data from the file in this container

resource getStream()

No description

Return Value

resource

Data stream to the asset in this container

string getURL(bool $grant = true)

No description

Parameters

bool $grant

Ensures that the url for any protected assets is granted for the current user. If set to true, and the file is currently in protected mode, the asset store will ensure the returned URL is accessible for the duration of the current session / user. This will have no effect if the file is in published mode. This will not grant access to users other than the owner of the current session.

Return Value

string

public url to the asset in this container

string getAbsoluteURL()

Get the absolute URL to this resource

Return Value

string

The absolute URL to the asset in this container

array|null getMetaData()

Get metadata for this file

Return Value

array|null

File information

string getMimeType()

Get mime type

Return Value

string

Mime type for this file

int getAbsoluteSize()

Return file size in bytes.

Return Value

int

string getFilename()

Get value of filename

Return Value

string

string getHash()

Get value of hash

Return Value

string

string getVariant()

Get value of variant

Return Value

string

bool getIsImage()

Determine if a valid non-empty image exists behind this asset, which is a format compatible with image manipulations

Return Value

bool

AssetContainer Pad(int $width, int $height, string $backgroundColor = 'FFFFFF', int $transparencyPercent = 0)

Fit image to specified dimensions and fill leftover space with a solid colour (default white). Use in templates with $Pad.

Parameters

int $width

The width to size to

int $height

The height to size to

string $backgroundColor
int $transparencyPercent

Level of transparency

Return Value

AssetContainer

AssetContainer Resampled()

Forces the image to be resampled, if possible

Return Value

AssetContainer

updateURL(string $url)

Update the url to point to a resampled version if forcing

Parameters

string $url

AssetContainer ResizedImage(int $width, int $height)

Generate a resized copy of this image with the given width & height.

This can be used in templates with $ResizedImage but should be avoided, as it's the only image manipulation function which can skew an image.

Parameters

int $width

Width to resize to

int $height

Height to resize to

Return Value

AssetContainer

AssetContainer Fit(int $width, int $height)

Scale image proportionally to fit within the specified bounds

Parameters

int $width

The width to size within

int $height

The height to size within

Return Value

AssetContainer

AssetContainer FitMax(int $width, int $height)

Proportionally scale down this image if it is wider or taller than the specified dimensions.

Similar to Fit but without up-sampling. Use in templates with $FitMax.

Parameters

int $width

The maximum width of the output image

int $height

The maximum height of the output image

Return Value

AssetContainer

AssetContainer ScaleWidth(int $width)

Scale image proportionally by width. Use in templates with $ScaleWidth.

Parameters

int $width

The width to set

Return Value

AssetContainer

AssetContainer ScaleMaxWidth(int $width)

Proportionally scale down this image if it is wider than the specified width.

Similar to ScaleWidth but without up-sampling. Use in templates with $ScaleMaxWidth.

Parameters

int $width

The maximum width of the output image

Return Value

AssetContainer

AssetContainer ScaleHeight(int $height)

Scale image proportionally by height. Use in templates with $ScaleHeight.

Parameters

int $height

The height to set

Return Value

AssetContainer

AssetContainer ScaleMaxHeight(int $height)

Proportionally scale down this image if it is taller than the specified height.

Similar to ScaleHeight but without up-sampling. Use in templates with $ScaleMaxHeight.

Parameters

int $height

The maximum height of the output image

Return Value

AssetContainer

AssetContainer CropWidth(int $width)

Crop image on X axis if it exceeds specified width. Retain height.

Use in templates with $CropWidth. Example: $Image.ScaleHeight(100).$CropWidth(100)

Parameters

int $width

The maximum width of the output image

Return Value

AssetContainer

AssetContainer CropHeight(int $height)

Crop image on Y axis if it exceeds specified height. Retain width.

Use in templates with $CropHeight. Example: $Image.ScaleWidth(100).CropHeight(100)

Parameters

int $height

The maximum height of the output image

Return Value

AssetContainer

AssetContainer FillMax(int $width, int $height)

Crop this image to the aspect ratio defined by the specified width and height, then scale down the image to those dimensions if it exceeds them.

Similar to Fill but without up-sampling. Use in templates with $FillMax.

Parameters

int $width

The relative (used to determine aspect ratio) and maximum width of the output image

int $height

The relative (used to determine aspect ratio) and maximum height of the output image

Return Value

AssetContainer

AssetContainer Fill(int $width, int $height)

Resize and crop image to fill specified dimensions.

Use in templates with $Fill

Parameters

int $width

Width to crop to

int $height

Height to crop to

Return Value

AssetContainer

AssetContainer Quality(int $quality)

Set the quality of the resampled image

Parameters

int $quality

Quality level from 0 - 100

Return Value

AssetContainer

Exceptions

InvalidArgumentException

DBFile|DBHTMLText CMSThumbnail()

Default CMS thumbnail

Return Value

DBFile|DBHTMLText

Either a resized thumbnail, or html for a thumbnail icon

AssetContainer|DBHTMLText StripThumbnail()

Generates a thumbnail for use in the gridfield view

Return Value

AssetContainer|DBHTMLText

Either a resized thumbnail, or html for a thumbnail icon

AssetContainer|DBHTMLText PreviewThumbnail()

Get preview for this file

Return Value

AssetContainer|DBHTMLText

Either a resized thumbnail, or html for a thumbnail icon

AssetContainer Thumbnail(int $width, int $height)

Default thumbnail generation for Images

Parameters

int $width
int $height

Return Value

AssetContainer

AssetContainer|DBHTMLText ThumbnailIcon(int $width, int $height)

Thubnail generation for all file types.

Resizes images, but returns an icon <img /> tag if this is not a resizable image

Parameters

int $width
int $height

Return Value

AssetContainer|DBHTMLText

DBHTMLText IconTag()

Get HTML for img containing the icon for this file

Return Value

DBHTMLText

string ThumbnailURL(int $width, int $height)

Get URL to thumbnail of the given size.

May fallback to default icon

Parameters

int $width
int $height

Return Value

string

string getIcon()

Return the relative URL of an icon for the file type, based on the appCategory() value.

Images are searched for in "framework/images/app_icons/".

Return Value

string

URL to icon

Image_Backend getImageBackend()

Get Image_Backend instance for this image

Return Value

Image_Backend

$this setImageBackend(Image_Backend $backend)

No description

Parameters

Image_Backend $backend

Return Value

$this

int getWidth()

Get the width of this image.

Return Value

int

int getHeight()

Get the height of this image.

Return Value

int

int getOrientation()

Get the orientation of this image.

Return Value

int

ORIENTATION_SQUARE | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE

bool isSize(int $width, int $height)

Determine if this image is of the specified size

Parameters

int $width

Width to check

int $height

Height to check

Return Value

bool

bool isWidth(int $width)

Determine if this image is of the specified width

Parameters

int $width

Width to check

Return Value

bool

bool isHeight(int $height)

Determine if this image is of the specified width

Parameters

int $height

Height to check

Return Value

bool

DBFile manipulateImage(string $variant, callable $callback)

Wrapper for manipulate that passes in and stores Image_Backend objects instead of tuples

Parameters

string $variant
callable $callback

Callback which takes an Image_Backend object, and returns an Image_Backend result. If this callback returns true then the current image will be duplicated without modification.

Return Value

DBFile

The manipulated file

DBFile manipulate(string $variant, callable $callback)

Generate a new DBFile instance using the given callback if it hasn't been created yet, or return the existing one if it has.

Parameters

string $variant

name of the variant to create

callable $callback

Callback which should return a new tuple as an array. This callback will be passed the backend, filename, hash, and variant This will not be called if the file does not need to be created.

Return Value

DBFile

The manipulated file

string variantName(string $format, $arg = null)

Name a variant based on a format with arbitrary parameters

Parameters

string $format

The format name.

$arg

Return Value

string

array|null variantParts($variantName)

Reverses variantName().

The "format" part of a variant name is a method name on the owner of this trait. For legacy reasons, there's no delimiter between this part, and the encoded arguments. This means we have to use a whitelist of "known formats", based on methods available on the Image class as the "main" user of this trait. This class is commonly decorated with additional manipulation methods through DataExtension.

Parameters

$variantName

Return Value

array|null

An array of arguments passed to variantName. The first item is the "format".

Exceptions

InvalidArgumentException

protected int castDimension(mixed $value, string $dimension)

Validate a width or size is valid and casts it to integer

Parameters

mixed $value

value of dimension

string $dimension

Name of dimension

Return Value

int

Validated value

bool IsLazyLoaded()

Determine whether the image should be lazy loaded

Return Value

bool

AssetContainer LazyLoad(mixed $lazyLoad)

Set the lazy loading state for this Image

Parameters

mixed $lazyLoad

Return Value

AssetContainer

protected AssetStore getStore()

No description

Return Value

AssetStore

string getTag()

Return a html5 tag of the appropriate for this file (normally img or a)

Return Value

string

string getFrontendTemplate()

Determine the template to render as on the frontend

Return Value

string

Name of template

string getBasename()

Get trailing part of filename

Return Value

string

string getExtension()

Get file extension

Return Value

string

string getTitle()

Alt title for this

Return Value

string

array setFromLocalFile(string $path, string $filename = null, string $hash = null, string $variant = null, array $config = [])

Assign a local file to the backend.

Parameters

string $path

Absolute filesystem path to file

string $filename

Optional path to ask the backend to name as. Will default to the filename of the $path, excluding directories.

string $hash

Hash of original file, if storing a variant.

string $variant

Name of variant, if storing a variant.

array $config

Write options. {\SilverStripe\Assets\Storage\AssetStore}

Return Value

array

Tuple associative array (Filename, Hash, Variant) Unless storing a variant, the hash will be calculated from the local file content.

array setFromStream(resource $stream, string $filename, string $hash = null, string $variant = null, array $config = [])

Assign a stream to the backend

Parameters

resource $stream

Streamable resource

string $filename

Name for the resulting file

string $hash

Hash of original file, if storing a variant.

string $variant

Name of variant, if storing a variant.

array $config

Write options. {\SilverStripe\Assets\Storage\AssetStore}

Return Value

array

Tuple associative array (Filename, Hash, Variant) Unless storing a variant, the hash will be calculated from the raw stream.

array setFromString(string $data, string $filename, string $hash = null, string $variant = null, array $config = [])

Assign a set of data to the backend

Parameters

string $data

Raw binary/text content

string $filename

Name for the resulting file

string $hash

Hash of original file, if storing a variant.

string $variant

Name of variant, if storing a variant.

array $config

Write options. {\SilverStripe\Assets\Storage\AssetStore}

Return Value

array

Tuple associative array (Filename, Hash, Variant) Unless storing a variant, the hash will be calculated from the given data.

Return URL for this image. Alias for getURL()

Return Value

string

Return absolute URL for this image. Alias for getAbsoluteURL()

Return Value

string

string getSourceURL(bool $grant = true)

Get URL, but without resampling.

Note that this will return the url even if the file does not exist.

Parameters

bool $grant

Ensures that the url for any protected assets is granted for the current user.

Return Value

string

string getVisibility()

Determine visibility of the given file

Return Value

string

one of values defined by the constants VISIBILITY_PROTECTED or VISIBILITY_PUBLIC, or null if the file does not exist

$this setOriginal(AssetContainer $original)

Customise this object with an "original" record for getting other customised fields

Parameters

AssetContainer $original

Return Value

$this

array getAllowedCategories()

Get list of allowed file categories

Return Value

array

$this setAllowedCategories(array|string $categories)

Assign allowed categories

Parameters

array|string $categories

Return Value

$this

protected array getAllowedExtensions()

Gets the list of extensions (if limited) for this field. Empty list means there is no restriction on allowed types.

Return Value

array

protected bool isValidFilename(string $filename)

Validate that this DBFile accepts this filename as valid

Parameters

string $filename

Return Value

bool

Exceptions

ValidationException

protected assertFilenameValid(string $filename)

Check filename, and raise a ValidationException if invalid

Parameters

string $filename

Exceptions

ValidationException

bool validate(ValidationResult $result, string $filename = null)

Hook to validate this record against a validation result

Parameters

ValidationResult $result
string $filename

Optional filename to validate. If omitted, the current value is validated.

Return Value

bool

Valid flag

string|false getSize()

Returns the size of the file type in an appropriate format.

Return Value

string|false

String value, or false if doesn't exist

bool deleteFile()

Delete a file (and all variants).

{\SilverStripe\Assets\Storage\AssetStore::delete()}

Return Value

bool

Flag if a file was deleted

publishFile()

Publicly expose the file (and all variants) identified by the given filename and hash {AssetStore::publish}

protectFile()

Protect a file (and all variants) from public access, identified by the given filename and hash.

{\SilverStripe\Assets\Storage\AssetStore::protect()}

grantFile()

Ensures that access to the specified protected file is granted for the current user.

If this file is currently in protected mode, the asset store will ensure the returned asset for the duration of the current session / user. This will have no effect if the file is in published mode. This will not grant access to users other than the owner of the current session. Does not require a member to be logged in.

revokeFile()

Revoke access to the given file for the current user.

Note: This will have no effect if the given file is public

bool canViewFile()

Check if the current user can view the given file.

Return Value

bool

True if the file is verified and grants access to the current session / user.

string renameFile(string $newName)

Rename to new filename, and point to new file

Parameters

string $newName

Return Value

string

Updated Filename

string copyFile(string $newName)

Copy to new filename.

This will not automatically point to the new file (as renameFile() does)

Parameters

string $newName

Return Value

string

Updated filename