class Image extends File implements Flushable (View source)

Represents an 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

public string $class from  SS_Object
protected array $extension_instances from  SS_Object
protected $beforeExtendCallbacks

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

from  SS_Object
protected $afterExtendCallbacks

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

from  SS_Object
protected ViewableData $failover

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

from  ViewableData
protected ViewableData $customisedObject from  ViewableData
public bool $destroyed

True if this DataObject has been destroyed.

from  DataObject
protected $model

The DataModel from this this object comes

from  DataObject
protected array $record

Data stored in this objects database record. An array indexed by fieldname.

from  DataObject
protected array $original

The database record (in the same format as $record), before any changes.

from  DataObject
protected bool $brokenOnDelete

Used by onBeforeDelete() to ensure child classes call parent::onBeforeDelete()

from  DataObject
protected bool $brokenOnWrite

Used by onBeforeWrite() to ensure child classes call parent::onBeforeWrite()

from  DataObject
public static $cache_has_own_table

Static caches used by relevant functions.

from  DataObject
protected static $_cache_db from  DataObject
protected static $_cache_get_one from  DataObject
protected static $_cache_get_class_ancestry from  DataObject
protected static $_cache_composite_fields from  DataObject
protected static $_cache_is_composite_field from  DataObject
protected static $_cache_custom_database_fields from  DataObject
protected static $_cache_field_labels from  DataObject
protected $components

Non-static relationship cache, indexed by component name.

from  DataObject
protected $unsavedRelations

Non-static cache of has_many and many_many relations that can't be written until this object is saved.

from  DataObject
protected array $sourceQueryParams from  DataObject
public static $allowed_actions

Provides a list of allowed methods that can be called via RESTful api.

from  DataObject
protected static array $cache_file_fields

Cached result of a "SHOW FIELDS" call in instance_get() for performance reasons.

from  File

Methods

public static 
config()

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

protected
beforeExtending(string $method, callable $callback)

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

protected
afterExtending(string $method, callable $callback)

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

public static 
create()

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

public static 
singleton()

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

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

public static 
parse_class_spec($classSpec)

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

public static 
strong_create()

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

public 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 Object::create()

public 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

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

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Return TRUE if a class has a specified extension.

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

Add an extension to a specific class.

public static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

public static 
get_extra_config_sources($class = null)

No description

public
__construct(array|null $record = null, bool $isSingleton = false, $model = null)

Construct a new DataObject.

public
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

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

public
defineMethods()

Set up template methods to access the transformations generated by 'generate' methods.

protected
array
findMethodsFromExtension(object $extension)

No description

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

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

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

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

protected
addWrapperMethod(string $method, string $wrap)

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

protected
createMethod(string $method, string $code)

Add an extra method using raw PHP code passed as a string

public
stat($name, $uncached = false)

No description

public
set_stat($name, $value)

No description

public
uninherited($name)

No description

public
bool
exists()

A file only exists if the file_exists() and is in the DB as a record

from  File
public
string
parentClass()

No description

public
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

public
string
__toString()

No description

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

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

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

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

public
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

public
bool
hasExtension(string $extension)

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

public
array
getExtensionInstances()

Get all extension instances for this specific object instance.

public
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

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

Clears the cache for the given cacheToFile call

protected
mixed
loadCache(string $cache, int $lifetime = 3600)

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

protected
saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

protected
string
sanitiseCachename(string $name)

Strip a file name of special characters so it is suitable for use as a cache file name

public 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);".

public 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 castingObjectCreator for more information about the constructor.

public
bool
__isset(string $property)

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

public
mixed
__get(string $property)

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

public
__set(string $property, mixed $value)

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

public
setFailover(ViewableData $failover)

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

public
getFailover()

Get the current failover object if set

public
bool
hasField(string $field)

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

public
mixed
getField(string $field)

Gets the value of a field.

public
setField(string $fieldName, mixed $val)

Set the value of the field Called by __set() and any setFieldName() methods you might create.

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

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

public
customise(array|ViewableData $data)

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

public
getCustomisedObj()

No description

public
setCustomisedObj(ViewableData $object)

No description

public
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 ViewableData::castingHelper() for information on casting helpers).

public
string
castingHelper(string $field)

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

public
string
castingClass(string $field)

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

public
string
escapeTypeForField(string $field)

Return the string-format type for the given field.

public
buildCastingCache(reference $cache)

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

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

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

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

protected
objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

protected
mixed
objCacheGet(string $key)

Get a cached value from the field cache

protected
objCacheSet(string $key, mixed $value)

Store a value in the field cache

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

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

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

public
bool
hasValue(string $field, array $arguments = 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)

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

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

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

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

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

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

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

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

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

public
array
getXMLValues($fields)

Get an array of XML-escaped values by field name

public
getIterator()

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

public
Me()

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

public
string
ThemeDir(string $subtheme = false)

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

public
string
CSSClasses(string $stopAtClass = 'ViewableData')

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

public
Debug()

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

public static 
bool
get_validation_enabled() deprecated

Returns when validation on DataObjects is enabled.

public static 
set_validation_enabled($enable) deprecated

Set whether DataObjects should be validated before they are written.

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

public static 
string
get_classname_spec(string $class, bool $queryDB = true)

Determines the specification for the ClassName field for the given class

public static 
array
database_fields(string $class, bool $queryDB = true)

Return the complete map of fields on this object, including "Created", "LastEdited" and "ClassName".

public static 
array
custom_database_fields(string $class)

Get all database columns explicitly defined on a class in DataObject::$db and 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.

public static 
string
is_composite_field(string $class, string $name, bool $aggregated = true)

Returns the field class if the given db field on the class is a composite field.

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

public
setDataModel(DataModel $model)

Set the DataModel

public
destroy()

Destroy all of this objects dependant objects and local caches.

public
duplicate($doWrite = true)

Create a duplicate of this node.

protected
duplicateManyManyRelations($sourceObject, $destinationObject)

Copies the many_many and belongs_many_many relations from one object to another instance of the name of object The destinationObject must be written to the database already and have an ID. Writing is performed automatically when adding the new relations.

public
getObsoleteClassName()

No description

public
getClassName()

No description

public
setClassName(string $className)

Set the ClassName attribute. $class is also updated.

public
newClassInstance(string $newClassName)

Create a new instance of a different class from this object's record.

public
bool
isEmpty()

Returns TRUE if all values (other than "ID") are considered empty (by weak boolean comparison).

public
string
singular_name()

Get the user friendly singular name of this DataObject.

public
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

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

public
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

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

public
data()

Returns the associated database record - in this case, the object itself.

public
array
toMap()

Convert this object to a map.

public
array
getQueriedDatabaseFields()

Return all currently fetched database fields.

public
update(array $data)

Update a number of fields on this object, given a map of the desired changes.

public
castedUpdate(array $data)

Pass changes as a map, and try to get automatic casting for these fields.

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

public
$this
forceChange()

Forces the record to think that all its data has changed.

protected
validate()

Validate the current object.

from  File
public
doValidate()

Public accessor for {DataObject::validate()}

protected
onBeforeWrite()

Make sure the file has a name

from  File
protected
onAfterWrite()

Set name on filesystem. If the current object is a "Folder", will also update references to subfolders and contained file records (both in database and filesystem)

from  File
protected
onBeforeDelete()

Event handler called before deleting from the database.

protected
onAfterDelete()

No description

public
populateDefaults()

Load the default values in from the self::$defaults array.

protected
validateWrite()

Determine validation of this object prior to write

protected
preWrite()

Prepare an object prior to write

protected
bool
updateChanges(bool $forceChanges = false)

Detects and updates all changes made to this object

protected
prepareManipulationTable(string $baseTable, string $now, bool $isNewRecord, array $manipulation, string $class)

Writes a subset of changes for a specific table to the given manipulation

