Public Member Functions | |
| __construct ($id, $title, $supportedLocales, $args=[]) | |
| getConfig () | |
 Public Member Functions inherited from PKP\components\listPanels\ListPanel | |
| __construct ($id, $title, $args=[]) | |
| set ($args) | |
Data Fields | |
| $apiUrl = '' | |
| $form = [] | |
| $getParams = [] | |
| $itemsMax = [] | |
| $lazyLoad = [] | |
| Data Fields inherited from PKP\components\listPanels\ListPanel | |
| $description = '' | |
| $emptyLabel = '' | |
| $expanded = [] | |
| $headingLevel = 'h2' | |
| $id = '' | |
| $isSidebarVisible = false | |
| $items = [] | |
| $title = '' | |
Detailed Description
Definition at line 17 of file PKPEmailTemplatesListPanel.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| PKP\components\listPanels\PKPEmailTemplatesListPanel::__construct | ( | $id, | |
| $title, | |||
| $supportedLocales, | |||
$args = [] |
|||
| ) |
Initialize the form with config parameters
- Parameters
-
$id string $title string $supportedLocales array $args array Configuration params
Definition at line 54 of file PKPEmailTemplatesListPanel.inc.php.
References PKP\components\listPanels\ListPanel\$id, and PKP\components\listPanels\ListPanel\$title.
Member Function Documentation
◆ getConfig()
| PKP\components\listPanels\PKPEmailTemplatesListPanel::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.
Reimplemented in APP\components\listPanels\EmailTemplatesListPanel.
Definition at line 62 of file PKPEmailTemplatesListPanel.inc.php.
References PKP\components\listPanels\PKPEmailTemplatesListPanel\$apiUrl, PKP\components\listPanels\PKPEmailTemplatesListPanel\$getParams, PKP\components\listPanels\PKPEmailTemplatesListPanel\$itemsMax, PKP\components\listPanels\PKPEmailTemplatesListPanel\$lazyLoad, DAORegistry\getDAO(), and AppLocale\requireComponents().
Field Documentation
◆ $apiUrl
| string PKPEmailTemplatesListPanel::$apiUrl = '' |
URL to the API endpoint where items can be retrieved
Definition at line 23 of file PKPEmailTemplatesListPanel.inc.php.
Referenced by PKP\components\listPanels\PKPEmailTemplatesListPanel\getConfig().
◆ $form
| PKP\components\listPanels\PKPEmailTemplatesListPanel::$form = [] |
- Parameters
-
array Form for adding or editing an email template
Definition at line 26 of file PKPEmailTemplatesListPanel.inc.php.
◆ $getParams
| array PKPEmailTemplatesListPanel::$getParams = [] |
Query parameters to pass if this list executes GET requests
Definition at line 32 of file PKPEmailTemplatesListPanel.inc.php.
Referenced by PKP\components\listPanels\PKPEmailTemplatesListPanel\getConfig().
◆ $itemsMax
| int PKPEmailTemplatesListPanel::$itemsMax = [] |
Max number of items available to display in this list panel
Definition at line 44 of file PKPEmailTemplatesListPanel.inc.php.
Referenced by PKP\components\listPanels\PKPEmailTemplatesListPanel\getConfig().
◆ $lazyLoad
| boolean PKPEmailTemplatesListPanel::$lazyLoad = [] |
Whether or not this component should be lazy-loaded
Definition at line 38 of file PKPEmailTemplatesListPanel.inc.php.
Referenced by PKP\components\listPanels\PKPEmailTemplatesListPanel\getConfig().
The documentation for this class was generated from the following file:
