Form Class Reference
[Core]

Class defining basic operations for handling HTML forms. More...

Inheritance diagram for Form:

AnnouncementForm AnnouncementTypeForm ArticleGalleyForm AuthorSubmitForm AuthorSubmitSuppFileForm AuthSourceSettingsForm ChangePasswordForm CmsRssSettingsForm CmsSettingsForm CommentForm CommentForm ContextForm CreateReviewerForm CustomThemeSettingsForm EditCommentForm EmailTemplateForm GoogleAnalyticsSettingsForm GroupForm ImportOJS1Form InstallForm IssueForm JournalSetupForm JournalSiteSettingsForm LanguageSettingsForm LoginChangePasswordForm MetadataForm OpenAdsSettingsForm PaymentSettingsForm PayMethodSettingsForm PhpMyVisitesSettingsForm ProfileForm RegistrationForm ReviewFormElementForm ReviewFormForm ReviewFormResponseForm SearchForm SectionForm SettingsForm SettingsForm SettingsForm SettingsForm SiteSettingsForm StudentThesisForm SubscriptionForm SubscriptionPolicyForm SubscriptionTypeForm SuppFileForm ThesisForm ThesisSettingsForm UpgradeForm UserManagementForm VersionForm XMLGalleySettingsForm

List of all members.

Public Member Functions

 addCheck ($formValidator)
 addError ($field, $message)
 addErrorField ($field)
 display ()
 execute ()
 Form ($template)
 getData ($key)
 getErrorsArray ()
 getFormLocale ()
 getLocaleFieldNames ()
 initData ()
 isLocaleResubmit ()
 isValid ()
 readInputData ()
 readUserDateVars ($vars)
 readUserVars ($vars)
 setData ($key, $value)
 smartyFieldLabel ($params, &$smarty)
 smartyFormLanguageChooser ($params, &$smarty)
 validate ()

Public Attributes

 $_checks
 $_data
 $_errors
 $_template
 $errorFields
 $errorsArray

Detailed Description

Class defining basic operations for handling HTML forms.

Definition at line 21 of file Form.inc.php.

Member Function Documentation

Form.addCheck ( $  formValidator  ) 

Add a validation check to the form.

Parameters:
$formValidator FormValidator

Definition at line 196 of file Form.inc.php.

Referenced by AnnouncementForm.AnnouncementForm(), AnnouncementTypeForm.AnnouncementTypeForm(), ArticleGalleyForm.ArticleGalleyForm(), AuthorSubmitForm.AuthorSubmitForm(), AuthorSubmitStep1Form.AuthorSubmitStep1Form(), AuthorSubmitStep2Form.AuthorSubmitStep2Form(), AuthorSubmitSuppFileForm.AuthorSubmitSuppFileForm(), AuthSourceSettingsForm.AuthSourceSettingsForm(), ChangePasswordForm.ChangePasswordForm(), CmsRssSettingsForm.CmsRssSettingsForm(), CmsSettingsForm.CmsSettingsForm(), CommentForm.CommentForm(), ContextForm.ContextForm(), CreateReviewerForm.CreateReviewerForm(), EditCommentForm.EditCommentForm(), EmailTemplateForm.EmailTemplateForm(), GoogleAnalyticsSettingsForm.GoogleAnalyticsSettingsForm(), GroupForm.GroupForm(), ImportOJS1Form.ImportOJS1Form(), InstallForm.InstallForm(), IssueForm.IssueForm(), JournalSetupForm.JournalSetupForm(), JournalSetupStep1Form.JournalSetupStep1Form(), JournalSetupStep2Form.JournalSetupStep2Form(), JournalSetupStep3Form.JournalSetupStep3Form(), JournalSiteSettingsForm.JournalSiteSettingsForm(), LanguageSettingsForm.LanguageSettingsForm(), LoginChangePasswordForm.LoginChangePasswordForm(), MetadataForm.MetadataForm(), OpenAdsSettingsForm.OpenAdsSettingsForm(), PaymentSettingsForm.PaymentSettingsForm(), PayMethodSettingsForm.PayMethodSettingsForm(), PhpMyVisitesSettingsForm.PhpMyVisitesSettingsForm(), ProfileForm.ProfileForm(), XMLGalleySettingsForm.readInputData(), ThesisSettingsForm.readInputData(), ThesisForm.readInputData(), StudentThesisForm.readInputData(), SettingsForm.readInputData(), SubscriptionPolicyForm.readInputData(), SubscriptionForm.readInputData(), MetadataForm.readInputData(), IssueForm.readInputData(), AuthorSubmitStep2Form.readInputData(), RegistrationForm.RegistrationForm(), ReviewFormElementForm.ReviewFormElementForm(), ReviewFormForm.ReviewFormForm(), ReviewFormResponseForm.ReviewFormResponseForm(), SearchForm.SearchForm(), SectionForm.SectionForm(), SettingsForm.SettingsForm(), SiteSettingsForm.SiteSettingsForm(), StudentThesisForm.StudentThesisForm(), SubscriptionForm.SubscriptionForm(), SubscriptionPolicyForm.SubscriptionPolicyForm(), SubscriptionTypeForm.SubscriptionTypeForm(), SuppFileForm.SuppFileForm(), ThesisForm.ThesisForm(), ThesisSettingsForm.ThesisSettingsForm(), UpgradeForm.UpgradeForm(), UserManagementForm.UserManagementForm(), IssueForm.validate(), VersionForm.VersionForm(), and XMLGalleySettingsForm.XMLGalleySettingsForm().

