Document
class Document extends Asset (View source)
A Document, e.g. PDF files, binaries, .
..
Properties
| protected PersistenceManagerInterface | $persistenceManager | from Asset | |
| protected LoggerInterface | $systemLogger | from Asset | |
| protected ResourceManager | $resourceManager | from Asset | |
| protected ThumbnailService | $thumbnailService | from Asset | |
| protected AssetService | $assetService | from Asset | |
| protected AssetRepository | $assetRepository | from Asset | |
| protected ImportedAssetRepository | $importedAssetRepository | from Asset | |
| protected DateTime | $lastModified | from Asset | |
| protected string | $title | from Asset | |
| protected string | $caption | from Asset | |
| protected string | $copyrightNotice | from Asset | |
| protected PersistentResource | $resource | from Asset | |
| protected Thumbnail> | $thumbnails | from Asset | |
| protected Tag> | $tags | from Asset | |
| protected AssetCollection> | $assetCollections | from Asset | |
| string | $assetSourceIdentifier | from Asset | |
| protected array | $assetSourcesConfiguration | from Asset | |
| protected AssetSourceInterface[] | $assetSources | from Asset |
Methods
Constructs an asset. The resource is set internally and then initialize() is called.
Sets the asset resource and (re-)initializes the asset.
Returns a file extension fitting to the media type of this asset
Returns a thumbnail of this asset
An internal method which adds a thumbnail which was generated by the ThumbnailService.
Refreshes this asset after the Resource or any other parameters affecting thumbnails have been modified
Set the asset collections that include this asset
Set the asset source identifier for this asset
Details
in
Asset at line 160
__construct(PersistentResource $resource)
Constructs an asset. The resource is set internally and then initialize() is called.
in
Asset at line 173
void
initializeObject(int $initializationCause)
No description
in
Asset at line 186
protected void
initialize()
Override this to initialize upon instantiation.
in
Asset at line 193
string
getIdentifier()
No description
in
Asset at line 201
string
getLabel()
No description
in
Asset at line 215
DateTime
getLastModified()
Returns the last modification timestamp for this asset
in
Asset at line 226
void
setResource(PersistentResource $resource)
Sets the asset resource and (re-)initializes the asset.
in
Asset at line 238
PersistentResource
getResource()
PersistentResource of the original file
in
Asset at line 248
string
getFileExtension()
Returns a file extension fitting to the media type of this asset
in
Asset at line 258
string
getMediaType()
Returns the IANA media type of this asset
in
Asset at line 269
void
setTitle(string $title)
Sets the title of this image (optional)
in
Asset at line 280
string
getTitle()
The title of this image
in
Asset at line 291
void
setCaption(string $caption)
Sets the caption of this asset (optional)
in
Asset at line 302
string
getCaption()
The caption of this asset
in
Asset at line 310
string
getCopyrightNotice()
No description
in
Asset at line 318
void
setCopyrightNotice(string $copyrightNotice)
No description
in
Asset at line 328
Collection
getTags()
Return the tags assigned to this asset
in
Asset at line 339
bool
addTag(Tag $tag)
Add a single tag to this asset
in
Asset at line 365
Thumbnail
getThumbnail(int $maximumWidth = null, int $maximumHeight = null, string $ratioMode = ImageInterface::RATIOMODE_INSET, bool $allowUpScaling = null)
Returns a thumbnail of this asset
If the maximum width / height is not specified or exceeds the original asset's dimensions, the width / height of the original asset is used.
in
Asset at line 378
mixed
addThumbnail(Thumbnail $thumbnail)
An internal method which adds a thumbnail which was generated by the ThumbnailService.
in
Asset at line 388
void
refresh()
Refreshes this asset after the Resource or any other parameters affecting thumbnails have been modified
in
Asset at line 408
void
setTags(Collection $tags)
Set the tags assigned to this asset
in
Asset at line 420
bool
removeTag(Tag $tag)
Remove a single tag from this asset
in
Asset at line 437
Collection
getAssetCollections()
Return the asset collections this asset is included in
in
Asset at line 448
void
setAssetCollections(Collection $assetCollections)
Set the asset collections that include this asset
in
Asset at line 476
void
setAssetSourceIdentifier(string $assetSourceIdentifier)
Set the asset source identifier for this asset
This is an internal method which allows Neos / Flow to keep track of assets which were imported from external asset sources.
in
Asset at line 484
string|null
getAssetSourceIdentifier()
No description
in
Asset at line 492
AssetProxyInterface|null
getAssetProxy()
No description
in
Asset at line 531
bool
isInUse()
Returns true if the asset is still in use.
in
Asset at line 542
int
getUsageCount()
Returns the number of times the asset is in use.