Image_Cached
class Image_Cached extends Image
A resized / processed {@link Image} object.
When Image object are processed or resized, a suitable Image_Cached object is returned, pointing to the cached copy of the processed image.
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 |
| ORIENTATION_SQUARE |
|
| ORIENTATION_PORTRAIT |
|
| ORIENTATION_LANDSCAPE |
|
Properties
| string | $class | from SS_Object | |
| boolean | $destroyed | True if this DataObject has been destroyed. | from DataObject |
| static | $cache_has_own_table | Static caches used by relevant functions. | from DataObject |
| static | $allowed_actions | Provides a list of allowed methods that can be called via RESTful api. | from DataObject |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}
This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
Return TRUE if a class has a specified extension.
Add an extension to a specific class.
No description
Create a new cached image.
Attemps 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
Override the parent's exists method becuase the ID is explicitly set to -1 on a cached image we can't use the default check
Check if this class is an instance of a specific class, or has that class as one of its parents
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
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.
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
Clears the cache for the given cacheToFile call
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.
Check if a field exists on this object or its failover.
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
Set a failover object to attempt to get data from if it is not present on this object.
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.
Set up template methods to access the transformations generated by 'generate' methods.
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.
Get the class name a field on this object will be casted to
Return the string-format type for the given field.
Save the casting cache for this object (including data from any failovers) into a variable
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
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.
Return the value of the field without any escaping being applied.
Return the value of a field in an SQL-safe format.
Return the value of a field in a JavaScript-save format.
Return the value of a field escaped suitable to be inserted into an XML node attribute.
Return a single-item iterator so you can iterate over the fields of a single record.
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Return the directory if the current active theme (relative to the site root).
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
Set whether DataObjects should be validated before they are written.
Clear all cached classname specs. It's necessary to clear all cached subclassed names for any classes if a new class manifest is generated.
Determines the specification for the ClassName field for the given class
Return the complete map of fields on this object, including "Created", "LastEdited" and "ClassName".
Get all database columns explicitly defined on a class in {@link DataObject::$db} and {@link DataObject::$has_one}. Resolves instances of {@link CompositeDBField} into the actual database fields, rather than the name of the field which might not equate a database column.
Returns the field class if the given db field on the class is a composite field.
Returns a list of all the composite if the given db field on the class is a composite field.
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.
Load the default values in from the self::$defaults array.
Prevent writing the cached image 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 component object from a one to one relationship, as a DataObject.
Returns a one-to-many relation as a HasManyList
No description
Find the foreign class of a relation on this DataObject, regardless of the relation type.
Tries to find the database key on another object that is used to store a relationship to this class. If no join field can be found it defaults to 'ParentID'.
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.
Return data for a specific has_one component.
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.
Return data for a specific belongs_to component.
Return all of the database fields defined in self::$db and all the parent classes.
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 data for a specific has_many component.
Return the many-to-many extra fields specification.
Return the many-to-many extra fields specification for a specific component.
Return information about a many-to-many component.
Return information about a specific many_many component. Returns a numeric array of:
array(
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()}.
Returns the fields to power the edit screen of files in the CMS.
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.
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 the field type of the given field, if it belongs to this class, and not a parent.
Returns the field type of the given field, if it belongs to this class, and not a parent.
Returns true if given class has its own table. Uses the rules for whether the table should exist rather than actually looking in the database.
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:
Returns true if the following conditions are met: - CMS_ACCESS_AssetAdmin
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.
Return the given element, searching by ID
Prevent creating new tables for the cached record
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().
Returns fields bu traversing the class heirachy in a bottom-up direction.
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 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
Collect all static properties on the object which contain natural language, and need to be translated.
Replace "[file_link id=n]" shortcode with an anchor tag or link to the file.
Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.
Return the relative URL of an icon for the file type, based on the {@link appCategory()} value.
Delete the database record (recursively for folders) without touching the filesystem
Collate selected descendants of this page.
Setter function for Name. Automatically sets a default title, and removes characters that might be invalid on the filesystem.
Does not change the filesystem itself, please use {@link write()} for this.
Returns path relative to webroot.
Caution: this does not change the location of the file on the filesystem.
Gets the extension of a filepath or filename, by stripping away everything before the last "dot".
Return the type of file for the given extension on the current file name.
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()}.
Retrieve the original filename from the path of a transformed image.
Return an XHTML img tag for this Image, or NULL if the image file doesn't exist on the filesystem.
File names are filtered through {@link FileNameFilter}, see class documentation on how to influence this behaviour.
Scale image proportionally to fit within the specified bounds
Scale image proportionally to fit within the specified bounds
Proportionally scale down this image if it is wider or taller than the specified dimensions.
Resize and crop image to fill specified dimensions.
Resize and crop image to fill specified dimensions.
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.
Fit image to specified dimensions and fill leftover space with a solid colour (default white). Use in templates with $Pad.
Fit image to specified dimensions and fill leftover space with a solid colour (default white). Use in templates with $Pad.
Scale image proportionally by width. Use in templates with $ScaleWidth.
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.
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.
Resize the image by preserving aspect ratio, keeping the image inside the $width and $height
Resize the image by preserving aspect ratio, keeping the image inside the $width and $height
Resize this Image by width, keeping aspect ratio. Use in templates with $SetWidth.
Resize this Image by width, keeping aspect ratio. Use in templates with $SetWidth.
Resize this Image by height, keeping aspect ratio. Use in templates with $SetHeight.
Resize this Image by height, keeping aspect ratio. Use in templates with $SetHeight.
Resize this Image by both width and height, using padded resize. Use in templates with $SetSize.
Resize this Image by both width and height, using padded resize. Use in templates with $SetSize.
Resize this image for the CMS. Use in templates with $CMSThumbnail.
Resize this image for preview in the Asset section. Use in templates with $AssetLibraryPreview.
Resize this image for thumbnail in the Asset section. Use in templates with $AssetLibraryThumbnail.
Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.
Resize this Image by both width and height, using padded resize. Use in templates with $PaddedImage.
Resize this Image by both width and height, using padded resize. Use in templates with $PaddedImage.
Determine if this image is of the specified size
Return an image object representing the image in the given format.
Return the filename for the cached image, given its format name and arguments.
Generate an image on the specified format. It will save the image at the location specified by cacheFilename(). The image will be generated using the specific 'generate' method for the specified format.
Generate a resized copy of this image with the given width & height.
Generate a resized copy of this image with the given width & height.
Generate a resized copy of this image with the given width & height, cropping to maintain aspect ratio.
Generate a resized copy of this image with the given width & height, cropping to maintain aspect ratio.
Regenerate all of the formatted cached images for this image.
Details
in SS_Object at line 60
static Config_ForClass|null
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in SS_Object at line 132
static SS_Object
create()
An implementation of the factory method, allows you to create an instance of a class
This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use {@link Object::useCustomClass()}
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();
in SS_Object at line 155
static SS_Object
singleton()
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
in SS_Object at line 190
static
create_from_string($classSpec, $firstArg = null)
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.
Object::create_from_string("Versioned('Stage','Live')") will return the result of
Versioned::create('Stage', 'Live);
It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.
If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.
Object::create_from_string("Varchar(50)", "MyField") will return the result of
Vachar::create('MyField', '50');
Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.
in SS_Object at line 215
static
parse_class_spec($classSpec)
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Returns a 2-elemnent array, with classname and arguments
in SS_Object at line 341
static SS_Object
strong_create()
Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}
in SS_Object at line 361
static
useCustomClass(string $oldClass, string $newClass, bool $strong = false)
This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}
in SS_Object at line 375
static string
getCustomClass(string $class)
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
in SS_Object at line 396
static any
static_lookup($class, $name, null $default = null)
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
in SS_Object at line 436
static
get_static($class, $name, $uncached = false)
deprecated
deprecated
in SS_Object at line 444
static
set_static($class, $name, $value)
deprecated
deprecated
in SS_Object at line 452
static
uninherited_static($class, $name, $uncached = false)
deprecated
deprecated
in SS_Object at line 460
static
combined_static($class, $name, $ceiling = false)
deprecated
deprecated
in SS_Object at line 470
static
addStaticVars($class, $properties, $replace = false)
deprecated
deprecated
in SS_Object at line 478
static
add_static_var($class, $name, $value, $replace = false)
deprecated
deprecated
in SS_Object at line 494
static
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 SS_Object at line 536
static
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).
in SS_Object at line 594
static
remove_extension(string $extension)
Remove an extension from a class.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.
in SS_Object at line 633
static array
get_extensions(string $class, bool $includeArgumentString = false)
in SS_Object at line 655
static
get_extra_config_sources($class = null)
at line 1084
__construct($filename = null, $isSingleton = false, Image $sourceImage = null)
Create a new cached image.
in SS_Object at line 725
mixed
__call(string $method, array $arguments)
Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in SS_Object at line 792
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 SS_Object at line 802
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in SS_Object at line 963
stat($name, $uncached = false)
in SS_Object at line 970
set_stat($name, $value)
in SS_Object at line 977
uninherited($name)
at line 1102
bool
exists()
Override the parent's exists method becuase the ID is explicitly set to -1 on a cached image we can't use the default check
in SS_Object at line 998
string
parentClass()
in SS_Object at line 1008
bool
is_a(string $class)
Check if this class is an instance of a specific class, or has that class as one of its parents
in SS_Object at line 1015
string
__toString()
in SS_Object at line 1030
mixed
invokeWithExtensions(string $method, mixed $argument = null)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in SS_Object at line 1058
array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
in SS_Object at line 1097
Extension
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in SS_Object at line 1115
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 SS_Object at line 1126
array
getExtensionInstances()
Get all extension instances for this specific object instance.
See {@link get_extensions()} to get all applied extension classes for this class (not the instance).
in SS_Object at line 1142
mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
in SS_Object at line 1171
clearCache($method, $ID = false, $arguments = array())
Clears the cache for the given cacheToFile call
in ViewableData at line 72
static string
castingObjectCreator(string $fieldSchema)
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
in ViewableData at line 83
static array
castingObjectCreatorPair(string $fieldSchema)
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.
in ViewableData at line 95
bool
__isset(string $property)
Check if a field exists on this object or its failover.
in ViewableData at line 117
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 138
__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 151
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 166
ViewableData|null
getFailover()
Get the current failover object if set
in DataObject at line 2778
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 2456
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 2663
setField(string $fieldName, mixed $val)
Set the value of the field Called by {@link __set()} and any setFieldName() methods you might create.
in Image at line 110
defineMethods()
Set up template methods to access the transformations generated by 'generate' methods.
in ViewableData at line 236
unknown
deprecatedCachedCall($method, $args = null, $identifier = null)
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
in ViewableData at line 255
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.
in ViewableData at line 272
ViewableData
getCustomisedObj()
in ViewableData at line 279
setCustomisedObj(ViewableData $object)
in ViewableData at line 296
array
castingHelperPair(string $field)
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).
The returned array contains two keys: - className: the class the field would be casted to (e.g. "Varchar") - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
in DataObject at line 2751
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.
in ViewableData at line 331
string
castingClass(string $field)
Get the class name a field on this object will be casted to
in ViewableData at line 346
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 357
buildCastingCache(reference $cache)
Save the casting cache for this object (including data from any failovers) into a variable
in ViewableData at line 394
HTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
in ViewableData at line 456
obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
in ViewableData at line 503
cachedCall(string $field, array $arguments = null, string $identifier = null)
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
in DataObject at line 4167
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 538
XML_val($field, $arguments = null, $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
in ViewableData at line 546
RAW_val($field, $arguments = null, $cache = true)
Return the value of the field without any escaping being applied.
in ViewableData at line 553
SQL_val($field, $arguments = null, $cache = true)
Return the value of a field in an SQL-safe format.
in ViewableData at line 560
JS_val($field, $arguments = null, $cache = true)
Return the value of a field in a JavaScript-save format.
in ViewableData at line 567
ATT_val($field, $arguments = null, $cache = true)
Return the value of a field escaped suitable to be inserted into an XML node attribute.
in ViewableData at line 579
array
getXMLValues($fields)
Get an array of XML-escaped values by field name
in ViewableData at line 599
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 ViewableData at line 611
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 627
string
ThemeDir(string $subtheme = false)
Return the directory if the current active theme (relative to the site root).
This method is useful for things such as accessing theme images from your template without hardcoding the theme
page - e.g. 
.
This method should only be used when a theme is currently active. However, it will fall over to the current project directory.
in ViewableData at line 648
string
CSSClasses(string $stopAtClass = 'ViewableData')
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
in ViewableData at line 671
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in DataObject at line 211
static bool
get_validation_enabled()
deprecated
deprecated 3.2 Use the "DataObject.validation_enabled" config setting instead
Returns when validation on DataObjects is enabled.
in DataObject at line 227
static
set_validation_enabled($enable)
deprecated
deprecated 3.2 Use the "DataObject.validation_enabled" config setting instead
Set whether DataObjects should be validated before they are written.
Caution: Validation can contain safeguards against invalid/malicious data, and check permission levels (e.g. on {@link Group}). Therefore it is recommended to only disable validation for very specific use cases.
in DataObject at line 241
static
clear_classname_spec_cache()
Clear all cached classname specs. It's necessary to clear all cached subclassed names for any classes if a new class manifest is generated.
in DataObject at line 254
static string
get_classname_spec(string $class, boolean $queryDB = true)
Determines the specification for the ClassName field for the given class
in DataObject at line 281
static array
database_fields(string $class, boolean $queryDB = true)
Return the complete map of fields on this object, including "Created", "LastEdited" and "ClassName".
See {@link custom_database_fields()} for a getter that excludes these "base fields".
in DataObject at line 310
static array
custom_database_fields(string $class)
Get all database columns explicitly defined on a class in {@link DataObject::$db} and {@link DataObject::$has_one}. Resolves instances of {@link CompositeDBField} into the actual database fields, rather than the name of the field which might not equate a database column.
Does not include "base fields" like "ID", "ClassName", "Created", "LastEdited", see {@link database_fields()}.
in DataObject at line 363
static string
is_composite_field(string $class, string $name, boolean $aggregated = true)
Returns the field class if the given db field on the class is a composite field.
Will check all applicable ancestor classes and aggregate results.
in DataObject at line 389
static
composite_fields($class, $aggregated = true)
Returns a list of all the composite if the given db field on the class is a composite field.
Will check all applicable ancestor classes and aggregate results.
in DataObject at line 510
DataObject
setDataModel(DataModel $model)
Set the DataModel
in DataObject at line 519
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 533
DataObject
duplicate($doWrite = true)
Create a duplicate of this node.
Note: now also duplicates relations.
in DataObject at line 614
getObsoleteClassName()
in DataObject at line 619
getClassName()
in DataObject at line 635
DataObject
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 660
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 743
boolean
isEmpty()
Returns TRUE if all values (other than "ID") are considered empty (by weak boolean comparison).
Only checks for fields listed in {@link custom_database_fields()}
in DataObject at line 765
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 784
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 795
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 818
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 841
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 854
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 863
array
toMap()
Convert this object to a map.
in DataObject at line 876
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 892
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".
update() doesn't write the main object, but if you use the dot syntax, it will write() the related objects that it alters.
in DataObject at line 949
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 977
Boolean
merge($rightObj, $priority = 'right', $includeRelations = true, $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 1054
$this
forceChange()
Forces the record to think that all its data has changed.
Doesn't write to the database. Only sets fields as changed if they are not already marked as changed.
in DataObject at line 1101
ValidationResult
doValidate()
Public accessor for {see DataObject::validate()}
in DataObject at line 1161
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.
at line 1124
write(boolean $showDebug = false, boolean $forceInsert = false, boolean $forceWrite = false, boolean $writeComponents = false)
Prevent writing the cached image to the database
in DataObject at line 1450
writeRelations()
Writes cached relation lists to the database, if possible
in DataObject at line 1469
DataObject
writeComponents($recursive = false)
Write the cached components to the database. Cached components could refer to two different instances of the same record.
in DataObject at line 1484
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 1519
static
delete_by_id(string $className, int $id)
Delete the record with the given ID.
in DataObject at line 1536
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 1555
DataObject
getComponent(string $componentName)
Return a 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 1624
HasManyList
getComponents(string $componentName, string|null $filter = null, string|null|array $sort = null, string $join = null, string|null|array $limit = null)
Returns a one-to-many relation as a HasManyList
in DataObject at line 1674
getComponentsQuery($componentName, $filter = "", $sort = "", $join = "", $limit = "")
deprecated
deprecated
in DataObject at line 1685
string
getRelationClass($relationName)
Find the foreign class of a relation on this DataObject, regardless of the relation type.
in DataObject at line 1723
string
getRemoteJoinField(string $component, string $type = 'has_many', boolean $polymorphic = false)
Tries to find the database key on another object that is used to store a relationship to this class. If no join field can be found it defaults to 'ParentID'.
If the remote field is polymorphic then $polymorphic is set to true, and the return value is in the form 'Relation' instead of 'RelationID', referencing the composite DBField.
in DataObject at line 1799
ManyManyList
getManyManyComponents($componentName, $filter = null, $sort = null, $join = null, $limit = null)
Returns a many-to-many component, as a ManyManyList.
in DataObject at line 1845
array|null
has_one(string $component = null)
deprecated
deprecated 4.0 Method has been replaced by hasOne() and hasOneComponent()
in DataObject at line 1863
string|array
hasOne(string $component = null)
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 1881
string|null
hasOneComponent(string $component)
Return data for a specific has_one component.
in DataObject at line 1895
array|null
belongs_to(string $component = null, bool $classOnly = true)
deprecated
deprecated 4.0 Method has been replaced by belongsTo() and belongsToComponent()
in DataObject at line 1914
string|array
belongsTo(string $component = null, 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 1939
string|false
belongsToComponent(string $component, bool $classOnly = true)
Return data for a specific belongs_to component.
in DataObject at line 1958
array
db(string $fieldName = null)
Return all of the database fields defined in self::$db and all the parent classes.
Doesn't include any fields specified by self::$has_one. Use $this->hasOne() to get these fields
in DataObject at line 1996
array|null
has_many(string $component = null, bool $classOnly = true)
deprecated
deprecated 4.0 Method has been replaced by hasMany() and hasManyComponent()
in DataObject at line 2015
string|array|false
hasMany(string $component = null, 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 2040
string|false
hasManyComponent(string $component, bool $classOnly = true)
Return data for a specific has_many component.
in DataObject at line 2058
array
many_many_extraFields(string $component = null)
deprecated
deprecated 4.0 Method has been replaced by manyManyExtraFields() and manyManyExtraFieldsForComponent()
in DataObject at line 2077
array|null
manyManyExtraFields(string $component = null)
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 2096
array|null
manyManyExtraFieldsForComponent(string $component)
Return the many-to-many extra fields specification for a specific component.
in DataObject at line 2142
array|null
many_many(string $component = null)
deprecated
deprecated 4.0 Method has been renamed to manyMany()
in DataObject at line 2161
array|null
manyMany(string $component = null)
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 2190
array|null
manyManyComponent(string $component)
Return information about a specific many_many component. Returns a numeric array of:
array(
in DataObject at line 2253
array
database_extensions($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 2268
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 2291
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 2349
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()}.
in Image at line 121
FieldList
getCMSFields()
Returns the fields to power the edit screen of files in the CMS.
You can modify this FieldList by subclassing folder, or by creating a {@link DataExtension} and implemeting updateCMSFields(FieldList $fields) on that extension.
in DataObject at line 2423
an
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 2441
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 2590
array
getChangedFields(boolean $databaseFieldsOnly = false, int $changeLevel = self::CHANGE_STRICT)
Return the fields that have changed.
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 2643
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 2733
setCastedField($fieldName, $val)
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 2794
boolean
hasDatabaseField(string $field)
Returns true if the given field exists as a database column
in DataObject at line 2807
string
hasOwnTableDatabaseField(string $field)
Returns the field type of the given field, if it belongs to this class, and not a parent.
Note that the field type will not include constructor arguments in round brackets, only the classname.
in DataObject at line 2819
static string
has_own_table_database_field(string $class, string $field)
Returns the field type of the given field, if it belongs to this class, and not a parent.
Note that the field type will not include constructor arguments in round brackets, only the classname.
in DataObject at line 2840
static bool
has_own_table(string $dataClass)
Returns true if given class has its own table. Uses the rules for whether the table should exist rather than actually looking in the database.
in DataObject at line 2866
boolean
can(string $perm, Member $member = null)
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 2946
boolean|null
extendedCan(String $methodName, Member|int $member)
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;
in File at line 332
boolean
canEdit(Member $member = null)
Returns true if the following conditions are met: - CMS_ACCESS_AssetAdmin
in DataObject at line 3013
string
debug()
Debugging used by Debug::show()
in DataObject at line 3032
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 3078
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).
in DataObject at line 3116
string
relField($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 3161
String
getReverseAssociation($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 3195
static DataList
get(string $callerClass = null, string|array $filter = "", string|array $sort = "", string $join = "", string|array $limit = null, string $containerClass = 'DataList')
Return all objects matching the filter sub-classes are automatically selected and included
in DataObject at line 3237
Aggregate($class = null)
deprecated
deprecated
in DataObject at line 3258
RelationshipAggregate($relationship)
deprecated
deprecated
in DataObject at line 3276
static DataObject
get_one(string $callerClass, string|array $filter = "", boolean $cache = true, string $orderby = "")
Return the first item matching the given query.
All calls to get_one() are cached.
in File at line 925
DataObject
flushCache($persistant = true)
Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.
in DataObject at line 3333
static
flush_and_destroy_cache()
Flush the get_one global cache and destroy associated objects.
in DataObject at line 3345
static
reset()
Reset all global caches associated with DataObject.
in DataObject at line 3366
static DataObject
get_by_id(string $callerClass, int $id, boolean $cache = true)
Return the given element, searching by ID
in DataObject at line 3387
baseTable()
Get the name of the base table for this object
in DataObject at line 3403
array
getSourceQueryParams()
in DataObject at line 3411
setSourceQueryParams(array $array)
in DataObject at line 3419
setSourceQueryParam($key, $value)
in DataObject at line 3427
Mixed
getSourceQueryParam($key)
in DataObject at line 3439
databaseIndexes()
Return the database indexes on this table.
This array is indexed by the name of the field with the index, and the value is the type of index.
at line 1115
requireTable()
Prevent creating new tables for the cached record
in DataObject at line 3611
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 3640
inheritedDatabaseFields()
Returns fields bu traversing the class heirachy in a bottom-up direction.
Needed to avoid getCMSFields being empty when customDatabaseFields overlooks the inheritance chain of the $db array, where a child data object has no $db array, but still needs to know the properties of its parent. This should be merged into databaseFields or customDatabaseFields.
in DataObject at line 3659
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 File at line 936
array|string
fieldLabels(boolean $includerelations = true)
in DataObject at line 3802
string
fieldLabel(string $name)
Get a human-readable label for a single field, see {@link fieldLabels()} for more details.
in DataObject at line 3814
array
summaryFields()
Get the default summary fields for this object.
in DataObject at line 3864
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 3889
boolean
isInDB()
in DataObject at line 3901
static
disable_subclass_access()
Temporarily disable subclass access in data object qeur
in DataObject at line 3904
static
enable_subclass_access()
in DataObject at line 4139
array
provideI18nEntities()
Collect all static properties on the object which contain natural language, and need to be translated.
The full entity name is composed from the class name and a custom identifier.
in File at line 191
static string
link_shortcode_handler($arguments, $content = null, $parser = null)
Replace "[file_link id=n]" shortcode with an anchor tag or link to the file.
in File at line 239
static mixed
find(String $filename)
Find a File object by the given filename.
in File at line 265
string
Link()
Just an alias function to keep a consistent API with SiteTree
in File at line 274
string
RelativeLink()
Just an alias function to keep a consistent API with SiteTree
in File at line 283
string
AbsoluteLink()
Just an alias function to keep a consistent API with SiteTree
in File at line 290
string
getTreeTitle()
in File at line 454
static String
get_app_category($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".
in File at line 467
String
appCategory()
Returns a category based on the file extension.
in Image at line 644
HTMLVarchar
StripThumbnail()
Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.
in Image at line 602
CMSThumbnail()
Resize this image for the CMS. Use in templates with $CMSThumbnail
in File at line 491
String
Icon()
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 Image at line 1051
onAfterUpload()
Should be called after the file was uploaded
in File at line 514
deleteDatabaseOnly()
Delete the database record (recursively for folders) without touching the filesystem
in File at line 557
updateFilesystem()
Moving the file if appropriate according to updated database content.
Throws an Exception if the new file already exists.
Caution: This method should just be called during a {@link write()} invocation, as it relies on {@link DataObject->isChanged()}, which is reset after a {@link write()} call. Might be called as {@link File->updateFilesystem()} from within {@link Folder->updateFilesystem()}, so it has to handle both files and folders.
Assumes that the "Filename" property was previously updated, either directly or indirectly. (it might have been influenced by {@link setName()} or {@link setParentID()} before).
in File at line 618
collateDescendants(condition $condition, collator $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.
in File at line 639
setName(string $name)
Setter function for Name. Automatically sets a default title, and removes characters that might be invalid on the filesystem.
Also adds a suffix to the name if the filename already exists on the filesystem, and is associated to a different {@link File} database record in the same folder. This means "myfile.jpg" might become "myfile-1.jpg".
Does not change the filesystem itself, please use {@link write()} for this.
in File at line 699
setParentID($parentID)
Does not change the filesystem itself, please use {@link write()} for this.
in File at line 714
string
getAbsoluteURL()
Gets the absolute URL accessible through the web.
in File at line 724
string
getURL()
Gets the relative URL accessible through the web.
in File at line 736
String
getFullPath()
Returns an absolute filesystem path to the file.
Use {@link getRelativePath()} to get the same path relative to the webroot.
at line 1106
String
getRelativePath()
Returns path relative to webroot.
Serves as a "fallback" method to create the "Filename" property if it isn't set. If no {@link Folder} is set ("ParentID" property), defaults to a filename relative to the ASSETS_DIR (usually "assets/").
in File at line 774
DeleteLink()
in File at line 778
getFilename()
in File at line 790
setFilename($val)
Caution: this does not change the location of the file on the filesystem.
in File at line 807
String
getExtension()
Returns the file extension
in File at line 825
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"
in File at line 835
string
getFileType()
Return the type of file for the given extension on the current file name.
in File at line 868
getSize()
Returns the size of the file type in an appropriate format.
in File at line 879
static string
format_size(int $size)
Formats a file size (eg: (int)42 becomes string '42 bytes')
in File at line 894
static int
ini2bytes(string $iniValue)
Convert a php.ini value (eg: 512M) to bytes
in File at line 916
int
getAbsoluteSize()
Return file size in bytes.
in File at line 1001
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()}.
in File at line 1012
static
set_class_for_file_extension(String|array $exts, String $class)
See {@link get_class_for_file_extension()}.
in Image at line 84
static
flush()
Triggered early in the request when someone requests a flush.
in Image at line 88
static
set_backend($backend)
in Image at line 92
static
get_backend()
in Image at line 103
static string
strip_resampled_prefix(string $path)
Retrieve the original filename from the path of a transformed image.
Any other filenames pass through unchanged.
in Image at line 145
string
getTag()
Return an XHTML img tag for this Image, or NULL if the image file doesn't exist on the filesystem.
in Image at line 165
string
forTemplate()
Return an XHTML img tag for this Image.
in Image at line 175
loadUploadedImage($tmpFile)
deprecated
deprecated 4.0
File names are filtered through {@link FileNameFilter}, see class documentation on how to influence this behaviour.
in Image at line 227
Image|null
Fit(integer $width, integer $height)
Scale image proportionally to fit within the specified bounds
in Image at line 256
Image_Backend
generateFit(Image_Backend $backend, integer $width, integer $height)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Scale image proportionally to fit within the specified bounds
in Image at line 270
Image
FitMax(integer $width, integer $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 Image at line 287
Image|null
Fill(integer $width, integer $height)
Resize and crop image to fill specified dimensions.
Use in templates with $Fill
in Image at line 303
Image_Backend
generateFill(Image_Backend $backend, integer $width, integer $height)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Resize and crop image to fill specified dimensions.
Use in templates with $Fill
in Image at line 318
Image
FillMax(integer $width, integer $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 Image at line 348
Image|null
Pad(integer $width, integer $height, string $backgroundColor = 'FFFFFF', integer $transparencyPercent)
Fit image to specified dimensions and fill leftover space with a solid colour (default white). Use in templates with $Pad.
in Image at line 365
Image_Backend
generatePad(Image_Backend $backend, integer $width, integer $height, string $backgroundColor = 'FFFFFF', integer $transparencyPercent)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Fit image to specified dimensions and fill leftover space with a solid colour (default white). Use in templates with $Pad.
in Image at line 378
Image|null
ScaleWidth(integer $width)
Scale image proportionally by width. Use in templates with $ScaleWidth.
in Image at line 392
Image_Backend
generateScaleWidth(Image_Backend $backend, int $width)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Scale image proportionally by width. Use in templates with $ScaleWidth.
in Image at line 405
Image
ScaleMaxWidth(integer $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 Image at line 420
Image|null
ScaleHeight(integer $height)
Scale image proportionally by height. Use in templates with $ScaleHeight.
in Image at line 434
Image_Backend
generateScaleHeight(Image_Backend $backend, integer $height)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Scale image proportionally by height. Use in templates with $ScaleHeight.
in Image at line 447
Image
ScaleMaxHeight(integer $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 Image at line 464
Image
CropWidth(integer $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 Image at line 481
Image
CropHeight(integer $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 Image at line 499
Image
SetRatioSize(integer $width, integer $height)
deprecated
deprecated 4.0 Use Fit instead
Resize the image by preserving aspect ratio, keeping the image inside the $width and $height
in Image at line 514
Image_Backend
generateSetRatioSize(Image_Backend $backend, integer $width, integer $height)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Resize the image by preserving aspect ratio, keeping the image inside the $width and $height
in Image at line 526
Image
SetWidth(integer $width)
deprecated
deprecated 4.0 Use ScaleWidth instead
Resize this Image by width, keeping aspect ratio. Use in templates with $SetWidth.
in Image at line 539
Image_Backend
generateSetWidth(Image_Backend $backend, int $width)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Resize this Image by width, keeping aspect ratio. Use in templates with $SetWidth.
in Image at line 551
Image
SetHeight(integer $height)
deprecated
deprecated 4.0 Use ScaleHeight instead
Resize this Image by height, keeping aspect ratio. Use in templates with $SetHeight.
in Image at line 564
Image_Backend
generateSetHeight(Image_Backend $backend, integer $height)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Resize this Image by height, keeping aspect ratio. Use in templates with $SetHeight.
in Image at line 578
Image
SetSize(integer $width, integer $height)
deprecated
deprecated 4.0 Use Pad instead
Resize this Image by both width and height, using padded resize. Use in templates with $SetSize.
in Image at line 592
Image_Backend
generateSetSize(Image_Backend $backend, integer $width, integer $height)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Resize this Image by both width and height, using padded resize. Use in templates with $SetSize.
in Image at line 612
Image_Backend
generateCMSThumbnail(Image_Backend $backend)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Resize this image for the CMS. Use in templates with $CMSThumbnail.
in Image at line 623
Image_Backend
generateAssetLibraryPreview(Image_Backend $backend)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Resize this image for preview in the Asset section. Use in templates with $AssetLibraryPreview.
in Image at line 634
Image_Backend
generateAssetLibraryThumbnail(Image_Backend $backend)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Resize this image for thumbnail in the Asset section. Use in templates with $AssetLibraryThumbnail.
in Image at line 654
Image_Backend
generateStripThumbnail(Image_Backend $backend)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.
in Image at line 669
Image
PaddedImage($width, $height, $backgroundColor = 'FFFFFF', $transparencyPercent)
deprecated
deprecated 4.0 Use Pad instead
Resize this Image by both width and height, using padded resize. Use in templates with $PaddedImage.
in Image at line 684
Image_Backend
generatePaddedImage(Image_Backend $backend, $width, $height, $backgroundColor = 'FFFFFF', $transparencyPercent)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Resize this Image by both width and height, using padded resize. Use in templates with $PaddedImage.
in Image at line 696
boolean
isSize(integer $width, integer $height)
Determine if this image is of the specified size
in Image at line 706
boolean
isWidth(integer $width)
Determine if this image is of the specified width
in Image at line 716
boolean
isHeight(integer $height)
Determine if this image is of the specified width
in Image at line 730
Image_Cached|null
getFormattedImage(string $format)
Return an image object representing the image in the given format.
This image will be generated using generateFormattedImage(). The generated image is cached, to flush the cache append ?flush=1 to your URL.
Just pass the correct number of parameters expected by the working function
in Image at line 751
string
cacheFilename(string $format)
Return the filename for the cached image, given its format name and arguments.
in Image at line 787
generateFormattedImage(string $format)
Generate an image on the specified format. It will save the image at the location specified by cacheFilename(). The image will be generated using the specific 'generate' method for the specified format.
in Image at line 825
Image
ResizedImage(integer $width, integer $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 Image at line 840
Image_Backend|null
generateResizedImage(Image_Backend $backend, integer $width, integer $height)
Generate a resized copy of this image with the given width & height.
Use in templates with $ResizedImage.
in Image at line 858
Image
CroppedImage(integer $width, integer $height)
deprecated
deprecated 4.0 Use Fill instead
Generate a resized copy of this image with the given width & height, cropping to maintain aspect ratio.
Use in templates with $CroppedImage
in Image at line 873
Image_Backend
generateCroppedImage(Image_Backend $backend, integer $width, integer $height)
deprecated
deprecated 4.0 Generate methods are no longer applicable
Generate a resized copy of this image with the given width & height, cropping to maintain aspect ratio.
Use in templates with $CroppedImage
in Image at line 951
int
regenerateFormattedImages()
Regenerate all of the formatted cached images for this image.
in Image at line 981
int
deleteFormattedImages()
Remove all of the formatted cached images for this image.
in Image at line 1006
string|int|null
getDimensions(string $dim = "string")
Get the dimensions of this Image.
in Image at line 1023
int
getWidth()
Get the width of this image.
in Image at line 1031
int
getHeight()
Get the height of this image.
in Image at line 1039
ORIENTATION_SQUARE
getOrientation()
Get the orientation of this image.