protected
writeBaseRecord(string $baseTable, string $now)

Ensures that a blank base record exists with the basic fixed fields for this dataobject

protected
writeManipulation(string $baseTable, string $now, bool $isNewRecord)

Generate and write the database manipulation for all changed fields

public
write(bool $showDebug = false, bool $forceInsert = false, bool $forceWrite = false, bool $writeComponents = false)

Writes all changes to this object to the database.

public
writeRelations()

Writes cached relation lists to the database, if possible

public
writeComponents($recursive = false)

Write the cached components to the database. Cached components could refer to two different instances of the same record.

public
delete()

Delete this data object.

public static 
delete_by_id(string $className, int $id)

Delete the record with the given ID.

public
array
getClassAncestry()

Get the class ancestry, including the current class name.

public
getComponent(string $componentName)

Return a component object from a one to one relationship, as a DataObject.

public
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

public
getComponentsQuery($componentName, $filter = "", $sort = "", $join = "", $limit = "") deprecated

No description

public
string
getRelationClass($relationName)

Find the foreign class of a relation on this DataObject, regardless of the relation type.

public
string
getRemoteJoinField(string $component, string $type = 'has_many', bool $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'.

public
getManyManyComponents(string $componentName, $filter = null, $sort = null, $join = null, $limit = null)

Returns a many-to-many component, as a ManyManyList.

public
array|null
has_one(string $component = null) deprecated

No description

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

public
string|null
hasOneComponent(string $component)

Return data for a specific has_one component.

public
array|null
belongs_to(string $component = null, bool $classOnly = true) deprecated

No description

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

public
string|false
belongsToComponent(string $component, bool $classOnly = true)

Return data for a specific belongs_to component.

public
array
db(string $fieldName = null)

Return all of the database fields defined in self::$db and all the parent classes.

public
array|null
has_many(string $component = null, bool $classOnly = true) deprecated

No description

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

public
string|false
hasManyComponent(string $component, bool $classOnly = true)

Return data for a specific has_many component.

public
array
many_many_extraFields(string $component = null) deprecated

No description

public
array|null
manyManyExtraFields(string $component = null)

Return the many-to-many extra fields specification.

public
array|null
manyManyExtraFieldsForComponent(string $component)

Return the many-to-many extra fields specification for a specific component.

public
array|null
many_many(string $component = null) deprecated

No description

public
array|null
manyMany(string $component = null)

Return information about a many-to-many component.

public
array|null
manyManyComponent(string $component)

Return information about a specific many_many component. Returns a numeric array of: array(

, The class that relation is defined in e.g. "Product" , The target class of the relation e.g. "Category" , The field name pointing to 's table e.g. "ProductID" , The field name pointing to 's table e.g. "CategoryID" The join table between the two classes e.g. "Product_Categories" )

public
array
database_extensions($class)

This returns an array (if it exists) describing the database extensions that are required, or false if none

public
getDefaultSearchContext()

Generates a SearchContext to be used for building and processing a generic search form for properties on this object.

public
scaffoldSearchFields(array $_params = null)

Determine which properties on the DataObject are searchable, and map them to their default FormField representations. Used for scaffolding a searchform for ModelAdmin.

public
scaffoldFormFields(array $_params = null)

Scaffold a simple edit form for all properties on this dataobject, based on default FormField} mapping in {@link DBField::scaffoldFormField().

protected
beforeUpdateCMSFields(callable $callback)

Allows user code to hook into DataObject::getCMSFields prior to updateCMSFields being called on extensions

public
getCMSFields()

Returns the fields to power the edit screen of files in the CMS.

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

public
getFrontEndFields(array $params = null)

Used for simple frontend forms without relation editing or TabSet} behaviour. Uses {@link scaffoldFormFields() by default. To customize, either overload this method in your subclass, or extend it by DataExtension->updateFrontEndFields().

protected
bool
loadLazyFields(string $tableClass = null)

Loads all the stub fields that an initial lazy load didn't load fully.

public
array
getChangedFields(bool $databaseFieldsOnly = false, int $changeLevel = self::CHANGE_STRICT)

Return the fields that have changed.

public
bool
isChanged(string $fieldName = null, int $changeLevel = self::CHANGE_STRICT)

Uses getChangedFields() to determine if fields have been changed since loading them from the database.

public
setCastedField($fieldName, $val)

Set the value of the field, using a casting object.

public
bool
hasDatabaseField(string $field)

Returns true if the given field exists as a database column

public
string
hasOwnTableDatabaseField(string $field)

Returns the field type of the given field, if it belongs to this class, and not a parent.

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

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

public
bool
can(string $perm, Member $member = null)

Returns true if the member is allowed to do the given action.

public
bool|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:

public
bool
canView(Member $member = null)

No description

from  File
public
bool
canEdit(Member $member = null)

Returns true if the following conditions are met:

  • CMS_ACCESS_AssetAdmin

from  File
public
bool
canDelete(Member $member = null)

No description

from  File
public
bool
canCreate(Member $member = null)

No description

from  File
public
string
debug()

Debugging used by Debug::show()

public
dbObject(string $fieldName)

Return the DBField object that represents the given field.

public
mixed
relObject(string $fieldPath)

Traverses to a DBField referenced by relationships between data objects.

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

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

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

public
Aggregate($class = null) deprecated

No description

public
RelationshipAggregate($relationship) deprecated

No description

public static 
get_one(string $callerClass, string|array $filter = "", bool $cache = true, string $orderby = "")

Return the first item matching the given query.

public
flushCache($persistant = true)

Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.

from  File
public static 
flush_and_destroy_cache()

Flush the get_one global cache and destroy associated objects.

public static 
reset()

Reset all global caches associated with DataObject.

public static 
get_by_id(string $callerClass, int $id, bool $cache = true)

Return the given element, searching by ID

public
baseTable()

Get the name of the base table for this object

public
array
getSourceQueryParams()

No description

public
setSourceQueryParams($array)

No description

public
setSourceQueryParam($key, $value)

No description

public
mixed
getSourceQueryParam($key)

No description

public
databaseIndexes()

Return the database indexes on this table.

protected
array
parseSortColumn(string $column)

Parses a specified column into a sort field and direction

public
requireTable()

Check the database schema and update it as necessary.

protected
validateModelDefinitions()

Validate that the configured relations for this class use the correct syntaxes

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

public
inheritedDatabaseFields()

Returns fields bu traversing the class heirachy in a bottom-up direction.

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

public
array|string
fieldLabels(bool $includerelations = true)

No description

from  File
public
string
fieldLabel(string $name)

Get a human-readable label for a single field, see fieldLabels() for more details.

public
array
summaryFields()

Get the default summary fields for this object.

public
array
defaultSearchFilters()

Defines a default list of filters for the search context.

public
bool
isInDB()

No description

public static 
disable_subclass_access()

Temporarily disable subclass access in data object qeur

public static 
enable_subclass_access()

No description

public
array
provideI18nEntities()

Collect all static properties on the object which contain natural language, and need to be translated.

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

from  File
public static 
mixed
find(string $filename)

Find a File object by the given filename.

from  File
public
string
Link()

Just an alias function to keep a consistent API with SiteTree

from  File
public
string
RelativeLink()

Just an alias function to keep a consistent API with SiteTree

from  File
public
string
AbsoluteLink()

Just an alias function to keep a consistent API with SiteTree

from  File
public
string
getTreeTitle()

No description

from  File
public static 
string
get_app_category($ext)

Returns a category based on the file extension.

from  File
public
string
appCategory()

Returns a category based on the file extension.

from  File
public
StripThumbnail()

Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.

public
CMSThumbnail()

Resize this image for the CMS. Use in templates with $CMSThumbnail

public
string
Icon()

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

from  File
public
onAfterUpload()

Should be called after the file was uploaded

public
deleteDatabaseOnly()

Delete the database record (recursively for folders) without touching the filesystem

from  File
public
updateFilesystem()

Moving the file if appropriate according to updated database content.

from  File
public
collateDescendants($condition, $collator)

Collate selected descendants of this page.

from  File
public
setName(string $name)

Setter function for Name. Automatically sets a default title, and removes characters that might be invalid on the filesystem.

from  File
protected
updateLinks(string $old, string $new)

No description

from  File
public
setParentID($parentID)

Does not change the filesystem itself, please use write() for this.

from  File
public
string
getAbsoluteURL()

Gets the absolute URL accessible through the web.

from  File
public
string
getURL()

Gets the relative URL accessible through the web.

from  File
public
string
getFullPath()

Returns an absolute filesystem path to the file.

from  File
public
string
getRelativePath()

Returns path relative to webroot.

from  File
public
DeleteLink()

No description

from  File
public
getFilename()

No description

from  File
public
setFilename($val)

Caution: this does not change the location of the file on the filesystem.

from  File
public
string
getExtension()

Returns the file extension

from  File
public static 
string
get_file_extension(string $filename)

Gets the extension of a filepath or filename, by stripping away everything before the last "dot".

from  File
public
string
getFileType()

Return the type of file for the given extension on the current file name.

from  File
public
getSize()

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

from  File
public static 
string
format_size(int $size)

Formats a file size (eg: (int)42 becomes string '42 bytes')

from  File
public static 
int
ini2bytes(string $iniValue)

Convert a php.ini value (eg: 512M) to bytes

from  File
public
int
getAbsoluteSize()

Return file size in bytes.

from  File
public static 
string
get_class_for_file_extension($ext)

Maps a File subclass to a specific extension.

from  File
public static 
set_class_for_file_extension($exts, $class)

See get_class_for_file_extension().

from  File
Parent()

Returns parent File

from  File
Owner()

Returns Member object of file owner.

from  File
public static 
flush()

Triggered early in the request when someone requests a flush.

public static 
set_backend($backend)

No description

public static 
get_backend()

No description

public static 
string
strip_resampled_prefix(string $path)

Retrieve the original filename from the path of a transformed image.

public
string
getTag()

Return an XHTML img tag for this Image, or NULL if the image file doesn't exist on the filesystem.

public
string
forTemplate()

Return an XHTML img tag for this Image.

public
loadUploadedImage($tmpFile) deprecated

File names are filtered through FileNameFilter, see class documentation on how to influence this behaviour.

public
Image|null
Fit(int $width, int $height)

Scale image proportionally to fit within the specified bounds

public
generateFit(Image_Backend $backend, int $width, int $height) deprecated

Scale image proportionally to fit within the specified bounds

public
FitMax(int $width, int $height)

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

public
Image|null
Fill(int $width, int $height)

Resize and crop image to fill specified dimensions.

public
generateFill(Image_Backend $backend, int $width, int $height) deprecated

Resize and crop image to fill specified dimensions.

public
FillMax(int $width, int $height)

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

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

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

public
generatePad(Image_Backend $backend, int $width, int $height, string $backgroundColor = 'FFFFFF', int $transparencyPercent = 0) deprecated

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

public
Image|null
ScaleWidth(int $width)

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

public
generateScaleWidth(Image_Backend $backend, int $width) deprecated

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

public
ScaleMaxWidth(int $width)

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

public
Image|null
ScaleHeight(int $height)

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

public
generateScaleHeight(Image_Backend $backend, int $height) deprecated

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

public
ScaleMaxHeight(int $height)

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

public
CropWidth(int $width)

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

public
CropHeight(int $height)

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

public
SetRatioSize(int $width, int $height) deprecated

Resize the image by preserving aspect ratio, keeping the image inside the $width and $height

public
generateSetRatioSize(Image_Backend $backend, int $width, int $height) deprecated

Resize the image by preserving aspect ratio, keeping the image inside the $width and $height

public
SetWidth(int $width) deprecated

Resize this Image by width, keeping aspect ratio. Use in templates with $SetWidth.

public
generateSetWidth(Image_Backend $backend, int $width) deprecated

Resize this Image by width, keeping aspect ratio. Use in templates with $SetWidth.

public
SetHeight(int $height) deprecated

Resize this Image by height, keeping aspect ratio. Use in templates with $SetHeight.

public
generateSetHeight(Image_Backend $backend, int $height) deprecated

Resize this Image by height, keeping aspect ratio. Use in templates with $SetHeight.

public
SetSize(int $width, int $height) deprecated

Resize this Image by both width and height, using padded resize. Use in templates with $SetSize.

public
generateSetSize(Image_Backend $backend, int $width, int $height) deprecated

Resize this Image by both width and height, using padded resize. Use in templates with $SetSize.

public
generateCMSThumbnail(Image_Backend $backend) deprecated

Resize this image for the CMS. Use in templates with $CMSThumbnail.

public
generateAssetLibraryPreview(Image_Backend $backend) deprecated

Resize this image for preview in the Asset section. Use in templates with $AssetLibraryPreview.

public
generateAssetLibraryThumbnail(Image_Backend $backend) deprecated

Resize this image for thumbnail in the Asset section. Use in templates with $AssetLibraryThumbnail.

public
generateStripThumbnail(Image_Backend $backend) deprecated

Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.

public
PaddedImage(int $width, int $height, $backgroundColor = 'FFFFFF', int $transparencyPercent = 0) deprecated

Resize this Image by both width and height, using padded resize. Use in templates with $PaddedImage.

public
generatePaddedImage(Image_Backend $backend, int $width, int $height, $backgroundColor = 'FFFFFF', int $transparencyPercent = 0) deprecated

Resize this Image by both width and height, using padded resize. Use in templates with $PaddedImage.

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

Determine if this image is of the specified size

public
bool
isWidth(int $width)

Determine if this image is of the specified width

public
bool
isHeight(int $height)

Determine if this image is of the specified width

public
getFormattedImage(string $format)

Return an image object representing the image in the given format.

public
string
cacheFilename(string $format)

Return the filename for the cached image, given its format name and arguments.

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

public
ResizedImage(int $width, int $height)

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

public
generateResizedImage(Image_Backend $backend, int $width, int $height)

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

public
CroppedImage(int $width, int $height) deprecated

Generate a resized copy of this image with the given width & height, cropping to maintain aspect ratio.

public
generateCroppedImage(Image_Backend $backend, int $width, int $height) deprecated

Generate a resized copy of this image with the given width & height, cropping to maintain aspect ratio.

public
int
regenerateFormattedImages()

Regenerate all of the formatted cached images for this image.

public
int
deleteFormattedImages()

Remove all of the formatted cached images for this image.

public
string|int|null
getDimensions(string $dim = "string")

Get the dimensions of this Image.

public
int
getWidth()

Get the width of this image.

public
int
getHeight()

Get the height of this image.

public
ORIENTATION_SQUARE
getOrientation()

Get the orientation of this image.

Details

static Config_ForClass|null config()

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

Return Value

Config_ForClass|null

protected beforeExtending(string $method, callable $callback)

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

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected afterExtending(string $method, callable $callback)

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

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

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 Object::useCustomClass()

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

Return Value

SS_Object

static SS_Object singleton()

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

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

Return Value

SS_Object

The singleton instance

static create_from_string($classSpec, $firstArg = null)

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

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

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

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

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

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

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

Parameters

$classSpec
$firstArg

static parse_class_spec($classSpec)

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

Returns a 2-elemnent array, with classname and arguments

Parameters

$classSpec

static SS_Object strong_create()

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

Return Value

SS_Object

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

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

Parameters

string $oldClass

the class to replace

string $newClass

the class to replace it with

bool $strong

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

static string getCustomClass(string $class)

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

Parameters

string $class

the class to check

Return Value

string

the class that would be created if you called Object::create() with the class

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

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

Parameters

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

Return Value

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

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

deprecated

No description

Parameters

$class
$name
$uncached

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

deprecated

No description

Parameters

$class
$name
$value

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

deprecated

No description

Parameters

$class
$name
$uncached

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

deprecated

No description

Parameters

$class
$name
$ceiling

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

deprecated

No description

Parameters

$class
$properties
$replace

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

deprecated

No description

Parameters

$class
$name
$value
$replace

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

Return TRUE if a class has a specified extension.

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

Parameters

string $classOrExtension

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

string $requiredExtension

used only if 2 arguments supplied

bool $strict

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

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

Add an extension to a specific class.

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

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

Parameters

string $classOrExtension

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

string $extension

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

See also

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

static remove_extension(string $extension)

Remove an extension from a class.

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

Add support for removing extensions with parameters

Parameters

string $extension

Classname of an Extension subclass, without parameters

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

No description

Parameters

string $class
bool $includeArgumentString

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

Return Value

array

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

static get_extra_config_sources($class = null)

No description

Parameters

$class

__construct(array|null $record = null, bool $isSingleton = false, $model = null)

Construct a new DataObject.

Parameters

array|null $record

Used internally for rehydrating an object from database content. Bypasses setters on this class, and hence should not be used for populating data on new records.

bool $isSingleton

This this to true if this is a singleton() object, a stub for calling methods. Singletons don't have their defaults set.

$model

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

Parameters

string $method
array $arguments

Return Value

mixed

bool hasMethod(string $method)

Return TRUE if a method exists on this object

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

Parameters

string $method

Return Value

bool

array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom

include methods added dynamically at runtime

Return Value

array

defineMethods()

Set up template methods to access the transformations generated by 'generate' methods.

protected array findMethodsFromExtension(object $extension)

No description

Parameters

object $extension

Return Value

array

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

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

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

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

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

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

protected addWrapperMethod(string $method, string $wrap)

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

Parameters

string $method

the method name to wrap

string $wrap

the method name to wrap to

protected createMethod(string $method, string $code)

Add an extra method using raw PHP code passed as a string

Parameters

string $method

the method name

string $code

the PHP code - arguments will be in an array called $args, while you can access this object by using $obj. Note that you cannot call protected methods, as the method is actually an external function

stat($name, $uncached = false)

No description

Parameters

$name
$uncached

See also

SS_Object::get_static

set_stat($name, $value)

No description

Parameters

$name
$value

See also

SS_Object::set_static

uninherited($name)

No description

Parameters

$name

See also

SS_Object::uninherited_static

bool exists()

A file only exists if the file_exists() and is in the DB as a record

Return Value

bool

string parentClass()

No description

Return Value

string

this classes parent class

bool is_a(string $class)

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

Parameters

string $class

Return Value

bool

string __toString()

No description

Return Value

string

the class name

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

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

integrate inheritance rules

Parameters

string $method

the method name to call

mixed $argument

a single argument to pass

Return Value

mixed

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

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

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

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

Parameters

string $method

the name of the method to call on each extension

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

Return Value

array

Extension getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

bool hasExtension(string $extension)

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

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

Parameters

string $extension

Classname of an Extension subclass without parameters

Return Value

bool

array getExtensionInstances()

Get all extension instances for this specific object instance.

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

Return Value

array

Map of DataExtension instances, keyed by classname.

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

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

Parameters

string $method

the method name to cache

int $lifetime

the cache lifetime in seconds

string $ID

custom cache ID to use

array $arguments

an optional array of arguments

Return Value

mixed

the cached data

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

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

protected mixed loadCache(string $cache, int $lifetime = 3600)

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

Parameters

string $cache

the cache name

int $lifetime

the lifetime (in seconds) of the cache before it is invalid

Return Value

mixed

protected saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

Parameters

string $cache

the cache name

mixed $data

data to save (must be serializable)

protected string sanitiseCachename(string $name)

Strip a file name of special characters so it is suitable for use as a cache file name

Parameters

string $name

Return Value

string

the name with all special cahracters replaced with underscores

static string castingObjectCreator(string $fieldSchema)

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

Parameters

string $fieldSchema

The field spec

Return Value

string

static array castingObjectCreatorPair(string $fieldSchema)

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

Parameters

string $fieldSchema

Return Value

array

bool __isset(string $property)

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

Parameters

string $property

Return Value

bool

mixed __get(string $property)

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

Parameters

string $property

Return Value

mixed

__set(string $property, mixed $value)

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

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

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

Parameters

string $field

Return Value

bool

mixed getField(string $field)

Gets the value of a field.

Called by __get() and any getFieldName() methods you might create.

Parameters

string $field

Return Value

mixed

setField(string $fieldName, mixed $val)

Set the value of the field Called by __set() and any setFieldName() methods you might create.

Parameters

string $fieldName

Name of the field

mixed $val

New field value

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

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

Parameters

$method
$args
string $identifier

an optional custom cache identifier

Return Value

unknown

ViewableData_Customised customise(array|ViewableData $data)

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

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

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

ViewableData getCustomisedObj()

No description

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

No description

Parameters

ViewableData $object

array castingHelperPair(string $field)

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

The returned array contains two keys:

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

Parameters

string $field

Return Value

array

string castingHelper(string $field)

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

Parameters

string $field

Return Value

string

string castingClass(string $field)

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

Parameters

string $field

Return Value

string

string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string 'xml'|'raw'

buildCastingCache(reference $cache)

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

Parameters

reference $cache

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

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

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

Parameters

string|array|SSViewer $template

the template to render into

array $customFields

fields to customise() the object with before rendering

Return Value

HTMLText

protected objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName

Name of field

array $arguments

List of optional arguments given

protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key

Cache key

Return Value

mixed

protected objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key

Cache key

mixed $value

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

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

Parameters

string $fieldName
array $arguments
bool $forceReturnedObject

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

bool $cache

Cache this object

string $cacheName

a custom cache name

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

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

Parameters

string $field
array $arguments
string $identifier

an optional custom cache identifier

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

Returns true if the given method/parameter has a value (Uses the DBField::hasValue if the parameter is a database field)

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

array getXMLValues($fields)

Get an array of XML-escaped values by field name

Parameters

$fields

Return Value

array

ArrayIterator getIterator()

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

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

Return Value

ArrayIterator

ViewableData Me()

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

Return Value

ViewableData

string ThemeDir(string $subtheme = false)

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

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

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

Parameters

string $subtheme

the subtheme path to get

Return Value

string

string CSSClasses(string $stopAtClass = 'ViewableData')

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

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

Parameters

string $stopAtClass

the class to stop at (default: ViewableData)

Return Value

string

ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

static bool get_validation_enabled() deprecated

deprecated 3.2 Use the "DataObject.validation_enabled" config setting instead

Returns when validation on DataObjects is enabled.

Return Value

bool

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 Group). Therefore it is recommended to only disable validation for very specific use cases.