Form.addError ( $  field,
$  message 
)

Add an error to the form. Errors are typically assigned as the form is validated.

Parameters:
$field string the name of the field where the error occurred

Definition at line 205 of file Form.inc.php.

Referenced by ArticleGalleyForm.uploadImage(), SuppFileForm.validate(), ArticleGalleyForm.validate(), IssueForm.validate(), and validate().

Form.addErrorField ( $  field  ) 

Add an error field for highlighting on form

Parameters:
$field string the name of the field where the error occurred

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

Referenced by SuppFileForm.validate(), ArticleGalleyForm.validate(), and IssueForm.validate().

Form.display (  ) 

Display the form.

Reimplemented in ImportOJS1Form, JournalSiteSettingsForm, SiteSettingsForm, AuthorSubmitForm, AuthorSubmitStep1Form, AuthorSubmitStep2Form, AuthorSubmitStep3Form, AuthorSubmitStep4Form, AuthorSubmitStep5Form, AuthorSubmitSuppFileForm, CommentForm, InstallForm, UpgradeForm, IssueForm, AnnouncementForm, AnnouncementTypeForm, EmailTemplateForm, GroupForm, LanguageSettingsForm, PaymentSettingsForm, PayMethodSettingsForm, ReviewFormElementForm, ReviewFormForm, SectionForm, JournalSetupForm, JournalSetupStep1Form, JournalSetupStep2Form, JournalSetupStep3Form, JournalSetupStep5Form, UserManagementForm, ContextForm, SearchForm, VersionForm, CreateReviewerForm, AuthSourceSettingsForm, ArticleGalleyForm, CommentForm, CopyeditCommentForm, EditorDecisionCommentForm, LayoutCommentForm, PeerReviewCommentForm, ProofreadCommentForm, MetadataForm, ReviewFormResponseForm, SuppFileForm, SubscriptionForm, SubscriptionPolicyForm, SubscriptionTypeForm, ChangePasswordForm, LoginChangePasswordForm, ProfileForm, RegistrationForm, OpenAdsSettingsForm, StudentThesisForm, ThesisForm, ThesisSettingsForm, and CustomThemeSettingsForm.

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

References Locale.getAllLocales(), getErrorsArray(), Locale.getLocale(), TemplateManager.getManager(), Locale.getSupportedLocales(), Request.getUserVar(), and isValid().

Form.execute (  ) 

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

Reimplemented in ImportOJS1Form, JournalSiteSettingsForm, SiteSettingsForm, AuthorSubmitStep1Form, AuthorSubmitStep2Form, AuthorSubmitStep3Form, AuthorSubmitStep4Form, AuthorSubmitStep5Form, AuthorSubmitSuppFileForm, CommentForm, InstallForm, UpgradeForm, AnnouncementForm, AnnouncementTypeForm, EmailTemplateForm, GroupForm, LanguageSettingsForm, PayMethodSettingsForm, ReviewFormElementForm, ReviewFormForm, SectionForm, JournalSetupForm, JournalSetupStep1Form, JournalSetupStep5Form, UserManagementForm, ContextForm, SearchForm, VersionForm, CreateReviewerForm, AuthSourceSettingsForm, CommentForm, CopyeditCommentForm, EditCommentForm, EditorDecisionCommentForm, LayoutCommentForm, PeerReviewCommentForm, ProofreadCommentForm, MetadataForm, ReviewFormResponseForm, SubscriptionForm, SubscriptionPolicyForm, SubscriptionTypeForm, ChangePasswordForm, LoginChangePasswordForm, ProfileForm, RegistrationForm, SettingsForm, SettingsForm, CmsSettingsForm, CmsRssSettingsForm, GoogleAnalyticsSettingsForm, OpenAdsSettingsForm, PhpMyVisitesSettingsForm, StudentThesisForm, ThesisForm, ThesisSettingsForm, SettingsForm, SettingsForm, XMLGalleySettingsForm, and CustomThemeSettingsForm.

