Asset Interface Reference
Inheritance diagram for Asset:
Collaboration diagram for Asset:
Public Member Functions | |
| setOriginalFilename ($filename) | |
| isNew () | |
| setContent ($content) | |
| getContent () | |
| getDownloadLink () | |
| delete () | |
Detailed Description
Interface for an asset file.
Implement your own asset objects and factory if you want to use your own storage for assets.
- Since
- Stud.IP 3.4
Member Function Documentation
◆ delete()
| delete | ( | ) |
Deletes this asset
Implemented in PluginAsset.
◆ getContent()
| getContent | ( | ) |
Returns the content of the asset.
- Returns
- String containing the content of the asset
Implemented in PluginAsset.
◆ getDownloadLink()
| getDownloadLink | ( | ) |
Returns a download to the asset.
- Parameters
-
String containing the uri to download the asset
Implemented in PluginAsset.
◆ isNew()
| isNew | ( | ) |
Returns whether the asset is new (and needs to be compiled/created).
- Returns
- bool indicating whether the asset if new
Implemented in PluginAsset.
◆ setContent()
| setContent | ( | $content | ) |
Sets the content of the asset.
- Parameters
-
String $content Content of the asset
Implemented in PluginAsset.
◆ setOriginalFilename()
| setOriginalFilename | ( | $filename | ) |
Sets the original file name of the source file.
- Parameters
-
String $filename Name of the original file
Implemented in PluginAsset.
The documentation for this interface was generated from the following file:
- lib/classes/assets/Asset.php
