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

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
 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)
 

Public Attributes

 $_context
 
 $_filterGroupSymbolic
 
 $_formDescription
 
- 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()
 

Additional Inherited Members

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

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 198 of file PKPFilterGridHandler.inc.php.

PKPFilterGridHandler::deleteFilter ( $args,
  $request 
)

Delete a filter

Parameters
$argsarray
$requestPKPRequest
Returns
string

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

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

Edit a filter

Parameters
$argsarray
$requestPKPRequest

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

& 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 79 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 295 of file PKPFilterGridHandler.inc.php.

PKPFilterGridHandler::getFilterGroupSymbolic ( )

Get the filter group symbol

Returns
string

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

PKPFilterGridHandler::getFormDescription ( )

Get the form description text

Returns
string

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

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

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

PKPFilterGridHandler::initialize (   $request)

Configure the grid

See Also
PKPHandler::initialize()

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

PKPFilterGridHandler::PKPFilterGridHandler ( )

Constructor

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

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 69 of file PKPFilterGridHandler.inc.php.

PKPFilterGridHandler::setFilterGroupSymbolic (   $filterGroupSymbolic)

Set the filter group symbol

Parameters
$filterGroupSymbolicstring

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

PKPFilterGridHandler::setFormDescription (   $formDescription)

Set the form description text

Parameters
$formDescriptionstring

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

PKPFilterGridHandler::updateFilter ( $args,
  $request 
)

Update a filter

Parameters
$argsarray
$requestPKPRequest
Returns
string

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

Member Data Documentation

object PKPFilterGridHandler::$_context

the context (journal, press, conference) for which we manage filters

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

mixed PKPFilterGridHandler::$_filterGroupSymbolic

the symbolic name of the filter group to be configured in this grid

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

string PKPFilterGridHandler::$_formDescription

the description text to be displayed in the filter form

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


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