AssetFileModel

Type
Class
Namespace
Craft
Inherits
Craft\AssetFileModel » Craft\BaseElementModel » Craft\BaseModel » CModel » CComponent
Implements
ArrayAccess, IteratorAggregate
Since
1.0

Class AssetFileModel

See also http://craftcms.com

View source

Protected Properties

PropertyDescription
$classSuffixstring
$elementTypestring
$strictAttributesboolean – Whether this model should be strict about only allowing values to be set on defined attributes

$elementType

Signature

protected string $elementType = \Craft\ElementType::Asset

Public Methods

MethodDescription
__call()Magic __call() method, used for chain-setting attribute values.
__construct()Constructor
__get()Magic getter
__isset()Checks if an attribute value is set.
__set()PHP setter magic method.
__toString()Use the entry's title as its string representation.
__unset()Sets a component property to be null.
addError()Adds a new error to the specified attribute.
addErrors()Adds a list of errors.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
attributeLabels()Returns the attribute labels.
attributeNames()Returns the list of this model's attribute names.
behaviors()Returns a list of behaviors that this model should behave as.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
clearErrors()Removes errors for all attributes or a single attribute.
copy()Returns a copy of this model.
createValidators()Creates validator objects based on the specification in {@link rules}.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
generateAttributeLabel()Generates a user friendly attribute label.
getAllErrors()Returns all errors in a single, flattened list, devoid of attribute names.
getAncestors()Returns the element's ancestors.
getAttribute()Gets an attribute’s value.
getAttributeConfigs()Returns this model's normalized attribute configs.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributes()Returns an array of attribute values.
getChildren()Returns the element's children.
getClassHandle()Get the class name, sans namespace and suffix.
getContent()Returns the content for the element.
getContentFromPost()Returns the raw content from the post data, before it was passed through {@link prepValueFromPost()}.
getContentPostLocation()Returns the location in POST that the content was pulled from.
getContentTable()Returns the name of the table this element's content is stored in.
getCpEditUrl()Returns the element's CP edit URL.
getDescendants()Returns the element's descendants.
getEagerLoadedElements()Returns some eager-loaded elements on a given handle.
getElementType()Returns the type of element this is.
getError()Returns the first error of the specified attribute.
getErrors()Returns the errors for all attribute or a single attribute.
getEventHandlers()Returns the list of attached event handlers for an event.
getExtension()Get the file extension.
getExtraAttributeNames()Returns a list of the names of the extra attributes that have been saved on this model, if it's not strict.
getFieldColumnPrefix()Returns the field column prefix this element's content uses.
getFieldContext()Returns the field context this element's content uses.
getFieldLayout()Returns the field layout used by this element.
getFieldValue()Returns the prepped content for a given field.
getFolder()
getHasFreshContent()Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHasUrls()Return whether the Asset has a URL.
getHeight()Get image height.
getImg()Returns an tag based on this asset.
getIterator()Returns an iterator for traversing the attributes in the model.
getLink()Returns an anchor pre-filled with this element's URL and title.
getLocales()Returns the locale IDs this element is available in.
getMimeType()
getNext()Returns the next element relative to this one, from a given set of criteria.
getNextSibling()Returns the element's next sibling.
getParent()Get the element's parent.
getParents()Returns a new ElementCriteriaModel prepped to return this element's same-type parents.
getPath()Returns the path to the asset, relative to the root of its asset source.
getPrev()Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling()Returns the element's previous sibling.
getRawContent()Returns the raw content saved on this entity.
getRef()Returns the reference string to this element.
getSafeAttributeNames()Returns the attribute names that are safe to be massively assigned.
getScenario()Returns the scenario that this model is used in.
getSiblings()Returns all of the element's siblings.
getSource()
getStatus()Returns the element's status.
getThumbUrl()Returns the URL to the element's thumbnail, if there is one.
getTitle()Returns the element's title.
getTotalDescendants()Returns the total number of descendants that the element has.
getTransformSource()
getUrl()Returns the URL to the file.
getUrlFormat()Returns the URL format used to generate this element's URL.
getValidatorList()Returns all the validators declared in the model.
getValidators()Returns the validators applicable to the current {@link scenario}.
getWidth()Get image width.
hasDescendants()Returns whether the element has descendants.
hasEagerLoadedElements()Returns whether elements have been eager-loaded with a given handle.
hasErrors()Returns a value indicating whether there is any validation error.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
hasThumb()Does this file have a thumbnail?
isAncestorOf()Returns whether this element is an ancestor of another one.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf()Returns whether this element is a direct child of another one.
isDescendantOf()Returns whether this element is a descendant of another one.
isEditable()Returns whether the current user can edit the element.
isNextSiblingOf()Returns whether this element is the direct next sibling of another one.
isParentOf()Returns whether this element is a direct parent of another one.
isPrevSiblingOf()Returns whether this element is the direct previous sibling of another one.
isSiblingOf()Returns whether this element is a sibling of another one.
offsetExists()Treats custom fields as array offsets.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Unsets the element at the specified offset.
onAfterConstruct()This event is raised after the model instance is created by new operator.
onAfterValidate()This event is raised after the validation is performed.
onBeforeValidate()This event is raised before the validation is performed.
onUnsafeAttribute()This method is invoked when an unsafe attribute is being massively assigned.
populateModel()Populates a new model instance with a given set of attributes.
populateModels()Mass-populates models based on an array of attribute arrays.
raiseEvent()Raises an event.
rules()Returns this model's validation rules.
setAttribute()Sets an attribute's value.
setAttributes()Sets multiple attribute values at once.
setContent()Sets the content for the element.
setContentFromPost()Sets the content from post data, calling prepValueFromPost() on the field types.
setContentPostLocation()Sets the location in POST that the content was pulled from.
setEagerLoadedElements()Sets some eager-loaded elements on a given handle.
setNext()Sets the default next element.
setParent()Sets the element's parent.
setPrev()Sets the default previous element.
setRawPostContent()Sets a field’s raw post content.
setScenario()Sets the scenario for the model.
setTransform()Sets the transform.
setTransformSource()Set a source to use for transforms for this Assets File.
unsetAttributes()Sets the attributes to be null.
validate()Validates all of the attributes for the current Model. Any attributes that fail validation will additionally get logged to the craft/storage/runtime/logs folder with a level of LogLevel::Warning.

