Open Monograph Press  3.3.0
PublicationFormatGridHandler Class Reference
Inheritance diagram for PublicationFormatGridHandler:
CategoryGridHandler GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 addFormat ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 clearPubId ($args, $request)
 
 deleteFormat ($args, $request)
 
 dependentFiles ($args, $request)
 
 editApprovedProof ($args, $request)
 
 editFormat ($args, $request)
 
 editFormatMetadata ($args, $request)
 
 editFormatTab ($args, $request)
 
 getAssignPublicIdentifiersFormTemplate ()
 
 getCategoryRowInstance ()
 
 getPublication ()
 
 getRequestArgs ()
 
 getRowInstance ()
 
 getSubmission ()
 
 identifiers ($args, $request)
 
 initialize ($request, $args=null)
 
 saveApprovedProof ($args, $request)
 
 selectFiles ($args, $request)
 
 setApproved ($args, $request)
 
 setAvailable ($args, $request)
 
 setProofFileCompletion ($args, $request)
 
 setPublication ($publication)
 
 setSubmission ($submission)
 
 updateFormat ($args, $request)
 
 updateFormatMetadata ($args, $request)
 
 updateIdentifiers ($args, $request)
 
- Public Member Functions inherited from CategoryGridHandler
 __construct ($dataProvider=null)
 
 fetchCategory ($args, $request)
 
 getCategoryItemsCount ($categoryElement, $request)
 
 getCurrentCategoryId ()
 
 getDataElementInCategorySequence ($categoryId, &$gridDataElement)
 
 getEmptyCategoryRowText ()
 
getGridCategoryDataElements ($request, $categoryElement)
 
 getJSHandler ()
 
 hasGridDataElementsInCategory ($categoryElement, $request)
 
 isDataElementInCategorySelected ($categoryId, &$gridDataElement)
 
 setDataElementInCategorySequence ($categoryId, &$gridDataElement, $newSequence)
 
 setEmptyCategoryRowText ($translationKey)
 
 setGridCategoryDataElements ($request, $categoryElementId, $data)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from GridHandler
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 fetchCell (&$args, $request)
 
 fetchGrid ($args, $request)
 
 fetchRow ($args, $request)
 
 fetchRows ($args, $request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
 getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag=null)
 
 getDataElementSequence ($gridDataElement)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 setEmptyRowText ($emptyRowText)
 
 setFootNote ($footNote)
 
 setGridDataElements ($data)
 
 setTemplate ($template)
 
 setTitle ($title)
 
- Public Member Functions inherited from PKPHandler
 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)
 
 index ($args, $request)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Data Fields

 $_cellProvider
 
 $_publication
 
 $_submission
 
- Data Fields inherited from CategoryGridHandler
 $_categoryData
 
 $_currentCategoryId = null
 
 $_emptyCategoryRowText = 'grid.noItems'
 
- Data Fields inherited from GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_columns = array()
 
 $_constants = []
 
 $_data
 
 $_dataProvider
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 

Protected Attributes

 $_canManage
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = 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())
 
- Protected Member Functions inherited from CategoryGridHandler
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
 getCategoryRowIdParameterName ()
 
 getRequestedCategoryRow ($request, $args)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 loadCategoryData ($request, &$categoryDataElement, $filter=null)
 
 renderRowInternally ($request, $row)
 
 setFirstDataColumn ()
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 initFeatures ($request, $args)
 
 isFilterFormCollapsible ()
 
 loadData ($request, $filter)
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderGridBodyPartsInternally ($request)
 
 renderRowsInternally ($request, &$elements)
 

Detailed Description

Handle publication format grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

PublicationFormatGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 55 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addFormat()

PublicationFormatGridHandler::addFormat (   $args,
  $request 
)

Add a new publication format

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 522 of file PublicationFormatGridHandler.inc.php.

References editFormat().

◆ authorize()

PublicationFormatGridHandler::authorize (   $request,
$args,
  $roleAssignments 
)
See also
PKPHandler::authorize()
Parameters
$requestPKPRequest
$argsarray
$roleAssignmentsarray

Reimplemented from GridHandler.

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

References PKPHandler\addPolicy().

◆ clearPubId()

PublicationFormatGridHandler::clearPubId (   $args,
  $request 
)

Clear pub id

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 666 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ deleteFormat()

PublicationFormatGridHandler::deleteFormat (   $args,
  $request 
)

Delete a format

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 320 of file PublicationFormatGridHandler.inc.php.

References PKPServices\get(), DAO\getDataChangedEvent(), Application\getRepresentationDAO(), and getSubmission().

◆ dependentFiles()

PublicationFormatGridHandler::dependentFiles (   $args,
  $request 
)

Show dependent files for a monograph file.

Parameters
$argsarray
$requestPKPRequest

Definition at line 682 of file PublicationFormatGridHandler.inc.php.

References DAORegistry\getDAO(), PKPHandler\getId(), PKPTemplateManager\getManager(), and getSubmission().

◆ editApprovedProof()

PublicationFormatGridHandler::editApprovedProof (   $args,
  $request 
)

Edit an approved proof.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 449 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), getSubmission(), and initialize().

◆ editFormat()

