File
class File extends DataObject implements AssetContainer, Thumbnail, CMSPreviewable, PermissionProvider, Resettable
This class handles the representation of a file on the filesystem within the framework.
Most of the methods also handle the {@link Folder} subclass.
Note: The files are stored in the assets/ directory, but SilverStripe looks at the db object to gather information about a file such as URL It then uses this for all processing functions (like image manipulation).
Security
Caution: It is recommended to disable any script execution in the "assets/" directory in the webserver configuration, to reduce the risk of exploits. See http://doc.silverstripe.org/secure-development#filesystem
Asset storage
As asset storage is configured separately to any File DataObject records, this class does not make any assumptions about how these records are saved. They could be on a local filesystem, remote filesystem, or a virtual record container (such as in local memory).
The File dataobject simply represents an externally facing view of shared resources within this asset store.
Internally individual files are referenced by a"Filename" parameter, which represents a File, extension, and is optionally prefixed by a list of custom directories. This path is root-agnostic, so it does not automatically have a direct url mapping (even to the site's base directory).
Additionally, individual files may have several versions distinguished by sha1 hash, of which a File DataObject can point to a single one. Files can also be distinguished by variants, which may be resized images or format-shifted documents.
Properties
- "Title": Optional title of the file (for display purposes only). Defaults to "Name". Note that the Title field of Folder (subclass of File) is linked to Name, so Name and Title will always be the same. -"File": Physical asset backing this DB record. This is a composite DB field with its own list of properties. {see DBFile} for more information
- "Content": Typically unused, but handy for a textual representation of files, e.g. for fulltext indexing of PDF documents.
- "ParentID": Points to a {@link Folder} record. Should be in sync with "Filename". A ParentID=0 value points to the "assets/" folder, not the webroot. -"ShowInSearch": True if this file is searchable
Traits
Constants
| CHANGE_NONE |
Represents a field that hasn't changed (before === after, thus before == after) |
| CHANGE_STRICT |
Represents a field that has changed type, although not the loosely defined value. (before !== after && before == after) E.g. change 1 to true or "true" to true, but not true to 0. Value changes are by nature also considered strict changes. |
| CHANGE_VALUE |
Represents a field that has changed the loosely defined value (before != after, thus, before !== after)) E.g. change false to true, but not false to 0 |
| EDIT_ALL |
Permission for edit all files |
Config options
| singular_name | string | ||
| non_live_permissions | array | Anyone with CMS access can view draft files | |
| allowed_extensions | array | ||
| app_categories | array | ||
| class_for_file_extension | Map of file extensions to class type | ||
| apply_restrictions_to_admin | bool | ||
| update_filesystem | boolean | ||
| file_types | string[] | A list of file extensions and a description of what type of file they represent |
Properties
| bool | $destroyed | from DataObject | |
| int | $ID | ID of the DataObject, 0 if the DataObject doesn't exist in database. | from DataObject |
| int | $OldID | ID of object, if deleted | from DataObject |
| string | $Title | Title of the file | |
| string | $ClassName | Class name of the DataObject | from DataObject |
| string | $LastEdited | Date and time of DataObject's last modification. | from DataObject |
| string | $Created | Date and time of DataObject creation. | from DataObject |
| string | $ObsoleteClassName | If ClassName no longer exists this will be set to the legacy value | from DataObject |
| string | $Name | Basename of the file | |
| string | $Filename | Full filename of this file | |
| DBFile | $File | asset stored behind this File record | |
| string | $Content | ||
| string | $ShowInSearch | Boolean that indicates if file is shown in search. Doesn't apply to Folders | |
| int | $ParentID | ID of parent File/Folder | |
| int | $OwnerID | ID of Member who owns the file |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on this object
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
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
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.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
Gets the uninherited value for the given config option
Construct a new DataObject.
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.
Returns true if the given field exists in a database column on any of
the objects tables and optionally look up a dynamic getter with
get
Set the value of the field Called by {@link __set()} and any setFieldName() methods you might create.
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.
A file only exists if the file_exists() and is in the DB as a record
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.
Get the class name a field on this object will be casted to.
Return the string-format type for the given field.
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.
Returns true if the given method/parameter has a value (Uses the DBField::hasValue if the parameter is a database field)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
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.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Create a duplicate of this node. Can duplicate many_many relations
Return obsolete class name, if this is no longer a valid class
Set the ClassName attribute. {@link $class} is also updated.
Create a new instance of a different class from this object's record.
Returns TRUE if all values (other than "ID") are considered empty (by weak boolean comparison).
Get the translated user friendly singular name of this DataObject same as singular_name() but runs it through the translating function
Get the user friendly plural name of this DataObject If the name is not defined (by renaming $plural_name in the subclass), this returns a pluralised version of the class name.
Get the translated user friendly plural name of this DataObject Same as plural_name but runs it through the translation function Translation string is in the form: $this->class.PLURALNAME Example: Page.PLURALNAME
Standard implementation of a title/label for a specific record. Tries to find properties 'Title' or 'Name', and falls back to the 'ID'. Useful to provide user-friendly identification of a record, e.g. in errormessages or UI-selections.
Returns the associated database record - in this case, the object itself.
Update a number of fields on this object, given a map of the desired changes.
Pass changes as a map, and try to get automatic casting for these fields.
Merges data and relations from another object of same class, without conflict resolution. Allows to specify which dataset takes priority in case its not empty.
No description
Find all objects that will be cascade deleted if this object is deleted
Load the default values in from the self::$defaults array.
Writes all changes to this object to the database.
Write the cached components to the database. Cached components could refer to two different instances of the same record.
Delete the record with the given ID.
Return a unary component object from a one to one relationship, as a DataObject.
Returns a one-to-many relation as a HasManyList
Find the foreign class of a relation on this DataObject, regardless of the relation type.
Given a relation name, determine the relation type
Given a relation declared on a remote class, generate a substitute component for the opposite side of the relation.
Returns a many-to-many component, as a ManyManyList.
Return the class of a one-to-one component. If $component is null, return all of the one-to-one components and their classes. If the selected has_one is a polymorphic field then 'DataObject' will be returned for the type.
Returns the class of a remote belongs_to relationship. If no component is specified a map of all components and their class name will be returned.
Gets the class of a one-to-many relationship. If no $component is specified then an array of all the one-to-many relationships and their classes will be returned.
Return the many-to-many extra fields specification.
This returns an array (if it exists) describing the database extensions that are required, or false if none
Generates a SearchContext to be used for building and processing a generic search form for properties on this object.
Determine which properties on the DataObject are searchable, and map them to their default {@link FormField} representations. Used for scaffolding a searchform for {@link ModelAdmin}.
Scaffold a simple edit form for all properties on this dataobject, based on default {@link FormField} mapping in {@link DBField::scaffoldFormField()}.
List of basic content editable file fields.
need to be overload by solid dataobject, so that the customised actions of that dataobject, including that dataobject's extensions customised actions could be added to the EditForm.
Used for simple frontend forms without relation editing or {@link TabSet} behaviour. Uses {@link scaffoldFormFields()} by default. To customize, either overload this method in your subclass, or extend it by {@link DataExtension->updateFrontEndFields()}.
Return the fields that have changed since the last write.
Uses {@link getChangedFields()} to determine if fields have been changed since loading them from the database.
Set the value of the field, using a casting object.
Returns true if the given field exists as a database column
Returns true if the member is allowed to do the given action.
Process tri-state responses from permission-alterting extensions. The extensions are expected to return one of three values:
Return the DBField object that represents the given field.
Traverses to a DBField referenced by relationships between data objects.
Traverses to a field referenced by relationships between data objects, returning the value The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
Temporary hack to return an association name, based on class, to get around the mangle of having to deal with reverse lookup of relationships to determine autogenerated foreign keys.
Return all objects matching the filter sub-classes are automatically selected and included
Return the first item matching the given query.
Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.
Flush the get_one global cache and destroy associated objects.
Reset all global caches associated with DataObject.
Return the given element, searching by ID.
Get list of parameters that should be inherited to relations on this object
Add default records to database. This function is called whenever the database is built, after the database tables have all been created. Overload this to add default records when the database is built, but make sure you call parent::requireDefaultRecords().
Get the default searchable fields for this object, as defined in the $searchable_fields list. If searchable fields are not defined on the data object, uses a default selection of summary fields.
Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.
Get a human-readable label for a single field, see {@link fieldLabels()} for more details.
Defines a default list of filters for the search context.
Temporarily disable subclass access in data object qeur
Returns the list of provided translations for this object.
If selected through a many_many through relation, this is the instance of the joined record
Find objects in the given relationships, merging them into the given list
Helper method to merge owned/owning items into a list.
Return clone of self which promises to only return existing thumbnails
No description
No description
Gets the URL of this file
Gets the URL of this file
Get metadata for this file
Get mime type
Return file size in bytes.
Get value of filename
Get value of hash
Get value of variant
Determine if a valid non-empty image exists behind this asset
Fit image to specified dimensions and fill leftover space with a solid colour (default white). Use in templates with $Pad.
Update the url to point to a resampled version if forcing
Generate a resized copy of this image with the given width & height.
Scale image proportionally to fit within the specified bounds
Proportionally scale down this image if it is wider or taller than the specified dimensions.
Scale image proportionally by width. Use in templates with $ScaleWidth.
Proportionally scale down this image if it is wider than the specified width.
Scale image proportionally by height. Use in templates with $ScaleHeight.
Proportionally scale down this image if it is taller than the specified height.
Crop image on X axis if it exceeds specified width. Retain height.
Crop image on Y axis if it exceeds specified height. Retain width.
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.
Resize and crop image to fill specified dimensions.
Generates a thumbnail for use in the gridfield view
Default thumbnail generation for Images
Thumbnail generation for all file types.
Get URL to thumbnail of the given size.
Return the relative URL of an icon for the file type, based on the {@link appCategory()} value.
Determine if this image is of the specified size
Determine if this image is of the specified width
Determine if this image is of the specified width
Wrapper for manipulate that passes in and stores Image_Backend objects instead of tuples
Generate a new DBFile instance using the given callback if it hasn't been created yet, or return the existing one if it has.
Name a variant based on a format with arbitrary parameters
No description
Just an alias function to keep a consistent API with SiteTree
Just an alias function to keep a consistent API with SiteTree
No description
Get title for current file status
Returns a category based on the file extension.
For a category or list of categories, get the list of file extensions
Returns a category based on the file extension.
Should be called after the file was uploaded
No description
This will check if the parent record and/or name do not match the name on the underlying DBFile record, and if so, copy this file to the new location, and update the record to point to this new file.
Collate selected descendants of this page.
Get URL, but without resampling.
Get expected value of Filename tuple value. Will be used to trigger a file move on draft stage.
Rename this file.
Copy to new filename.
Update the ParentID and Name for the given filename.
Returns the file extension
Gets the extension of a filepath or filename, by stripping away everything before the last "dot".
Given an extension, determine the icon that should be used
Return the type of file for the given extension on the current file name.
Get descriptive type of file based on filename
Returns the size of the file type in an appropriate format.
Formats a file size (eg: (int)42 becomes string '42 bytes')
Maps a {@link File} subclass to a specific extension.
See {@link get_class_for_file_extension()}.
Assign a local file to the backend.
Assign a stream to the backend
Assign a set of data to the backend
Return a html5 tag of the appropriate for this file (normally img or a)
Return a html5 tag of the appropriate for this file (normally img or a)
Get the back-link tracking objects that link to this file via HTML fields
Count of backlinks Note: Doesn't filter broken records
Joins one or more segments together to build a Filename identifier.
Delete a file (and all variants).
Determine visibility of the given file
Publicly expose the file (and all variants) identified by the given filename and hash {see AssetStore::publish}
Protect a file (and all variants) from public access, identified by the given filename and hash.
Ensures that access to the specified protected file is granted for the current user.
Revoke access to the given file for the current user.
Check if the current user can view the given file.
No description
Determine the preview link, if available, for this object.
No description
Return a map of permission codes to add to the dropdown shown in the Security section of the CMS.
Get the list of globally allowed file extensions for file uploads.
Returns parent File
Returns Member object of file owner.
Details
in CustomMethods at line 50
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in CustomMethods at line 144
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
in CustomMethods at line 172
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in Extensible at line 163
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).
in Extensible at line 224
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.
in Extensible at line 264
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 298
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
in Extensible at line 359
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
in Extensible at line 395
array
invokeWithExtensions(string $method, mixed $arguments)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in Extensible at line 424
array
extend(string $method, mixed $arguments)
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()}.
in Extensible at line 465
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in Extensible at line 494
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
in Extensible at line 508
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See {@link get_extensions()} to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
in Injectable at line 26
static Injectable
create(array $args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();
in Injectable at line 43
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
in Configurable at line 20
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in Configurable at line 32
mixed
stat(string $name)
deprecated
deprecated 5.0 Use ->config()->get() instead
Get inherited config value
in Configurable at line 44
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
in Configurable at line 57
$this
set_stat(string $name, mixed $value)
deprecated
deprecated 5.0 Use ->config()->set() instead
Update the config value for a given property
in DataObject at line 327
__construct(array|null $record = null, boolean $isSingleton = false, array $queryParams = array())
Construct a new DataObject.
in ViewableData at line 106
bool
__isset(string $property)
Check if a field exists on this object or its failover.
Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.
in ViewableData at line 129
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
in ViewableData at line 152
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
in ViewableData at line 167
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
in ViewableData at line 183
ViewableData|null
getFailover()
Get the current failover object if set
in DataObject at line 2827
bool
hasField(string $field)
Returns true if the given field exists in a database column on any of
the objects tables and optionally look up a dynamic getter with
get
in DataObject at line 2470
mixed
getField(string $field)
Gets the value of a field.
Called by {@link __get()} and any getFieldName() methods you might create.
in DataObject at line 2688
$this
setField(string $fieldName, mixed $val)
Set the value of the field Called by {@link __set()} and any setFieldName() methods you might create.
in DataObject at line 717
defineMethods()
Adds methods from the extensions.
Called by Object::__construct() once per class.
in ViewableData at line 258
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
at line 285
bool
exists()
A file only exists if the file_exists() and is in the DB as a record
Use $file->isInDB() to only check for a DB record Use $file->File->exists() to only check if the asset exists
in ViewableData at line 289
string
__toString()
in ViewableData at line 297
ViewableData
getCustomisedObj()
in ViewableData at line 305
setCustomisedObj(ViewableData $object)
in DataObject at line 2798
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.
in ViewableData at line 352
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
in ViewableData at line 365
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 389
DBHTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
in ViewableData at line 471
Object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
in ViewableData at line 516
Object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
in DataObject at line 4091
bool
hasValue(string $field, array $arguments = null, bool $cache = true)
Returns true if the given method/parameter has a value (Uses the DBField::hasValue if the parameter is a database field)
in ViewableData at line 545
string
XML_val(string $field, array $arguments = [], bool $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
in ViewableData at line 558
array
getXMLValues(array $fields)
Get an array of XML-escaped values by field name
in ViewableData at line 579
ArrayIterator
getIterator()
Return a single-item iterator so you can iterate over the fields of a single record.
This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.
in DataObject at line 2458
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
in ViewableData at line 603
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
in ViewableData at line 620
string
ThemeDir()
deprecated
deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead
Return the directory if the current active theme (relative to the site root).
This method is useful for things such as accessing theme images from your template without hardcoding the theme
page - e.g. 
.
This method should only be used when a theme is currently active. However, it will fall over to the current project directory.
in ViewableData at line 647
string
CSSClasses(string $stopAtClass = self::class)
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
in ViewableData at line 676
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in DataObject at line 312
static DataObjectSchema
getSchema()
Get schema object
in DataObject at line 408
destroy()
Destroy all of this objects dependant objects and local caches.
You'll need to call this to get the memory of an object that has components or extensions freed.
in DataObject at line 425
DataObject
duplicate(bool $doWrite = true, array|null|false $relations = null)
Create a duplicate of this node. Can duplicate many_many relations
in DataObject at line 631
string
getObsoleteClassName()
Return obsolete class name, if this is no longer a valid class
in DataObject at line 645
string
getClassName()
Gets name of this class
in DataObject at line 664
$this
setClassName(string $className)
Set the ClassName attribute. {@link $class} is also updated.
Warning: This will produce an inconsistent record, as the object instance will not automatically switch to the new subclass. Please use {@link newClassInstance()} for this purpose, or destroy and reinstanciate the record.
in DataObject at line 692
DataObject
newClassInstance(string $newClassName)
Create a new instance of a different class from this object's record.
This is useful when dynamically changing the type of an instance. Specifically, it ensures that the instance of the class is a match for the className of the record. Don't set the {@link DataObject->class} or {@link DataObject->ClassName} property manually before calling this method, as it will confuse change detection.
If the new class is different to the original class, defaults are populated again because this will only occur automatically on instantiation of a DataObject if there is no record, or the record has no ID. In this case, we do have an ID but we still need to repopulate the defaults.
in DataObject at line 766
boolean
isEmpty()
Returns TRUE if all values (other than "ID") are considered empty (by weak boolean comparison).
in DataObject at line 794
string
i18n_pluralise(string $count)
Pluralise this item given a specific count.
E.g. "0 Pages", "1 File", "3 Images"
in DataObject at line 811
string
singular_name()
Get the user friendly singular name of this DataObject.
If the name is not defined (by redefining $singular_name in the subclass), this returns the class name.
in DataObject at line 835
string
i18n_singular_name()
Get the translated user friendly singular name of this DataObject same as singular_name() but runs it through the translating function
Translating string is in the form: $this->class.SINGULARNAME Example: Page.SINGULARNAME
in DataObject at line 847
string
plural_name()
Get the user friendly plural name of this DataObject If the name is not defined (by renaming $plural_name in the subclass), this returns a pluralised version of the class name.
in DataObject at line 870
string
i18n_plural_name()
Get the translated user friendly plural name of this DataObject Same as plural_name but runs it through the translation function Translation string is in the form: $this->class.PLURALNAME Example: Page.PLURALNAME
in DataObject at line 892
string
getTitle()
Standard implementation of a title/label for a specific record. Tries to find properties 'Title' or 'Name', and falls back to the 'ID'. Useful to provide user-friendly identification of a record, e.g. in errormessages or UI-selections.
Overload this method to have a more specialized implementation,
e.g. for an Address record this could be:
function getTitle() {
return "{$this->StreetNumber} {$this->StreetName} {$this->City}";
}
in DataObject at line 911
DataObject
data()
Returns the associated database record - in this case, the object itself.
This is included so that you can call $dataOrController->data() and get a DataObject all the time.
in DataObject at line 921
array
toMap()
Convert this object to a map.
in DataObject at line 935
array
getQueriedDatabaseFields()
Return all currently fetched database fields.
This function is similar to toMap() but doesn't trigger the lazy-loading of all unfetched fields. Obviously, this makes it a lot faster.
in DataObject at line 955
DataObject
update(array $data)
Update a number of fields on this object, given a map of the desired changes.
The field names can be simple names, or you can use a dot syntax to access $has_one relations. For example, array("Author.FirstName" => "Jim") will set $this->Author()->FirstName to "Jim".
Doesn't write the main object, but if you use the dot syntax, it will write() the related objects that it alters.
When using this method with user supplied data, it's very important to whitelist the allowed keys.
in DataObject at line 1016
DataObject
castedUpdate(array $data)
Pass changes as a map, and try to get automatic casting for these fields.
Doesn't write to the database. To write the data, use the write() method.
in DataObject at line 1045
Boolean
merge(DataObject $rightObj, string $priority = 'right', bool $includeRelations = true, bool $overwriteWithEmpty = false)
Merges data and relations from another object of same class, without conflict resolution. Allows to specify which dataset takes priority in case its not empty.
has_one-relations are just transferred with priority 'right'. has_many and many_many-relations are added regardless of priority.
Caution: has_many/many_many relations are moved rather than duplicated, meaning they are not connected to the merged object any longer. Caution: Just saves updated has_many/many_many relations to the database, doesn't write the updated object itself (just writes the object-properties). Caution: Does not delete the merged object. Caution: Does now overwrite Created date on the original object.
in DataObject at line 1126
$this
forceChange()
Forces the record to think that all its data has changed.
Doesn't write to the database. Force-change preseved until next write. Existing CHANGE_VALUE or CHANGE_STRICT values are preserved.
at line 1046
ValidationResult
validate()
in DataObject at line 1170
ValidationResult
doValidate()
Public accessor for {see DataObject::validate()}
in DataObject at line 1218
ArrayList
findCascadeDeletes(bool $recursive = true, ArrayList $list = null)
Find all objects that will be cascade deleted if this object is deleted
Notes: - If this object is versioned, objects will only be searched in the same stage as the given record. - This will only be useful prior to deletion, as post-deletion this record will no longer exist.
in DataObject at line 1258
DataObject
populateDefaults()
Load the default values in from the self::$defaults array.
Will traverse the defaults of the current class and all its parent classes. Called by the constructor when creating new records.
in DataObject at line 1517
write(boolean $showDebug = false, boolean $forceInsert = false, boolean $forceWrite = false, boolean|array $writeComponents = false)
Writes all changes to this object to the database.
- It will insert a record whenever ID isn't set, otherwise update.
- All relevant tables will be updated.
- $this->onBeforeWrite() gets called beforehand.
- Extensions such as Versioned will ammend the database-write to ensure that a version is saved.
in DataObject at line 1584
writeRelations()
Writes cached relation lists to the database, if possible
in DataObject at line 1607
DataObject
writeComponents(bool $recursive = false, array $skip = [])
Write the cached components to the database. Cached components could refer to two different instances of the same record.
in DataObject at line 1674
delete()
Delete this data object.
$this->onBeforeDelete() gets called. Note that in Versioned objects, both Stage and Live will be deleted.
in DataObject at line 1718
static
delete_by_id(string $className, int $id)
Delete the record with the given ID.
in DataObject at line 1736
array
getClassAncestry()
Get the class ancestry, including the current class name.
The ancestry will be returned as an array of class names, where the 0th element will be the class that inherits directly from DataObject, and the last element will be the current class.
in DataObject at line 1750
DataObject
getComponent(string $componentName)
Return a unary component object from a one to one relationship, as a DataObject.
If no component is available, an 'empty component' will be returned for non-polymorphic relations, or for polymorphic relations with a class set.
in DataObject at line 1830
$this
setComponent(string $componentName, DataObject|null $item)
Assign an item to the given component
in DataObject at line 1876
HasManyList|UnsavedRelationList
getComponents(string $componentName, int|array $id = null)
Returns a one-to-many relation as a HasManyList
in DataObject at line 1922
string
getRelationClass(string $relationName)
Find the foreign class of a relation on this DataObject, regardless of the relation type.
in DataObject at line 1959
string
getRelationType(string $component)
Given a relation name, determine the relation type
in DataObject at line 1989
DataList|DataObject
inferReciprocalComponent(string $remoteClass, string $remoteRelation)
Given a relation declared on a remote class, generate a substitute component for the opposite side of the relation.
Notes on behaviour: - This can still be used on components that are defined on both sides, but do not need to be. - All has_ones on remote class will be treated as local has_many, even if they are belongs_to - Polymorphic relationships do not have two natural endpoints (only on one side) and thus attempting to infer them will return nothing. - Cannot be used on unsaved objects.
in DataObject at line 2089
ManyManyList|UnsavedRelationList
getManyManyComponents(string $componentName, int|array $id = null)
Returns a many-to-many component, as a ManyManyList.
in DataObject at line 2158
string|array
hasOne()
Return the class of a one-to-one component. If $component is null, return all of the one-to-one components and their classes. If the selected has_one is a polymorphic field then 'DataObject' will be returned for the type.
in DataObject at line 2171
string|array
belongsTo(bool $classOnly = true)
Returns the class of a remote belongs_to relationship. If no component is specified a map of all components and their class name will be returned.
in DataObject at line 2189
string|array|false
hasMany(bool $classOnly = true)
Gets the class of a one-to-many relationship. If no $component is specified then an array of all the one-to-many relationships and their classes will be returned.
in DataObject at line 2207
array|null
manyManyExtraFields()
Return the many-to-many extra fields specification.
If you don't specify a component name, it returns all extra fields for all components available.
in DataObject at line 2220
array|null
manyMany()
Return information about a many-to-many component.
The return value is an array of (parentclass, childclass). If $component is null, then all many-many components are returned.
in DataObject at line 2237
array|false
database_extensions(string $class)
This returns an array (if it exists) describing the database extensions that are required, or false if none
This is experimental, and is currently only a Postgres-specific enhancement.
in DataObject at line 2253
SearchContext
getDefaultSearchContext()
Generates a SearchContext to be used for building and processing a generic search form for properties on this object.
in DataObject at line 2277
FieldList
scaffoldSearchFields(array $_params = null)
Determine which properties on the DataObject are searchable, and map them to their default {@link FormField} representations. Used for scaffolding a searchform for {@link ModelAdmin}.
Some additional logic is included for switching field labels, based on how generic or specific the field type is.
Used by {@link SearchContext}.
in DataObject at line 2352
FieldList
scaffoldFormFields(array $_params = null)
Scaffold a simple edit form for all properties on this dataobject, based on default {@link FormField} mapping in {@link DBField::scaffoldFormField()}.
Field labels/titles will be auto generated from {@link DataObject::fieldLabels()}.
at line 476
FieldList
getCMSFields()
List of basic content editable file fields.
Note: These fields no longer affect the edit form in asset-admin. To add fields to the file edit form in asset-admin, you will need to add an extension to FileFormFactory and use the updateFormFields() hook.
in DataObject at line 2431
FieldList
getCMSActions()
need to be overload by solid dataobject, so that the customised actions of that dataobject, including that dataobject's extensions customised actions could be added to the EditForm.
in DataObject at line 2450
FieldList
getFrontEndFields(array $params = null)
Used for simple frontend forms without relation editing or {@link TabSet} behaviour. Uses {@link scaffoldFormFields()} by default. To customize, either overload this method in your subclass, or extend it by {@link DataExtension->updateFrontEndFields()}.
in DataObject at line 2601
array
getChangedFields(boolean|array $databaseFieldsOnly = false, int $changeLevel = self::CHANGE_STRICT)
Return the fields that have changed since the last write.
The change level affects what the functions defines as "changed": - Level CHANGE_STRICT (integer 1) will return strict changes, even !== ones. - Level CHANGE_VALUE (integer 2) is more lenient, it will only return real data changes, for example a change from 0 to null would not be included.
Example return:
array(
'Title' = array('before' => 'Home', 'after' => 'Home-Changed', 'level' => DataObject::CHANGE_VALUE)
)
in DataObject at line 2669
boolean
isChanged(string $fieldName = null, int $changeLevel = self::CHANGE_STRICT)
Uses {@link getChangedFields()} to determine if fields have been changed since loading them from the database.
in DataObject at line 2780
$this
setCastedField(string $fieldName, mixed $value)
Set the value of the field, using a casting object.
This is useful when you aren't sure that a date is in SQL format, for example. setCastedField() can also be used, by forms, to set related data. For example, uploaded images can be saved into the Image table.
in DataObject at line 2846
boolean
hasDatabaseField(string $field)
Returns true if the given field exists as a database column
in DataObject at line 2863
boolean
can(string $perm, Member $member = null, array $context = array())
Returns true if the member is allowed to do the given action.
See {@link extendedCan()} for a more versatile tri-state permission control.
in DataObject at line 2907
boolean|null
extendedCan(string $methodName, Member|int $member, array $context = array())
Process tri-state responses from permission-alterting extensions. The extensions are expected to return one of three values:
- false: Disallow this permission, regardless of what other extensions say
- true: Allow this permission, as long as no other extensions return false
- NULL: Don't affect the outcome
This method itself returns a tri-state value, and is designed to be used like this:
$extended = $this->extendedCan('canDoSomething', $member);
if($extended !== null) return $extended;
else return $normalValue;
at line 358
boolean
canView(Member $member = null)
at line 384
boolean
canEdit(Member $member = null)
Check if this file can be modified
at line 442
boolean
canDelete(Member $member = null)
Check if this file can be deleted
at line 411
boolean
canCreate(Member $member = null, array $context = array())
Check if a file can be created
in DataObject at line 2983
string
debug()
Debugging used by Debug::show()
in DataObject at line 3006
DBField
dbObject(string $fieldName)
Return the DBField object that represents the given field.
This works similarly to obj() with 2 key differences: - it still returns an object even when the field has no value. - it only matches fields and not methods - it matches foreign keys generated by has_one relationships, eg, "ParentID"
in DataObject at line 3054
mixed
relObject(string $fieldPath)
Traverses to a DBField referenced by relationships between data objects.
The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName).
If a relation is blank, this will return null instead. If a relation name is invalid (e.g. non-relation on a parent) this can throw a LogicException.
in DataObject at line 3092
mixed
relField(string $fieldName)
Traverses to a field referenced by relationships between data objects, returning the value The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
in DataObject at line 3119
string
getReverseAssociation(string $className)
Temporary hack to return an association name, based on class, to get around the mangle of having to deal with reverse lookup of relationships to determine autogenerated foreign keys.
in DataObject at line 3160
static DataList
get(string $callerClass = null, string|array $filter = "", string|array $sort = "", string $join = "", string|array $limit = null, string $containerClass = DataList::class)
Return all objects matching the filter sub-classes are automatically selected and included
in DataObject at line 3225
static DataObject|null
get_one(string|null $callerClass = null, string|array $filter = "", boolean $cache = true, string $orderBy = "")
Return the first item matching the given query.
All calls to get_one() are cached.
The filter argument supports parameterised queries (see SQLSelect::addWhere() for syntax examples). Because
of that (and differently from e.g. DataList::filter()) you need to manually escape the field names:
$member = DataObject::get_one('Member', [ '"FirstName"' => 'John' ]);
at line 1394
DataObject
flushCache(boolean $persistent = true)
Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.
in DataObject at line 3291
static
flush_and_destroy_cache()
Flush the get_one global cache and destroy associated objects.
at line 1402
static
reset()
Reset all global caches associated with DataObject.
in DataObject at line 3332
static DataObject
get_by_id(string|int $classOrID, int|bool $idOrCache = null, boolean $cache = true)
Return the given element, searching by ID.
This can be called either via DataObject::get_by_id(MyClass::class, $id)
or MyClass::get_by_id($id)
in DataObject at line 3354
string
baseTable()
Get the name of the base table for this object
in DataObject at line 3364
string
baseClass()
Get the base class for this object
in DataObject at line 3380
array
getSourceQueryParams()
in DataObject at line 3390
array
getInheritableQueryParams()
Get list of parameters that should be inherited to relations on this object
in DataObject at line 3401
setSourceQueryParams(array $array)
in DataObject at line 3411
setSourceQueryParam(string $key, string $value)
in DataObject at line 3421
string
getSourceQueryParam(string $key)
in DataObject at line 3436
requireTable()
Check the database schema and update it as necessary.
in DataObject at line 3539
requireDefaultRecords()
Add default records to database. This function is called whenever the database is built, after the database tables have all been created. Overload this to add default records when the database is built, but make sure you call parent::requireDefaultRecords().
in DataObject at line 3566
array
searchableFields()
Get the default searchable fields for this object, as defined in the $searchable_fields list. If searchable fields are not defined on the data object, uses a default selection of summary fields.
in DataObject at line 3666
array
fieldLabels(boolean $includerelations = true)
Get any user defined searchable fields labels that exist. Allows overriding of default field names in the form interface actually presented to the user.
The reason for keeping this separate from searchable_fields, which would be a logical place for this functionality, is to avoid bloating and complicating the configuration array. Currently much of this system is based on sensible defaults, and this property would generally only be set in the case of more complex relationships between data object being required in the search interface.
Generates labels based on name of the field itself, if no static property {@link self::field_labels} exists.
in DataObject at line 3732
string
fieldLabel(string $name)
Get a human-readable label for a single field, see {@link fieldLabels()} for more details.
in DataObject at line 3745
array
summaryFields()
Get the default summary fields for this object.
in DataObject at line 3804
array
defaultSearchFilters()
Defines a default list of filters for the search context.
If a filter class mapping is defined on the data object, it is constructed here. Otherwise, the default filter specified in {@link DBField} is used.
in DataObject at line 3825
boolean
isInDB()
in DataObject at line 3838
static
disable_subclass_access()
Temporarily disable subclass access in data object qeur
in DataObject at line 3843
static
enable_subclass_access()
in DataObject at line 4065
array
provideI18nEntities()
Returns the list of provided translations for this object.
Note: Pluralised forms are always returned in array format.
Example usage:
class MyTestClass implements i18nEntityProvider
{
public function provideI18nEntities()
{
$entities = [];
foreach($this->config()->get('my_static_array') as $key => $value) {
$entities["MyTestClass.my_static_array_{$key}"] = $value;
}
$entities["MyTestClass.PLURALS"] = [
'one' => 'A test class',
'other' => '{count} test classes',
]
return $entities;
}
}
Example usage in {@link DataObject->provideI18nEntities()}.
You can ask textcollector to add the provided entity to a different module. Simply wrap the returned value for any item in an array with the format: [ 'default' => $defaultValue, 'module' => $module ]
class MyTestClass implements i18nEntityProvider
{
public function provideI18nEntities()
{
$entities = [
'MyOtherModuleClass.MYENTITY' => [
'default' => $value,
'module' => 'myothermodule',
]
];
}
return $entities;
}
in DataObject at line 4107
DataObject
getJoin()
If selected through a many_many through relation, this is the instance of the joined record
in DataObject at line 4119
$this
setJoin(DataObject $object, string $alias = null)
Set joining object
in DataObject at line 4142
ArrayList
findRelatedObjects(string $source, bool $recursive = true, ArrayList $list = null)
Find objects in the given relationships, merging them into the given list
in DataObject at line 4191
ArrayList
mergeRelatedObjects(ArrayList $list, mixed $items)
Helper method to merge owned/owning items into a list.
Items already present in the list will be skipped.
in ImageManipulation at line 67
$this
setAllowGeneration(bool $allow)
Set whether image resizes are allowed
in ImageManipulation at line 78
bool
getAllowGeneration()
Check if resizes are allowed
in ImageManipulation at line 88
DBFile
existingOnly()
Return clone of self which promises to only return existing thumbnails
at line 1120
string
getString()
at line 1112
resource
getStream()
at line 799
string
getURL(bool $grant = true)
Gets the URL of this file
at line 783
string
getAbsoluteURL()
Gets the URL of this file
at line 1096
array|null
getMetaData()
Get metadata for this file
at line 1104
string
getMimeType()
Get mime type
at line 1038
int
getAbsoluteSize()
Return file size in bytes.
at line 1166
string
getFilename()
Get value of filename
at line 1171
string
getHash()
Get value of hash
at line 1176
string
getVariant()
Get value of variant
at line 1161
bool
getIsImage()
Determine if a valid non-empty image exists behind this asset
in ImageManipulation at line 241
AssetContainer
Pad(int $width, int $height, string $backgroundColor = 'FFFFFF', int $transparencyPercent)
Fit image to specified dimensions and fill leftover space with a solid colour (default white). Use in templates with $Pad.
in ImageManipulation at line 262
AssetContainer
Resampled()
Forces the image to be resampled, if possible
in ImageManipulation at line 285
updateURL(string $url)
Update the url to point to a resampled version if forcing
in ImageManipulation at line 314
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.
in ImageManipulation at line 334
AssetContainer
Fit(int $width, int $height)
Scale image proportionally to fit within the specified bounds
in ImageManipulation at line 375
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.
in ImageManipulation at line 419
AssetContainer
ScaleWidth(int $width)
Scale image proportionally by width. Use in templates with $ScaleWidth.
in ImageManipulation at line 439
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.
in ImageManipulation at line 457
AssetContainer
ScaleHeight(int $height)
Scale image proportionally by height. Use in templates with $ScaleHeight.
in ImageManipulation at line 477
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.
in ImageManipulation at line 498
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)
in ImageManipulation at line 520
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)
in ImageManipulation at line 544
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.
in ImageManipulation at line 584
AssetContainer
Fill(int $width, int $height)
Resize and crop image to fill specified dimensions.
Use in templates with $Fill
in ImageManipulation at line 604
AssetContainer
Quality(int $quality)
Set the quality of the resampled image
in ImageManipulation at line 618
DBFile|DBHTMLText
CMSThumbnail()
Default CMS thumbnail
in ImageManipulation at line 630
AssetContainer|DBHTMLText
StripThumbnail()
Generates a thumbnail for use in the gridfield view
in ImageManipulation at line 642
AssetContainer|DBHTMLText
PreviewThumbnail()
Get preview for this file
in ImageManipulation at line 655
AssetContainer
Thumbnail(int $width, int $height)
Default thumbnail generation for Images
in ImageManipulation at line 669
AssetContainer|DBHTMLText
ThumbnailIcon(int $width, int $height)
Thumbnail generation for all file types.
Resizes images, but returns an icon <img /> tag if this is not a resizable image
in ImageManipulation at line 679
DBHTMLText
IconTag()
Get HTML for img containing the icon for this file
in ImageManipulation at line 698
string
ThumbnailURL(int $width, int $height)
Get URL to thumbnail of the given size.
May fallback to default icon
in ImageManipulation at line 714
string
getIcon()
Return the relative URL of an icon for the file type, based on the {@link appCategory()} value.
Images are searched for in "framework/images/app_icons/".
in ImageManipulation at line 726
Image_Backend
getImageBackend()
Get Image_Backend instance for this image
in ImageManipulation at line 751
$this
setImageBackend(Image_Backend $backend)
in ImageManipulation at line 762
int
getWidth()
Get the width of this image.
in ImageManipulation at line 776
int
getHeight()
Get the height of this image.
in ImageManipulation at line 790
int
getOrientation()
Get the orientation of this image.
in ImageManipulation at line 810
boolean
isSize(int $width, int $height)
Determine if this image is of the specified size
in ImageManipulation at line 821
boolean
isWidth(int $width)
Determine if this image is of the specified width
in ImageManipulation at line 833
boolean
isHeight(int $height)
Determine if this image is of the specified width
in ImageManipulation at line 847
DBFile
manipulateImage(string $variant, callable $callback)
Wrapper for manipulate that passes in and stores Image_Backend objects instead of tuples
in ImageManipulation at line 917
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.
in ImageManipulation at line 994
string
variantName($format, $arg = null)
Name a variant based on a format with arbitrary parameters
in ImageManipulation at line 1013
array|null
variantParts($variantName)
Reverses {@link 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 {@link Image} class as the "main" user of this trait. This class is commonly decorated with additional manipulation methods through {@link DataExtension}.
at line 272
static
get_shortcodes()
at line 296
static File
find(string $filename)
Find a File object by the given filename.
at line 322
string
Link()
Just an alias function to keep a consistent API with SiteTree
at line 330
RelativeLink()
deprecated
deprecated 4.0
at line 341
string
AbsoluteLink()
Just an alias function to keep a consistent API with SiteTree
at line 349
string
getTreeTitle()
at line 500
string
getStatusTitle()
Get title for current file status
at line 520
static string
get_app_category(string $ext)
Returns a category based on the file extension.
This can be useful when grouping files by type, showing icons on filelinks, etc. Possible group values are: "audio", "mov", "zip", "image".
at line 537
static array
get_category_extensions(array|string $categories)
For a category or list of categories, get the list of file extensions
at line 572
string
appCategory()
Returns a category based on the file extension.
at line 580
onAfterUpload()
Should be called after the file was uploaded
at line 660
onAfterRevertToLive()
at line 705
bool
updateFilesystem()
This will check if the parent record and/or name do not match the name on the underlying DBFile record, and if so, copy this file to the new location, and update the record to point to this new file.
This method will update the File {see DBFile} field value on success, so it must be called before writing to the database
at line 752
true|null
collateDescendants(string $condition, array $collator)
Collate selected descendants of this page.
$condition will be evaluated on each descendant, and if it is succeeds, that item will be added to the $collator array.
at line 813
string
getSourceURL(bool $grant = true)
Get URL, but without resampling.
at line 827
string
generateFilename()
Get expected value of Filename tuple value. Will be used to trigger a file move on draft stage.
at line 845
string
renameFile(string $newName)
Rename this file.
Note: This method will immediately save to the database to maintain filesystem consistency with the database.
at line 852
string
copyFile(string $newName)
Copy to new filename.
This will not automatically point to the new file (as renameFile() does)
at line 868
$this
setFilename(string $filename)
Update the ParentID and Name for the given filename.
On save, the underlying DBFile record will move the underlying file to this location. Thus it will not update the underlying Filename value until this is done.
at line 900
string
getExtension()
Returns the file extension
at line 919
static string
get_file_extension(string $filename)
Gets the extension of a filepath or filename, by stripping away everything before the last "dot".
Caution: Only returns the last extension in "double-barrelled" extensions (e.g. "gz" for "tar.gz").
Examples: - "myfile" returns "" - "myfile.txt" returns "txt" - "myfile.tar.gz" returns "gz"
at line 930
static string
get_icon_for_extension(string $extension)
Given an extension, determine the icon that should be used
at line 955
string
getFileType()
Return the type of file for the given extension on the current file name.
at line 966
static string
get_file_type(string $filename)
Get descriptive type of file based on filename
at line 988
string|false
getSize()
Returns the size of the file type in an appropriate format.
at line 1003
static string
format_size(int $size)
Formats a file size (eg: (int)42 becomes string '42 bytes')
at line 1027
static int
ini2bytes(string $iniValue)
deprecated
deprecated 5.0 Use Convert::memstring2bytes() instead
Convert a php.ini value (eg: 512M) to bytes
at line 1069
static String
get_class_for_file_extension(String $ext)
Maps a {@link File} subclass to a specific extension.
By default, files with common image extensions will be created as {@link Image} instead of {@link File} when using {@link Folder::constructChild}, {@link Folder::addUploadToFolder}), and the {@link Upload} class (either directly or through {@link FileField}). For manually instanciated files please use this mapping getter.
Caution: Changes to mapping doesn't apply to existing file records in the database. Also doesn't hook into {@link Object::getCustomClass()}.
at line 1081
static
set_class_for_file_extension(String|array $exts, String $class)
See {@link get_class_for_file_extension()}.
at line 1128
array
setFromLocalFile(string $path, string $filename = null, string $hash = null, string $variant = null, array $config = array())
Assign a local file to the backend.
at line 1139
array
setFromStream(resource $stream, string $filename, string $hash = null, string $variant = null, array $config = array())
Assign a stream to the backend
at line 1150
array
setFromString(string $data, string $filename, string $hash = null, string $variant = null, array $config = array())
Assign a set of data to the backend
at line 1186
string
forTemplate()
Return a html5 tag of the appropriate for this file (normally img or a)
at line 1196
string
getTag()
Return a html5 tag of the appropriate for this file (normally img or a)
at line 1210
BackLinkTracking()
Get the back-link tracking objects that link to this file via HTML fields
at line 1230
int
BackLinkTrackingCount()
Count of backlinks Note: Doesn't filter broken records
at line 1244
static string
join_paths($part = null)
Joins one or more segments together to build a Filename identifier.
Note that the result will not have a leading slash, and should not be used with local file paths.
at line 1262
bool
deleteFile()
Delete a file (and all variants).
{see AssetStore::delete()}
at line 1267
string
getVisibility()
Determine visibility of the given file
at line 1272
publishFile()
Publicly expose the file (and all variants) identified by the given filename and hash {see AssetStore::publish}
at line 1277
protectFile()
Protect a file (and all variants) from public access, identified by the given filename and hash.
{see AssetStore::protect()}
at line 1282
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.
at line 1287
revokeFile()
Revoke access to the given file for the current user.
Note: This will have no effect if the given file is public
at line 1292
bool
canViewFile()
Check if the current user can view the given file.
at line 1297
string
CMSEditLink()
at line 1304
string
PreviewLink(string $action = null)
Determine the preview link, if available, for this object.
If no preview is available for this record, it may return null.
at line 1319
PermissionChecker
getPermissionChecker()
at line 1330
providePermissions()
Return a map of permission codes to add to the dropdown shown in the Security section of the CMS.
array( 'VIEW_SITE' => 'View the site', );
at line 1356
static array
getAllowedExtensions()
Get the list of globally allowed file extensions for file uploads.
Specific extensions can be disabled with configuration, for example:
SilverStripe\Assets\File:
allowed_extensions:
dmg: false
docx: false
at line 102
File
Parent()
Returns parent File
at line 102
Member
Owner()
Returns Member object of file owner.