Open Monograph Press  3.3.0
PKP\components\listPanels\PKPAnnouncementsListPanel Class Reference
Inheritance diagram for PKP\components\listPanels\PKPAnnouncementsListPanel:
PKP\components\listPanels\ListPanel

Public Member Functions

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

Data Fields

 $apiUrl = ''
 
 $count = 30
 
 $form = null
 
 $getParams = []
 
 $itemsMax = []
 
- Data Fields inherited from PKP\components\listPanels\ListPanel
 $description = ''
 
 $emptyLabel = ''
 
 $expanded = []
 
 $headingLevel = 'h2'
 
 $id = ''
 
 $isSidebarVisible = false
 
 $items = []
 
 $title = ''
 

Detailed Description

Definition at line 16 of file PKPAnnouncementsListPanel.inc.php.

Constructor & Destructor Documentation

◆ __construct()

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

Initialize the form with config parameters

Parameters
$idstring
$titlestring
$argsarray Configuration params

Reimplemented from PKP\components\listPanels\ListPanel.

Definition at line 52 of file PKPAnnouncementsListPanel.inc.php.

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

Member Function Documentation

◆ getConfig()

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

References PKPApplication\get(), and AppLocale\requireComponents().

Field Documentation

◆ $apiUrl

string PKPAnnouncementsListPanel::$apiUrl = ''

URL to the API endpoint where items can be retrieved

Definition at line 22 of file PKPAnnouncementsListPanel.inc.php.

◆ $count

int PKPAnnouncementsListPanel::$count = 30

How many items to display on one page in this list

Definition at line 28 of file PKPAnnouncementsListPanel.inc.php.

◆ $form

PKP\components\listPanels\PKPAnnouncementsListPanel::$form = null
Parameters

Definition at line 31 of file PKPAnnouncementsListPanel.inc.php.

◆ $getParams

array PKPAnnouncementsListPanel::$getParams = []

Query parameters to pass if this list executes GET requests

Definition at line 37 of file PKPAnnouncementsListPanel.inc.php.

◆ $itemsMax

int PKPAnnouncementsListPanel::$itemsMax = []

Max number of items available to display in this list panel

Definition at line 43 of file PKPAnnouncementsListPanel.inc.php.


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