Parameters

$enable bool

See also

DataObject::validate

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.

static string get_classname_spec(string $class, bool $queryDB = true)

Determines the specification for the ClassName field for the given class

Parameters

string $class
bool $queryDB

Determine if the DB may be queried for additional information

Return Value

string

Resulting ClassName spec. If $queryDB is true this will include all legacy types that no longer have concrete classes in PHP

static array database_fields(string $class, bool $queryDB = true)

Return the complete map of fields on this object, including "Created", "LastEdited" and "ClassName".

See custom_database_fields() for a getter that excludes these "base fields".

Parameters

string $class
bool $queryDB

Determine if the DB may be queried for additional information

Return Value

array

static array custom_database_fields(string $class)

Get all database columns explicitly defined on a class in DataObject::$db and 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 database_fields().

Parameters

string $class

Return Value

array

Map of fieldname to specification, similiar to DataObject::$db.

static string is_composite_field(string $class, string $name, bool $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.

Parameters

string $class

Class to check

string $name

Field to check

bool $aggregated

True if parent classes should be checked, or false to limit to this class

Return Value

string

Class name of composite field if it exists

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.

Parameters

$class
$aggregated

DataObject setDataModel(DataModel $model)

Set the DataModel

Parameters

DataModel $model

Return Value

DataObject $this

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.

DataObject duplicate($doWrite = true)

Create a duplicate of this node.

Note: now also duplicates relations.

Parameters

$doWrite

Perform a write() operation before returning the object. If this is true, it will create the duplicate in the database.

Return Value

DataObject

A duplicate of this node. The exact type will be the type of this node.

protected DataObject duplicateManyManyRelations($sourceObject, $destinationObject)

Copies the many_many and belongs_many_many relations from one object to another instance of the name of object The destinationObject must be written to the database already and have an ID. Writing is performed automatically when adding the new relations.

Parameters

$sourceObject

the source object to duplicate from

$destinationObject

the destination object to populate with the duplicated relations

Return Value

DataObject

with the new many_many relations copied in

getObsoleteClassName()

No description

getClassName()

No description

DataObject setClassName(string $className)

Set the ClassName attribute. $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 newClassInstance() for this purpose, or destroy and reinstanciate the record.

Parameters

string $className

The new ClassName attribute (a subclass of DataObject)

Return Value

DataObject $this

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

Parameters

string $newClassName

The name of the new class

Return Value

DataObject

The new instance of the new class, The exact type will be of the class name provided.

bool isEmpty()

Returns TRUE if all values (other than "ID") are considered empty (by weak boolean comparison).

Only checks for fields listed in custom_database_fields()

Use DBField->hasValue()

Return Value

bool

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.

Return Value

string

User friendly singular name of this DataObject

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

Return Value

string

User friendly translated singular name of this DataObject

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.

Return Value

string

User friendly plural name of this DataObject

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

Return Value

string

User friendly translated plural name of this DataObject

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}";
}

