Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SeriesGridHandler Class Reference
Inheritance diagram for SeriesGridHandler:
SetupGridHandler GridHandler PKPHandler

Public Member Functions

 addSeries ($args, $request)
 
 deleteSeries ($args, $request)
 
 editSeries ($args, $request)
 
 getDataElementSequence ($row)
 
 getRowInstance ()
 
 initFeatures ($request, $args)
 
 SeriesGridHandler ()
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 updateSeries ($args, $request)
 
- Public Member Functions inherited from SetupGridHandler
 authorize ($request, &$args, $roleAssignments, $contextRequired=true)
 
 initialize ($request)
 
 SetupGridHandler ()
 
 uploadImage ($args, $request)
 
- 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)
 

Additional Inherited Members

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

Handle series grid requests.

Definition at line 19 of file SeriesGridHandler.inc.php.

Member Function Documentation

SeriesGridHandler::addSeries (   $args,
  $request 
)

An action to add a new series

Parameters
$argsarray
$requestPKPRequest

Definition at line 170 of file SeriesGridHandler.inc.php.

References editSeries().

SeriesGridHandler::deleteSeries (   $args,
  $request 
)

Delete a series

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 222 of file SeriesGridHandler.inc.php.

References DAORegistry\getDAO(), DAO\getDataChangedEvent(), and AppLocale\requireComponents().

SeriesGridHandler::editSeries (   $args,
  $request 
)

An action to edit a series

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 182 of file SeriesGridHandler.inc.php.

References JSONMessage\getString(), and PKPHandler\setupTemplate().

Referenced by addSeries().

SeriesGridHandler::getDataElementSequence (   $row)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

Definition at line 147 of file SeriesGridHandler.inc.php.

SeriesGridHandler::getRowInstance ( )

Get the row handler - override the default row handler

Returns
SeriesGridRow

Definition at line 140 of file SeriesGridHandler.inc.php.

SeriesGridHandler::initFeatures (   $request,
  $args 
)

Override to init grid features. This method is called by GridHandler::initialize() method that use the returned array with the initialized features to add them to grid.

Parameters
$requestRequest
$argsarray
Returns
array Array with initialized grid features objects.

Definition at line 131 of file SeriesGridHandler.inc.php.

SeriesGridHandler::SeriesGridHandler ( )

Constructor

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

References PKPHandler\addRoleAssignment().

SeriesGridHandler::setDataElementSequence (   $request,
  $rowId,
  $gridDataElement,
  $newSequence 
)

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Definition at line 154 of file SeriesGridHandler.inc.php.

References DAORegistry\getDAO().

SeriesGridHandler::updateSeries (   $args,
  $request 
)

Update a series

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 199 of file SeriesGridHandler.inc.php.

References DAO\getDataChangedEvent().


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