MarketForm Class Reference

Inheritance diagram for MarketForm:

Public Member Functions
	__construct ($submission, $publication, $market)
	execute (... $functionArgs)
	fetch ($request, $template=null, $display=false)
	getMarket ()
	getPublication ()
	getSubmission ()
	initData ()
	readInputData ()
	setMarket ($market)
	setPublication ($publication)
	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
	$_market
	$_submission
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for adding/editing a market region entry.

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

Constructor & Destructor Documentation

__construct()

MarketForm::__construct	(		$submission,
			$publication,
			$market
	)

Constructor.

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

References Form\addCheck(), setMarket(), setPublication(), and setSubmission().

Member Function Documentation

execute()

MarketForm::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 227 of file MarketForm.inc.php.

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

fetch()

MarketForm::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 123 of file MarketForm.inc.php.

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

getMarket()

MarketForm::getMarket

(

)

Get the entry

Returns

Market

Definition at line 49 of file MarketForm.inc.php.

References $_market.

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

getPublication()

MarketForm::getPublication

(

)

Get the Publication

Returns

Publication

Definition at line 81 of file MarketForm.inc.php.

Referenced by execute(), and fetch().

getSubmission()

MarketForm::getSubmission

(

)

Get the Submission

Returns

Submission

Definition at line 65 of file MarketForm.inc.php.

References $_submission.

Referenced by execute(), and fetch().

initData()

MarketForm::initData

(

)

Initialize form data from the market entry.

Reimplemented from Form.

Definition at line 100 of file MarketForm.inc.php.

References getMarket().

readInputData()

MarketForm::readInputData

(

)

Assign form data to user-submitted data.

See also

Form::readInputData()

Reimplemented from Form.

Definition at line 202 of file MarketForm.inc.php.

References Form\readUserVars().

setMarket()

MarketForm::setMarket

(

$market

)

Set the entry

Parameters

Definition at line 57 of file MarketForm.inc.php.

Referenced by __construct().

setPublication()

MarketForm::setPublication

(

$publication

)

Set the Publication

Parameters

Publication

Definition at line 89 of file MarketForm.inc.php.

Referenced by __construct().

setSubmission()

MarketForm::setSubmission

(

$submission

)

Set the Submission

Parameters

Submission

Definition at line 73 of file MarketForm.inc.php.

Referenced by __construct().

Field Documentation

$_market

MarketForm::$_market

Market the entry being edited

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

Referenced by getMarket().

$_submission

MarketForm::$_submission

The submission associated with the format being edited

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

Referenced by getSubmission().

---

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

• MarketForm.inc.php