*/
class WebFormHelper extends BaseWebHelper implements HelpableTemplate {
/**
- * Wether the form tag is opened (keep at false or else your forms will
+ * Whether the form tag is opened (keep at false or else your forms will
* never work!)
*/
private $formOpened = false;
private $formName = '';
/**
- * Wether form tag is enabled (default: true)
+ * Whether form tag is enabled (default: true)
*/
private $formEnabled = true;
* @param $templateInstance An instance of a valid template engine
* @param $formName Name of the form
* @param $formId Value for 'id' attribute (default: $formName)
- * @param $withForm Wether include the form tag
+ * @param $withForm Whether include the form tag
* @return $helperInstance A preparedf instance of this helper
*/
public static final function createWebFormHelper (CompileableTemplate $templateInstance, $formName, $formId = false, $withForm = true) {
// Close the form is default
$formContent = '</form>';
- // Check wether we shall open or close the form
+ // Check whether we shall open or close the form
if (($this->formOpened === false) && ($this->formEnabled === true)) {
// Add HTML code
$formContent = sprintf("<form name=\"%s\" class=\"forms\" action=\"%s/%s\" method=\"%s\" target=\"%s\"",
* yet opened. The field's name will be set as id.
*
* @param $fieldName Input field name
- * @param $fieldChecked Wether the field is checked (defaut: checked)
+ * @param $fieldChecked Whether the field is checked (defaut: checked)
* @return void
* @throws FormClosedException If the form is not yet opened
*/
throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
} // END - if
- // Set wether the check box is checked...
+ // Set whether the check box is checked...
$checked = " checked=\"checked\"";
if ($fieldChecked === false) $checked = ' ';
/**
* Enables/disables the form tag usage
*
- * @param $formEnabled Wether form is enabled or disabled
+ * @param $formEnabled Whether form is enabled or disabled
* @return void
*/
public final function enableForm ($formEnabled = true) {
}
/**
- * Checks wether the registration requires a valid email address
+ * Checks whether the registration requires a valid email address
*
- * @return $required Wether the email address is required
+ * @return $required Whether the email address is required
*/
public function ifRegisterRequiresEmailVerification () {
$required = ($this->getConfigInstance()->getConfigEntry('register_requires_email') == 'Y');
}
/**
- * Checks wether profile data shall be asked
+ * Checks whether profile data shall be asked
*
- * @return $required Wether profile data shall be asked
+ * @return $required Whether profile data shall be asked
*/
public function ifRegisterIncludesProfile () {
$required = ($this->getConfigInstance()->getConfigEntry('register_includes_profile') == 'Y');
}
/**
- * Checks wether this form is secured by a CAPTCHA
+ * Checks whether this form is secured by a CAPTCHA
*
- * @return $isSecured Wether this form is secured by a CAPTCHA
+ * @return $isSecured Whether this form is secured by a CAPTCHA
*/
public function ifFormSecuredWithCaptcha () {
$isSecured = ($this->getConfigInstance()->getConfigEntry($this->getFormName().'_captcha_secured') == 'Y');
}
/**
- * Checks wether personal data shall be asked
+ * Checks whether personal data shall be asked
*
- * @return $required Wether personal data shall be asked
+ * @return $required Whether personal data shall be asked
*/
public function ifRegisterIncludesPersonaData () {
$required = ($this->getConfigInstance()->getConfigEntry('register_personal_data') == 'Y');
}
/**
- * Checks wether for birthday shall be asked
+ * Checks whether for birthday shall be asked
*
- * @return $required Wether birthday shall be asked
+ * @return $required Whether birthday shall be asked
*/
public function ifProfileIncludesBirthDay () {
$required = ($this->getConfigInstance()->getConfigEntry('profile_includes_birthday') == 'Y');
}
/**
- * Checks wether email addresses can only be once used
+ * Checks whether email addresses can only be once used
*
* @return $isUnique
*/
}
/**
- * Checks wether the specified chat protocol is enabled in this form
+ * Checks whether the specified chat protocol is enabled in this form
*
- * @return $required Wether the specified chat protocol is enabled
+ * @return $required Whether the specified chat protocol is enabled
*/
public function ifChatEnabled ($chatProtocol) {
$required = ($this->getConfigInstance()->getConfigEntry('chat_enabled_' . $chatProtocol) == 'Y');
}
/**
- * Checks wether login is enabled or disabled
+ * Checks whether login is enabled or disabled
*
- * @return $isEnabled Wether the login is enabled or disabled
+ * @return $isEnabled Whether the login is enabled or disabled
*/
public function ifLoginIsEnabled () {
$isEnabled = ($this->getConfigInstance()->getConfigEntry('login_enabled') == 'Y');
}
/**
- * Checks wether login shall be done by username
+ * Checks whether login shall be done by username
*
- * @return $isEnabled Wether the login shall be done by username
+ * @return $isEnabled Whether the login shall be done by username
*/
public function ifLoginWithUsername () {
$isEnabled = ($this->getConfigInstance()->getConfigEntry('login_type') == "username");
}
/**
- * Checks wether login shall be done by email
+ * Checks whether login shall be done by email
*
- * @return $isEnabled Wether the login shall be done by email
+ * @return $isEnabled Whether the login shall be done by email
*/
public function ifLoginWithEmail () {
$isEnabled = ($this->getConfigInstance()->getConfigEntry('login_type') == "email");
}
/**
- * Checks wether guest login is allowed
+ * Checks whether guest login is allowed
*
- * @return $isAllowed Wether guest login is allowed
+ * @return $isAllowed Whether guest login is allowed
*/
public function ifGuestLoginAllowed () {
$isAllowed = ($this->getConfigInstance()->getConfigEntry('guest_login_allowed') == 'Y');
}
/**
- * Checks wether the email address change must be confirmed
+ * Checks whether the email address change must be confirmed
*
- * @return $requireConfirm Wether email change must be confirmed
+ * @return $requireConfirm Whether email change must be confirmed
*/
public function ifEmailChangeRequireConfirmation () {
$requireConfirm = ($this->getConfigInstance()->getConfigEntry('email_change_confirmation') == 'Y');
}
/**
- * Checks wether the rules has been updated
+ * Checks whether the rules has been updated
*
- * @return $rulesUpdated Wether rules has been updated
+ * @return $rulesUpdated Whether rules has been updated
* @todo Implement check if rules have been changed
*/
public function ifRulesHaveChanged () {
}
/**
- * Checks wether email change is allowed
+ * Checks whether email change is allowed
*
- * @return $emailChange Wether changing email address is allowed
+ * @return $emailChange Whether changing email address is allowed
*/
public function ifEmailChangeAllowed () {
$emailChange = ($this->getConfigInstance()->getConfigEntry('email_change_allowed') == 'Y');
}
/**
- * Checks wether the user account is unconfirmed
+ * Checks whether the user account is unconfirmed
*
- * @return $isUnconfirmed Wether the user account is unconfirmed
+ * @return $isUnconfirmed Whether the user account is unconfirmed
*/
public function ifUserAccountUnconfirmed () {
$isUnconfirmed = ($this->getValueField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS) === $this->getConfigInstance()->getConfigEntry('user_status_unconfirmed'));
}
/**
- * Checks wether the user account is locked
+ * Checks whether the user account is locked
*
- * @return $isUnconfirmed Wether the user account is locked
+ * @return $isUnconfirmed Whether the user account is locked
*/
public function ifUserAccountLocked () {
$isUnconfirmed = ($this->getValueField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS) === $this->getConfigInstance()->getConfigEntry('user_status_locked'));
}
/**
- * Checks wether the user account is a guest
+ * Checks whether the user account is a guest
*
- * @return $isUnconfirmed Wether the user account is a guest
+ * @return $isUnconfirmed Whether the user account is a guest
*/
public function ifUserAccountGuest () {
$isUnconfirmed = ($this->getValueField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS) === $this->getConfigInstance()->getConfigEntry('user_status_guest'));
}
/**
- * Checks wether the refill page is active which should be not the default
+ * Checks whether the refill page is active which should be not the default
* on non-web applications.
*
- * @return $refillActive Wether the refill page is active
+ * @return $refillActive Whether the refill page is active
*/
public function ifRefillPageActive () {
$refillActive = ($this->getConfigInstance()->getConfigEntry('refill_page_active') == 'Y');