ProxyType extends Base
Table of Contents
Constants
- SUFFIX_DISK = 'disk/'
- SUFFIX_FILE_DETAIL = 'file/'
- SUFFIX_FILE_HISTORY = 'file-history/'
- SUFFIX_FOLDER_LIST = 'path/'
- SUFFIX_TRASHCAN_DETAIL_FILE = 'trash/file/'
- SUFFIX_TRASHCAN_LIST = 'trashcan/'
Methods
- __construct() : mixed
- Constructor
- canAttachToExternalEntity() : bool
- Potential opportunity to attach object to external entity
- canIndexBySearch() : bool
- Tells if objects is allowed to index by module "Search".
- className() : string
- getBaseUrlFileDetail() : string
- Gets url on detail of file.
- getBaseUrlFileHistory() : string
- Gets url on history of file.
- getBaseUrlFolderList() : string
- Gets url on listing root folder in storage.
- getBaseUrlTashcanList() : string
- Gets url on listing root of trash can in storage.
- getBaseUrlTrashcanFileDetail() : string
- Gets url on detail of file in trash can.
- getEntityImageSrc() : string
- Get image (avatar) of entity.
- getEntityTitle() : string
- Get name of entity (ex. user last name + first name, group name, etc) By default: get title
- getEntityUrl() : string
- Get url to view entity of storage (ex. user profile, group profile, etc) By default: folder list
- getSecurityContextByCurrentUser() : SecurityContext
- Gets security context for current user.
- getSecurityContextByUser() : SecurityContext
- Gets security context (access provider) for user.
- getStorageBaseUrl() : string
- Gets url which use for building url to listing folders, trashcan, etc.
- getTitle() : string
- Return name of storage.
- getTitleForCurrentUser() : string
- Return name of storage.
Constants
SUFFIX_DISK
public
mixed
SUFFIX_DISK
= 'disk/'
SUFFIX_FILE_DETAIL
public
mixed
SUFFIX_FILE_DETAIL
= 'file/'
SUFFIX_FILE_HISTORY
public
mixed
SUFFIX_FILE_HISTORY
= 'file-history/'
SUFFIX_FOLDER_LIST
public
mixed
SUFFIX_FOLDER_LIST
= 'path/'
SUFFIX_TRASHCAN_DETAIL_FILE
public
mixed
SUFFIX_TRASHCAN_DETAIL_FILE
= 'trash/file/'
SUFFIX_TRASHCAN_LIST
public
mixed
SUFFIX_TRASHCAN_LIST
= 'trashcan/'
Methods
__construct()
Constructor
public
__construct(string $entityId, Storage $storage[, null $entityMiscData = null ]) : mixed
Parameters
- $entityId : string
-
Id of entity.
- $storage : Storage
-
Storage which belongs to entity.
- $entityMiscData : null = null
-
Container with different data.
canAttachToExternalEntity()
Potential opportunity to attach object to external entity
public
canAttachToExternalEntity() : bool
Return values
boolcanIndexBySearch()
Tells if objects is allowed to index by module "Search".
public
canIndexBySearch() : bool
Return values
boolclassName()
public
static className() : string
Return values
string —the fully qualified name of this class.
getBaseUrlFileDetail()
Gets url on detail of file.
public
getBaseUrlFileDetail() : string
Return values
stringgetBaseUrlFileHistory()
Gets url on history of file.
public
getBaseUrlFileHistory() : string
Return values
stringgetBaseUrlFolderList()
Gets url on listing root folder in storage.
public
getBaseUrlFolderList() : string
Return values
stringgetBaseUrlTashcanList()
Gets url on listing root of trash can in storage.
public
getBaseUrlTashcanList() : string
Return values
stringgetBaseUrlTrashcanFileDetail()
Gets url on detail of file in trash can.
public
getBaseUrlTrashcanFileDetail() : string
Return values
stringgetEntityImageSrc()
Get image (avatar) of entity.
public
final getEntityImageSrc(mixed $width, mixed $height) : string
Can be shown with entityTitle in different lists.
Parameters
- $width : mixed
-
Image width.
- $height : mixed
-
Image height.
Return values
stringgetEntityTitle()
Get name of entity (ex. user last name + first name, group name, etc) By default: get title
public
final getEntityTitle() : string
Return values
stringgetEntityUrl()
Get url to view entity of storage (ex. user profile, group profile, etc) By default: folder list
public
getEntityUrl() : string
Return values
stringgetSecurityContextByCurrentUser()
Gets security context for current user.
public
getSecurityContextByCurrentUser() : SecurityContext
Return values
SecurityContextgetSecurityContextByUser()
Gets security context (access provider) for user.
public
final getSecurityContextByUser(mixed $user) : SecurityContext
Attention! File/Folder can use anywhere and SecurityContext have to check rights anywhere (any module).
Parameters
- $user : mixed
-
User which use for check rights.
Return values
SecurityContextgetStorageBaseUrl()
Gets url which use for building url to listing folders, trashcan, etc.
public
final getStorageBaseUrl() : string
Return values
stringgetTitle()
Return name of storage.
public
final getTitle() : string
Return values
stringgetTitleForCurrentUser()
Return name of storage.
public
getTitleForCurrentUser() : string
May be concrete by current user context. Should not use in notification, email to another person.