Open Journal Systems  3.3.0
GenreGridHandler Class Reference
Inheritance diagram for GenreGridHandler:
SetupGridHandler GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 addGenre ($args, $request)
 
 deleteGenre ($args, $request)
 
 editGenre ($args, $request)
 
 getDataElementSequence ($row)
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 restoreGenres ($args, $request)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 updateGenre ($args, $request)
 
- Public Member Functions inherited from SetupGridHandler
 authorize ($request, &$args, $roleAssignments, $contextRequired=true)
 
 uploadImage ($args, $request)
 
- Public Member Functions inherited from GridHandler
 __construct ($dataProvider=null)
 
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 authorize ($request, &$args, $roleAssignments)
 
 fetchCell (&$args, $request)
 
 fetchGrid ($args, $request)
 
 fetchRow ($args, $request)
 
 fetchRows ($args, $request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
 getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag=null)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setEmptyRowText ($emptyRowText)
 
 setFootNote ($footNote)
 
 setGridDataElements ($data)
 
 setTemplate ($template)
 
 setTitle ($title)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from PKPHandler
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 getApiToken ()
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, &$contextsCount=null)
 
 index ($args, $request)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Protected Member Functions

 getRowInstance ()
 
 loadData ($request, $filter)
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 isFilterFormCollapsible ()
 
 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())
 
- Data Fields inherited from GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_columns = array()
 
 $_constants = []
 
 $_data
 
 $_dataProvider
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle Genre grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

GenreGridHandler::__construct ( )

Constructor

Reimplemented from SetupGridHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addGenre()

GenreGridHandler::addGenre (   $args,
  $request 
)

An action to add a new Genre

Parameters
$argsarray
$requestPKPRequest

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

References editGenre().

◆ deleteGenre()

GenreGridHandler::deleteGenre (   $args,
  $request 
)

Delete a Genre.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

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

◆ editGenre()

GenreGridHandler::editGenre (   $args,
  $request 
)

An action to edit a Genre

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

References PKPHandler\setupTemplate().

Referenced by addGenre().

◆ getDataElementSequence()

GenreGridHandler::getDataElementSequence (   $row)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

Reimplemented from GridHandler.

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

◆ getRowInstance()

GenreGridHandler::getRowInstance ( )
protected

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

Reimplemented from GridHandler.

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

◆ initFeatures()

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
$requestPKPRequest
$argsarray
Returns
array Array with initialized grid features objects.

Reimplemented from GridHandler.

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

◆ initialize()

GenreGridHandler::initialize (   $request,
  $args = null 
)

◆ loadData()

GenreGridHandler::loadData (   $request,
  $filter 
)
protected

Implement this method to load data into the grid.

Parameters
$requestPKPRequest
$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

Reimplemented from GridHandler.

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

References DAORegistry\getDAO().

◆ restoreGenres()

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
JSONMessage JSON object

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

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

◆ setDataElementSequence()

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

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Reimplemented from GridHandler.

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

References DAORegistry\getDAO().

◆ updateGenre()

GenreGridHandler::updateGenre (   $args,
  $request 
)

Update a Genre

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

References DAO\getDataChangedEvent().


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