Open Journal Systems  3.3.0
SearchHandler Class Reference
Inheritance diagram for SearchHandler:
Handler PKPHandler

Public Member Functions

 _assignSearchFilters ($request, &$templateMgr, $searchFilters)
 
 authorize ($request, &$args, $roleAssignments)
 
 authors ($args, $request)
 
 index ($args, $request)
 
 search ($args, $request)
 
 setupTemplate ($request)
 
 similarDocuments ($args, &$request)
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 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)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 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())
 
- 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 site index requests.

Definition at line 19 of file SearchHandler.inc.php.

Member Function Documentation

◆ _assignSearchFilters()

SearchHandler::_assignSearchFilters (   $request,
$templateMgr,
  $searchFilters 
)

Private function to transmit current filter values to the template.

Parameters
$requestPKPRequest
$templateMgrTemplateManager
$searchFiltersarray

Definition at line 48 of file SearchHandler.inc.php.

References PKPServices\get().

Referenced by search().

◆ authorize()

SearchHandler::authorize (   $request,
$args,
  $roleAssignments 
)

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.

Parameters
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
Returns
boolean

Reimplemented from PKPHandler.

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

References PKPHandler\addPolicy().

◆ authors()

SearchHandler::authors (   $args,
  $request 
)

Show index of published submissions by author.

Parameters
$argsarray
$requestPKPRequest

Definition at line 187 of file SearchHandler.inc.php.

References PKPServices\get(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), PKPHandler\getRangeInfo(), setupTemplate(), and PKPHandler\validate().

◆ index()

SearchHandler::index (   $args,
  $request 
)

Show the search form

Parameters
$argsarray
$requestPKPRequest

Reimplemented from PKPHandler.

Definition at line 36 of file SearchHandler.inc.php.

References search(), and PKPHandler\validate().

◆ search()

SearchHandler::search (   $args,
  $request 
)

Show the search form

Parameters
$argsarray
$requestPKPRequest

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

References _assignSearchFilters(), PKPTemplateManager\getManager(), PKPHandler\getRangeInfo(), setupTemplate(), and PKPHandler\validate().

Referenced by index().

◆ setupTemplate()

SearchHandler::setupTemplate (   $request)

Setup common template variables.

Parameters
$requestPKPRequest

Reimplemented from PKPHandler.

Definition at line 301 of file SearchHandler.inc.php.

References PKPTemplateManager\getManager().

Referenced by authors(), and search().

◆ similarDocuments()

SearchHandler::similarDocuments (   $args,
$request 
)

Redirect to a search query that shows documents similar to the one identified by an article id in the request.

Parameters
$argsarray
$requestRequest

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

References PKPHandler\validate().


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