PublicationFormatGridHandler::editFormat (   $args,
  $request 
)

Edit a publication format modal

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 242 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getId(), PKPTemplateManager\getManager(), PluginRegistry\getPlugins(), getPublication(), Application\getRepresentationDAO(), and getSubmission().

Referenced by addFormat().

◆ editFormatMetadata()

PublicationFormatGridHandler::editFormatMetadata (   $args,
  $request 
)

Load a form to edit a format's metadata

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 595 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), getPublication(), and getSubmission().

◆ editFormatTab()

PublicationFormatGridHandler::editFormatTab (   $args,
  $request 
)

Edit a format

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 277 of file PublicationFormatGridHandler.inc.php.

References getPublication(), Application\getRepresentationDAO(), and getSubmission().

◆ getAssignPublicIdentifiersFormTemplate()

PublicationFormatGridHandler::getAssignPublicIdentifiersFormTemplate ( )

Get the filename of the "assign public identifiers" form template.

Returns
string

Definition at line 486 of file PublicationFormatGridHandler.inc.php.

Referenced by setApproved(), and setProofFileCompletion().

◆ getCategoryRowInstance()

PublicationFormatGridHandler::getCategoryRowInstance ( )

◆ getPublication()

PublicationFormatGridHandler::getPublication ( )

Get the publication associated with this publication format grid.

Returns
Publication

Definition at line 104 of file PublicationFormatGridHandler.inc.php.

References $_publication.

Referenced by editFormat(), editFormatMetadata(), editFormatTab(), getCategoryRowInstance(), getRequestArgs(), initialize(), selectFiles(), updateFormat(), and updateFormatMetadata().

◆ getRequestArgs()

PublicationFormatGridHandler::getRequestArgs ( )

Get the arguments that will identify the data in the grid In this case, the submission.

Returns
array

Reimplemented from CategoryGridHandler.

Definition at line 505 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getId(), getPublication(), and getSubmission().

Referenced by initialize().

◆ getRowInstance()

PublicationFormatGridHandler::getRowInstance ( )

Get a new instance of a grid row. May be overridden by subclasses if they want to provide a custom row definition.

Returns
GridRow

Reimplemented from GridHandler.

Definition at line 496 of file PublicationFormatGridHandler.inc.php.

◆ getSubmission()

◆ identifiers()

PublicationFormatGridHandler::identifiers (   $args,
  $request 
)

Edit pub ids

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 631 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ initialize()

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

◆ saveApprovedProof()

PublicationFormatGridHandler::saveApprovedProof (   $args,
  $request 
)

Save an approved proof.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 467 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAO\getDataChangedEvent(), and getSubmission().

◆ selectFiles()

PublicationFormatGridHandler::selectFiles (   $args,
  $request 
)

Show the form to allow the user to select files from previous stages

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 580 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), PKPHandler\getId(), getPublication(), and getSubmission().

◆ setApproved()

PublicationFormatGridHandler::setApproved (   $args,
  $request 
)

◆ setAvailable()

PublicationFormatGridHandler::setAvailable (   $args,
  $request 
)

Set a format's "available" state

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 407 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), getSubmission(), and SubmissionLog\logEvent().

◆ setProofFileCompletion()

PublicationFormatGridHandler::setProofFileCompletion (   $args,
  $request 
)

Set the approval status for a file.

Parameters
$argsarray
$requestPKPRequest

Definition at line 531 of file PublicationFormatGridHandler.inc.php.

References getAssignPublicIdentifiersFormTemplate(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), getSubmission(), and SubmissionFileLog\logEvent().

◆ setPublication()

PublicationFormatGridHandler::setPublication (   $publication)

Set the publication

Parameters
$publicationPublication

Definition at line 112 of file PublicationFormatGridHandler.inc.php.

Referenced by initialize().

◆ setSubmission()

PublicationFormatGridHandler::setSubmission (   $submission)

Set the submission

Parameters
$submissionSubmission

Definition at line 96 of file PublicationFormatGridHandler.inc.php.

Referenced by initialize().

◆ updateFormat()

PublicationFormatGridHandler::updateFormat (   $args,
  $request 
)

Update a format

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 297 of file PublicationFormatGridHandler.inc.php.

References DAO\getDataChangedEvent(), getPublication(), Application\getRepresentationDAO(), and getSubmission().

◆ updateFormatMetadata()

PublicationFormatGridHandler::updateFormatMetadata (   $args,
  $request 
)

Save a form to edit format's metadata

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 611 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAO\getDataChangedEvent(), getPublication(), and getSubmission().

◆ updateIdentifiers()

PublicationFormatGridHandler::updateIdentifiers (   $args,
  $request 
)

Update pub ids

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 646 of file PublicationFormatGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().

Field Documentation

◆ $_canManage

boolean PublicationFormatGridHandler::$_canManage
protected

Definition at line 50 of file PublicationFormatGridHandler.inc.php.

◆ $_cellProvider

PublicationFormatGridCellProvider PublicationFormatGridHandler::$_cellProvider

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

◆ $_publication

Publication PublicationFormatGridHandler::$_publication

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

Referenced by getPublication().

◆ $_submission

Submission PublicationFormatGridHandler::$_submission

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

Referenced by getSubmission().


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