Inheritance diagram for ListbuilderHandler:

Public Member Functions
	canAddItems ()

	deleteEntry ($request, $rowId)

	fetch ($args, $request)

	fetchOptions ($args, $request)

	getAddItemLinkAction ($actionRequest)

	getNewRowId ($request)

	getOptions ($request)

	getSaveFieldName ()

	getSaveType ()

	getSourceType ()

	getTemplate ()

	initialize ($request, $args=null)

	insertEntry ($request, $newRowId)

	save ($args, $request)

	setSaveFieldName ($fieldName)

	setSaveType ($saveType)

	setSourceType ($sourceType)

	updateEntry ($request, $rowId, $newRowId)

Public Member Functions inherited from GridHandler
	__construct ($dataProvider=null)

	addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)

	addColumn ($column)

	authorize ($request, &$args, $roleAssignments)

	fetchCell (&$args, $request)

	fetchGrid ($args, $request)

	fetchRow ($args, $request)

	fetchRows ($args, $request)

	getActions ($position=GRID_ACTION_POSITION_ABOVE)

	getColumn ($columnId)

&	getColumns ()

&	getColumnsByFlag ($flag)

	getColumnsCount ($flag=null)

	getDataElementSequence ($gridDataElement)

	getDataProvider ()

	getEmptyRowText ()

	getFeatures ()

	getFootNote ()

&	getGridDataElements ($request)

	getGridRangeInfo ($request, $rangeName, $contextData=null)

	getIsSubcomponent ()

	getItemIterator ()

	getJSHandler ()

	getPublishChangeEvents ()

	getRequestArg ($key)

	getRequestArgs ()

	getRequestedRow ($request, $args)

	getSelectName ()

	getTitle ()

	getUrls ()

	hasColumn ($columnId)

	hasGridDataElements ($request)

	isDataElementSelected ($gridDataElement)

	renderRow ($request, $row)

	saveSequence ($args, $request)

	setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)

	setEmptyRowText ($emptyRowText)

	setFootNote ($footNote)

	setGridDataElements ($data)

	setTemplate ($template)

	setTitle ($title)

	setUrls ($request, $extraUrls=array())

Public Member Functions inherited from PKPHandler
	__construct ()

	addPolicy ($authorizationPolicy, $addToTop=false)

	addRoleAssignment ($roleIds, $operations)

	getApiToken ()

&	getAuthorizedContext ()

&	getAuthorizedContextObject ($assocType)

&	getDispatcher ()

	getFirstUserContext ($user, $contexts)

	getId ()

	getLastAuthorizationMessage ()

	getRoleAssignment ($roleId)

	getRoleAssignments ()

	getSiteRedirectContext ($request)

	getTargetContext ($request, &$contextsCount=null)

	index ($args, $request)

	initialize ($request)

	markRoleAssignmentsChecked ()

	requireSSL ()

	setApiToken ($apiToken)

	setDispatcher ($dispatcher)

	setEnforceRestrictedSite ($enforceRestrictedSite)

	setId ($id)

	setupTemplate ($request)

	validate ($requiredContexts=null, $request=null)

Static Public Member Functions
static	unpack ($request, $data, $deletionCallback, $insertionCallback, $updateCallback)

Static Public Member Functions inherited from PKPHandler
static	getPageParamName ($rangeName)

static	getRangeInfo ($request, $rangeName, $contextData=null)

static	hashPageContext ($request, $contextData=array())

Data Fields
	$_saveFieldName = null

	$_saveType = LISTBUILDER_SAVE_TYPE_INTERNAL

	$_sourceType

Data Fields inherited from GridHandler
	$_actions = array(GRID_ACTION_POSITION_DEFAULT => array())

	$_columns = array()

	$_constants = []

	$_data

	$_dataProvider

	$_emptyRowText = 'grid.noItems'

	$_features

	$_footNote = ''

	$_itemIterator

	$_template

	$_title = ''

	$_urls

Data Fields inherited from PKPHandler
	$_authorizationDecisionManager

	$_checks = array()

	$_dispatcher

	$_enforceRestrictedSite = true

	$_id

	$_isBackendPage = false

	$_roleAssignments = array()

	$_roleAssignmentsChecked = false

Protected Member Functions
	getRowInstance ()

Protected Member Functions inherited from GridHandler
	callFeaturesHook ($hookName, $args)

	doSpecificFetchGridActions ($args, $request, $templateMgr)

