Open Journal Systems
3.3.0
|
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 | |
Class defining basic operations for handling Listbuilder UI elements.
Definition at line 35 of file ListbuilderHandler.inc.php.
ListbuilderHandler::canAddItems | ( | ) |
Can items be added to this list builder?
Definition at line 334 of file ListbuilderHandler.inc.php.
Referenced by initialize().
ListbuilderHandler::deleteEntry | ( | $request, | |
$rowId | |||
) |
Delete an entry.
$request | Request object |
$rowId | mixed ID of row to modify |
Definition at line 163 of file ListbuilderHandler.inc.php.
References fatalError().
Referenced by updateEntry().
ListbuilderHandler::fetch | ( | $args, | |
$request | |||
) |
Fetch the listbuilder.
$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().
ListbuilderHandler::fetchOptions | ( | $args, | |
$request | |||
) |
Load the set of options for a select list type listbuilder.
$args | array |
$request | PKPRequest |
Definition at line 323 of file ListbuilderHandler.inc.php.
References getOptions().
ListbuilderHandler::getAddItemLinkAction | ( | $actionRequest | ) |
Get the "add item" link action.
$actionRequest | ActionRequest |
Definition at line 137 of file ListbuilderHandler.inc.php.
Referenced by initialize().
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)
$request | PKPRequest |
Definition at line 153 of file ListbuilderHandler.inc.php.
Referenced by ReviewFormElementResponseItemListbuilderHandler\getRowDataElement().
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' );
request | Request |
Definition at line 202 of file ListbuilderHandler.inc.php.
Referenced by fetch(), and fetchOptions().
|
protected |
Reimplemented from GridHandler.
Definition at line 345 of file ListbuilderHandler.inc.php.
ListbuilderHandler::getSaveFieldName | ( | ) |
Set the save field name for LISTBUILDER_SAVE_TYPE_EXTERNAL. This will be the HTML field that receives the data upon submission.
Definition at line 127 of file ListbuilderHandler.inc.php.
References $_saveFieldName.
ListbuilderHandler::getSaveType | ( | ) |
Get the save type (using this handler or another external one)
Definition at line 110 of file ListbuilderHandler.inc.php.
References $_saveType.
ListbuilderHandler::getSourceType | ( | ) |
Get the type of source (Free text input, select from list, autocomplete)
Definition at line 94 of file ListbuilderHandler.inc.php.
References $_sourceType.
ListbuilderHandler::getTemplate | ( | ) |
Get the listbuilder template.
Reimplemented from GridHandler.
Definition at line 74 of file ListbuilderHandler.inc.php.
References GridHandler\$_template, and GridHandler\setTemplate().
ListbuilderHandler::initialize | ( | $request, | |
$args = null |
|||
) |
$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().
ListbuilderHandler::insertEntry | ( | $request, | |
$newRowId | |||
) |
Persist a new entry insert.
$request | Request object |
$newRowId | mixed ID of row to modify |
Definition at line 188 of file ListbuilderHandler.inc.php.
References fatalError().
Referenced by updateEntry().
ListbuilderHandler::save | ( | $args, | |
$request | |||
) |
Save the listbuilder using the internal handler.
$args | array |
$request | PKPRequest |
Definition at line 302 of file ListbuilderHandler.inc.php.
References unpack().
ListbuilderHandler::setSaveFieldName | ( | $fieldName | ) |
Set the save field name for LISTBUILDER_SAVE_TYPE_EXTERNAL
$fieldName | string |
Definition at line 118 of file ListbuilderHandler.inc.php.
Referenced by ReviewFormElementResponseItemListbuilderHandler\initialize().
ListbuilderHandler::setSaveType | ( | $saveType | ) |
Set the save type (using this handler or another external one)
$sourceType | int LISTBUILDER_SAVE_TYPE_... |
Definition at line 102 of file ListbuilderHandler.inc.php.
Referenced by ReviewFormElementResponseItemListbuilderHandler\initialize().
ListbuilderHandler::setSourceType | ( | $sourceType | ) |
Set the type of source (Free text input, select from list, autocomplete)
$sourceType | int LISTBUILDER_SOURCE_TYPE_... |
Definition at line 86 of file ListbuilderHandler.inc.php.
Referenced by ReviewFormElementResponseItemListbuilderHandler\initialize().
|
static |
Unpack data to save using an external handler.
$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().
ListbuilderHandler::updateEntry | ( | $request, | |
$rowId, | |||
$newRowId | |||
) |
Persist an update to an entry.
$request | Request object |
$rowId | mixed ID of row to modify |
$newRowId | mixed ID of the new entry |
Definition at line 174 of file ListbuilderHandler.inc.php.
References deleteEntry(), and insertEntry().
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().
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().
int ListbuilderHandler::$_sourceType |
Definition of the type of source LISTBUILDER_SOURCE_TYPE_...
Definition at line 40 of file ListbuilderHandler.inc.php.
Referenced by getSourceType().