ChapterGridHandler Class Reference

Handle chapter grid requests. More...

List of all members.

Public Member Functions
&	_getChapterFromRequest (&$request)
	addChapter ($args, &$request)
	authorize (&$request, $args, $roleAssignments)
	ChapterGridHandler ()
	deleteChapter ($args, &$request)
	editChapter ($args, &$request)
	getCategoryData (&$chapter)
	getCategoryDataElementSequence ($chapter)
	getCategoryRowIdParameterName ()
&	getCategoryRowInstance ()
&	getMonograph ()
	getReadOnly ()
	getRequestArgs ()
	getRowDataElementSequence ($author)
	initFeatures ($request, $args)
	initialize (&$request)
&	loadData (&$request, $filter)
	saveCategoryDataElementSequence ($chapter, $newSequence)
	saveRowDataElementSequence ($author, $chapterId, $newSequence)
	setReadOnly ($readOnly)
	updateChapter ($args, &$request)

---

Detailed Description

Handle chapter grid requests.

Definition at line 26 of file ChapterGridHandler.inc.php.

---

Member Function Documentation

& ChapterGridHandler._getChapterFromRequest

(

&$

request

)

Fetch and validate the chapter from the request arguments

Definition at line 362 of file ChapterGridHandler.inc.php.

References getMonograph().

Referenced by deleteChapter(), editChapter(), and updateChapter().

ChapterGridHandler.addChapter	(	$	args,
		&$	request
	)

Add a chapter.

Parameters:

	$args	array
	$request	Request

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

References editChapter().

ChapterGridHandler.authorize	(	&$	request,
		$	args,
		$	roleAssignments
	)

See also:

PKPHandler.authorize()

Parameters:

	$request	PKPRequest
	$args	array
	$roleAssignments	array

Definition at line 84 of file ChapterGridHandler.inc.php.

ChapterGridHandler.ChapterGridHandler

(

)

Constructor

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

ChapterGridHandler.deleteChapter	(	$	args,
		&$	request
	)

Delete a chapter

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 335 of file ChapterGridHandler.inc.php.

References _getChapterFromRequest().

ChapterGridHandler.editChapter	(	$	args,
		&$	request
	)

Edit a chapter

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 286 of file ChapterGridHandler.inc.php.

References _getChapterFromRequest(), and getMonograph().

Referenced by addChapter().

ChapterGridHandler.getCategoryData

(

&$

chapter

)

See also:

CategoryGridHandler.getCategoryData()

Definition at line 243 of file ChapterGridHandler.inc.php.

ChapterGridHandler.getCategoryDataElementSequence

(

$

chapter

)

See also:

CategoryGridHandler.getCategoryDataElementSequence()

Definition at line 252 of file ChapterGridHandler.inc.php.

ChapterGridHandler.getCategoryRowIdParameterName

(

)

See also:

CategoryGridHandler.getCategoryRowIdParameterName()

Definition at line 184 of file ChapterGridHandler.inc.php.

& ChapterGridHandler.getCategoryRowInstance

(

)

See also:

CategoryGridHandler.getCategoryRowInstance()

Definition at line 232 of file ChapterGridHandler.inc.php.

References getMonograph(), and getReadOnly().

& ChapterGridHandler.getMonograph

(

)

Get the monograph associated with this chapter grid.

Returns:

Monograph

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

Referenced by _getChapterFromRequest(), editChapter(), getCategoryRowInstance(), getRequestArgs(), initFeatures(), loadData(), saveRowDataElementSequence(), and updateChapter().

ChapterGridHandler.getReadOnly

(

)

Get whether or not this grid should be 'read only'

Returns:

boolean

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

Referenced by getCategoryRowInstance(), and initialize().

ChapterGridHandler.getRequestArgs

(

)

See also:

GridDataProvider.getRequestArgs()

Definition at line 173 of file ChapterGridHandler.inc.php.

References getMonograph().

Referenced by initialize().

ChapterGridHandler.getRowDataElementSequence

(

$

author

)

See also:

GridHandler.getRowDataElementSequence()

Definition at line 206 of file ChapterGridHandler.inc.php.

ChapterGridHandler.initFeatures	(	$	request,
		$	args
	)

See also:

GridHandler.initFeatures()

Definition at line 157 of file ChapterGridHandler.inc.php.

References getMonograph(), and setReadOnly().

ChapterGridHandler.initialize

(

&$

request

)

Configure the grid

Parameters:

$request

PKPRequest

Definition at line 94 of file ChapterGridHandler.inc.php.

References getReadOnly(), and getRequestArgs().

& ChapterGridHandler.loadData	(	&$	request,
		$	filter
	)

See also:

GridHandler.loadData

Definition at line 192 of file ChapterGridHandler.inc.php.

References getMonograph().

ChapterGridHandler.saveCategoryDataElementSequence	(	$	chapter,
		$	newSequence
	)

See also:

CategoryGridHandler.saveCategoryDataElementSequence()

Definition at line 259 of file ChapterGridHandler.inc.php.

ChapterGridHandler.saveRowDataElementSequence	(	$	author,
		$	chapterId,
		$	newSequence
	)

See also:

CategoryGridHandler.saveRowDataElementSequence()

Definition at line 213 of file ChapterGridHandler.inc.php.

References getMonograph().

ChapterGridHandler.setReadOnly

(

$

readOnly

)

Set the boolean for 'read only' status

Parameters:

boolean

Definition at line 70 of file ChapterGridHandler.inc.php.

Referenced by initFeatures().

ChapterGridHandler.updateChapter	(	$	args,
		&$	request
	)

Update a chapter

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 304 of file ChapterGridHandler.inc.php.

References _getChapterFromRequest(), and getMonograph().

---

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

• controllers/grid/users/chapter/ChapterGridHandler.inc.php