&	getDataElementFromRequest ($request, &$elementId)

	getFilterForm ()

	getFilterSelectionData ($request)

	getRowDataElement ($request, &$rowId)

	getRowsSequence ($request)

	initFeatures ($request, $args)

	isFilterFormCollapsible ()

	loadData ($request, $filter)

	noAutocompleteResults ()

	renderFilter ($request, $filterData=array())

	renderGridBodyPartsInternally ($request)

	renderRowInternally ($request, $row)

	renderRowsInternally ($request, &$elements)

	setFirstDataColumn ()

Additional Inherited Members
Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Class defining basic operations for handling Listbuilder UI elements.

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

Member Function Documentation

◆ canAddItems()

ListbuilderHandler::canAddItems ( )

Can items be added to this list builder?

Returns: boolean

Definition at line 334 of file ListbuilderHandler.inc.php.

Referenced by initialize().

◆ deleteEntry()

ListbuilderHandler::deleteEntry	(	$request,
		$rowId
	)

Delete an entry.

Parameters

$request	Request object
$rowId	mixed ID of row to modify

Returns: boolean

Definition at line 163 of file ListbuilderHandler.inc.php.

References fatalError().

Referenced by updateEntry().

◆ fetch()

ListbuilderHandler::fetch	(	$args,
		$request
	)

Fetch the listbuilder.

Parameters

$args	array
$request	PKPRequest

Reimplemented in ReviewFormElementResponseItemListbuilderHandler.

Definition at line 214 of file ListbuilderHandler.inc.php.

References GridHandler\fetchGrid(), GridHandler\getGridDataElements(), PKPTemplateManager\getManager(), and getOptions().

◆ fetchOptions()

ListbuilderHandler::fetchOptions	(	$args,
		$request
	)

Load the set of options for a select list type listbuilder.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 323 of file ListbuilderHandler.inc.php.

References getOptions().

◆ getAddItemLinkAction()

ListbuilderHandler::getAddItemLinkAction ( $actionRequest )

Get the "add item" link action.

Parameters

$actionRequest ActionRequest

Returns: LinkAction

Definition at line 137 of file ListbuilderHandler.inc.php.

Referenced by initialize().

◆ getNewRowId()

ListbuilderHandler::getNewRowId ( $request )

Get the new row ID from the request. For multi-column listbuilders, this is an array representing the row. For single-column listbuilders, this is a single piece of data (i.e. a string or int)

Parameters

$request PKPRequest

Returns: mixed

Definition at line 153 of file ListbuilderHandler.inc.php.

Referenced by ReviewFormElementResponseItemListbuilderHandler\getRowDataElement().

◆ getOptions()

ListbuilderHandler::getOptions ( $request )

