BrowserFolder
class BrowserFolder extends AbstractBrowserItem
Class BrowserFolder
Properties
protected int | $id | from AbstractBrowserItem | |
protected string | $name | from AbstractBrowserItem | |
protected int | $size | from AbstractBrowserItem | |
protected string | $author | from AbstractBrowserItem | |
protected string | $source | from AbstractBrowserItem | |
protected string | $thumbnail_url | from AbstractBrowserItem | |
protected bool | $selectable | from AbstractBrowserItem | |
protected int | $created_at | from AbstractBrowserItem | |
protected int | $modified_at | from AbstractBrowserItem | |
protected bool | $has_children |
Methods
Returns the type of this item. Possible types are folder and file.
Returns the modification time in unix timestamp format.
Returns the name of this item with optional source.
Return the name with escaping for usage in XSS context
Returns the numeric representation of the selectable value.
Returns the url of the thumbnail image of this item. This method should return an empty string if there is no thumbnail, in this case, the item displays an icon based on the extension or type of this item.
Returns whether this folder has sub folders or not.
Returns whether this file can be selected in the browser or not. This method returns true by default (if not set).
Sets whether this folder has dub folders or not.
Details
in
AbstractBrowserItem at line 260
string
__get($method)
Template property via method access support
in
AbstractBrowserItem at line 65
string
get_author()
Returns the author of this item.
in
AbstractBrowserItem at line 221
int
get_created_at()
Returns the creation time in unix timestamp format.
in
AbstractBrowserItem at line 103
string
get_id()
Returns the identifier of this item.
This id is used by the browser for navigating and selecting items.
in
AbstractBrowserItem at line 212
string
get_item_type()
Returns the type of this item. Possible types are folder and file.
in
AbstractBrowserItem at line 239
int
get_modified_at()
Returns the modification time in unix timestamp format.
in
AbstractBrowserItem at line 121
string
get_name()
Returns the name of this item.
in
AbstractBrowserItem at line 139
string
get_name_tooltip()
Returns the name of this item with optional source.
in
AbstractBrowserItem at line 129
final string|null
get_secure_name()
Return the name with escaping for usage in XSS context
in
AbstractBrowserItem at line 192
int
get_selectable()
Returns the numeric representation of the selectable value.
This value can be used by frontend to present the selectable value.
in
AbstractBrowserItem at line 47
int
get_size()
Returns the size of this file in bytes.
in
AbstractBrowserItem at line 83
string
get_source()
Returns the source where this item is placed.
in
AbstractBrowserItem at line 162
string
get_thumbnail_url()
Returns the url of the thumbnail image of this item. This method should return an empty string if there is no thumbnail, in this case, the item displays an icon based on the extension or type of this item.
at line 22
bool
has_children()
Returns whether this folder has sub folders or not.
in
AbstractBrowserItem at line 181
bool
is_selectable()
Returns whether this file can be selected in the browser or not. This method returns true by default (if not set).
in
AbstractBrowserItem at line 74
set_author(string $author)
Sets the author for this item.
in
AbstractBrowserItem at line 230
set_created_at(int $created_at)
Sets the creation time.
at line 32
set_has_children(bool $has_children)
Sets whether this folder has dub folders or not.
in
AbstractBrowserItem at line 112
set_id(string $id)
Sets the identifier for this item.
in
AbstractBrowserItem at line 248
set_modified_at(int $modified_at)
Sets the modification time.
in
AbstractBrowserItem at line 149
set_name(string $name)
Sets the name of this item.
in
AbstractBrowserItem at line 202
set_selectable($bool)
Sets the selectable status for this item.
Set true to make this item selectable by the browser.
in
AbstractBrowserItem at line 56
set_size(int $size)
Sets the site of this file in bytes.
in
AbstractBrowserItem at line 92
set_source(string $source)
Sets the source location of this item.
in
AbstractBrowserItem at line 171
set_thumbnail_url(string $url)
Sets the thumbnail url of this item.