Return Value

string

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.

Return Value

DataObject

Associated database record

array toMap()

Convert this object to a map.

Return Value

array

The data as a map.

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.

Return Value

array

The data as a map.

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.

Parameters

array $data

A map of field name to data values to update.

Return Value

DataObject $this

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.

Parameters

array $data

A map of field name to data values to update.

Return Value

DataObject $this

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

Parameters

$rightObj
$priority

String left|right Determines who wins in case of a conflict (optional)

$includeRelations

Boolean Merge any existing relations (optional)

$overwriteWithEmpty

Boolean Overwrite existing left values with empty right values. Only applicable with $priority='right'. (optional)

Return Value

bool

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

Return Value

$this

protected ValidationResult validate()

Validate the current object.

By default, there is no validation - objects are always valid! However, you can overload this method in your DataObject sub-classes to specify custom validation, or use the hook through DataExtension.

Invalid objects won't be able to be written - a warning will be thrown and no write will occur. onBeforeWrite() and onAfterWrite() won't get called either.

It is expected that you call validate() in your own application to test that an object is valid before attempting a write, and respond appropriately if it isn't.

Return Value

ValidationResult

ValidationResult doValidate()

Public accessor for {DataObject::validate()}

Return Value

ValidationResult

protected onBeforeWrite()