Definition at line 141 of file Form.inc.php.

Form.Form ( $  template  ) 

Constructor.

Parameters:
$template string the path to the form template file

Definition at line 45 of file Form.inc.php.

Form.getData ( $  key  ) 

Get the value of a form field.

Parameters:
$key string
Returns:
mixed

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

Referenced by SubscriptionForm.display(), SiteSettingsForm.display(), EditCommentForm.email(), CommentForm.email(), CustomThemeSettingsForm.execute(), XMLGalleySettingsForm.execute(), ThesisSettingsForm.execute(), ThesisForm.execute(), StudentThesisForm.execute(), PhpMyVisitesSettingsForm.execute(), OpenAdsSettingsForm.execute(), GoogleAnalyticsSettingsForm.execute(), CmsRssSettingsForm.execute(), SettingsForm.execute(), RegistrationForm.execute(), ProfileForm.execute(), LoginChangePasswordForm.execute(), ChangePasswordForm.execute(), SubscriptionTypeForm.execute(), SubscriptionPolicyForm.execute(), SubscriptionForm.execute(), ReviewFormResponseForm.execute(), MetadataForm.execute(), PeerReviewCommentForm.execute(), EditCommentForm.execute(), ArticleGalleyForm.execute(), AuthSourceSettingsForm.execute(), CreateReviewerForm.execute(), VersionForm.execute(), SearchForm.execute(), ContextForm.execute(), UserManagementForm.execute(), JournalSetupStep5Form.execute(), JournalSetupStep1Form.execute(), SectionForm.execute(), ReviewFormForm.execute(), ReviewFormElementForm.execute(), PayMethodSettingsForm.execute(), LanguageSettingsForm.execute(), GroupForm.execute(), EmailTemplateForm.execute(), AnnouncementTypeForm.execute(), AnnouncementForm.execute(), IssueForm.execute(), UpgradeForm.execute(), InstallForm.execute(), CommentForm.execute(), AuthorSubmitStep5Form.execute(), AuthorSubmitStep2Form.execute(), AuthorSubmitStep1Form.execute(), SiteSettingsForm.execute(), JournalSiteSettingsForm.execute(), ImportOJS1Form.execute(), LanguageSettingsForm.initData(), XMLGalleySettingsForm.readInputData(), SettingsForm.readInputData(), RegistrationForm.readInputData(), ProfileForm.readInputData(), SubscriptionForm.readInputData(), CreateReviewerForm.readInputData(), UserManagementForm.readInputData(), PayMethodSettingsForm.readInputData(), LanguageSettingsForm.readInputData(), IssueForm.readInputData(), InstallForm.readInputData(), JournalSiteSettingsForm.readInputData(), CmsSettingsForm.save(), SuppFileForm.setSuppFileData(), AuthorSubmitSuppFileForm.setSuppFileData(), smartyFormLanguageChooser(), SuppFileForm.validate(), ArticleGalleyForm.validate(), and IssueForm.validate().

Form.getErrorsArray (  ) 

Return set of errors that occurred in form validation. If multiple errors occurred processing a single field, only the first error is included.

Returns:
array erroneous fields and associated error messages

Definition at line 230 of file Form.inc.php.

Referenced by display(), and validate().

Form.getFormLocale (  ) 

Get the current form locale.

Returns:
string

Definition at line 166 of file Form.inc.php.

References Locale.getLocale(), and Request.getUserVar().

Referenced by MetadataForm.execute(), JournalSetupStep5Form.execute(), IssueForm.execute(), and SiteSettingsForm.execute().

Form.getLocaleFieldNames (  ) 

Get the list of field names that need to support multiple locales

Returns:
array

Reimplemented in JournalSiteSettingsForm, SiteSettingsForm, AuthorSubmitStep2Form, AuthorSubmitSuppFileForm, IssueForm, AnnouncementForm, AnnouncementTypeForm, GroupForm, PaymentSettingsForm, ReviewFormElementForm, ReviewFormForm, SectionForm, JournalSetupStep1Form, JournalSetupStep2Form, JournalSetupStep3Form, JournalSetupStep4Form, JournalSetupStep5Form, UserManagementForm, CreateReviewerForm, MetadataForm, SuppFileForm, SubscriptionPolicyForm, SubscriptionTypeForm, ProfileForm, and RegistrationForm.

