SeriesForm Class Reference

Form for adding/edditing a series stores/retrieves from an associative array. More...

List of all members.

Public Member Functions
	deleteCategoryEntry (&$request, $rowId)
	deleteSeriesEditorEntry (&$request, $rowId)
	execute ($args, &$request)
	fetch (&$request)
	getSeriesId ()
	initData ($args, &$request)
	insertCategoryEntry (&$request, $newRowId)
	insertSeriesEditorEntry (&$request, $newRowId)
	readInputData ()
	SeriesForm ($seriesId=null)
	setSeriesId ($seriesId)
	updateCategoryEntry (&$request, $rowId, $newRowId)
	updateSeriesEditorEntry (&$request, $rowId, $newRowId)
	validate ()
Public Attributes
	$_seriesId

---

Detailed Description

Form for adding/edditing a series stores/retrieves from an associative array.

Definition at line 21 of file SeriesForm.inc.php.

---

Member Function Documentation

SeriesForm.deleteCategoryEntry	(	&$	request,
		$	rowId
	)

Delete a category association with this series.

See also:

ListbuilderHandler.deleteEntry

Parameters:

	$request	PKPRequest
	$rowId	int

Definition at line 345 of file SeriesForm.inc.php.

References getSeriesId().

Referenced by updateCategoryEntry().

SeriesForm.deleteSeriesEditorEntry	(	&$	request,
		$	rowId
	)

Delete a series editor association with this series.

See also:

ListbuilderHandler.deleteEntry

Parameters:

	$request	PKPRequest
	$rowId	int

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

References getSeriesId().

Referenced by updateSeriesEditorEntry().

SeriesForm.execute	(	$	args,
		&$	request
	)

Save series.

Parameters:

	$args	array
	$request	PKPRequest

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

References getSeriesId(), and setSeriesId().

SeriesForm.fetch

(

&$

request

)

Fetch

Parameters:

$request

PKPRequest

See also:

Form.fetch()

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

References getSeriesId().

SeriesForm.getSeriesId

(

)

Get the series ID for this series.

Returns:

int

Definition at line 258 of file SeriesForm.inc.php.

Referenced by deleteCategoryEntry(), deleteSeriesEditorEntry(), execute(), fetch(), initData(), insertCategoryEntry(), and insertSeriesEditorEntry().

SeriesForm.initData	(	$	args,
		&$	request
	)

Initialize form data from current settings.

Parameters:

	$args	array
	$request	PKPRequest

Definition at line 56 of file SeriesForm.inc.php.

References getSeriesId().

SeriesForm.insertCategoryEntry	(	&$	request,
		$	newRowId
	)

Persist a category association

See also:

ListbuilderHandler.insertEntry

Definition at line 322 of file SeriesForm.inc.php.

References getSeriesId().

Referenced by updateCategoryEntry().

SeriesForm.insertSeriesEditorEntry	(	&$	request,
		$	newRowId
	)

Persist a series editor association

See also:

ListbuilderHandler.insertEntry

Definition at line 274 of file SeriesForm.inc.php.

References getSeriesId().

Referenced by updateSeriesEditorEntry().

SeriesForm.readInputData

(

)

Assign form data to user-submitted data.

See also:

Form.readInputData()

Definition at line 124 of file SeriesForm.inc.php.

SeriesForm.SeriesForm

(

$

seriesId = null

)

Constructor.

Definition at line 37 of file SeriesForm.inc.php.

References setSeriesId().

SeriesForm.setSeriesId

(

$

seriesId

)

Set the series ID for this series.

Parameters:

$seriesId

int

Definition at line 266 of file SeriesForm.inc.php.

Referenced by execute(), and SeriesForm().

SeriesForm.updateCategoryEntry	(	&$	request,
		$	rowId,
		$	newRowId
	)

Update a category association with this series.

See also:

ListbuilderHandler.updateEntry

Parameters:

	$request	PKPRequest
	$rowId	int old category
	$newRowId	array new category

Definition at line 360 of file SeriesForm.inc.php.

References deleteCategoryEntry(), and insertCategoryEntry().

SeriesForm.updateSeriesEditorEntry	(	&$	request,
		$	rowId,
		$	newRowId
	)

Update a series editor association with this series.

See also:

ListbuilderHandler.deleteEntry

Parameters:

	$request	PKPRequest
	$rowId	int the old series editor
	$newRowId	array the new series editor

Definition at line 312 of file SeriesForm.inc.php.

References deleteSeriesEditorEntry(), and insertSeriesEditorEntry().

SeriesForm.validate

(

)

See also:

Form.validate()

Definition at line 82 of file SeriesForm.inc.php.

---

Member Data Documentation

SeriesForm.$_seriesId

the id for the series being edited

Definition at line 23 of file SeriesForm.inc.php.

---

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

• controllers/grid/settings/series/form/SeriesForm.inc.php