Make sure the file has a name

protected onAfterWrite()

Set name on filesystem. If the current object is a "Folder", will also update references to subfolders and contained file records (both in database and filesystem)

protected onBeforeDelete()

Event handler called before deleting from the database.

You can overload this to clean up or otherwise process data before delete this record. Don't forget to call parent::onBeforeDelete(), though!

protected onAfterDelete()

No description

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.

Return Value

DataObject $this

protected ValidationException validateWrite()

Determine validation of this object prior to write

Return Value

ValidationException

Exception generated by this write, or null if valid

protected preWrite()

Prepare an object prior to write

Exceptions

ValidationException

protected bool updateChanges(bool $forceChanges = false)

Detects and updates all changes made to this object

Parameters

bool $forceChanges

If set to true, force all fields to be treated as changed

Return Value

bool

True if any changes are detected

protected prepareManipulationTable(string $baseTable, string $now, bool $isNewRecord, array $manipulation, string $class)

Writes a subset of changes for a specific table to the given manipulation

Parameters

string $baseTable

Base table

string $now

Timestamp to use for the current time

bool $isNewRecord

Whether this should be treated as a new record write

array $manipulation

Manipulation to write to

string $class

Table and Class to select and write to

protected writeBaseRecord(string $baseTable, string $now)

Ensures that a blank base record exists with the basic fixed fields for this dataobject

Does nothing if an ID is already assigned for this record

Parameters

string $baseTable

Base table

string $now

Timestamp to use for the current time

protected writeManipulation(string $baseTable, string $now, bool $isNewRecord)

Generate and write the database manipulation for all changed fields

Parameters

string $baseTable

Base table

string $now

Timestamp to use for the current time

bool $isNewRecord

If this is a new record