Fetch the options for a LISTBUILDER_SOURCE_TYPE_SELECT LB Should return a multidimensional array: array( array('column 1 option 1', 'column 2 option 1'), array('column 1 option 2', 'column 2 option 2' );

Parameters

request Request

Returns: array

Definition at line 202 of file ListbuilderHandler.inc.php.

Referenced by fetch(), and fetchOptions().

◆ getRowInstance()

ListbuilderHandler::getRowInstance ( )

protected

See also: GridHandler::getRowInstance()

Returns: ListbuilderGridRow

Reimplemented from GridHandler.

Definition at line 345 of file ListbuilderHandler.inc.php.

◆ getSaveFieldName()

ListbuilderHandler::getSaveFieldName ( )

Set the save field name for LISTBUILDER_SAVE_TYPE_EXTERNAL. This will be the HTML field that receives the data upon submission.

Returns: string

Definition at line 127 of file ListbuilderHandler.inc.php.

References $_saveFieldName.

◆ getSaveType()

ListbuilderHandler::getSaveType ( )

Get the save type (using this handler or another external one)

Returns: int LISTBUILDER_SAVE_TYPE_...

Definition at line 110 of file ListbuilderHandler.inc.php.

References $_saveType.

◆ getSourceType()

ListbuilderHandler::getSourceType ( )

Get the type of source (Free text input, select from list, autocomplete)

Returns: int LISTBUILDER_SOURCE_TYPE_...

Definition at line 94 of file ListbuilderHandler.inc.php.

References $_sourceType.

◆ getTemplate()

ListbuilderHandler::getTemplate ( )

Get the listbuilder template.

Returns: string

Reimplemented from GridHandler.

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

References GridHandler\$_template, and GridHandler\setTemplate().

◆ initialize()

ListbuilderHandler::initialize	(	$request,
		$args = `null`
	)

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from GridHandler.

Reimplemented in SetupListbuilderHandler, and ReviewFormElementResponseItemListbuilderHandler.

Definition at line 57 of file ListbuilderHandler.inc.php.

References GridHandler\addAction(), canAddItems(), and getAddItemLinkAction().

◆ insertEntry()

ListbuilderHandler::insertEntry	(	$request,
		$newRowId
	)

Persist a new entry insert.

Parameters

$request	Request object
$newRowId	mixed ID of row to modify

Returns: boolean

Definition at line 188 of file ListbuilderHandler.inc.php.

References fatalError().

Referenced by updateEntry().

◆ save()

ListbuilderHandler::save	(	$args,
		$request
	)

Save the listbuilder using the internal handler.

Parameters

$args	array
$request	PKPRequest

Definition at line 302 of file ListbuilderHandler.inc.php.

References unpack().

◆ setSaveFieldName()

ListbuilderHandler::setSaveFieldName ( $fieldName )

Set the save field name for LISTBUILDER_SAVE_TYPE_EXTERNAL

Parameters

$fieldName string

Definition at line 118 of file ListbuilderHandler.inc.php.

Referenced by ReviewFormElementResponseItemListbuilderHandler\initialize().

◆ setSaveType()

ListbuilderHandler::setSaveType ( $saveType )

Set the save type (using this handler or another external one)

Parameters

$sourceType int LISTBUILDER_SAVE_TYPE_...

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

Referenced by ReviewFormElementResponseItemListbuilderHandler\initialize().

◆ setSourceType()

ListbuilderHandler::setSourceType ( $sourceType )

Set the type of source (Free text input, select from list, autocomplete)

Parameters

$sourceType int LISTBUILDER_SOURCE_TYPE_...

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

Referenced by ReviewFormElementResponseItemListbuilderHandler\initialize().

◆ unpack()

static ListbuilderHandler::unpack	(	$request,
		$data,
		$deletionCallback,
		$insertionCallback,
		$updateCallback
	)

static

Unpack data to save using an external handler.

Parameters

$data	String (the json encoded data from the listbuilder itself)
$deletionCallback	array callback to be used for each deleted element
$insertionCallback	array callback to be used for each updated element
$updateCallback	array callback to be used for each updated element

Definition at line 245 of file ListbuilderHandler.inc.php.

Referenced by ReviewFormElementForm\execute(), and save().

◆ updateEntry()

ListbuilderHandler::updateEntry	(	$request,
		$rowId,
		$newRowId
	)

Persist an update to an entry.

Parameters

$request	Request object
$rowId	mixed ID of row to modify
$newRowId	mixed ID of the new entry

Returns: boolean

Definition at line 174 of file ListbuilderHandler.inc.php.

References deleteEntry(), and insertEntry().

Field Documentation

◆ $_saveFieldName

string ListbuilderHandler::$_saveFieldName = null

Field for LISTBUILDER_SAVE_TYPE_EXTERNAL naming the field used to send the saved contents of the LB

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

Referenced by getSaveFieldName().

◆ $_saveType

int ListbuilderHandler::$_saveType = LISTBUILDER_SAVE_TYPE_INTERNAL

Constant indicating the save approach for the LB LISTBUILDER_SAVE_TYPE_...

Definition at line 46 of file ListbuilderHandler.inc.php.

Referenced by getSaveType().

◆ $_sourceType

int ListbuilderHandler::$_sourceType

Definition of the type of source LISTBUILDER_SOURCE_TYPE_...

Definition at line 40 of file ListbuilderHandler.inc.php.

Referenced by getSourceType().

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

ListbuilderHandler.inc.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canAddItems()

◆ deleteEntry()

◆ fetch()

◆ fetchOptions()

◆ getAddItemLinkAction()

◆ getNewRowId()

◆ getOptions()

◆ getRowInstance()

◆ getSaveFieldName()

◆ getSaveType()

◆ getSourceType()

◆ getTemplate()

◆ initialize()

◆ insertEntry()

◆ save()

◆ setSaveFieldName()

◆ setSaveType()

◆ setSourceType()

◆ unpack()

◆ updateEntry()

Field Documentation

◆ $_saveFieldName

◆ $_saveType

◆ $_sourceType