QueryNoteForm Class Reference

Inheritance diagram for QueryNoteForm:

Public Member Functions
	__construct ($actionArgs, $query, $user, $noteId=null)
	execute (... $functionArgs)
	fetch ($request, $template=null, $display=false)
	getQuery ()
	readInputData ()
	setQuery ($query)
Public Member Functions inherited from Form
	_decomposeArray ($name, $value, $stack)
	addCheck ($formValidator)
	addError ($field, $message)
	addErrorField ($field)
	addSupportedFormLocale ($supportedLocale)
	display ($request=null, $template=null)
	getData ($key)
	getDefaultFormLocale ()
	getErrorsArray ()
	getLocaleFieldNames ()
	getRequiredLocale ()
	getTemplate ()
	initData ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_actionArgs
	$_isNew
	$_noteId
	$_query
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for adding/editing a new query note.

Definition at line 18 of file QueryNoteForm.inc.php.

Constructor & Destructor Documentation

__construct()

QueryNoteForm::__construct	(		$actionArgs,
			$query,
			$user,
			$noteId = null
	)

Constructor.

Parameters

$actionArgs	array Action arguments
$query	Query
$user	User The current user ID
$noteId	int The note ID to edit, or null for new.

Reimplemented from Form.

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

References Form\addCheck(), Core\getCurrentDate(), DAORegistry\getDAO(), and setQuery().

Member Function Documentation

execute()

QueryNoteForm::execute

(

$functionArgs

)

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters

mixed

$functionArgs,...

Arguments from the caller to be passed to the hook consumer

Returns

mixed Result from the consumer to be passed to the caller. Send a true-ish result if you want the caller to do something with the return value.

Note The created note object.

Reimplemented from Form.

Definition at line 122 of file QueryNoteForm.inc.php.

References PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), and getQuery().

fetch()

QueryNoteForm::fetch	(		$request,
			$template = null,
			$display = false
	)

Returns a string of the rendered form

Parameters

$request	PKPRequest
$template	string the template to be rendered, mandatory if no template has been specified on class instantiation.
$display	boolean

Returns

string the rendered form

Reimplemented from Form.

Definition at line 108 of file QueryNoteForm.inc.php.

References PKPTemplateManager\getManager().

getQuery()

QueryNoteForm::getQuery

(

)

Get the query

Returns

Query

Definition at line 83 of file QueryNoteForm.inc.php.

References $_query.

Referenced by execute().

readInputData()

QueryNoteForm::readInputData

(

)

Assign form data to user-submitted data.

See also

Form::readInputData()

Reimplemented from Form.

Definition at line 99 of file QueryNoteForm.inc.php.

References Form\readUserVars().

setQuery()

QueryNoteForm::setQuery

(

$query

)

Set the query

Parameters

Definition at line 91 of file QueryNoteForm.inc.php.

Referenced by __construct().

Field Documentation

$_actionArgs

array QueryNoteForm::$_actionArgs

Action arguments

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

$_isNew

boolean QueryNoteForm::$_isNew

Whether or not this is a new note

Definition at line 41 of file QueryNoteForm.inc.php.

$_noteId

int QueryNoteForm::$_noteId

Note ID

Definition at line 35 of file QueryNoteForm.inc.php.

$_query

Query QueryNoteForm::$_query

Definition at line 29 of file QueryNoteForm.inc.php.

Referenced by getQuery().

---

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

• QueryNoteForm.inc.php