write(bool $showDebug = false, bool $forceInsert = false, bool $forceWrite = false, bool $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.

Parameters

bool $showDebug

Show debugging information

bool $forceInsert

Run INSERT command rather than UPDATE, even if record already exists

bool $forceWrite

Write to database even if there are no changes

bool $writeComponents

Call write() on all associated component instances which were previously retrieved through getComponent()}, {@link getComponents() or getManyManyComponents() (Default: false)

Exceptions

ValidationException

writeRelations()

Writes cached relation lists to the database, if possible

DataObject writeComponents($recursive = false)

Write the cached components to the database. Cached components could refer to two different instances of the same record.

Parameters

$recursive

Recursively write components

Return Value

DataObject $this

delete()

Delete this data object.

$this->onBeforeDelete() gets called. Note that in Versioned objects, both Stage and Live will be deleted.

static delete_by_id(string $className, int $id)

Delete the record with the given ID.

Parameters

string $className

The class name of the record to be deleted

int $id

ID of record to be deleted

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.

Return Value

array

Class ancestry

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.

Parameters

string $componentName

Name of the component

Return Value

DataObject

The component object. It's exact type will be that of the component.

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

Parameters

string $componentName

Name of the component

string|null $filter

Deprecated. A filter to be inserted into the WHERE clause

string|null|array $sort

Deprecated. A sort expression to be inserted into the ORDER BY clause. If omitted, the static field $default_sort on the component class will be used.

string $join

Deprecated, use leftJoin($table, $joinClause) instead

string|null|array $limit

Deprecated. A limit expression to be inserted into the LIMIT clause

Return Value

HasManyList

The components of the one-to-many relationship.

getComponentsQuery($componentName, $filter = "", $sort = "", $join = "", $limit = "") deprecated

deprecated

No description

Parameters

$componentName
$filter
$sort
$join
$limit

string getRelationClass($relationName)

Find the foreign class of a relation on this DataObject, regardless of the relation type.

Parameters

$relationName

Relation name.

Return Value

string

Class name, or null if not found.

string getRemoteJoinField(string $component, string $type = 'has_many', bool $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.

Parameters

string $component

Name of the relation on the current object pointing to the remote object.

string $type

the join type - either 'has_many' or 'belongs_to'

bool $polymorphic

Flag set to true if the remote join field is polymorphic.

Return Value

string

ManyManyList getManyManyComponents(string $componentName, $filter = null, $sort = null, $join = null, $limit = null)

Returns a many-to-many component, as a ManyManyList.

Implement query-params

Parameters

string $componentName

Name of the many-many component

$filter
$sort
$join
$limit

Return Value

ManyManyList

The set of components

array|null has_one(string $component = null) deprecated

deprecated 4.0 Method has been replaced by hasOne() and hasOneComponent()

No description

Parameters

string $component

Return Value

array|null

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.

Parameters

string $component

Deprecated - Name of component

Return Value

string|array

The class of the one-to-one component, or an array of all one-to-one components and their classes.

string|null hasOneComponent(string $component)

Return data for a specific has_one component.

Parameters

string $component

Return Value

string|null

array|null belongs_to(string $component = null, bool $classOnly = true) deprecated

deprecated 4.0 Method has been replaced by belongsTo() and belongsToComponent()

No description

Parameters

string $component
bool $classOnly

Return Value

array|null

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.

Parameters

string $component
  • Name of component
bool $classOnly

If this is TRUE, than any has_many relationships in the form "ClassName.Field" will have the field data stripped off. It defaults to TRUE.

Return Value

string|array

string|false belongsToComponent(string $component, bool $classOnly = true)

Return data for a specific belongs_to component.

Parameters

string $component
bool $classOnly

If this is TRUE, than any has_many relationships in the form "ClassName.Field" will have the field data stripped off. It defaults to TRUE.

Return Value

string|false

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

Parameters

string $fieldName

Limit the output to a specific field name

Return Value

array

The database fields

array|null has_many(string $component = null, bool $classOnly = true) deprecated

deprecated 4.0 Method has been replaced by hasMany() and hasManyComponent()

No description

Parameters

string $component
bool $classOnly

Return Value

array|null

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.

Parameters

string $component

Deprecated - Name of component

bool $classOnly

If this is TRUE, than any has_many relationships in the form "ClassName.Field" will have the field data stripped off. It defaults to TRUE.

Return Value

string|array|false

string|false hasManyComponent(string $component, bool $classOnly = true)

Return data for a specific has_many component.

Parameters

string $component
bool $classOnly

If this is TRUE, than any has_many relationships in the form "ClassName.Field" will have the field data stripped off. It defaults to TRUE.

Return Value

string|false

array many_many_extraFields(string $component = null) deprecated

deprecated 4.0 Method has been replaced by manyManyExtraFields() and manyManyExtraFieldsForComponent()

No description

Parameters

string $component

Return Value

array

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.

Parameters

string $component

Deprecated - Name of component

Return Value

array|null

array|null manyManyExtraFieldsForComponent(string $component)

Return the many-to-many extra fields specification for a specific component.

Parameters

string $component

Return Value

array|null

array|null many_many(string $component = null) deprecated

deprecated 4.0 Method has been renamed to manyMany()

No description

Parameters

string $component

Return Value

array|null

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.

Parameters

string $component

Deprecated - Name of component

Return Value

array|null

An array of (parentclass, childclass), or an array of all many-many components

See also

DataObject::manyManyComponent

array|null manyManyComponent(string $component)

Return information about a specific many_many component. Returns a numeric array of: array(

, The class that relation is defined in e.g. "Product" , The target class of the relation e.g. "Category" , The field name pointing to 's table e.g. "ProductID" , The field name pointing to 's table e.g. "CategoryID" The join table between the two classes e.g. "Product_Categories" )

Parameters

string $component

The component name

Return Value

array|null

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.

Parameters

$class

Return Value

array

or false

SearchContext getDefaultSearchContext()

Generates a SearchContext to be used for building and processing a generic search form for properties on this object.

Return Value

SearchContext

FieldList scaffoldSearchFields(array $_params = null)

Determine which properties on the DataObject are searchable, and map them to their default FormField representations. Used for scaffolding a searchform for ModelAdmin.

Some additional logic is included for switching field labels, based on how generic or specific the field type is.

Used by SearchContext.

Parameters

array $_params

'fieldClasses': Associative array of field names as keys and FormField classes as values 'restrictFields': Numeric array of a field name whitelist

Return Value

FieldList

FieldList scaffoldFormFields(array $_params = null)

Scaffold a simple edit form for all properties on this dataobject, based on default FormField} mapping in {@link DBField::scaffoldFormField().

Field labels/titles will be auto generated from DataObject::fieldLabels().

Parameters

array $_params

Associative array passing through properties to FormScaffolder.

Return Value

FieldList

protected beforeUpdateCMSFields(callable $callback)

Allows user code to hook into DataObject::getCMSFields prior to updateCMSFields being called on extensions

Parameters

callable $callback

The callback to execute

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 DataExtension and implemeting updateCMSFields(FieldList $fields) on that extension.

Return Value

FieldList

Returns a TabSet for usage within the CMS - don't use for frontend forms.

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.

Return Value

an

Empty FieldList(); need to be overload by solid subclass

FieldList getFrontEndFields(array $params = null)

Used for simple frontend forms without relation editing or TabSet} behaviour. Uses {@link scaffoldFormFields() by default. To customize, either overload this method in your subclass, or extend it by DataExtension->updateFrontEndFields().

Decide on naming for "website|frontend|site|page" and stick with it in the API

Parameters

array $params

See scaffoldFormFields()

Return Value

FieldList

Always returns a simple field collection without TabSet.

protected bool loadLazyFields(string $tableClass = null)

Loads all the stub fields that an initial lazy load didn't load fully.

Parameters

string $tableClass

Base table to load the values from. Others are joined as required. Not specifying a tableClass will load all lazy fields from all tables.

Return Value

bool

Flag if lazy loading succeeded

array getChangedFields(bool $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)
)

Parameters

bool $databaseFieldsOnly

Get only database fields that have changed

int $changeLevel

The strictness of what is defined as change. Defaults to strict

Return Value

array

bool isChanged(string $fieldName = null, int $changeLevel = self::CHANGE_STRICT)

Uses getChangedFields() to determine if fields have been changed since loading them from the database.

Parameters

string $fieldName

Name of the database field to check, will check for any if not given

int $changeLevel

See getChangedFields()

Return Value

bool

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.

Parameters

$fieldName
$val

bool hasDatabaseField(string $field)

Returns true if the given field exists as a database column

Parameters

string $field

Name of the field

Return Value

bool

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.

Parameters

string $field

Name of the field

Return Value

string

The field type of the given field

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.

Parameters

string $class

Class name to check

string $field

Name of the field

Return Value

string

The field type of the given field

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.

Parameters

string $dataClass

Return Value

bool

bool can(string $perm, Member $member = null)

Returns true if the member is allowed to do the given action.

See extendedCan() for a more versatile tri-state permission control.

Parameters

string $perm

The permission to be checked, such as 'View'.

Member $member

The member whose permissions need checking. Defaults to the currently logged in user.

Return Value

bool

True if the the member is allowed to do the given action

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

Parameters

string $methodName

Method on the same object, e.g. canEdit()

Member|int $member

Return Value

bool|null

bool canView(Member $member = null)

No description

Enforce on filesystem URL level via mod_rewrite

Parameters

Member $member

Return Value

bool

bool canEdit(Member $member = null)

Returns true if the following conditions are met:

  • CMS_ACCESS_AssetAdmin

Decouple from CMS view access

Parameters

Member $member

Return Value

bool

bool canDelete(Member $member = null)

No description

Parameters

Member $member

Return Value

bool

bool canCreate(Member $member = null)

No description

Parameters

Member $member

Return Value

bool

string debug()

Debugging used by Debug::show()

Return Value

string

HTML data representing this object

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"

Parameters

string $fieldName

Name of the field

Return Value

DBField

The field as a DBField object

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

Parameters

string $fieldPath

Return Value

mixed

DBField of the field on the object or a DataList instance.

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)

Parameters

$fieldName

Return Value

string

| null - will return null on a missing value

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.

Parameters

$className

Return Value

string

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

$containerClass is Ignored, why?

Parameters

string $callerClass

The class of objects to be returned

string|array $filter

A filter to be inserted into the WHERE clause. Supports parameterised queries. See SQLQuery::addWhere() for syntax examples.

string|array $sort

A sort expression to be inserted into the ORDER BY clause. If omitted, self::$default_sort will be used.

