SelectorProvider extends BaseProvider
Table of Contents
Methods
- __construct() : void
- SelectorProvider constructor.
- doSearch() : void
- Sets search result to the dialog.
- fillDialog() : void
- getChildren() : void
- Sets children items to Dialog.
- getFolders() : array<string|int, Item>
- Returns folders by Parent ID.
- getItems() : array<string|int, Item>
- Not implemented yet.
- getLandings() : array<string|int, Item>
- Returns landings by Parent ID.
- getOption() : mixed
- getOptions() : array<string|int, mixed>
- getPreselectedItems() : array<string|int, Item>
- getSelectedItems() : array<string|int, Item>
- Not implemented yet.
- handleBeforeItemSave() : void
- isAvailable() : bool
- This provider is available for everyone (of course not because we have access checking on API level).
Methods
__construct()
SelectorProvider constructor.
public
__construct([array<string|int, mixed> $options = [] ]) : void
Parameters
- $options : array<string|int, mixed> = []
-
Options data.
doSearch()
Sets search result to the dialog.
public
doSearch(SearchQuery $searchQuery, Dialog $dialog) : void
Parameters
- $searchQuery : SearchQuery
-
Search query instance.
- $dialog : Dialog
-
Main dialog instance.
fillDialog()
public
fillDialog(Dialog $dialog) : void
Parameters
- $dialog : Dialog
getChildren()
Sets children items to Dialog.
public
getChildren(Item $parentItem, Dialog $dialog) : void
Parameters
getFolders()
Returns folders by Parent ID.
public
static getFolders(int $siteId[, int|null $parentId = null ]) : array<string|int, Item>
Parameters
- $siteId : int
-
Site id.
- $parentId : int|null = null
-
Parent folder id (null for root dir).
Return values
array<string|int, Item>getItems()
Not implemented yet.
public
getItems(array<string|int, mixed> $ids) : array<string|int, Item>
Parameters
- $ids : array<string|int, mixed>
Return values
array<string|int, Item>getLandings()
Returns landings by Parent ID.
public
static getLandings(int $siteId[, int|null $landingId = null ][, int|null $parentId = null ]) : array<string|int, Item>
Parameters
- $siteId : int
-
Site id.
- $landingId : int|null = null
-
Landing id (for mark item as selected).
- $parentId : int|null = null
-
Parent folder id (null for root dir).
Return values
array<string|int, Item>getOption()
public
getOption(string $option[, mixed $defaultValue = null ]) : mixed
Parameters
- $option : string
- $defaultValue : mixed = null
getOptions()
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getPreselectedItems()
public
getPreselectedItems(array<string|int, mixed> $ids) : array<string|int, Item>
Parameters
- $ids : array<string|int, mixed>
Return values
array<string|int, Item>getSelectedItems()
Not implemented yet.
public
getSelectedItems(array<string|int, mixed> $ids) : array<string|int, Item>
Parameters
- $ids : array<string|int, mixed>
Return values
array<string|int, Item>handleBeforeItemSave()
public
handleBeforeItemSave(Item $item) : void
Parameters
- $item : Item
isAvailable()
This provider is available for everyone (of course not because we have access checking on API level).
public
isAvailable() : bool