Public Member Functions | |
| getConfig () | |
| getItems ($request) | |
| getItemsMax () | |
 Public Member Functions inherited from PKP\components\listPanels\ListPanel | |
| __construct ($id, $title, $args=[]) | |
| set ($args) | |
Data Fields | |
| $apiUrl = '' | |
| $count = 30 | |
| $getParams = [] | |
| $itemsMax = 0 | |
| $lazyLoad = false | |
| Data Fields inherited from PKP\components\listPanels\ListPanel | |
| $description = '' | |
| $emptyLabel = '' | |
| $expanded = [] | |
| $headingLevel = 'h2' | |
| $id = '' | |
| $isSidebarVisible = false | |
| $items = [] | |
| $title = '' | |
Protected Member Functions | |
| _getItemsParams () | |
Detailed Description
Definition at line 21 of file PKPSubmissionsListPanel.inc.php.
Member Function Documentation
◆ _getItemsParams()
|
protected |
Helper method to compile initial params to get items
- Returns
- array
Definition at line 232 of file PKPSubmissionsListPanel.inc.php.
References PKPApplication\get().
Referenced by PKP\components\listPanels\PKPSubmissionsListPanel\getItems(), and PKP\components\listPanels\PKPSubmissionsListPanel\getItemsMax().
◆ getConfig()
| PKP\components\listPanels\PKPSubmissionsListPanel::getConfig | ( | ) |
Convert the object into an assoc array ready to be json_encoded and passed to the UI component
- Returns
- array Configuration data
Reimplemented from PKP\components\listPanels\ListPanel.
Definition at line 56 of file PKPSubmissionsListPanel.inc.php.
References PKP\components\listPanels\PKPSubmissionsListPanel\$apiUrl, PKP\components\listPanels\PKPSubmissionsListPanel\$count, PKP\components\listPanels\PKPSubmissionsListPanel\$getParams, PKP\components\listPanels\PKPSubmissionsListPanel\$itemsMax, PKP\components\listPanels\PKPSubmissionsListPanel\$lazyLoad, PKPApplication\get(), PKPTemplateManager\getManager(), and AppLocale\requireComponents().
◆ getItems()
| PKP\components\listPanels\PKPSubmissionsListPanel::getItems | ( | $request | ) |
Helper method to get the items property according to the self::$getParams
- Parameters
-
Request $request
- Returns
- array
Definition at line 208 of file PKPSubmissionsListPanel.inc.php.
References PKP\components\listPanels\ListPanel\$items, PKP\components\listPanels\PKPSubmissionsListPanel\_getItemsParams(), and PKPServices\get().
◆ getItemsMax()
| PKP\components\listPanels\PKPSubmissionsListPanel::getItemsMax | ( | ) |
Helper method to get the itemsMax property according to self::$getParams
- Returns
- int
Definition at line 223 of file PKPSubmissionsListPanel.inc.php.
References PKP\components\listPanels\PKPSubmissionsListPanel\_getItemsParams().
Field Documentation
◆ $apiUrl
| string PKPSubmissionsListPanel::$apiUrl = '' |
URL to the API endpoint where items can be retrieved
Definition at line 27 of file PKPSubmissionsListPanel.inc.php.
Referenced by PKP\components\listPanels\PKPSubmissionsListPanel\getConfig().
◆ $count
| integer PKPSubmissionsListPanel::$count = 30 |
Number of items to show at one time
Definition at line 33 of file PKPSubmissionsListPanel.inc.php.
Referenced by PKP\components\listPanels\PKPSubmissionsListPanel\getConfig().
◆ $getParams
| array PKPSubmissionsListPanel::$getParams = [] |
Query parameters to pass if this list executes GET requests
Definition at line 39 of file PKPSubmissionsListPanel.inc.php.
Referenced by PKP\components\listPanels\PKPSubmissionsListPanel\getConfig().
◆ $itemsMax
| integer PKPSubmissionsListPanel::$itemsMax = 0 |
Count of total items available for list
Definition at line 51 of file PKPSubmissionsListPanel.inc.php.
Referenced by PKP\components\listPanels\PKPSubmissionsListPanel\getConfig().
◆ $lazyLoad
| boolean PKPSubmissionsListPanel::$lazyLoad = false |
Should items be loaded after the component is mounted?
Definition at line 45 of file PKPSubmissionsListPanel.inc.php.
Referenced by PKP\components\listPanels\PKPSubmissionsListPanel\getConfig().
The documentation for this class was generated from the following file:
