PKP\components\listPanels\PKPSelectReviewerListPanel Class Reference

Inheritance diagram for PKP\components\listPanels\PKPSelectReviewerListPanel:

Public Member Functions
	getConfig ()
	getItems ($request)
	getItemsMax ()
	set ($args)
Public Member Functions inherited from PKP\components\listPanels\ListPanel
	__construct ($id, $title, $args=[])

Data Fields
	$apiUrl = ''
	$count = 30
	$currentlyAssigned = []
	$getParams = []
	$itemsMax = 0
	$selectorName = ''
	$warnOnAssignment = []
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 17 of file PKPSelectReviewerListPanel.inc.php.

Member Function Documentation

_getItemsParams()

PKP\components\listPanels\PKPSelectReviewerListPanel::_getItemsParams ( )

protected

Helper method to compile initial params to get items

Returns

array

Definition at line 192 of file PKPSelectReviewerListPanel.inc.php.

Referenced by PKP\components\listPanels\PKPSelectReviewerListPanel\getItems(), and PKP\components\listPanels\PKPSelectReviewerListPanel\getItemsMax().

getConfig()

PKP\components\listPanels\PKPSelectReviewerListPanel::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 73 of file PKPSelectReviewerListPanel.inc.php.

References PKP\components\listPanels\PKPSelectReviewerListPanel\$apiUrl, PKP\components\listPanels\PKPSelectReviewerListPanel\$count, PKP\components\listPanels\PKPSelectReviewerListPanel\$currentlyAssigned, PKP\components\listPanels\PKPSelectReviewerListPanel\$getParams, PKP\components\listPanels\PKPSelectReviewerListPanel\$itemsMax, PKP\components\listPanels\PKPSelectReviewerListPanel\$selectorName, and PKP\components\listPanels\PKPSelectReviewerListPanel\$warnOnAssignment.

getItems()

PKP\components\listPanels\PKPSelectReviewerListPanel::getItems

(

$request

)

Helper method to get the items property according to the self::$getParams

Parameters

Request

$request

Returns

array

Definition at line 165 of file PKPSelectReviewerListPanel.inc.php.

References PKP\components\listPanels\ListPanel\$items, PKP\components\listPanels\PKPSelectReviewerListPanel\_getItemsParams(), and PKPServices\get().

getItemsMax()

PKP\components\listPanels\PKPSelectReviewerListPanel::getItemsMax

(

)

Helper method to get the itemsMax property according to self::$getParams

Returns

int

Definition at line 183 of file PKPSelectReviewerListPanel.inc.php.

References PKP\components\listPanels\PKPSelectReviewerListPanel\_getItemsParams().

set()

PKP\components\listPanels\PKPSelectReviewerListPanel::set

(

$args

)

Set configuration data for the component

Parameters

$args

array Configuration params

Returns

Reimplemented from PKP\components\listPanels\ListPanel.

Definition at line 64 of file PKPSelectReviewerListPanel.inc.php.

References PKP\components\listPanels\PKPSelectReviewerListPanel\$currentlyAssigned, and PKP\components\listPanels\PKPSelectReviewerListPanel\$warnOnAssignment.

Field Documentation

$apiUrl

string PKPSelectReviewerListPanel::$apiUrl = ''

URL to the API endpoint where items can be retrieved

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

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

$count

integer PKPSelectReviewerListPanel::$count = 30

Number of items to show at one time

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

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

$currentlyAssigned

array PKPSelectReviewerListPanel::$currentlyAssigned = []

List of user IDs already assigned as a reviewer to this submission

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

Referenced by PKP\components\listPanels\PKPSelectReviewerListPanel\getConfig(), and PKP\components\listPanels\PKPSelectReviewerListPanel\set().

$getParams

array PKPSelectReviewerListPanel::$getParams = []

Query parameters to pass if this list executes GET requests

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

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

$itemsMax

integer PKPSelectReviewerListPanel::$itemsMax = 0

Count of total items available for list

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

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

$selectorName

string PKPSelectReviewerListPanel::$selectorName = ''

Name of the input field

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

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

$warnOnAssignment

array PKPSelectReviewerListPanel::$warnOnAssignment = []

List of user IDs which may not be suitable for blind review because of existing access to author details

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

Referenced by PKP\components\listPanels\PKPSelectReviewerListPanel\getConfig(), and PKP\components\listPanels\PKPSelectReviewerListPanel\set().

---

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

• PKPSelectReviewerListPanel.inc.php