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

Public Member Functions

 getOptions ()
 
 getRequestArgs ()
 
 getRowDataElement ($request, $rowId)
 
 getSeriesId ()
 
 initialize ($request)
 
 loadData ($request)
 
 SeriesEditorsListbuilderHandler ()
 
 setSeriesId ($seriesId)
 
- Public Member Functions inherited from SetupListbuilderHandler
 authorize ($request, &$args, $roleAssignments)
 
 getContext ()
 
 initialize ($request)
 
 setContext ($context)
 
 SetupListbuilderHandler ()
 
- 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

 $seriesId
 
- 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()
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- 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 ()
 

Detailed Description

Class for adding a series editor.

Definition at line 18 of file SeriesEditorsListbuilderHandler.inc.php.

Member Function Documentation

SeriesEditorsListbuilderHandler::getOptions ( )

Get possible items to populate autosuggest list with

Definition at line 73 of file SeriesEditorsListbuilderHandler.inc.php.

References getSeriesId().

SeriesEditorsListbuilderHandler::getRequestArgs ( )

Preserve the series ID for internal listbuilder requests.

See Also
GridHandler::getRequestArgs

Definition at line 114 of file SeriesEditorsListbuilderHandler.inc.php.

SeriesEditorsListbuilderHandler::getRowDataElement (   $request,
  $rowId 
)
See Also
GridHandler::getRowDataElement Get the data element that corresponds to the current request Allow for a blank $rowId for when creating a not-yet-persisted row

Definition at line 97 of file SeriesEditorsListbuilderHandler.inc.php.

SeriesEditorsListbuilderHandler::getSeriesId ( )

Get the series ID

Returns
int

Definition at line 48 of file SeriesEditorsListbuilderHandler.inc.php.

References $seriesId, and SetupListbuilderHandler\getContext().

Referenced by getOptions().

SeriesEditorsListbuilderHandler::initialize (   $request)

Configure the grid

Parameters
PKPRequest$request

Definition at line 128 of file SeriesEditorsListbuilderHandler.inc.php.

SeriesEditorsListbuilderHandler::loadData (   $request)

Load the list from an external source into the grid structure

Parameters
$requestPKPRequest

Definition at line 56 of file SeriesEditorsListbuilderHandler.inc.php.

SeriesEditorsListbuilderHandler::SeriesEditorsListbuilderHandler ( )

Constructor

Definition at line 28 of file SeriesEditorsListbuilderHandler.inc.php.

SeriesEditorsListbuilderHandler::setSeriesId (   $seriesId)

Set the series ID

Parameters
$seriesIdint

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

References $seriesId.

Member Data Documentation

The SeriesEditorsListbuilderHandler::$seriesId

group ID for this listbuilder

Definition at line 23 of file SeriesEditorsListbuilderHandler.inc.php.

Referenced by getSeriesId(), and setSeriesId().


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