class SystemDMSBrowserFolder extends BrowserFolder

Class SystemDMSBrowserFolder

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 from BrowserFolder

Methods

int
get_size()

Returns the size of this file in bytes.

set_size(int $size)

Sets the site of this file in bytes.

string
get_author()

Returns the author of this item.

set_author(string $author)

Sets the author for this item.

string
get_source()

Returns the source where this item is placed.

set_source(string $source)

Sets the source location of this item.

string
get_id()

Returns the identifier of this item.

set_id(string $id)

Sets the identifier for this item.

string
get_name()

Returns the name of this item.

set_name(string $name)

Sets the name of this item.

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.

set_thumbnail_url(string $url)

Sets the thumbnail url of this item.

bool
is_selectable()

Returns whether this file can be selected in the browser or not. This method returns true by default (if not set).

int
get_selectable()

Returns the numeric representation of the selectable value.

set_selectable($bool)

Sets the selectable status for this item.

string
get_item_type()

Returns the type of this item. Possible types are folder and file.

int
get_created_at()

Returns the creation time in unix timestamp format.

set_created_at(int $created_at)

Sets the creation time.

int
get_modified_at()

Returns the modification time in unix timestamp format.

set_modified_at(int $modified_at)

Sets the modification time.

string
__get($method)

Template property via method access support

bool
has_children()

Returns whether this folder has sub folders or not.

set_has_children(bool $has_children)

Sets whether this folder has dub folders or not.

__construct(xm_system_dms_category $category)

SystemDMSBrowserFolder constructor.

Details

in AbstractBrowserItem at line 47
int get_size()

Returns the size of this file in bytes.

Return Value

int Size in bytes.

in AbstractBrowserItem at line 56
set_size(int $size)

Sets the site of this file in bytes.

Parameters

int $size Size in bytes.

in AbstractBrowserItem at line 65
string get_author()

Returns the author of this item.

Return Value

string

in AbstractBrowserItem at line 74
set_author(string $author)

Sets the author for this item.

Parameters

string $author

in AbstractBrowserItem at line 83
string get_source()

Returns the source where this item is placed.

Return Value

string

in AbstractBrowserItem at line 92
set_source(string $source)

Sets the source location of this item.

Parameters

string $source

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.

Return Value

string Alphanumeric identifier.

in AbstractBrowserItem at line 112
set_id(string $id)

Sets the identifier for this item.

Parameters

string $id An alphanumeric identifier .

in AbstractBrowserItem at line 121
string get_name()

Returns the name of this item.

Return Value

string The name of this item.

in AbstractBrowserItem at line 130
set_name(string $name)

Sets the name of this item.

Parameters

string $name The name of this item.

in AbstractBrowserItem at line 143
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.

Return Value

string The url of the thumbnail image.

in AbstractBrowserItem at line 152
set_thumbnail_url(string $url)

Sets the thumbnail url of this item.

Parameters

string $url The url of the thumbnail.

in AbstractBrowserItem at line 162
bool is_selectable()

Returns whether this file can be selected in the browser or not. This method returns true by default (if not set).

Return Value

bool Selectable or not.

in AbstractBrowserItem at line 173
int get_selectable()

Returns the numeric representation of the selectable value.

This value can be used by frontend to present the selectable value.

Return Value

int Selectable or not.

in AbstractBrowserItem at line 183
set_selectable($bool)

Sets the selectable status for this item.

Set true to make this item selectable by the browser.

Parameters

$bool Boolean if this item should be selectable or not.

in AbstractBrowserItem at line 193
string get_item_type()

Returns the type of this item. Possible types are folder and file.

Return Value

string Item type (folder | file)

in AbstractBrowserItem at line 202
int get_created_at()

Returns the creation time in unix timestamp format.

Return Value

int Unix timestamp.

in AbstractBrowserItem at line 211
set_created_at(int $created_at)

Sets the creation time.

Parameters

int $created_at Unix timestamp.

in AbstractBrowserItem at line 220
int get_modified_at()

Returns the modification time in unix timestamp format.

Return Value

int Unix timestamp.

in AbstractBrowserItem at line 229
set_modified_at(int $modified_at)

Sets the modification time.

Parameters

int $modified_at Unix timestamp.

in AbstractBrowserItem at line 241
string __get($method)

Template property via method access support

Parameters

$method

Return Value

string

Exceptions

Exception

in BrowserFolder at line 22
bool has_children()

Returns whether this folder has sub folders or not.

Return Value

bool

in BrowserFolder at line 32
set_has_children(bool $has_children)

Sets whether this folder has dub folders or not.

Parameters

bool $has_children

at line 20
__construct(xm_system_dms_category $category)

SystemDMSBrowserFolder constructor.

Parameters

xm_system_dms_category $category