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

Public Member Functions

 AnnouncementGridHandler ()
 authorize ($request, &$args, $roleAssignments, $requireAnnouncementsEnabled=true)
 initialize ($request)
 loadData ($request, $filter)
 moreInformation ($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()
 $_emptyRowText = 'grid.noItems'
 $_footNote = ''
 $_instructions = ''
 $_title = ''
- Public Attributes inherited from PKPHandler
 $_checks = array()
 $_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 announcements grid requests.

Definition at line 20 of file

Member Function Documentation

AnnouncementGridHandler::AnnouncementGridHandler ( )


Definition at line 24 of file

AnnouncementGridHandler::authorize (   $request,
  $requireAnnouncementsEnabled = true 

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
$enforceRestrictedSiteboolean True iff site restrictions are to be enforced
$requireAnnouncementsEnabledIff true, allow access only if context settings enable announcements

Definition at line 36 of file

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

AnnouncementGridHandler::initialize (   $request)

See Also
$argsarray optional

Definition at line 65 of file

References GridHandler\addColumn(), Config\getVar(), and GridHandler\setEmptyRowText().

AnnouncementGridHandler::loadData (   $request,

Implement this method to load data into the grid.

$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.
grid data

Definition at line 113 of file

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

AnnouncementGridHandler::moreInformation (   $args,

Load and fetch the announcement form in read-only mode.


Definition at line 132 of file

References JSONMessage\getString().

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