1. interface
  2. Neos
  3. \
  4. Media
  5. \
  6. Domain
  7. \
  8. Model
  9. \
  10. AssetInterface

AssetInterface

interface AssetInterface implements ResourceBasedInterface, ThumbnailSupportInterface, AssetSourceAwareInterface (View source)

A user-managed Asset which is stored in the Asset Repository

Methods

PersistentResource
getResource()

Returns the resource of this asset

void
refresh()

Refreshes this asset after the PersistentResource has been modified

from  ResourceBasedInterface
Thumbnail
getThumbnail(int $maximumWidth = null, int $maximumHeight = null, string $ratioMode = ImageInterface::RATIOMODE_INSET, bool $allowUpScaling = null)

Returns a thumbnail of this model

from  ThumbnailSupportInterface
mixed
addThumbnail(Thumbnail $thumbnail)

Adds a thumbnail which was generated by the ThumbnailService.

from  ThumbnailSupportInterface
void
setAssetSourceIdentifier(string $assetSourceIdentifier)

No description

from  AssetSourceAwareInterface
string|null
getAssetSourceIdentifier()

No description

from  AssetSourceAwareInterface
AssetProxyInterface|null
getAssetProxy()

No description

from  AssetSourceAwareInterface
string
getTitle()

The title of this asset

void
setTitle(string $title)

Sets the title of this asset

void
setResource(PersistentResource $resource)

Sets the resource and possibly triggers a refresh of dependent behavior

string
getMediaType()

Returns the IANA media type of this asset

string
getFileExtension()

Returns a file extension fitting to the media type of this asset

Details

at line 56
PersistentResource getResource()

Returns the resource of this asset

Return Value

PersistentResource

in ResourceBasedInterface at line 31
void refresh()

Refreshes this asset after the PersistentResource has been modified

Return Value

void

in ThumbnailSupportInterface at line 32
Thumbnail getThumbnail(int $maximumWidth = null, int $maximumHeight = null, string $ratioMode = ImageInterface::RATIOMODE_INSET, bool $allowUpScaling = null)

Returns a thumbnail of this model

If the maximum width / height is not specified or exceeds the original asset's dimensions, the width / height of the original asset is used.

Parameters

int $maximumWidth

The thumbnail's maximum width in pixels
int $maximumHeight

The thumbnail's maximum height in pixels
string $ratioMode

Whether the resulting image should be cropped if both edge's sizes are supplied that would hurt the aspect ratio
bool $allowUpScaling

Whether the resulting image should be upscaled

Return Value

Thumbnail

in ThumbnailSupportInterface at line 41
mixed addThumbnail(Thumbnail $thumbnail)

Adds a thumbnail which was generated by the ThumbnailService.

Parameters

Thumbnail $thumbnail

Return Value

mixed

See also

getThumbnail()

in AssetSourceAwareInterface at line 21
void setAssetSourceIdentifier(string $assetSourceIdentifier)

No description

Parameters

string $assetSourceIdentifier

Return Value

void

in AssetSourceAwareInterface at line 26
string|null getAssetSourceIdentifier()

No description

Return Value

string|null

in AssetSourceAwareInterface at line 31
AssetProxyInterface|null getAssetProxy()

No description

Return Value

AssetProxyInterface|null

at line 30
string getTitle()

The title of this asset

Return Value

string

Title of the asset

at line 39
void setTitle(string $title)

Sets the title of this asset

Parameters

string $title

Return Value

void

at line 48
void setResource(PersistentResource $resource)

Sets the resource and possibly triggers a refresh of dependent behavior

Parameters

PersistentResource $resource

Return Value

void

at line 63
string getMediaType()

Returns the IANA media type of this asset

Return Value

string

at line 70
string getFileExtension()

Returns a file extension fitting to the media type of this asset

Return Value

string