string $join

Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.

string|array $limit

A limit expression to be inserted into the LIMIT clause.

string $containerClass

The container class to return the results in.

Return Value

DataList

The objects matching the filter, in the class specified by $containerClass

Aggregate($class = null) deprecated

deprecated

No description

Parameters

$class

RelationshipAggregate($relationship) deprecated

deprecated

No description

Parameters

$relationship

static DataObject get_one(string $callerClass, string|array $filter = "", bool $cache = true, string $orderby = "")

Return the first item matching the given query.

All calls to get_one() are cached.

Parameters

string $callerClass

The class of objects to be returned

string|array $filter

A filter to be inserted into the WHERE clause. Supports parameterised queries. See SQLQuery::addWhere() for syntax examples.

bool $cache

Use caching

string $orderby

A sort expression to be inserted into the ORDER BY clause.

Return Value

DataObject

The first item matching the query

DataObject flushCache($persistant = true)

Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.

Parameters

$persistant

Return Value

DataObject $this

static flush_and_destroy_cache()

Flush the get_one global cache and destroy associated objects.

static reset()

Reset all global caches associated with DataObject.

static DataObject get_by_id(string $callerClass, int $id, bool $cache = true)

Return the given element, searching by ID

Parameters

string $callerClass

The class of the object to be returned

int $id

The id of the element

bool $cache

See get_one()

Return Value

DataObject

The element

baseTable()

Get the name of the base table for this object

array getSourceQueryParams()

No description

Return Value

array

See also

$sourceQueryParams

setSourceQueryParams($array)

No description

Parameters

$array

See also

$sourceQueryParams

setSourceQueryParam($key, $value)

No description

Parameters

$key
$value

See also

$sourceQueryParams

mixed getSourceQueryParam($key)

No description

Parameters

$key

Return Value

mixed

See also

$sourceQueryParams

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.

protected array parseSortColumn(string $column)

Parses a specified column into a sort field and direction

Parameters

string $column

String to parse containing the column name

Return Value

array

Resolved table and column.

requireTable()

Check the database schema and update it as necessary.

protected validateModelDefinitions()

Validate that the configured relations for this class use the correct syntaxes

Exceptions

LogicException

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

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.

review whether this is still needed after recent API changes

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.

Return Value

array

array|string fieldLabels(bool $includerelations = true)

No description

Parameters

bool $includerelations

a boolean value to indicate if the labels returned include relation fields

Return Value

array|string

Array of all element labels if no argument given, otherwise the label of the field

string fieldLabel(string $name)

Get a human-readable label for a single field, see fieldLabels() for more details.

Parameters

string $name

Name of the field

Return Value

string

Label of the field

array summaryFields()

Get the default summary fields for this object.

use the translation apparatus to return a default field selection for the language

Return Value

array

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 DBField is used.

error handling/type checking for valid FormField and SearchFilter subclasses?

Return Value

array

bool isInDB()

No description

Return Value

bool

True if the object is in the database

static disable_subclass_access()

Temporarily disable subclass access in data object qeur

static enable_subclass_access()

No description

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.

Return Value

array

All entites in an associative array, with entity name as the key, and a numerical array of pseudo-arguments for _t() as a value.

Replace "[file_link id=n]" shortcode with an anchor tag or link to the file.

Parameters

$arguments

array Arguments to the shortcode

$content

string Content of the returned link (optional)

$parser

object Specify a parser to parse the content (see ShortCodeParser)

Return Value

string

anchor HTML tag if content argument given, otherwise file path link

static mixed find(string $filename)

Find a File object by the given filename.

Parameters

string $filename

Matched against the "Name" property.

Return Value

mixed

null if not found, File object of found file

Just an alias function to keep a consistent API with SiteTree

Return Value

string

The link to the file

Just an alias function to keep a consistent API with SiteTree

Return Value

string

The relative link to the file

Just an alias function to keep a consistent API with SiteTree

Return Value

string

The absolute link to the file

string getTreeTitle()

No description

Return Value

string

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

Parameters

$ext

Return Value

string

string appCategory()

Returns a category based on the file extension.

Return Value

string

HTMLVarchar StripThumbnail()

Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.

Return Value

HTMLVarchar

CMSThumbnail()

Resize this image for the CMS. Use in templates with $CMSThumbnail

string Icon()

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

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

Return Value

string

onAfterUpload()

Should be called after the file was uploaded

deleteDatabaseOnly()

Delete the database record (recursively for folders) without touching the filesystem

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 write() invocation, as it relies on DataObject->isChanged()}, which is reset after a {@link write() call. Might be called as 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 setName()} or {@link setParentID() before).

collateDescendants($condition, $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.

Parameters

$condition
$collator

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 File database record in the same folder. This means "myfile.jpg" might become "myfile-1.jpg".

Does not change the filesystem itself, please use write() for this.

Parameters

string $name

No description

Parameters

string $old

File path relative to the webroot

string $new

File path relative to the webroot

setParentID($parentID)

Does not change the filesystem itself, please use write() for this.

Parameters

$parentID

string getAbsoluteURL()

Gets the absolute URL accessible through the web.

Return Value

string

string getURL()

Gets the relative URL accessible through the web.

Return Value

string

string getFullPath()

Returns an absolute filesystem path to the file.

Use getRelativePath() to get the same path relative to the webroot.

Return Value

string

string getRelativePath()

Returns path relative to webroot.

Serves as a "fallback" method to create the "Filename" property if it isn't set. If no Folder is set ("ParentID" property), defaults to a filename relative to the ASSETS_DIR (usually "assets/").

Return Value

string

No description

Coupling with cms module, remove this method.

getFilename()

No description

setFilename($val)

Caution: this does not change the location of the file on the filesystem.

Parameters

$val

string getExtension()

Returns the file extension

This overrides getExtension() in DataObject, but it does something completely different. This should be renamed to getFileExtension(), but has not been yet as it may break legacy code.

Return Value

string

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"

Parameters

string $filename

Return Value

string

string getFileType()

Return the type of file for the given extension on the current file name.

Return Value

string

getSize()

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

static string format_size(int $size)

Formats a file size (eg: (int)42 becomes string '42 bytes')

Parameters

int $size

Return Value

string

static int ini2bytes(string $iniValue)

Convert a php.ini value (eg: 512M) to bytes

Parameters

string $iniValue

Return Value

int

int getAbsoluteSize()

Return file size in bytes.

Return Value

int

static string get_class_for_file_extension($ext)

Maps a File subclass to a specific extension.

By default, files with common image extensions will be created as Image} instead of {@link File when using Folder::constructChild}, {@link Folder::addUploadToFolder), and the 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 Object::getCustomClass().

Parameters

$ext

Return Value

string

Classname for a subclass of File

static set_class_for_file_extension($exts, $class)

See get_class_for_file_extension().

Parameters

$exts
$class

File Parent()

Returns parent File

Return Value

File

Member Owner()

Returns Member object of file owner.

Return Value

Member

static flush()

Triggered early in the request when someone requests a flush.

static set_backend($backend)

No description

Parameters

$backend

static get_backend()

No description

static string strip_resampled_prefix(string $path)

Retrieve the original filename from the path of a transformed image.

Any other filenames pass through unchanged.

Parameters

string $path

Return Value

string

string getTag()

Return an XHTML img tag for this Image, or NULL if the image file doesn't exist on the filesystem.

Return Value

string

string forTemplate()

Return an XHTML img tag for this Image.

Return Value

string

loadUploadedImage($tmpFile) deprecated

deprecated 4.0

File names are filtered through FileNameFilter, see class documentation on how to influence this behaviour.

Parameters

$tmpFile

Image|null Fit(int $width, int $height)

Scale image proportionally to fit within the specified bounds

Parameters

int $width

The width to size within

int $height

The height to size within

Return Value

Image|null