Definition at line 148 of file Form.inc.php.

Referenced by JournalSetupForm.execute(), and smartyFormLanguageChooser().

Form.initData (  ) 

Initialize form data for a new form.

Reimplemented in JournalSiteSettingsForm, SiteSettingsForm, AuthorSubmitStep1Form, AuthorSubmitStep2Form, AuthorSubmitStep3Form, AuthorSubmitStep5Form, AuthorSubmitSuppFileForm, CommentForm, InstallForm, AnnouncementForm, AnnouncementTypeForm, EmailTemplateForm, GroupForm, LanguageSettingsForm, PaymentSettingsForm, PayMethodSettingsForm, ReviewFormElementForm, ReviewFormForm, SectionForm, JournalSetupForm, UserManagementForm, ContextForm, SearchForm, VersionForm, AuthSourceSettingsForm, ArticleGalleyForm, EditCommentForm, MetadataForm, SuppFileForm, SubscriptionForm, SubscriptionPolicyForm, SubscriptionTypeForm, ProfileForm, RegistrationForm, SettingsForm, SettingsForm, CmsRssSettingsForm, GoogleAnalyticsSettingsForm, OpenAdsSettingsForm, PhpMyVisitesSettingsForm, StudentThesisForm, ThesisForm, ThesisSettingsForm, SettingsForm, SettingsForm, XMLGalleySettingsForm, and CustomThemeSettingsForm.

Definition at line 103 of file Form.inc.php.

Form.isLocaleResubmit (  ) 

Determine whether or not the current request results from a resubmit of locale data resulting from a form language change.

Returns:
boolean

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

References Request.getUserVar().

Form.isValid (  ) 

Check if form passes all validation checks.

Returns:
boolean

Definition at line 221 of file Form.inc.php.

Referenced by display(), validate(), and AuthorSubmitStep5Form.validate().

Form.readInputData (  ) 

Assign form data to user-submitted data.

Reimplemented in ImportOJS1Form, JournalSiteSettingsForm, SiteSettingsForm, AuthorSubmitStep1Form, AuthorSubmitStep2Form, AuthorSubmitStep3Form, AuthorSubmitStep5Form, AuthorSubmitSuppFileForm, CommentForm, InstallForm, UpgradeForm, IssueForm, AnnouncementForm, AnnouncementTypeForm, EmailTemplateForm, GroupForm, LanguageSettingsForm, PaymentSettingsForm, PayMethodSettingsForm, ReviewFormElementForm, ReviewFormForm, SectionForm, JournalSetupForm, JournalSetupStep5Form, UserManagementForm, ContextForm, SearchForm, VersionForm, CreateReviewerForm, AuthSourceSettingsForm, ArticleGalleyForm, CommentForm, CopyeditCommentForm, EditCommentForm, EditorDecisionCommentForm, LayoutCommentForm, PeerReviewCommentForm, ProofreadCommentForm, MetadataForm, ReviewFormResponseForm, SuppFileForm, SubscriptionForm, SubscriptionPolicyForm, SubscriptionTypeForm, ChangePasswordForm, LoginChangePasswordForm, ProfileForm, RegistrationForm, SettingsForm, SettingsForm, CmsSettingsForm, CmsRssSettingsForm, GoogleAnalyticsSettingsForm, OpenAdsSettingsForm, PhpMyVisitesSettingsForm, StudentThesisForm, ThesisForm, ThesisSettingsForm, SettingsForm, SettingsForm, XMLGalleySettingsForm, and CustomThemeSettingsForm.

Definition at line 109 of file Form.inc.php.

Form.readUserDateVars ( $  vars  ) 

Adds specified user date variables to input data.

Parameters:
$vars array the names of the date variables to read

Definition at line 186 of file Form.inc.php.

References Request.getUserDateVar(), and setData().

Referenced by IssueForm.readInputData().

Form.readUserVars ( $  vars  ) 

Adds specified user variables to input data.

Parameters:
$vars array the names of the variables to read

Definition at line 176 of file Form.inc.php.

References Request.getUserVar(), and setData().

