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

Public Member Functions

_getGenreFromArgs ($request, $args)
 
 addGenre ($args, $request)
 
 deleteGenre ($args, $request)
 
 editGenre ($args, $request)
 
 GenreGridHandler ()
 
 getDataElementSequence ($row)
 
 getRowInstance ()
 
 initFeatures ($request, $args)
 
 loadData ($request, $filter)
 
 restoreGenres ($args, $request)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 updateGenre ($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 Genre grid requests.

Definition at line 20 of file GenreGridHandler.inc.php.

Member Function Documentation

& GenreGridHandler::_getGenreFromArgs (   $request,
  $args 
)

This will retrieve a Genre object from the grids data source based on the request arguments. If no Genre can be found then this will raise a fatal error.

Parameters
$argsarray
Returns
Genre

Definition at line 268 of file GenreGridHandler.inc.php.

References GridHandler\getRowDataElement().

Referenced by deleteGenre().

GenreGridHandler::addGenre (   $args,
  $request 
)

An action to add a new Genre

Parameters
$argsarray
$requestPKPRequest

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

References editGenre().

GenreGridHandler::deleteGenre (   $args,
  $request 
)

Delete a Genre.

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 226 of file GenreGridHandler.inc.php.

References _getGenreFromArgs(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

GenreGridHandler::editGenre (   $args,
  $request 
)

An action to edit a Genre

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 181 of file GenreGridHandler.inc.php.

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

Referenced by addGenre().

GenreGridHandler::GenreGridHandler ( )

Constructor

Definition at line 24 of file GenreGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

GenreGridHandler::getDataElementSequence (   $row)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

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

GenreGridHandler::getRowInstance ( )

Get a new instance of a grid row. May be overridden by subclasses if they want to provide a custom row definition.

Returns
GridRow
GenreGridRow

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

GenreGridHandler::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 GenreGridHandler.inc.php.

GenreGridHandler::loadData (   $request,
  $filter 
)

Implement this method to load data into the grid.

Parameters
$requestRequest
$filterarray An associative array with filter data as returned by getFilterSelectionData(). If no filter has been selected by the user then the array will be empty.
Returns
grid data

Definition at line 118 of file GenreGridHandler.inc.php.

References DAORegistry\getDAO(), and PKPHandler\getId().

GenreGridHandler::restoreGenres (   $args,
  $request 
)

Restore the default Genre settings for the context. All default settings that were available when the context instance was created will be restored.

Parameters
$argsarray
$requestPKPRequest
Returns
string

Definition at line 248 of file GenreGridHandler.inc.php.

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

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

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

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

References DAORegistry\getDAO().

GenreGridHandler::updateGenre (   $args,
  $request 
)

Update a Genre

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 201 of file GenreGridHandler.inc.php.

References DAO\getDataChangedEvent().


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