Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PKPFilterGridHandler Class Reference
Inheritance diagram for PKPFilterGridHandler:
GridHandler PKPHandler FilterGridHandler LookupFilterGridHandler ParserFilterGridHandler

Public Member Functions

 addFilter (&$args, &$request)
 
 deleteFilter (&$args, &$request)
 
 editFilter (&$args, &$request, $newFilter=false)
 
getContext ()
 
getFilterFromArgs ($request, &$args, $mayBeTemplate=false)
 
 getFilterGroupSymbolic ()
 
 getFormDescription ()
 
getRowInstance ()
 
 initialize (&$request)
 
 PKPFilterGridHandler ()
 
 setContext (&$context)
 
 setFilterGroupSymbolic ($filterGroupSymbolic)
 
 setFormDescription ($formDescription)
 
 updateFilter (&$args, &$request)
 
- Public Member Functions inherited from GridHandler
 _addFeatures ($features)
 
 _fixColumnWidths ()
 
_getInitializedRowInstance (&$request, $elementId, &$element, $isModified=false)
 
 _renderCellInternally (&$request, &$row, &$column)
 
 _renderGridBodyPartsInternally (&$request)
 
 _renderRowsInternally (&$request, &$elements)
 
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn (&$column)
 
 authorize (&$request, &$args, $roleAssignments)
 
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, &$request, &$templateMgr)
 
 fetchCell (&$args, &$request)
 
 fetchGrid ($args, &$request)
 
 fetchRow (&$args, &$request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag)
 
getDataElementFromRequest (&$request, &$elementId)
 
getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getInstructions ()
 
 getIsSubcomponent ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRangeInfo ($rangeName, $contextData=null)
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
getRequestedRow ($request, $args)
 
 getRowDataElement ($request, $rowId)
 
 getRowDataElementSequence (&$gridDataElement)
 
getRowInstance ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 GridHandler ($dataProvider=null)
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 initFeatures (&$request, $args)
 
 initialize (&$request, $args=null)
 
loadData (&$request, $filter)
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderRowInternally (&$request, &$row)
 
 saveRowDataElementSequence (&$request, $rowId, &$gridDataElement, $newSequence)
 
 saveSequence ($args, &$request)
 
 setEmptyRowText ($emptyRowText)
 
 setFirstDataColumn ()
 
 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)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 requireSSL ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

Manage filter administration and settings.

Definition at line 27 of file PKPFilterGridHandler.inc.php.

Member Function Documentation

PKPFilterGridHandler::addFilter ( $args,
$request 
)

An action to manually add a new filter

Parameters
$argsarray
$requestPKPRequest

Definition at line 186 of file PKPFilterGridHandler.inc.php.

References editFilter().

PKPFilterGridHandler::deleteFilter ( $args,
$request 
)

Delete a filter

Parameters
$argsarray
$requestPKPRequest
Returns
string

Definition at line 263 of file PKPFilterGridHandler.inc.php.

References DAORegistry\getDAO(), and getFilterFromArgs().

PKPFilterGridHandler::editFilter ( $args,
$request,
  $newFilter = false 
)
& PKPFilterGridHandler::getContext ( )

Get the context that filters are being managed for.

Returns
DataObject The context (journal, press, conference) for which we manage filters.

Definition at line 70 of file PKPFilterGridHandler.inc.php.

& PKPFilterGridHandler::getFilterFromArgs (   $request,
$args,
  $mayBeTemplate = false 
)

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

Parameters
$argsarray
$mayBeTemplateboolean whether filter templates should be considered.
Returns
Filter

Definition at line 292 of file PKPFilterGridHandler.inc.php.

References DAORegistry\getDAO(), and GridHandler\getRowDataElement().

Referenced by deleteFilter(), editFilter(), and updateFilter().

PKPFilterGridHandler::getFilterGroupSymbolic ( )

Get the filter group symbol

Returns
string

Definition at line 102 of file PKPFilterGridHandler.inc.php.

Referenced by editFilter(), and initialize().

PKPFilterGridHandler::getFormDescription ( )

Get the form description text

Returns
string

Definition at line 86 of file PKPFilterGridHandler.inc.php.

Referenced by editFilter(), and updateFilter().

& PKPFilterGridHandler::getRowInstance ( )
See Also
GridHandler::getRowInstance()

Definition at line 171 of file PKPFilterGridHandler.inc.php.

Referenced by updateFilter().

PKPFilterGridHandler::PKPFilterGridHandler ( )

Constructor

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

References DAORegistry\getDAO().

PKPFilterGridHandler::setContext ( $context)

Set the context that filters are being managed for. This object must implement the getId() and getSettings() methods.

Parameters
$contextDataObject The context (journal, press, conference) for which we manage filters.

Definition at line 60 of file PKPFilterGridHandler.inc.php.

PKPFilterGridHandler::setFilterGroupSymbolic (   $filterGroupSymbolic)

Set the filter group symbol

Parameters
$filterGroupSymbolicstring

Definition at line 94 of file PKPFilterGridHandler.inc.php.

Referenced by LookupFilterGridHandler\initialize(), and ParserFilterGridHandler\initialize().

PKPFilterGridHandler::setFormDescription (   $formDescription)

Set the form description text

Parameters
$formDescriptionstring

Definition at line 78 of file PKPFilterGridHandler.inc.php.

Referenced by LookupFilterGridHandler\initialize(), and ParserFilterGridHandler\initialize().

PKPFilterGridHandler::updateFilter ( $args,
$request 
)

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