Referenced by CustomThemeSettingsForm.readInputData(), XMLGalleySettingsForm.readInputData(), ThesisSettingsForm.readInputData(), ThesisForm.readInputData(), StudentThesisForm.readInputData(), PhpMyVisitesSettingsForm.readInputData(), OpenAdsSettingsForm.readInputData(), GoogleAnalyticsSettingsForm.readInputData(), CmsRssSettingsForm.readInputData(), CmsSettingsForm.readInputData(), SettingsForm.readInputData(), RegistrationForm.readInputData(), ProfileForm.readInputData(), LoginChangePasswordForm.readInputData(), ChangePasswordForm.readInputData(), SubscriptionTypeForm.readInputData(), SubscriptionPolicyForm.readInputData(), SubscriptionForm.readInputData(), SuppFileForm.readInputData(), ReviewFormResponseForm.readInputData(), MetadataForm.readInputData(), PeerReviewCommentForm.readInputData(), EditorDecisionCommentForm.readInputData(), EditCommentForm.readInputData(), ArticleGalleyForm.readInputData(), AuthSourceSettingsForm.readInputData(), CreateReviewerForm.readInputData(), VersionForm.readInputData(), SearchForm.readInputData(), ContextForm.readInputData(), UserManagementForm.readInputData(), JournalSetupStep5Form.readInputData(), JournalSetupForm.readInputData(), SectionForm.readInputData(), ReviewFormForm.readInputData(), ReviewFormElementForm.readInputData(), PayMethodSettingsForm.readInputData(), PaymentSettingsForm.readInputData(), LanguageSettingsForm.readInputData(), GroupForm.readInputData(), EmailTemplateForm.readInputData(), AnnouncementTypeForm.readInputData(), AnnouncementForm.readInputData(), IssueForm.readInputData(), UpgradeForm.readInputData(), InstallForm.readInputData(), CommentForm.readInputData(), AuthorSubmitSuppFileForm.readInputData(), AuthorSubmitStep5Form.readInputData(), AuthorSubmitStep3Form.readInputData(), AuthorSubmitStep2Form.readInputData(), AuthorSubmitStep1Form.readInputData(), SiteSettingsForm.readInputData(), JournalSiteSettingsForm.readInputData(), and ImportOJS1Form.readInputData().

Form.setData ( $  key,
$  value 
)

Set the value of a form field.

Parameters:
$key 
$value 

Definition at line 93 of file Form.inc.php.

References Core.cleanVar().

Referenced by CreateReviewerForm.CreateReviewerForm(), StudentThesisForm.display(), RegistrationForm.display(), CommentForm.display(), JournalSetupStep1Form.execute(), LanguageSettingsForm.execute(), XMLGalleySettingsForm.initData(), OpenAdsSettingsForm.initData(), CmsRssSettingsForm.initData(), SettingsForm.initData(), RegistrationForm.initData(), MetadataForm.initData(), LanguageSettingsForm.initData(), IssueForm.initData(), AuthorSubmitStep2Form.initData(), SettingsForm.readInputData(), RegistrationForm.readInputData(), ProfileForm.readInputData(), CreateReviewerForm.readInputData(), UserManagementForm.readInputData(), SectionForm.readInputData(), LanguageSettingsForm.readInputData(), InstallForm.readInputData(), JournalSiteSettingsForm.readInputData(), readUserDateVars(), readUserVars(), and CmsSettingsForm.save().

Form.smartyFieldLabel ( $  params,
&$  smarty 
)

Custom Smarty function for labelling/highlighting of form fields.

Parameters:
$params array can contain 'name' (field name/ID), 'required' (required field), 'key' (localization key), 'label' (non-localized label string), 'suppressId' (boolean)
$smarty Smarty

Definition at line 245 of file Form.inc.php.

References Locale.translate().

Form.smartyFormLanguageChooser ( $  params,
&$  smarty 
)

Add hidden form parameters for the localized fields for this form and display the language chooser field

Parameters:
$params array
$smarty object

Definition at line 284 of file Form.inc.php.

References getData(), and getLocaleFieldNames().

Form.validate (  ) 

Validate form data.

Reimplemented in AuthorSubmitStep5Form, ArticleGalleyForm, and SuppFileForm.

Definition at line 115 of file Form.inc.php.

References $errorFields, addError(), getErrorsArray(), and isValid().

Member Data Documentation

Form.$_checks

Validation checks for this form

Definition at line 30 of file Form.inc.php.

Form.$_data

Associative array containing form data

Definition at line 27 of file Form.inc.php.

Form.$_errors

Errors occurring in form validation

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

Form.$_template

The template file containing the HTML form

Definition at line 24 of file Form.inc.php.

Form.$errorFields

Array of field names where an error occurred

Definition at line 39 of file Form.inc.php.

Referenced by validate().

Form.$errorsArray

Array of field names where an error occurred and the associated error message

Definition at line 36 of file Form.inc.php.

The documentation for this class was generated from the following file:
Generated on Mon Jul 14 10:55:42 2008 for Open Journal Systems by  doxygen 1.5.6