Image_Backend generateFit(Image_Backend $backend, int $width, int $height) deprecated

deprecated 4.0 Generate methods are no longer applicable

Scale image proportionally to fit within the specified bounds

Parameters

Image_Backend $backend
int $width

The width to size within

int $height

The height to size within

Return Value

Image_Backend

Image FitMax(int $width, int $height)

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

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

Parameters

int $width

The maximum width of the output image

int $height

The maximum height of the output image

Return Value

Image

Image|null Fill(int $width, int $height)

Resize and crop image to fill specified dimensions.

Use in templates with $Fill

Parameters

int $width

Width to crop to

int $height

Height to crop to

Return Value

Image|null

Image_Backend generateFill(Image_Backend $backend, int $width, int $height) deprecated

deprecated 4.0 Generate methods are no longer applicable

Resize and crop image to fill specified dimensions.

Use in templates with $Fill

Parameters

Image_Backend $backend
int $width

Width to crop to

int $height

Height to crop to

Return Value

Image_Backend

Image FillMax(int $width, int $height)

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

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

Parameters

int $width

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

int $height

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

Return Value

Image

Image|null Pad(int $width, int $height, string $backgroundColor = 'FFFFFF', int $transparencyPercent = 0)

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

Parameters

int $width

The width to size to

int $height

The height to size to

string $backgroundColor

The background colour to use on padded sides (default white)

int $transparencyPercent

Level of transparency

Return Value

Image|null

Image_Backend generatePad(Image_Backend $backend, int $width, int $height, string $backgroundColor = 'FFFFFF', int $transparencyPercent = 0) 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.

Parameters

Image_Backend $backend
int $width

The width to size to

int $height

The height to size to

string $backgroundColor

The background colour to use on padded sides (default white)

int $transparencyPercent

Level of transparency

Return Value

Image_Backend

Image|null ScaleWidth(int $width)

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

Parameters

int $width

The width to set

Return Value

Image|null

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.

Parameters

Image_Backend $backend
int $width

The width to set

Return Value

Image_Backend

Image ScaleMaxWidth(int $width)

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

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

Parameters

int $width

The maximum width of the output image

Return Value

Image

Image|null ScaleHeight(int $height)

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

Parameters

int $height

The height to set

Return Value

Image|null

Image_Backend generateScaleHeight(Image_Backend $backend, int $height) deprecated

deprecated 4.0 Generate methods are no longer applicable

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

Parameters

Image_Backend $backend
int $height

The height to set

Return Value

Image_Backend

Image ScaleMaxHeight(int $height)

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

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

Parameters

int $height

The maximum height of the output image

Return Value

Image

Image CropWidth(int $width)

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

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

Parameters

int $width

The maximum width of the output image

Return Value

Image

Image CropHeight(int $height)

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

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

Parameters

int $height

The maximum height of the output image

Return Value

Image

Image SetRatioSize(int $width, int $height) deprecated

deprecated 4.0 Use Fit instead

Resize the image by preserving aspect ratio, keeping the image inside the $width and $height

Parameters

int $width

The width to size within

int $height

The height to size within

Return Value

Image

Image_Backend generateSetRatioSize(Image_Backend $backend, int $width, int $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

Parameters

Image_Backend $backend
int $width

The width to size within

int $height

The height to size within

Return Value

Image_Backend

Image SetWidth(int $width) deprecated

deprecated 4.0 Use ScaleWidth instead

Resize this Image by width, keeping aspect ratio. Use in templates with $SetWidth.

Parameters

int $width

The width to set

Return Value

Image

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.

Parameters

Image_Backend $backend
int $width

The width to set

Return Value

Image_Backend

Image SetHeight(int $height) deprecated

deprecated 4.0 Use ScaleHeight instead

Resize this Image by height, keeping aspect ratio. Use in templates with $SetHeight.

Parameters

int $height

The height to set

Return Value

Image

Image_Backend generateSetHeight(Image_Backend $backend, int $height) deprecated

deprecated 4.0 Generate methods are no longer applicable

Resize this Image by height, keeping aspect ratio. Use in templates with $SetHeight.

Parameters

Image_Backend $backend
int $height

The height to set

Return Value

Image_Backend

Image SetSize(int $width, int $height) deprecated

deprecated 4.0 Use Pad instead

Resize this Image by both width and height, using padded resize. Use in templates with $SetSize.

Parameters

int $width

The width to size to

int $height

The height to size to

Return Value

Image

See also

Image::PaddedImage

Image_Backend generateSetSize(Image_Backend $backend, int $width, int $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.

Parameters

Image_Backend $backend
int $width

The width to size to

int $height

The height to size to

Return Value

Image_Backend

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.

Parameters

Image_Backend $backend

Return Value

Image_Backend

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.

Parameters

Image_Backend $backend

Return Value

Image_Backend

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.

Parameters

Image_Backend $backend

Return Value

Image_Backend

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.

Parameters

Image_Backend $backend

Return Value

Image_Backend

Image PaddedImage(int $width, int $height, $backgroundColor = 'FFFFFF', int $transparencyPercent = 0) deprecated

deprecated 4.0 Use Pad instead

Resize this Image by both width and height, using padded resize. Use in templates with $PaddedImage.

Parameters

int $width

The width to size to

int $height

The height to size to

$backgroundColor
int $transparencyPercent

Level of transparency

Return Value

Image

See also

Image::SetSize

Image_Backend generatePaddedImage(Image_Backend $backend, int $width, int $height, $backgroundColor = 'FFFFFF', int $transparencyPercent = 0) 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.

Parameters

Image_Backend $backend
int $width

The width to size to

int $height

The height to size to

$backgroundColor
int $transparencyPercent

Level of transparency

Return Value

Image_Backend

bool isSize(int $width, int $height)

Determine if this image is of the specified size

Parameters

int $width

Width to check

int $height

Height to check

Return Value

bool

bool isWidth(int $width)

Determine if this image is of the specified width

Parameters

int $width

Width to check

Return Value

bool

bool isHeight(int $height)

Determine if this image is of the specified width

Parameters

int $height

Height to check

Return Value

bool

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

Parameters

string $format

The name of the format.

Return Value

Image_Cached|null

string cacheFilename(string $format)

Return the filename for the cached image, given its format name and arguments.

Parameters

string $format

The format name.

Return Value

string

Exceptions

InvalidArgumentException

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.

Parameters

string $format

Name of the format to generate.

Image ResizedImage(int $width, int $height)

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

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

Parameters

int $width

Width to resize to

int $height

Height to resize to

Return Value

Image

Image_Backend|null generateResizedImage(Image_Backend $backend, int $width, int $height)

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

Use in templates with $ResizedImage.

Parameters

Image_Backend $backend
int $width

Width to resize to

int $height

Height to resize to

Return Value

Image_Backend|null

Image CroppedImage(int $width, int $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

Parameters

int $width

Width to crop to

int $height

Height to crop to

Return Value

Image

Image_Backend generateCroppedImage(Image_Backend $backend, int $width, int $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

Parameters

Image_Backend $backend
int $width

Width to crop to

int $height

Height to crop to

Return Value

Image_Backend

int regenerateFormattedImages()

Regenerate all of the formatted cached images for this image.

Return Value

int

The number of formatted images regenerated

int deleteFormattedImages()

Remove all of the formatted cached images for this image.

Return Value

int

The number of formatted images deleted

string|int|null getDimensions(string $dim = "string")

Get the dimensions of this Image.

Parameters

string $dim

If this is equal to "string", return the dimensions in string form, if it is 0 return the height, if it is 1 return the width.

Return Value

string|int|null

int getWidth()

Get the width of this image.

Return Value

int

int getHeight()

Get the height of this image.

Return Value

int

ORIENTATION_SQUARE getOrientation()

Get the orientation of this image.

Return Value

ORIENTATION_SQUARE

| ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE