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

Public Member Functions

 _renderGridBodyPartsInternally (&$request)
 
 _setLists ($lists)
 
 addList ($list)
 
 fetch ($args, &$request)
 
getLists ()
 
getRowInstance ()
 
 getTemplate ()
 
 initFeatures ($request, $args)
 
 initialize ($request)
 
 loadData ($request, $filter)
 
 MultipleListsListbuilderHandler ()
 
 setListsData (&$request, $filter)
 
- Public Member Functions inherited from ListbuilderHandler
 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 ()
 
 requireSSL ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

Class defining basic operations for handling multiple lists listbuilder UI elements.

Definition at line 21 of file MultipleListsListbuilderHandler.inc.php.

Member Function Documentation

MultipleListsListbuilderHandler::_renderGridBodyPartsInternally ( $request)
MultipleListsListbuilderHandler::_setLists (   $lists)

Set the array with all listbuilder lists.

Parameters
$listsArray of ListbuilderList objects.

Definition at line 191 of file MultipleListsListbuilderHandler.inc.php.

Referenced by addList().

MultipleListsListbuilderHandler::addList (   $list)

Add a list to listbuilder.

Parameters
$listListbuilderList

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

References _setLists(), and getLists().

MultipleListsListbuilderHandler::fetch (   $args,
$request 
)

Fetch the listbuilder.

Parameters
$argsarray
$requestPKPRequest

Definition at line 176 of file MultipleListsListbuilderHandler.inc.php.

References getLists().

& MultipleListsListbuilderHandler::getLists ( )

Get an array with all listbuilder lists.

Returns
Array of ListbuilderList objects.

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

Referenced by addList(), fetch(), and loadData().

& MultipleListsListbuilderHandler::getRowInstance ( )
MultipleListsListbuilderHandler::getTemplate ( )
MultipleListsListbuilderHandler::initFeatures (   $request,
  $args 
)
MultipleListsListbuilderHandler::initialize (   $request)
MultipleListsListbuilderHandler::loadData (   $request,
  $filter 
)
See Also
GridHandler::loadData($request, $filter) You should not extend or override this method. All the data loading for this component is done using ListbuilderList objects.

Definition at line 81 of file MultipleListsListbuilderHandler.inc.php.

References getLists(), and setListsData().

MultipleListsListbuilderHandler::MultipleListsListbuilderHandler ( )

Constructor.

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

MultipleListsListbuilderHandler::setListsData ( $request,
  $filter 
)

Implement to set data on each list. This will be used by the loadData method to retrieve the listbuilder data.

Parameters
$requestRequest
$filterstring

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

Referenced by loadData().


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