__get()

Magic getter

View source

Arguments

Returns

mixed

Throws

Signature

public mixed __get ( $name )

__isset()

Checks if an attribute value is set.

View source

Arguments

Returns

boolean

Signature

public boolean __isset ( $name )

__toString()

Use the entry's title as its string representation.

View source

Returns

string

Signature

public string __toString ( )

getAttribute()

Gets an attribute’s value.

BaseModel::getAttribute()

BaseModel::getAttribute()

View source

Arguments

  • $name (string) – The attribute’s name.
  • $flattenValue (boolean)

Returns

mixed

Signature

public mixed getAttribute ( $name, $flattenValue = false )

getExtension()

Get the file extension.

View source

Returns

mixed

Signature

public mixed getExtension ( )

getFieldLayout()

Returns the field layout used by this element.

BaseElementModel::getFieldLayout()

View source

Returns

Craft\FieldLayoutModel, null

Signature

public Craft\FieldLayoutModel, null getFieldLayout ( )

getFolder()

Signature

public Craft\AssetFolderModel, null getFolder ( )

getHasUrls()

Return whether the Asset has a URL.

View source

Returns

boolean

Signature

public boolean getHasUrls ( )

getHeight()

Get image height.

View source

Arguments

  • $transform (string, array, null) – The transform that should be applied, if any. Can either be the handle of a named transform, or an array that defines the transform settings.

Returns

boolean, float, mixed

Signature

public boolean, float, mixed getHeight ( $transform = null )

getImg()

Returns an tag based on this asset.

View source

Returns

\Twig_Markup, null

Signature

public \Twig_Markup, null getImg ( )

getMimeType()

Signature

public string getMimeType ( )

getPath()

Returns the path to the asset, relative to the root of its asset source.

View source

Returns

string

Signature

public string getPath ( )

getSource()

Signature

public Craft\AssetSourceModel, null getSource ( )

getThumbUrl()

Returns the URL to the element's thumbnail, if there is one.

BaseElementModel::getThumbUrl()

View source

Arguments

Returns

string, null

Signature

public string, null getThumbUrl ( $size = 125 )

getTransformSource()

Signature

public string getTransformSource ( )

getUrl()

Returns the URL to the file.

View source

Arguments

  • $transform (string, array, null) – The transform that should be applied, if any. Can either be the handle of a named transform, or an array that defines the transform settings.

Returns

mixed

Signature

public mixed getUrl ( $transform = null )

getWidth()

Get image width.

View source

Arguments

  • $transform (string, null) – The optional transform handle for which to get thumbnail.

Returns

boolean, float, mixed

Signature

public boolean, float, mixed getWidth ( $transform = null )

hasThumb()

Does this file have a thumbnail?

View source

Returns

boolean

Signature

public boolean hasThumb ( )

isEditable()

Returns whether the current user can edit the element.

BaseElementModel::isEditable()

View source

Returns

boolean

Signature

public boolean isEditable ( )

setTransform()

Sets the transform.

View source

Arguments

  • $transform (string, array, null) – The transform that should be applied, if any. Can either be the handle of a named transform, or an array that defines the transform settings.

Returns

Craft\AssetFileModel

Signature

public Craft\AssetFileModel setTransform ( $transform )

setTransformSource()

Set a source to use for transforms for this Assets File.

View source

Arguments

  • $uri

Signature

public void setTransformSource ( $uri )

Protected Methods

MethodDescription
afterConstruct()This method is invoked after a model instance is created by new operator.
afterValidate()This method is invoked after validation ends.
beforeValidate()This method is invoked before validation starts.
createContent()Creates the content model associated with this element.
defineAttributes()Defines this model's attributes.
getFieldByHandle()Returns the field with a given handle.

defineAttributes()

Defines this model's attributes.

BaseModel::defineAttributes()

BaseModel::defineAttributes()

View source

Returns

array

Signature

protected array defineAttributes ( )

Constants

ConstantDescription
ARCHIVED
DISABLED
ENABLED