SalesRightsForm Class Reference

Inheritance diagram for SalesRightsForm:

Public Member Functions
	__construct ($submission, $publication, $salesRights)
	execute (... $functionArgs)
	fetch ($request, $template=null, $display=false)
	getPublication ()
	getSalesRights ()
	getSubmission ()
	initData ()
	readInputData ()
	setPublication ($publication)
	setSalesRights ($salesRights)
	setSubmission ($submission)
Public Member Functions inherited from Form
	__construct ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
	_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 ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_salesRights
	$_submission
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for adding/editing a sales rights entry.

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

Constructor & Destructor Documentation

__construct()

SalesRightsForm::__construct	(		$submission,
			$publication,
			$salesRights
	)

Constructor.

Definition at line 28 of file SalesRightsForm.inc.php.

References Form\addCheck(), DAORegistry\getDAO(), setPublication(), setSalesRights(), and setSubmission().

Member Function Documentation

execute()

SalesRightsForm::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.

Reimplemented from Form.

Definition at line 193 of file SalesRightsForm.inc.php.

References fatalError(), DAORegistry\getDAO(), Form\getData(), getPublication(), getSalesRights(), and getSubmission().

fetch()

SalesRightsForm::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 129 of file SalesRightsForm.inc.php.

References fatalError(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), getPublication(), getSalesRights(), and getSubmission().

getPublication()

SalesRightsForm::getPublication

(

)

Get the Publication

Returns

Publication

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

Referenced by execute(), and fetch().

getSalesRights()

SalesRightsForm::getSalesRights

(

)

Get the entry

Returns

SalesRights

Definition at line 59 of file SalesRightsForm.inc.php.

References $_salesRights.

Referenced by execute(), fetch(), and initData().

getSubmission()

SalesRightsForm::getSubmission

(

)

Get the Submission

Returns

Submission

Definition at line 75 of file SalesRightsForm.inc.php.

References $_submission.

Referenced by execute(), and fetch().

initData()

SalesRightsForm::initData

(

)

Initialize form data from the sales rights entry.

Reimplemented from Form.

Definition at line 110 of file SalesRightsForm.inc.php.

References getSalesRights().

readInputData()

SalesRightsForm::readInputData

(

)

Assign form data to user-submitted data.

See also

Form::readInputData()

Reimplemented from Form.

Definition at line 177 of file SalesRightsForm.inc.php.

References Form\readUserVars().

setPublication()

SalesRightsForm::setPublication

(

$publication

)

Set the Publication

Parameters

Publication

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

Referenced by __construct().

setSalesRights()

SalesRightsForm::setSalesRights

(

$salesRights

)

Set the entry

Parameters

Definition at line 67 of file SalesRightsForm.inc.php.

Referenced by __construct().

setSubmission()

SalesRightsForm::setSubmission

(

$submission

)

Set the Submission

Parameters

Submission

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

Referenced by __construct().

Field Documentation

$_salesRights

SalesRightsForm::$_salesRights

Sales Rights the entry being edited

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

Referenced by getSalesRights().

$_submission

SalesRightsForm::$_submission

The submission associated with the format being edited

Definition at line 20 of file SalesRightsForm.inc.php.

Referenced by getSubmission().

---

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

• SalesRightsForm.inc.php