PHP Class QueryForm, pkp-lib

Inheritance: extends Form
Show file Open project: pkp/pkp-lib Class Usage Examples

Public Properties

Property Type Description
$_assocId Assoc ID (per _assocType)
$_assocType ASSOC_TYPE_...
$_isNew True iff this is a newly-created query
$_query The query being edited *
$_stageId The stage id associated with the query being edited *

Public Methods

Method Description
__construct ( $request, $assocType, $assocId, $stageId, $queryId = null ) Constructor.
deleteEntry ( $request, $rowId )
execute ( $request )
fetch ( $request, $actionArgs = [] ) Fetch the form.
getAssocId ( ) : integer Get assoc id
getAssocType ( ) : integer Get assoc type
getQuery ( ) : Query Get the query
getStageId ( ) : integer Get the stage id
initData ( ) Initialize form data from the associated author.
insertEntry ( $request, $newRowId )
readInputData ( ) Assign form data to user-submitted data.
setAssocId ( $assocId ) Set assoc id
setAssocType ( $assocType ) Set assoc type
setQuery ( $query ) Set the query
setStageId ( $stageId ) Set the stage id
updateEntry ( $request, $rowId, $newRowId )

Method Details

__construct() public method

Constructor.
public __construct ( $request, $assocType, $assocId, $stageId, $queryId = null )
$request Request
$assocType int ASSOC_TYPE_...
$assocId int Assoc ID (per assocType)
$stageId int WORKFLOW_STAGE_...
$queryId int Optional query ID to edit. If none provided, a (potentially temporary) query will be created.

deleteEntry() public method

public deleteEntry ( $request, $rowId )

execute() public method

public execute ( $request )
$request PKPRequest

fetch() public method

Fetch the form.
See also: Form::fetch()
public fetch ( $request, $actionArgs = [] )
$request PKPRequest
$actionArgs array Optional list of additional arguments

getAssocId() public method

Get assoc id
public getAssocId ( ) : integer
return integer

getAssocType() public method

Get assoc type
public getAssocType ( ) : integer
return integer ASSOC_TYPE_...

getQuery() public method

Get the query
public getQuery ( ) : Query
return Query

getStageId() public method

Get the stage id
public getStageId ( ) : integer
return integer

initData() public method

Initialize form data from the associated author.
public initData ( )

insertEntry() public method

public insertEntry ( $request, $newRowId )

readInputData() public method

Assign form data to user-submitted data.
See also: Form::readInputData()
public readInputData ( )

setAssocId() public method

Set assoc id
public setAssocId ( $assocId )
$assocId int

setAssocType() public method

Set assoc type
public setAssocType ( $assocType )
$assocType int ASSOC_TYPE_...

setQuery() public method

Set the query
public setQuery ( $query )

setStageId() public method

Set the stage id
public setStageId ( $stageId )

updateEntry() public method

public updateEntry ( $request, $rowId, $newRowId )

Property Details

$_assocId public property

Assoc ID (per _assocType)
public $_assocId

$_assocType public property

ASSOC_TYPE_...
public $_assocType

$_isNew public property

True iff this is a newly-created query
public $_isNew

$_query public property

The query being edited *
public $_query

$_stageId public property

The stage id associated with the query being edited *
public $_stageId