Open Journal Systems
3.3.0
|
Public Member Functions | |
__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) | |
execute (... $functionArgs) | |
fetch ($request, $template=null, $display=false) | |
getData ($key) | |
getDefaultFormLocale () | |
getErrorsArray () | |
getLocaleFieldNames () | |
getRequiredLocale () | |
getTemplate () | |
initData () | |
isValid () | |
readInputData () | |
readUserVars ($vars) | |
setData ($key, $value=null) | |
setDefaultFormLocale ($defaultLocale) | |
setTemplate ($template) | |
validate ($callHooks=true) | |
Data Fields | |
$_checks | |
$_data | |
$_errors | |
$_template | |
$cssValidation | |
$defaultLocale | |
$errorFields | |
$errorsArray | |
$formSectionErrors | |
$requiredLocale | |
$supportedLocales | |
Class defining basic operations for handling HTML forms.
Definition at line 47 of file Form.inc.php.
Form::__construct | ( | $template = null , |
|
$callHooks = true , |
|||
$requiredLocale = null , |
|||
$supportedLocales = null |
|||
) |
Constructor.
$template | string the path to the form template file |
Reimplemented in PKPAssignPublicIdentifiersForm, ManageQueryNoteFilesForm, SubmissionFilesMetadataForm, NewReviewRoundForm, InitiateReviewForm, PromoteForm, SendReviewsForm, ReviewerNotifyActionForm, ArticleGalleyForm, ReviewerReviewForm, PKPStageParticipantNotifyForm, StageParticipantNotifyForm, and QueryNoteForm.
Definition at line 95 of file Form.inc.php.
References $requiredLocale, $supportedLocales, HookRegistry\call(), AppLocale\getLocale(), AppLocale\getPrimaryLocale(), AppLocale\getSupportedFormLocales(), and strtolower_codesafe().
Form::_decomposeArray | ( | $name, | |
$value, | |||
$stack | |||
) |
Convert PHP variable (literals or arrays) into HTML containing hidden input fields.
$name | string Name of variable |
$value | mixed Value of variable |
$stack | array Names of array keys (for recursive calling) |
Definition at line 450 of file Form.inc.php.
Form::addCheck | ( | $formValidator | ) |
Add a validation check to the form.
$formValidator | FormValidator |
Definition at line 395 of file Form.inc.php.
Referenced by EnrollExistingReviewerForm\__construct(), SubmissionSubmitStep1Form\__construct(), LoginChangePasswordForm\__construct(), ReviewerReviewStep3Form\__construct(), NewNoteForm\__construct(), AdvancedSearchReviewerForm\__construct(), ContactForm\__construct(), CreateReviewerForm\__construct(), InstitutionalSubscriptionForm\__construct(), PKPReviewerReviewStep1Form\__construct(), PKPReviewerReviewStep3Form\__construct(), ReviewReminderForm\__construct(), SectionForm\__construct(), ThankReviewerForm\__construct(), CriticalTimesIssueTocFormHandler\__construct(), IndividualSubscriptionForm\__construct(), IdentityForm\__construct(), PKPNotificationSettingsForm\__construct(), ReviewFormForm\__construct(), ReviewFormElements\__construct(), PaymentTypesForm\__construct(), PKPAuthorForm\__construct(), PreviewReviewForm\__construct(), MaintenanceForm\__construct(), SubmissionChecklistForm\__construct(), PublicProfileForm\__construct(), NewLibraryFileForm\__construct(), EmailReviewerForm\__construct(), CitationStyleLanguageSettingsForm\__construct(), UsageStatsSettingsForm\__construct(), UserEmailForm\__construct(), LibraryFileForm\__construct(), ManageSubmissionFilesForm\__construct(), UserRoleForm\__construct(), BaseProfileForm\__construct(), PKPSubmissionSubmitStep1Form\__construct(), IssueAccessForm\__construct(), TextureArticleGalleyForm\__construct(), UserForm\__construct(), IssueForm\__construct(), SubscriptionSSOSettingsForm\__construct(), UploadPluginForm\__construct(), UserDisableForm\__construct(), ChangePasswordForm\__construct(), EditReviewForm\__construct(), ReviewerForm\__construct(), IssueGalleyForm\__construct(), PKPNavigationMenuItemsForm\__construct(), WebFeedSettingsForm\__construct(), GoogleAnalyticsSettingsForm\__construct(), AnnouncementFeedSettingsForm\__construct(), UserDetailsForm\__construct(), AnnouncementTypeForm\__construct(), NavigationMenuForm\__construct(), ReviewerGossipForm\__construct(), CustomBlockForm\__construct(), UserGroupForm\__construct(), ReviewFormElementForm\__construct(), GenreForm\__construct(), StaticPageForm\__construct(), ArticleGalleyForm\__construct(), PKPStageParticipantNotifyForm\__construct(), SubmissionFilesMetadataForm\__construct(), PKPSectionForm\__construct(), RecommendationForm\__construct(), SwordDepositPointForm\__construct(), OrcidProfileSettingsForm\__construct(), SubscriptionTypeForm\__construct(), ReviewerReviewForm\__construct(), UserIndividualSubscriptionForm\__construct(), UserInstitutionalSubscriptionForm\__construct(), QueryNoteForm\__construct(), RegistrationForm\__construct(), QuickSubmitForm\__construct(), SubmissionSubmitForm\__construct(), PKPSubmissionFilesUploadBaseForm\__construct(), EditorDecisionForm\__construct(), SubscriptionForm\__construct(), AddParticipantForm\__construct(), CategoryForm\__construct(), PKPPublicIdentifiersForm\__construct(), PKPAssignPublicIdentifiersForm\__construct(), SubscriptionPolicyForm\__construct(), QueryForm\__construct(), DataciteSettingsForm\__construct(), MedraSettingsForm\__construct(), URNSettingsForm\__construct(), DOISettingsForm\__construct(), DOAJSettingsForm\__construct(), CrossRefSettingsForm\__construct(), InstallForm\__construct(), UploadImageForm\__construct(), PKPReportGeneratorForm\__construct(), WebFeedSettingsForm\readInputData(), InstitutionalSubscriptionForm\readInputData(), UserInstitutionalSubscriptionForm\readInputData(), UserIndividualSubscriptionForm\readInputData(), SubscriptionForm\readInputData(), SubscriptionTypeForm\readInputData(), SubscriptionPolicyForm\readInputData(), IssueForm\readInputData(), SubmissionFilesUploadForm\validate(), MarkupProfileSettingsForm\validate(), and MarkupSettingsForm\validate().
Form::addError | ( | $field, | |
$message | |||
) |
Add an error to the form. Errors are typically assigned as the form is validated.
$field | string the name of the field where the error occurred |
Definition at line 404 of file Form.inc.php.
Referenced by InstitutionalSubscriptionForm\__construct(), IndividualSubscriptionForm\__construct(), SectionForm\validate(), IssueGalleyForm\validate(), ArticleGalleyForm\validate(), IssueForm\validate(), CategoryForm\validate(), PKPPublicIdentifiersForm\validate(), QuickSubmitForm\validate(), RegistrationForm\validate(), NavigationMenuForm\validate(), PKPNavigationMenuItemsForm\validate(), and validate().
Form::addErrorField | ( | $field | ) |
Add an error field for highlighting on form
$field | string the name of the field where the error occurred |
Definition at line 412 of file Form.inc.php.
Referenced by InstitutionalSubscriptionForm\__construct(), IndividualSubscriptionForm\__construct(), IssueGalleyForm\validate(), ArticleGalleyForm\validate(), IssueForm\validate(), and PKPPublicIdentifiersForm\validate().
Form::addSupportedFormLocale | ( | $supportedLocale | ) |
Add a supported locale.
$supportedLocale | string |
Definition at line 364 of file Form.inc.php.
References PKPApplication\get().
Referenced by CreateReviewerForm\__construct(), IdentityForm\__construct(), and UserDetailsForm\__construct().
Form::display | ( | $request = null , |
|
$template = null |
|||
) |
Display the form.
$request | PKPRequest |
$template | string the template to be rendered, mandatory if no template has been specified on class instantiation. |
Reimplemented in UserDetailsForm, InstallForm, UserIndividualSubscriptionForm, UserInstitutionalSubscriptionForm, QuickSubmitForm, UserDisableForm, UserForm, PaypalPaymentForm, LoginChangePasswordForm, UserRoleForm, and MaintenanceForm.
Definition at line 159 of file Form.inc.php.
References fetch().
Form::execute | ( | $functionArgs | ) |
Execute the form's action. (Note that it is assumed that the form has already been validated.)
mixed | $functionArgs,... | Arguments from the caller to be passed to the hook consumer |
Reimplemented in ReviewerForm, QuickSubmitForm, UserDetailsForm, AddParticipantForm, PKPAuthorForm, UserGroupForm, RecommendationForm, NavigationMenuForm, PKPNavigationMenuItemsForm, PKPNotificationSettingsForm, SubmissionFilesMetadataForm, PKPStageParticipantNotifyForm, SubmissionFilesUploadForm, PKPReviewerReviewStep1Form, PKPReviewerReviewStep3Form, StaticPageForm, PromoteForm, UserRoleForm, PKPReviewerReviewStep2Form, InitiateReviewForm, SubmissionSubmitStep4Form, UpgradeForm, QueryForm, PKPSubmissionSubmitStep1Form, PKPReportGeneratorForm, CategoryForm, RegistrationForm, InstallForm, SubscriptionForm, IssueForm, PKPPublicIdentifiersForm, MarkupSettingsForm, UserInstitutionalSubscriptionForm, SubscriptionPolicyForm, IssueGalleyForm, SubscriptionTypeForm, ArticleGalleyForm, SectionForm, URNSettingsForm, UserIndividualSubscriptionForm, DOISettingsForm, MedraSettingsForm, PublicProfileForm, ReviewReminderForm, InstitutionalSubscriptionForm, GenreForm, QueryNoteForm, PLNSettingsForm, CrossRefSettingsForm, EditReviewForm, DataciteSettingsForm, ReviewFormElementForm, MarkupProfileSettingsForm, PKPSectionForm, UsageStatsSettingsForm, AnnouncementTypeForm, SendReviewsForm, TextureArticleGalleyForm, DOAJSettingsForm, ChangePasswordForm, ThankReviewerForm, CitationStyleLanguageSettingsForm, SubmissionChecklistForm, OrcidProfileSettingsForm, UserForm, NewNoteForm, ContactForm, IdentityForm, UserDisableForm, PKPSubmissionSubmitStep3Form, ReviewerNotifyActionForm, WebFeedSettingsForm, RolesForm, CreateReviewerForm, SubscriptionSSOSettingsForm, AnnouncementFeedSettingsForm, CustomBlockForm, IssueAccessForm, PaymentTypesForm, GoogleAnalyticsSettingsForm, APIProfileForm, InstallLanguageForm, ReviewFormForm, UserEmailForm, IndividualSubscriptionForm, ReviewerGossipForm, UploadPluginForm, SubmissionFilesUploadConfirmationForm, LoginChangePasswordForm, NewLibraryFileForm, EditLibraryFileForm, EditLibraryFileForm, EnrollExistingReviewerForm, BaseProfileForm, SubmissionFilesArtworkMetadataForm, SupplementaryFileMetadataForm, PublicIdentifiersForm, NewLibraryFileForm, NewReviewRoundForm, ReinstateReviewerForm, UnassignReviewerForm, PKPSubmissionSubmitStep4Form, PKPSubmissionSubmitStep2Form, and InitiateExternalReviewForm.
Definition at line 316 of file Form.inc.php.
References HookRegistry\call(), and strtolower_codesafe().
Form::fetch | ( | $request, | |
$template = null , |
|||
$display = false |
|||
) |
Returns a string of the rendered form
$request | PKPRequest |
$template | string the template to be rendered, mandatory if no template has been specified on class instantiation. |
$display | boolean |
Reimplemented in ReviewerForm, PKPSubmissionFilesUploadBaseForm, CategoryForm, RecommendationForm, UserGroupForm, SubmissionFilesMetadataForm, PKPNotificationSettingsForm, PKPAuthorForm, SubmissionFilesUploadForm, PublicProfileForm, EditorDecisionForm, AddParticipantForm, SectionForm, EditorDecisionWithEmailForm, QueryNoteForm, SubscriptionTypeForm, SubscriptionPolicyForm, ReviewReminderForm, PKPReportGeneratorForm, RegistrationForm, GenreForm, SubscriptionForm, ReviewerReviewForm, PLNSettingsForm, StaticPageForm, PKPSubmissionSubmitStep1Form, PKPSectionForm, OrcidProfileSettingsForm, UsageStatsSettingsForm, PKPPublicIdentifiersForm, ChangePasswordForm, SubmissionChecklistForm, ArticleGalleyForm, PKPReviewerReviewStep3Form, PKPAssignPublicIdentifiersForm, SubscriptionSSOSettingsForm, PKPStageParticipantNotifyForm, IssueForm, EditReviewForm, PKPNavigationMenuItemsForm, SendReviewsForm, GoogleAnalyticsSettingsForm, IssueGalleyForm, NewNoteForm, ReviewFormElementForm, CitationStyleLanguageSettingsForm, SubmissionSubmitForm, NewFileNoteForm, ReviewFormForm, NavigationMenuForm, ReviewerGossipForm, UploadPluginForm, UserEmailForm, CreateReviewerForm, APIProfileForm, ManageQueryNoteFilesForm, LibraryFileForm, PKPSubmissionSubmitStep3Form, IdentityForm, NewLibraryFileForm, PKPReviewerReviewStep1Form, AssignPublicIdentifiersForm, ManageProofFilesForm, InstallLanguageForm, AdvancedSearchReviewerForm, PLNStatusForm, IssueAccessForm, PreviewReviewForm, ReviewFormElements, ContactForm, SubmissionSubmitStep3Form, PKPReviewerReviewStep2Form, RolesForm, PublicIdentifiersForm, EnrollExistingReviewerForm, SubmissionSubmitStep1Form, and AnnouncementTypeForm.
Definition at line 171 of file Form.inc.php.
References HookRegistry\call(), getDefaultFormLocale(), getErrorsArray(), PKPTemplateManager\getManager(), isValid(), and strtolower_codesafe().
Referenced by UserForm\display(), UserDisableForm\display(), and display().
Form::getData | ( | $key | ) |
Get the value of a form field.
$key | string |
Definition at line 220 of file Form.inc.php.
Referenced by SwordDepositPointForm\__construct(), UserGroupForm\_assignStagesToUserGroup(), EditorDecisionForm\_initiateReviewRound(), EditorDecisionWithEmailForm\_sendReviewMailToAuthor(), UserGroupForm\_setUserGroupLocaleFields(), QuickSubmitForm\cancel(), ReviewFormElementForm\deleteEntry(), UserForm\display(), QuickSubmitForm\display(), SupplementaryFileMetadataForm\execute(), SubmissionFilesArtworkMetadataForm\execute(), EnrollExistingReviewerForm\execute(), EditLibraryFileForm\execute(), NewLibraryFileForm\execute(), LoginChangePasswordForm\execute(), SubmissionFilesUploadConfirmationForm\execute(), UploadPluginForm\execute(), ReviewerGossipForm\execute(), SwordSettingsForm\execute(), UserEmailForm\execute(), InstallLanguageForm\execute(), ReviewFormForm\execute(), ManageSubmissionFilesForm\execute(), APIProfileForm\execute(), EmailReviewerForm\execute(), PromoteForm\execute(), PaymentTypesForm\execute(), GoogleAnalyticsSettingsForm\execute(), IssueAccessForm\execute(), CustomBlockForm\execute(), AnnouncementFeedSettingsForm\execute(), SubscriptionSSOSettingsForm\execute(), CriticalTimesIssueTocFormHandler\execute(), RolesForm\execute(), CreateReviewerForm\execute(), WebFeedSettingsForm\execute(), ReviewerNotifyActionForm\execute(), UserDisableForm\execute(), AuthorDepositForm\execute(), IdentityForm\execute(), ContactForm\execute(), NewNoteForm\execute(), UserForm\execute(), SubmissionChecklistForm\execute(), OrcidProfileSettingsForm\execute(), CitationStyleLanguageSettingsForm\execute(), ThankReviewerForm\execute(), DOAJSettingsForm\execute(), TextureArticleGalleyForm\execute(), AnnouncementTypeForm\execute(), UsageStatsSettingsForm\execute(), StaticPageForm\execute(), PKPSectionForm\execute(), MarkupProfileSettingsForm\execute(), ReviewFormElementForm\execute(), DataciteSettingsForm\execute(), EditReviewForm\execute(), PKPReviewerReviewStep3Form\execute(), CrossRefSettingsForm\execute(), PLNSettingsForm\execute(), SwordDepositPointForm\execute(), PKPReviewerReviewStep1Form\execute(), QueryNoteForm\execute(), GenreForm\execute(), InstitutionalSubscriptionForm\execute(), ReviewReminderForm\execute(), SubmissionFilesUploadForm\execute(), PublicProfileForm\execute(), MedraSettingsForm\execute(), PKPStageParticipantNotifyForm\execute(), DOISettingsForm\execute(), UserIndividualSubscriptionForm\execute(), SubmissionFilesMetadataForm\execute(), PKPNotificationSettingsForm\execute(), URNSettingsForm\execute(), ArticleGalleyForm\execute(), SectionForm\execute(), SubscriptionTypeForm\execute(), IssueGalleyForm\execute(), PKPNavigationMenuItemsForm\execute(), NavigationMenuForm\execute(), UploadImageForm\execute(), RecommendationForm\execute(), SubscriptionPolicyForm\execute(), UserGroupForm\execute(), UserInstitutionalSubscriptionForm\execute(), PKPAuthorForm\execute(), MarkupSettingsForm\execute(), PKPPublicIdentifiersForm\execute(), IssueForm\execute(), SubscriptionForm\execute(), AddParticipantForm\execute(), RegistrationForm\execute(), CategoryForm\execute(), PKPReportGeneratorForm\execute(), UserDetailsForm\execute(), QuickSubmitForm\execute(), ReviewerForm\execute(), PKPSubmissionSubmitStep1Form\execute(), QueryForm\execute(), InstallLanguageForm\fetch(), NavigationMenuForm\fetch(), UsageStatsSettingsForm\fetch(), PKPSubmissionFilesUploadBaseForm\fetch(), UploadImageForm\fetchTemporaryFile(), PKPSubmissionFilesUploadBaseForm\getAssocId(), QueryForm\getAssocId(), PKPSubmissionFilesUploadBaseForm\getAssocType(), QueryForm\getAssocType(), PKPSubmissionFilesUploadBaseForm\getRevisedFileId(), SubmissionFilesMetadataForm\getShowButtons(), PKPSubmissionFilesUploadBaseForm\getSubmissionFiles(), ReviewFormElementForm\insertEntry(), PLNSettingsForm\readInputData(), AnnouncementFeedSettingsForm\readInputData(), WebFeedSettingsForm\readInputData(), UsageStatsSettingsForm\readInputData(), ContactForm\readInputData(), InstitutionalSubscriptionForm\readInputData(), UserInstitutionalSubscriptionForm\readInputData(), UserIndividualSubscriptionForm\readInputData(), SubscriptionForm\readInputData(), RegistrationForm\readInputData(), InstallForm\readInputData(), UserDetailsForm\readInputData(), UploadImageForm\removeTemporaryFile(), PKPReviewerReviewStep3Form\saveForLater(), PKPReviewerReviewStep3Form\saveReviewForm(), PKPStageParticipantNotifyForm\sendMessage(), SubmissionSubmitStep1Form\setPublicationData(), PKPSubmissionSubmitStep1Form\setPublicationData(), ReviewFormElementForm\updateEntry(), PKPSubmissionSubmitStep1Form\validate(), SectionForm\validate(), IssueGalleyForm\validate(), SubmissionFilesUploadForm\validate(), ArticleGalleyForm\validate(), SubmissionSubmitStep1Form\validate(), IssueForm\validate(), CategoryForm\validate(), MarkupSettingsForm\validate(), PKPPublicIdentifiersForm\validate(), QuickSubmitForm\validate(), RegistrationForm\validate(), NavigationMenuForm\validate(), PKPNavigationMenuItemsForm\validate(), and AddParticipantForm\validate().
Form::getDefaultFormLocale | ( | ) |
Get the default form locale.
Definition at line 346 of file Form.inc.php.
References $defaultLocale, and $requiredLocale.
Referenced by QuickSubmitForm\__construct(), QuickSubmitForm\display(), fetch(), and QuickSubmitForm\initData().
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.
Definition at line 429 of file Form.inc.php.
References $errorsArray.
Referenced by fetch(), and validate().
Form::getLocaleFieldNames | ( | ) |
Get the list of field names that need to support multiple locales
Reimplemented in UserDetailsForm, SubscriptionPolicyForm, PKPNavigationMenuItemsForm, SectionForm, SubmissionFilesMetadataForm, CategoryForm, ReviewFormForm, QuickSubmitForm, SubscriptionTypeForm, UploadImageForm, PKPSubmissionSubmitStep3Form, UserGroupForm, IssueForm, ReviewFormElementForm, AnnouncementTypeForm, and NavigationMenuForm.
Definition at line 331 of file Form.inc.php.
References HookRegistry\call(), and strtolower_codesafe().
Form::getRequiredLocale | ( | ) |
Get the required locale for this form (i.e. the locale for which required fields must be set, all others being optional)
Definition at line 146 of file Form.inc.php.
References $requiredLocale.
Form::getTemplate | ( | ) |
Form::initData | ( | ) |
Initialize form data for a new form.
Reimplemented in QuickSubmitForm, QueryForm, InstallForm, IssueForm, RegistrationForm, ReviewerForm, NavigationMenuForm, URNSettingsForm, IssueGalleyForm, DOISettingsForm, SubscriptionPolicyForm, CategoryForm, ArticleGalleyForm, PKPNavigationMenuItemsForm, SubscriptionTypeForm, SubscriptionForm, PKPPublicIdentifiersForm, MedraSettingsForm, UserDetailsForm, CrossRefSettingsForm, PKPAuthorForm, DataciteSettingsForm, UserIndividualSubscriptionForm, UserInstitutionalSubscriptionForm, UploadImageForm, RecommendationForm, UserGroupForm, ReviewFormElementForm, DOAJSettingsForm, ManageReviewFilesForm, InstitutionalSubscriptionForm, AnnouncementTypeForm, SwordDepositPointForm, MarkupSettingsForm, StaticPageForm, IdentityForm, OrcidProfileSettingsForm, MarkupProfileSettingsForm, PaymentTypesForm, EditReviewForm, RolesForm, IssueAccessForm, ManageSubmissionFilesForm, ContactForm, CustomBlockForm, PreviewReviewForm, ReviewFormElements, ReviewReminderForm, GoogleAnalyticsSettingsForm, SubscriptionSSOSettingsForm, ThankReviewerForm, ReviewerNotifyActionForm, AnnouncementFeedSettingsForm, WebFeedSettingsForm, UserDisableForm, ReviewFormForm, EditLibraryFileForm, PKPReviewerReviewStep3Form, UserForm, SwordSettingsForm, UsageStatsSettingsForm, EditLibraryFileForm, SectionForm, PKPSubmissionSubmitStep3Form, PLNSettingsForm, PublicProfileForm, CitationStyleLanguageSettingsForm, InstallLanguageForm, and APIProfileForm.
Definition at line 240 of file Form.inc.php.
References HookRegistry\call(), and strtolower_codesafe().
Form::isValid | ( | ) |
Check if form passes all validation checks.
Definition at line 420 of file Form.inc.php.
Referenced by fetch(), and validate().
Form::readInputData | ( | ) |
Assign form data to user-submitted data. Can be overridden from subclasses.
Reimplemented in QueryForm, ReviewerForm, QuickSubmitForm, PKPReportGeneratorForm, PKPSubmissionSubmitStep1Form, PKPSubmissionFilesUploadBaseForm, UserDetailsForm, AddParticipantForm, InstallForm, IssueForm, CategoryForm, RecommendationForm, PKPPublicIdentifiersForm, NavigationMenuForm, PKPAuthorForm, RegistrationForm, SubscriptionPolicyForm, SubscriptionTypeForm, PKPNavigationMenuItemsForm, IssueGalleyForm, URNSettingsForm, ArticleGalleyForm, PKPStageParticipantNotifyForm, DOISettingsForm, SectionForm, PKPAssignPublicIdentifiersForm, MedraSettingsForm, SubscriptionForm, MarkupSettingsForm, UserIndividualSubscriptionForm, UploadImageForm, UserInstitutionalSubscriptionForm, UserGroupForm, SubmissionFilesMetadataForm, ReviewReminderForm, ReviewerNotifyActionForm, GenreForm, PKPReviewerReviewStep1Form, CrossRefSettingsForm, DataciteSettingsForm, EditorDecisionForm, ReviewFormElementForm, EditorDecisionWithEmailForm, EditReviewForm, QueryNoteForm, InstitutionalSubscriptionForm, AnnouncementTypeForm, SubmissionSubmitStep1Form, DOAJSettingsForm, ChangePasswordForm, ThankReviewerForm, SubmissionChecklistForm, StaticPageForm, TextureArticleGalleyForm, NewNoteForm, SubmissionFilesUploadForm, IdentityForm, OrcidProfileSettingsForm, PreviewReviewForm, MarkupProfileSettingsForm, ContactForm, CustomBlockForm, PKPSubmissionSubmitStep3Form, RolesForm, PaymentTypesForm, CriticalTimesIssueTocFormHandler, PromoteForm, IssueAccessForm, CreateReviewerForm, SubscriptionSSOSettingsForm, LibraryFileForm, PKPReviewerReviewStep3Form, ManageSubmissionFilesForm, UserDisableForm, UsageStatsSettingsForm, PKPSectionForm, InstallLanguageForm, UserForm, GoogleAnalyticsSettingsForm, WebFeedSettingsForm, SendReviewsForm, AnnouncementFeedSettingsForm, AuthorDepositForm, PublicProfileForm, PLNSettingsForm, SwordSettingsForm, LoginChangePasswordForm, SubmissionFilesUploadConfirmationForm, CitationStyleLanguageSettingsForm, UploadPluginForm, ReviewerGossipForm, UserEmailForm, EmailReviewerForm, EnrollExistingReviewerForm, APIProfileForm, NewLibraryFileForm, ReviewFormForm, SubmissionFilesArtworkMetadataForm, SupplementaryFileMetadataForm, PKPNotificationSettingsForm, AdvancedSearchReviewerForm, and NewLibraryFileForm.
Definition at line 253 of file Form.inc.php.
Form::readUserVars | ( | $vars | ) |
Adds specified user variables to input data.
$vars | array the names of the variables to read |
Definition at line 378 of file Form.inc.php.
References HookRegistry\call(), PKPApplication\get(), setData(), and strtolower_codesafe().
Referenced by AdvancedSearchReviewerForm\readInputData(), PKPNotificationSettingsForm\readInputData(), ReviewFormForm\readInputData(), SubmissionFilesArtworkMetadataForm\readInputData(), NewLibraryFileForm\readInputData(), SupplementaryFileMetadataForm\readInputData(), APIProfileForm\readInputData(), EnrollExistingReviewerForm\readInputData(), EmailReviewerForm\readInputData(), UserEmailForm\readInputData(), UploadPluginForm\readInputData(), ReviewerGossipForm\readInputData(), LoginChangePasswordForm\readInputData(), SubmissionFilesUploadConfirmationForm\readInputData(), CitationStyleLanguageSettingsForm\readInputData(), SwordSettingsForm\readInputData(), PLNSettingsForm\readInputData(), PublicProfileForm\readInputData(), SendReviewsForm\readInputData(), AnnouncementFeedSettingsForm\readInputData(), AuthorDepositForm\readInputData(), UserForm\readInputData(), WebFeedSettingsForm\readInputData(), GoogleAnalyticsSettingsForm\readInputData(), PKPSectionForm\readInputData(), ManageSubmissionFilesForm\readInputData(), UsageStatsSettingsForm\readInputData(), UserDisableForm\readInputData(), PKPReviewerReviewStep3Form\readInputData(), LibraryFileForm\readInputData(), SubscriptionSSOSettingsForm\readInputData(), CreateReviewerForm\readInputData(), IssueAccessForm\readInputData(), PromoteForm\readInputData(), PaymentTypesForm\readInputData(), CriticalTimesIssueTocFormHandler\readInputData(), RolesForm\readInputData(), ContactForm\readInputData(), CustomBlockForm\readInputData(), MarkupProfileSettingsForm\readInputData(), OrcidProfileSettingsForm\readInputData(), IdentityForm\readInputData(), SubmissionFilesUploadForm\readInputData(), NewNoteForm\readInputData(), StaticPageForm\readInputData(), TextureArticleGalleyForm\readInputData(), SubmissionChecklistForm\readInputData(), ThankReviewerForm\readInputData(), ChangePasswordForm\readInputData(), SwordDepositPointForm\readInputData(), DOAJSettingsForm\readInputData(), SubmissionSubmitStep1Form\readInputData(), AnnouncementTypeForm\readInputData(), InstitutionalSubscriptionForm\readInputData(), QueryNoteForm\readInputData(), EditReviewForm\readInputData(), EditorDecisionWithEmailForm\readInputData(), ReviewFormElementForm\readInputData(), EditorDecisionForm\readInputData(), DataciteSettingsForm\readInputData(), CrossRefSettingsForm\readInputData(), PKPReviewerReviewStep1Form\readInputData(), GenreForm\readInputData(), ReviewerNotifyActionForm\readInputData(), ReviewReminderForm\readInputData(), UserGroupForm\readInputData(), SubmissionFilesMetadataForm\readInputData(), UserInstitutionalSubscriptionForm\readInputData(), UserIndividualSubscriptionForm\readInputData(), UploadImageForm\readInputData(), MarkupSettingsForm\readInputData(), SubscriptionForm\readInputData(), SectionForm\readInputData(), MedraSettingsForm\readInputData(), PKPStageParticipantNotifyForm\readInputData(), DOISettingsForm\readInputData(), ArticleGalleyForm\readInputData(), URNSettingsForm\readInputData(), IssueGalleyForm\readInputData(), PKPNavigationMenuItemsForm\readInputData(), SubscriptionTypeForm\readInputData(), SubscriptionPolicyForm\readInputData(), RegistrationForm\readInputData(), PKPAuthorForm\readInputData(), NavigationMenuForm\readInputData(), PKPPublicIdentifiersForm\readInputData(), RecommendationForm\readInputData(), CategoryForm\readInputData(), IssueForm\readInputData(), InstallForm\readInputData(), AddParticipantForm\readInputData(), UserDetailsForm\readInputData(), PKPSubmissionFilesUploadBaseForm\readInputData(), PKPSubmissionSubmitStep1Form\readInputData(), PKPReportGeneratorForm\readInputData(), QuickSubmitForm\readInputData(), ReviewerForm\readInputData(), and QueryForm\readInputData().
Form::setData | ( | $key, | |
$value = null |
|||
) |
Set the value of one or several form fields.
$key | string|array If a string, then set a single field. If an associative array, then set many. |
$value | mixed |
Definition at line 229 of file Form.inc.php.
Referenced by SubmissionFilesUploadConfirmationForm\__construct(), SubmissionFilesUploadForm\__construct(), PKPSubmissionFilesUploadBaseForm\__construct(), DataciteSettingsForm\__construct(), MedraSettingsForm\__construct(), URNSettingsForm\__construct(), DOISettingsForm\__construct(), CrossRefSettingsForm\__construct(), ReviewFormElementForm\deleteEntry(), EnrollExistingReviewerForm\execute(), CreateReviewerForm\execute(), ReviewFormElementForm\execute(), UsageStatsSettingsForm\fetch(), PKPReportGeneratorForm\fetch(), EditorDecisionWithEmailForm\fetch(), EditorDecisionForm\fetch(), SubmissionFilesUploadForm\fetch(), PKPSubmissionFilesUploadBaseForm\fetch(), ReviewerForm\fetch(), APIProfileForm\initData(), InstallLanguageForm\initData(), CriticalTimesIssueTocFormHandler\initData(), CitationStyleLanguageSettingsForm\initData(), PLNSettingsForm\initData(), SectionForm\initData(), SwordSettingsForm\initData(), UsageStatsSettingsForm\initData(), PKPReviewerReviewStep3Form\initData(), UserForm\initData(), ReviewFormForm\initData(), ReviewerNotifyActionForm\initData(), AnnouncementFeedSettingsForm\initData(), WebFeedSettingsForm\initData(), ThankReviewerForm\initData(), EditorDecisionWithEmailForm\initData(), PreviewReviewForm\initData(), PromoteForm\initData(), ReviewFormElements\initData(), ReviewReminderForm\initData(), CustomBlockForm\initData(), ManageSubmissionFilesForm\initData(), EditReviewForm\initData(), PaymentTypesForm\initData(), MarkupProfileSettingsForm\initData(), StaticPageForm\initData(), MarkupSettingsForm\initData(), SwordDepositPointForm\initData(), ManageReviewFilesForm\initData(), DOAJSettingsForm\initData(), UserGroupForm\initData(), RecommendationForm\initData(), UploadImageForm\initData(), DataciteSettingsForm\initData(), CrossRefSettingsForm\initData(), UserDetailsForm\initData(), MedraSettingsForm\initData(), PKPPublicIdentifiersForm\initData(), PKPNavigationMenuItemsForm\initData(), CategoryForm\initData(), DOISettingsForm\initData(), URNSettingsForm\initData(), ReviewerForm\initData(), QuickSubmitForm\initData(), ReviewFormElementForm\insertEntry(), PLNSettingsForm\readInputData(), AnnouncementFeedSettingsForm\readInputData(), WebFeedSettingsForm\readInputData(), InstallLanguageForm\readInputData(), UsageStatsSettingsForm\readInputData(), ContactForm\readInputData(), SwordDepositPointForm\readInputData(), RegistrationForm\readInputData(), CategoryForm\readInputData(), InstallForm\readInputData(), UserDetailsForm\readInputData(), readUserVars(), QueryForm\setAssocId(), QueryForm\setAssocType(), SubmissionFilesMetadataForm\setShowButtons(), and ReviewFormElementForm\updateEntry().
Form::setDefaultFormLocale | ( | $defaultLocale | ) |
Set the default form locale.
$defaultLocale | string |
Definition at line 356 of file Form.inc.php.
References $defaultLocale.
Referenced by PKPAuthorForm\__construct(), PKPSubmissionSubmitStep3Form\__construct(), SubmissionFilesMetadataForm\__construct(), and QuickSubmitForm\__construct().
Form::setTemplate | ( | $template | ) |
Set the template
$template | string |
Definition at line 129 of file Form.inc.php.
Referenced by EnrollExistingReviewerForm\__construct(), AdvancedSearchReviewerForm\__construct(), and CreateReviewerForm\__construct().
Form::validate | ( | $callHooks = true | ) |
Validate form data.
$callHooks | boolean True (default) iff hooks are to be called. |
Reimplemented in PKPNavigationMenuItemsForm, AddParticipantForm, NavigationMenuForm, RegistrationForm, QuickSubmitForm, PKPPublicIdentifiersForm, CategoryForm, IssueForm, SubmissionSubmitStep1Form, ArticleGalleyForm, SubmissionFilesUploadForm, IssueGalleyForm, SectionForm, PKPSubmissionSubmitStep1Form, and PKPReviewerReviewStep1Form.
Definition at line 261 of file Form.inc.php.
References $errorFields, addError(), HookRegistry\call(), PKPApplication\get(), getErrorsArray(), isValid(), and strtolower_codesafe().
Form::$_checks |
Validation checks for this form
Definition at line 56 of file Form.inc.php.
Form::$_data |
Associative array containing form data
Definition at line 53 of file Form.inc.php.
Form::$_errors |
Errors occurring in form validation
Definition at line 59 of file Form.inc.php.
Form::$_template |
The template file containing the HTML form
Definition at line 50 of file Form.inc.php.
Referenced by getTemplate().
Form::$cssValidation |
Client-side validation rules
Definition at line 71 of file Form.inc.php.
string Form::$defaultLocale |
Default form locale
Definition at line 89 of file Form.inc.php.
Referenced by getDefaultFormLocale(), and setDefaultFormLocale().
Form::$errorFields |
Array of field names where an error occurred
Definition at line 65 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 62 of file Form.inc.php.
Referenced by getErrorsArray().
Form::$formSectionErrors |
Array of errors for the form section currently being processed
Definition at line 68 of file Form.inc.php.
string Form::$requiredLocale |
Symbolic name of required locale
Definition at line 77 of file Form.inc.php.
Referenced by __construct(), getDefaultFormLocale(), and getRequiredLocale().
array Form::$supportedLocales |
Set of supported locales
Definition at line 83 of file Form.inc.php.
Referenced by __construct(), UserGroupForm\_setUserGroupLocaleFields(), and InstallLanguageForm\execute().