CrmDocumentBrowser
class CrmDocumentBrowser extends AbstractDocumentBrowser
Class GroupsDocumentBrowser
Properties
| protected string | $mode | from AbstractDocumentBrowser | |
| protected bool | $multiple | from AbstractDocumentBrowser | |
| protected int | $item_limit | from AbstractDocumentBrowser | |
| protected bool | $show_operation_options | from AbstractDocumentBrowser | |
| protected bool | $enable_load_more | from AbstractDocumentBrowser | |
| protected bool | $enable_search | from AbstractDocumentBrowser | |
| protected array | $allowed_file_types | from AbstractDocumentBrowser | |
| protected bool | $enable_context_menu | from AbstractDocumentBrowser | |
| protected string | $custom_operation_title | from AbstractDocumentBrowser | |
| protected string[][] | $confirmMessages | from AbstractDocumentBrowser | |
| protected xm_crm | $mod |
Methods
CrmDocumentBrowser constructor.
Applies operation settings based on the context of the document model.
Returns a custom title for the operation button or null if not set.
Returns whether the context menu should be displayed or not.
Returns whether more documents should be loaded on scroll.
Returns whether the search should be displayed or not.
Returns the limit how many items should be loaded per one call.
No description
Returns a boolean whether multiple items can be selected or not.
Returns whether to show the option to set the operation for selecting item (link, move, copy).
Returns a title for this browser.
This method is called after the selection in the browser is submitted by the user. This method give the possibility to handle the selected files before they will be processed by further submit handling.
No description
No description
Sets the limit how many items should be loaded per one call.
Sets the mode for display and selection of browser items. Allowed modes are folders and files.
Sets whether multiple items can be selected or not.
Sets whether to show the option to set the operation for selecting item (link, move, copy).
Details
at line 26
__construct(xm_crm $mod)
CrmDocumentBrowser constructor.
in
AbstractDocumentBrowser at line 214
protected
applyOperations(BrowserFile $item, DocumentModel $model)
Applies operation settings based on the context of the document model.
This operation may be override by the xui browser based on min reference levels requested from individual component.
in
AbstractDocumentBrowser at line 87
string[]
getConfirmMessages()
No description
in
AbstractDocumentBrowser at line 56
string
get_custom_operation_title()
Returns a custom title for the operation button or null if not set.
in
AbstractDocumentBrowser at line 186
bool
get_enable_context_menu()
Returns whether the context menu should be displayed or not.
in
AbstractDocumentBrowser at line 177
bool
get_enable_load_more()
Returns whether more documents should be loaded on scroll.
in
AbstractDocumentBrowser at line 195
bool
get_enable_search()
Returns whether the search should be displayed or not.
in
AbstractDocumentBrowser at line 128
int
get_item_limit()
Returns the limit how many items should be loaded per one call.
at line 36
AbstractBrowserItem[]
get_items(string $id, int $offset = 0)
No description
in
AbstractDocumentBrowser at line 108
string
get_mode()
Returns the browse mode.
This returns files if the intent is to select a file of folders if the intent is to select a target folder.
in
AbstractDocumentBrowser at line 148
bool
get_multiple_selection()
Returns a boolean whether multiple items can be selected or not.
This option affects only in files mode.
in
AbstractDocumentBrowser at line 158
bool
get_show_operation_options()
Returns whether to show the option to set the operation for selecting item (link, move, copy).
at line 95
string
get_title($item_id)
Returns a title for this browser.
in
AbstractDocumentBrowser at line 287
handle_selection(array $item_ids, string $form_temp_path)
This method is called after the selection in the browser is submitted by the user. This method give the possibility to handle the selected files before they will be processed by further submit handling.
This method is not required and can be override by sub class.
in
AbstractDocumentBrowser at line 80
setConfirmMessageForCopy(string $message, int $itemId)
No description
in
AbstractDocumentBrowser at line 64
setConfirmMessageForPassiveLink(string $message, int $itemId)
No description
in
AbstractDocumentBrowser at line 72
setConfirmMessageForReferenceLink(string $message, int $itemId)
No description
in
AbstractDocumentBrowser at line 202
set_allowed_file_types(array $types)
No description
in
AbstractDocumentBrowser at line 118
set_item_limit($limit)
Sets the limit how many items should be loaded per one call.
in
AbstractDocumentBrowser at line 97
set_mode(string $mode)
Sets the mode for display and selection of browser items. Allowed modes are folders and files.
in
AbstractDocumentBrowser at line 138
set_multiple_selection($bool)
Sets whether multiple items can be selected or not.
This option affects only in files mode.
in
AbstractDocumentBrowser at line 168
set_show_operation_options($bool)
Sets whether to show the option to set the operation for selecting item (link, move, copy).