PKPSectionForm Class Reference

Inheritance diagram for PKPSectionForm:

Public Member Functions
	__construct ($request, $template, $sectionId=null)
	execute (... $functionArgs)
	fetch ($request, $template=null, $display=false)
	getSectionId ()
	readInputData ()
	setSectionId ($sectionId)
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 ()
	initData ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_imageExtension
	$_sectionId
	$_sizeArray
	$_userId
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for adding/editing a section.

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

Constructor & Destructor Documentation

__construct()

PKPSectionForm::__construct	(		$request,
			$template,
			$sectionId = null
	)

Constructor.

Parameters

$request	PKPRequest
$template	string Template path
$sectionId	int optional

Definition at line 46 of file PKPSectionForm.inc.php.

References Form\addCheck(), AppLocale\requireComponents(), and setSectionId().

Member Function Documentation

execute()

PKPSectionForm::execute

(

$functionArgs

)

Save changes to subeditors

Parameters

$contextId

int

Reimplemented from Form.

Reimplemented in SectionForm.

Definition at line 112 of file PKPSectionForm.inc.php.

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

fetch()

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

Reimplemented in SectionForm.

Definition at line 87 of file PKPSectionForm.inc.php.

References PKPServices\get(), and PKPTemplateManager\getManager().

getSectionId()

PKPSectionForm::getSectionId

(

)

Get the section ID for this section.

Returns

int

Definition at line 72 of file PKPSectionForm.inc.php.

References $_sectionId.

Referenced by execute(), SectionForm\execute(), SectionForm\fetch(), SectionForm\initData(), and SectionForm\validate().

readInputData()

PKPSectionForm::readInputData

(

)

Assign form data to user-submitted data. Can be overridden from subclasses.

Reimplemented from Form.

Reimplemented in SectionForm.

Definition at line 64 of file PKPSectionForm.inc.php.

References Form\readUserVars().

setSectionId()

PKPSectionForm::setSectionId

(

$sectionId

)

Set the section ID for this section.

Parameters

$sectionId

int

Definition at line 80 of file PKPSectionForm.inc.php.

Referenced by __construct(), and SectionForm\execute().

Field Documentation

$_imageExtension

string PKPSectionForm::$_imageExtension

Cover image extension

Definition at line 32 of file PKPSectionForm.inc.php.

$_sectionId

PKPSectionForm::$_sectionId

the id for the section being edited

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

Referenced by getSectionId().

$_sizeArray

array PKPSectionForm::$_sizeArray

Cover image information from getimagesize

Definition at line 38 of file PKPSectionForm.inc.php.

$_userId

int PKPSectionForm::$_userId

The current user ID

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

---

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

• PKPSectionForm.inc.php