Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PublicationEntryHandler Class Reference
Inheritance diagram for PublicationEntryHandler:
Handler PKPHandler CatalogEntryHandler

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 fetch ($args, $request)
 
 fetchFormatInfo ($args, $request)
 
 getStageId ()
 
getSubmission ()
 
 getTabPosition ()
 
 initialize ($request, $args=null)
 
 PublicationEntryHandler ()
 
- Public Member Functions inherited from Handler
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, $bestGuess=true)
 
 getWorkingContexts ($request)
 
 Handler ()
 
- 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

 $_stageId
 
 $_submission
 
 $_tabPosition
 
- 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())
 

Detailed Description

Base handler to generate the tab structure for a submission's publication metadata.

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

Member Function Documentation

PublicationEntryHandler::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.
$enforceRestrictedSiteboolean True iff site restrictions are to be enforced
Returns
boolean

Definition at line 62 of file PublicationEntryHandler.inc.php.

References PKPHandler\addPolicy().

PublicationEntryHandler::fetch (   $args,
  $request 
)

Display the tabs index page.

Parameters
$argsarray
$requestPKPRequest

Definition at line 105 of file PublicationEntryHandler.inc.php.

References getStageId(), getSubmission(), getTabPosition(), and PKPHandler\setupTemplate().

PublicationEntryHandler::fetchFormatInfo (   $args,
  $request 
)

Returns a JSON response containing information regarding the formats enabled for this submission.

Parameters
$argsarray
$requestRequest

Definition at line 128 of file PublicationEntryHandler.inc.php.

PublicationEntryHandler::getStageId ( )

Get the stage id

Returns
int

Definition at line 85 of file PublicationEntryHandler.inc.php.

References $_stageId.

Referenced by CatalogEntryHandler\fetch(), and fetch().

& PublicationEntryHandler::getSubmission ( )
PublicationEntryHandler::getTabPosition ( )

Get the current tab position

Returns
int

Definition at line 93 of file PublicationEntryHandler.inc.php.

References $_tabPosition.

Referenced by fetch().

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

Subclasses can override this method to configure the handler.

NB: This method will be called after validation and authorization.

Parameters
$requestPKPRequest
$argsarray

Definition at line 47 of file PublicationEntryHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), AppLocale\requireComponents(), and PKPHandler\setupTemplate().

PublicationEntryHandler::PublicationEntryHandler ( )

Constructor.

Definition at line 33 of file PublicationEntryHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Data Documentation

PublicationEntryHandler::$_stageId

The current stage id

Definition at line 25 of file PublicationEntryHandler.inc.php.

Referenced by getStageId().

PublicationEntryHandler::$_submission

The submission

Definition at line 22 of file PublicationEntryHandler.inc.php.

Referenced by getSubmission().

PublicationEntryHandler::$_tabPosition

the current tab position

Definition at line 28 of file PublicationEntryHandler.inc.php.

Referenced by getTabPosition().


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