Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
MultipleListsListbuilderHandler Class Reference
Inheritance diagram for MultipleListsListbuilderHandler:
ListbuilderHandler GridHandler PKPHandler BlockPluginsListbuilderHandler

Public Member Functions

 addList ($list)
 
 fetch ($args, $request)
 
getLists ()
 
 getTemplate ()
 
 initialize ($request)
 
 loadData ($request, $filter)
 
 MultipleListsListbuilderHandler ()
 
- Public Member Functions inherited from ListbuilderHandler
 deleteEntry ($request, $rowId)
 
 fetch ($args, $request)
 
 fetchOptions ($args, $request)
 
 getAddItemLinkAction ($actionRequest)
 
 getNewRowId ($request)
 
 getOptions ($request)
 
 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
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 
 fetchCell (&$args, $request)
 
 fetchGrid ($args, $request)
 
 fetchRow (&$args, $request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
 getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag)
 
 getDataElementSequence (&$gridDataElement)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getInstructions ()
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 GridHandler ($dataProvider=null)
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 initialize ($request, $args=null)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setDataElementSequence ($request, $rowId, &$gridDataElement, $newSequence)
 
 setEmptyRowText ($emptyRowText)
 
 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, $enforceRestrictedSite=true)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getWorkingContexts ($request)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 PKPHandler ()
 
 setDispatcher ($dispatcher)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Public Attributes

 $_lists
 
- Public Attributes inherited from ListbuilderHandler
 $_saveFieldName = null
 
 $_saveType = LISTBUILDER_SAVE_TYPE_INTERNAL
 
 $_sourceType
 
- Public Attributes inherited from GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_columns = array()
 
 $_data
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_instructions = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 

Protected Member Functions

 getRowInstance ()
 
 initFeatures ($request, $args)
 
 renderGridBodyPartsInternally ($request)
 
 setListsData ($request, $filter)
 
- Protected Member Functions inherited from ListbuilderHandler
 getRowInstance ()
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowDataElement ($request, $rowId)
 
 getRowInstance ()
 
 getRowsSequence ($request)
 
 initFeatures ($request, &$args)
 
 loadData ($request, $filter)
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderGridBodyPartsInternally ($request)
 
 renderRowInternally ($request, $row)
 
 renderRowsInternally ($request, &$elements)
 
 setFirstDataColumn ()
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 

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::addList (   $list)

Add a list to listbuilder.

Parameters
$listListbuilderList

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

Referenced by BlockPluginsListbuilderHandler\initialize().

MultipleListsListbuilderHandler::fetch (   $args,
  $request 
)

Fetch the listbuilder.

Parameters
$argsarray
$requestPKPRequest

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

& MultipleListsListbuilderHandler::getLists ( )

Get an array with all listbuilder lists.

Returns
Array of ListbuilderList objects.

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

Referenced by BlockPluginsListbuilderHandler\setListsData().

MultipleListsListbuilderHandler::getRowInstance ( )
protected
MultipleListsListbuilderHandler::getTemplate ( )
MultipleListsListbuilderHandler::initFeatures (   $request,
  $args 
)
protected
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 84 of file MultipleListsListbuilderHandler.inc.php.

MultipleListsListbuilderHandler::MultipleListsListbuilderHandler ( )

Constructor.

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

References GridHandler\setTemplate().

MultipleListsListbuilderHandler::renderGridBodyPartsInternally (   $request)
protected
MultipleListsListbuilderHandler::setListsData (   $request,
  $filter 
)
protected

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 186 of file MultipleListsListbuilderHandler.inc.php.

Member Data Documentation

array MultipleListsListbuilderHandler::$_lists

Set of ListbuilderList objects that this listbuilder will handle *

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


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