CatalogEntryCatalogMetadataForm Class Reference

Displays a submission's catalog metadata entry form. More...

List of all members.

Public Member Functions
	_buildSurrogateImage (&$cover, $basePath, $type)
	CatalogEntryCatalogMetadataForm ($monographId, $userId, $stageId=null, $formParams=null)
	execute (&$request)
	fetch (&$request)
	getFormParams ()
&	getMonograph ()
&	getPublishedMonograph ()
	getStageId ()
	readInputData ()
	validate ()
Public Attributes
	$_formParams

---

Detailed Description

Displays a submission's catalog metadata entry form.

Definition at line 31 of file CatalogEntryCatalogMetadataForm.inc.php.

---

Member Function Documentation

CatalogEntryCatalogMetadataForm._buildSurrogateImage	(	&$	cover,
		$	basePath,
		$	type
	)

Generates a surrogate image used either as a thumbnail or in the catalog.

Parameters:

	resource	$cover the cover image uploaded.
	string	$basePath base file path.
	int	$type the type of image to create.

Returns:

array the details for the image (dimensions, file name, etc).

Definition at line 293 of file CatalogEntryCatalogMetadataForm.inc.php.

Referenced by execute().

CatalogEntryCatalogMetadataForm.CatalogEntryCatalogMetadataForm	(	$	monographId,
		$	userId,
		$	stageId = null,
		$	formParams = null
	)

Constructor.

Parameters:

	$monographId	integer
	$userId	integer
	$stageId	integer
	$formParams	array

Definition at line 63 of file CatalogEntryCatalogMetadataForm.inc.php.

CatalogEntryCatalogMetadataForm.execute

(

&$

request

)

Save the metadata and store the catalog data for this published monograph.

Definition at line 199 of file CatalogEntryCatalogMetadataForm.inc.php.

References _buildSurrogateImage(), and getMonograph().

CatalogEntryCatalogMetadataForm.fetch

(

&$

request

)

Fetch the HTML contents of the form.

Parameters:

$request

PKPRequest return string

Definition at line 78 of file CatalogEntryCatalogMetadataForm.inc.php.

References getFormParams(), getMonograph(), getPublishedMonograph(), and getStageId().

CatalogEntryCatalogMetadataForm.getFormParams

(

)

Get the extra form parameters.

Definition at line 156 of file CatalogEntryCatalogMetadataForm.inc.php.

Referenced by fetch().

& CatalogEntryCatalogMetadataForm.getMonograph

(

)

Get the Monograph

Returns:

Monograph

Definition at line 133 of file CatalogEntryCatalogMetadataForm.inc.php.

Referenced by execute(), and fetch().

& CatalogEntryCatalogMetadataForm.getPublishedMonograph

(

)

Get the PublishedMonograph

Returns:

PublishedMonograph

Definition at line 141 of file CatalogEntryCatalogMetadataForm.inc.php.

Referenced by fetch().

CatalogEntryCatalogMetadataForm.getStageId

(

)

Get the stage id

Returns:

int

Definition at line 149 of file CatalogEntryCatalogMetadataForm.inc.php.

Referenced by fetch().

CatalogEntryCatalogMetadataForm.readInputData

(

)

Assign form data to user-submitted data.

Definition at line 163 of file CatalogEntryCatalogMetadataForm.inc.php.

CatalogEntryCatalogMetadataForm.validate

(

)

Validate the form.

Returns:

boolean

Definition at line 176 of file CatalogEntryCatalogMetadataForm.inc.php.

---

Member Data Documentation

CatalogEntryCatalogMetadataForm.$_formParams

Parameters to configure the form template.

Definition at line 54 of file CatalogEntryCatalogMetadataForm.inc.php.

---

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

• controllers/tab/catalogEntry/form/CatalogEntryCatalogMetadataForm.inc.php