Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
ListbuilderHandler Class Reference
Inheritance diagram for ListbuilderHandler:
GridHandler PKPHandler MultipleListsListbuilderHandler

Public Member Functions

 deleteEntry (&$request, $rowId)
 
 fetch ($args, &$request)
 
 fetchOptions ($args, &$request)
 
 getNewRowId ($request)
 
 getOptions (&$request)
 
getRowInstance ()
 
 getSaveFieldName ()
 
 getSaveType ()
 
 getSourceType ()
 
 getTemplate ()
 
 initialize (&$request, $addItemLink=true)
 
 insertEntry (&$request, $newRowId)
 
 ListbuilderHandler ()
 
 save ($args, &$request)
 
 setSaveFieldName ($fieldName)
 
 setSaveType ($saveType)
 
 setSourceType ($sourceType)
 
 unpack (&$request, $data, $deletionCallback=null, $insertionCallback=null, $updateCallback=null)
 
 updateEntry (&$request, $rowId, $newRowId)
 
- Public Member Functions inherited from GridHandler
 _addFeatures ($features)
 
 _fixColumnWidths ()
 
_getInitializedRowInstance (&$request, $elementId, &$element, $isModified=false)
 
 _renderCellInternally (&$request, &$row, &$column)
 
 _renderGridBodyPartsInternally (&$request)
 
 _renderRowsInternally (&$request, &$elements)
 
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn (&$column)
 
 authorize (&$request, &$args, $roleAssignments)
 
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, &$request, &$templateMgr)
 
 fetchCell (&$args, &$request)
 
 fetchGrid ($args, &$request)
 
 fetchRow (&$args, &$request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag)
 
getDataElementFromRequest (&$request, &$elementId)
 
getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getInstructions ()
 
 getIsSubcomponent ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRangeInfo ($rangeName, $contextData=null)
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
getRequestedRow ($request, $args)
 
 getRowDataElement ($request, $rowId)
 
 getRowDataElementSequence (&$gridDataElement)
 
getRowInstance ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 GridHandler ($dataProvider=null)
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 initFeatures (&$request, $args)
 
 initialize (&$request, $args=null)
 
loadData (&$request, $filter)
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderRowInternally (&$request, &$row)
 
 saveRowDataElementSequence (&$request, $rowId, &$gridDataElement, $newSequence)
 
 saveSequence ($args, &$request)
 
 setEmptyRowText ($emptyRowText)
 
 setFirstDataColumn ()
 
 setFootNote ($footNote)
 
 setGridDataElements (&$data)
 
 setInstructions ($instructions)
 
 setTemplate ($template)
 
 setTitle ($title)
 
 setUrls (&$request, $extraUrls=array())
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy (&$authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize (&$request, &$args, $roleAssignments)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

Class defining basic operations for handling Listbuilder UI elements.

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

Member Function Documentation

ListbuilderHandler::deleteEntry ( $request,
  $rowId 
)

Delete an entry.

Parameters
$requestRequest object
$rowIdmixed ID of row to modify
Returns
boolean

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

Referenced by updateEntry().

ListbuilderHandler::fetch (   $args,
$request 
)

Fetch the listbuilder.

Parameters
$argsarray
$requestPKPRequest

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

References GridHandler\fetchGrid().

ListbuilderHandler::fetchOptions (   $args,
$request 
)

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

Parameters
$argsarray
$requestPKPRequest

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

References getOptions().

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
$requestPKPRequest
Returns
mixed

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

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
requestRequest
Returns
array

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

Referenced by fetchOptions().

& ListbuilderHandler::getRowInstance ( )
See Also
GridHandler::getRowInstance()
Returns
CitationGridRow

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

ListbuilderHandler::getSaveFieldName ( )

Set the save field name for LISTBUILDER_SAVE_TYPE_EXTERNAL

Returns
string

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

ListbuilderHandler::getSaveType ( )

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

Returns
int LISTBUILDER_SAVE_TYPE_...

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

ListbuilderHandler::getSourceType ( )

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

Returns
int LISTBUILDER_SOURCE_TYPE_...

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

ListbuilderHandler::getTemplate ( )

Get the listbuilder template.

Returns
string

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

References GridHandler\setTemplate().

ListbuilderHandler::initialize ( $request,
  $addItemLink = true 
)
See Also
GridHandler::initialize

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

References GridHandler\addAction().

ListbuilderHandler::insertEntry ( $request,
  $newRowId 
)

Persist a new entry insert.

Parameters
$requestRequest object
$newRowIdmixed ID of row to modify

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

Referenced by updateEntry().

ListbuilderHandler::ListbuilderHandler ( )

Constructor.

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

ListbuilderHandler::save (   $args,
$request 
)

Save the listbuilder using the internal handler.

Parameters
$argsarray
$requestPKPRequest

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

References unpack().

ListbuilderHandler::setSaveFieldName (   $fieldName)

Set the save field name for LISTBUILDER_SAVE_TYPE_EXTERNAL

Parameters
$fieldNamestring

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

ListbuilderHandler::setSaveType (   $saveType)

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

Parameters
$sourceTypeint LISTBUILDER_SAVE_TYPE_...

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

Referenced by MultipleListsListbuilderHandler\initialize().

ListbuilderHandler::setSourceType (   $sourceType)

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

Parameters
$sourceTypeint LISTBUILDER_SOURCE_TYPE_...

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

Referenced by MultipleListsListbuilderHandler\initialize().

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

Unpack data to save using an external handler.

Parameters
$dataString (the json encoded data from the listbuilder itself)
$deletionCallbackarray callback to be used for each deleted element
$insertionCallbackarray callback to be used for each updated element
$updateCallbackarray callback to be used for each updated element

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

Referenced by FormValidatorListbuilder\isValid(), and save().

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

Persist an update to an entry.

Parameters
$requestRequest object
$rowIdmixed ID of row to modify
$newRowIdmixed ID of the new entry
Returns
boolean

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

References deleteEntry(), and insertEntry().


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