PKP\components\listPanels\ListPanel Class Reference

Inheritance diagram for PKP\components\listPanels\ListPanel:

Public Member Functions
	__construct ($id, $title, $args=[])
	getConfig ()
	set ($args)

Data Fields
	$description = ''
	$emptyLabel = ''
	$expanded = []
	$headingLevel = 'h2'
	$id = ''
	$isSidebarVisible = false
	$items = []
	$title = ''

Detailed Description

Definition at line 17 of file ListPanel.inc.php.

Constructor & Destructor Documentation

__construct()

PKP\components\listPanels\ListPanel::__construct	(		$id,
			$title,
			$args = []
	)

Initialize the form with config parameters

Parameters

$id	string
$title	string
$args	array Configuration params

Reimplemented in PKP\components\listPanels\PKPAnnouncementsListPanel.

Definition at line 74 of file ListPanel.inc.php.

References PKP\components\listPanels\ListPanel\$id, and PKP\components\listPanels\ListPanel\$title.

Member Function Documentation

getConfig()

PKP\components\listPanels\ListPanel::getConfig

(

)

Convert the object into an assoc array ready to be json_encoded and passed to the UI component

Returns

array Configuration data

Reimplemented in PKP\components\listPanels\PKPSelectReviewerListPanel, PKP\components\listPanels\PKPEmailTemplatesListPanel, PKP\components\listPanels\PKPAnnouncementsListPanel, PKP\components\listPanels\PKPSubmissionsListPanel, APP\components\listPanels\CatalogListPanel, and APP\components\listPanels\EmailTemplatesListPanel.

Definition at line 102 of file ListPanel.inc.php.

References PKP\components\listPanels\ListPanel\$description, PKP\components\listPanels\ListPanel\$emptyLabel, PKP\components\listPanels\ListPanel\$expanded, PKP\components\listPanels\ListPanel\$headingLevel, PKP\components\listPanels\ListPanel\$id, PKP\components\listPanels\ListPanel\$isSidebarVisible, PKP\components\listPanels\ListPanel\$items, and PKP\components\listPanels\ListPanel\$title.

set()

PKP\components\listPanels\ListPanel::set

(

$args

)

Set configuration data for the component

Parameters

$args

array Configuration params

Returns

Reimplemented in PKP\components\listPanels\PKPSelectReviewerListPanel.

Definition at line 86 of file ListPanel.inc.php.

Field Documentation

$description

string ListPanel::$description = ''

An optional description to add beneath the title

Definition at line 23 of file ListPanel.inc.php.

Referenced by PKP\components\listPanels\ListPanel\getConfig().

$emptyLabel

string ListPanel::$emptyLabel = ''

An optional message to display when no items are in the list

Definition at line 29 of file ListPanel.inc.php.

Referenced by PKP\components\listPanels\ListPanel\getConfig().

$expanded

array ListPanel::$expanded = []

Array of item ids that should be expanded on initial load

Definition at line 35 of file ListPanel.inc.php.

Referenced by PKP\components\listPanels\ListPanel\getConfig().

$headingLevel

string ListPanel::$headingLevel = 'h2'

The appropriate heading level for this component

Definition at line 41 of file ListPanel.inc.php.

Referenced by PKP\components\listPanels\ListPanel\getConfig().

$id

string ListPanel::$id = ''

An ID for this component

Definition at line 53 of file ListPanel.inc.php.

Referenced by PKP\components\listPanels\PKPAnnouncementsListPanel\__construct(), PKP\components\listPanels\PKPEmailTemplatesListPanel\__construct(), PKP\components\listPanels\ListPanel\__construct(), and PKP\components\listPanels\ListPanel\getConfig().

$isSidebarVisible

boolean ListPanel::$isSidebarVisible = false

Should the sidebar be visible on initial load?

Definition at line 47 of file ListPanel.inc.php.

Referenced by PKP\components\listPanels\ListPanel\getConfig().

$items

array ListPanel::$items = []

Items to display in the list

Definition at line 59 of file ListPanel.inc.php.

Referenced by PKP\components\listPanels\ListPanel\getConfig(), PKP\components\listPanels\PKPSelectReviewerListPanel\getItems(), and PKP\components\listPanels\PKPSubmissionsListPanel\getItems().

$title

string ListPanel::$title = ''

Title (expects a translation key)

Definition at line 65 of file ListPanel.inc.php.

Referenced by PKP\components\listPanels\PKPAnnouncementsListPanel\__construct(), PKP\components\listPanels\PKPEmailTemplatesListPanel\__construct(), PKP\components\listPanels\ListPanel\__construct(), and PKP\components\listPanels\ListPanel\getConfig().

---

The documentation for this class was generated from the following file:

• ListPanel.inc.php