* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
class WebFormHelper extends BaseHelper {
+ /**
+ * Instance to the class which provides field values
+ */
+ private $valueInstance = null;
+
/**
* Wether the form tag is opened (keep at false or else your forms will
* never work!)
private $subGroupName = "";
// Class Constants
- const EXCEPTION_FORM_NAME_INVALID = 0xb00;
- const EXCEPTION_CLOSED_FORM = 0xb01;
- const EXCEPTION_OPENED_FORM = 0xb02;
- const EXCEPTION_UNEXPECTED_CLOSED_GROUP = 0xb03;
+ const EXCEPTION_FORM_NAME_INVALID = 0x030;
+ const EXCEPTION_CLOSED_FORM = 0x031;
+ const EXCEPTION_OPENED_FORM = 0x032;
+ const EXCEPTION_UNEXPECTED_CLOSED_GROUP = 0x033;
/**
- * Private constructor
+ * Protected constructor
*
* @return void
*/
parent::__construct(__CLASS__);
// Set part description
- $this->setObjectDescription("HTML-Formularhilfsklasse");
+ $this->setObjectDescription("Helper class for HTML forms");
+
+ // Create unique ID number
+ $this->generateUniqueId();
}
/**
return $helperInstance;
}
+ /**
+ * Pre-fetches field default values from the given registry key instance into this class
+ *
+ * @param $registryKey
+ * @return void
+ * @throws NullPointerException If an instance from registry is null
+ */
+ public function prefetchFieldValues ($registryKey) {
+ // Get the required instance
+ $this->valueInstance = Registry::getRegistry()->getInstance($registryKey);
+
+ // Is the instance valid?
+ if (is_null($this->valueInstance)) {
+ // Throw an exception
+ throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
+ } // END - if
+ }
+
/**
* Add the form tag or close it an already opened form tag
*
if (($this->formOpened === false) && ($formName === false)) {
// Thrown an exception
throw new InvalidFormNameException ($this, self::EXCEPTION_FORM_NAME_INVALID);
- }
+ } // END - if
// Close the form is default
$formContent = "</form>";
// Check wether we shall open or close the form
if ($this->formOpened === false) {
// Add HTML code
- $formContent = sprintf("<form name=\"%s\" class=\"forms\" action=\"%s\" method=\"%s\" target=\"%s\"",
+ $formContent = sprintf("<form name=\"%s\" class=\"forms\" action=\"%s/%s\" method=\"%s\" target=\"%s\"",
$formName,
- $this->getConfigInstance()->readConfig("form_action"),
- $this->getConfigInstance()->readConfig("form_method"),
- $this->getConfigInstance()->readConfig("form_target")
+ $this->getConfigInstance()->readConfig('base_url'),
+ $this->getConfigInstance()->readConfig('form_action'),
+ $this->getConfigInstance()->readConfig('form_method'),
+ $this->getConfigInstance()->readConfig('form_target')
);
// Is the form id set?
$this->formName = $formName;
} else {
// Add the hidden field required to identify safely this form
- $this->addInputHiddenField("form", $this->formName);
+ $this->addInputHiddenField('form', $this->formName);
// Is a group open?
if ($this->groupOpened === true) {
// Then automatically close it here
$this->addFormGroup("", "");
- }
+ } // END - if
- // @TODO Add some unique PIN here to bypass problems with some browser and/or extensions
+ /* @TODO Add some unique PIN here to bypass problems with some browser and/or extensions */
// Simply close it
$this->formOpened = false;
}
* Add a text input tag to the form or throw an exception if it is not yet
* opened. The field's name will be set as id.
*
- * @param $fieldName Input field name
- * @param $fieldSize Input size
- * @param $fieldMaxLength Input max length
- * @param $fieldValue Input default value (default: empty)
+ * @param $fieldName Input field name
+ * @param $fieldValue Input default value (default: empty)
* @return void
* @throws FormClosedException If the form is not yet opened
*/
- public function addInputTextField ($fieldName, $fieldSize, $fieldMaxLength, $fieldValue = "") {
+ public function addInputTextField ($fieldName, $fieldValue = "") {
// Is the form opened?
if ($this->formOpened === false) {
// Throw an exception
throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
- }
+ } // END - if
// Generate the content
- $inputContent = sprintf("<input type=\"text\" class=\"textfield\" id=\"%s\" name=\"%s\" size=\"%d\" maxlength=\"%d\" value=\"%s\" />",
- $fieldName, $fieldName, $fieldSize, $fieldMaxLength, $fieldValue);
+ $inputContent = sprintf("<input type=\"text\" class=\"textfield\" id=\"%s\" name=\"%s\" value=\"%s\" />",
+ $fieldName,
+ $fieldName,
+ $fieldValue
+ );
// And add it maybe with a "li" tag
$this->addContent($inputContent);
}
+ /**
+ * Add a text input tag to the form with pre-loaded default value
+ *
+ * @param $fieldName Input field name
+ * @return void
+ */
+ public function addInputTextFieldWithDefault ($fieldName) {
+ // Get the value from instance
+ $fieldValue = call_user_func_array(array($this->valueInstance, "getField"), array($fieldName));
+ //* DEBUG: */ echo __METHOD__.":".$fieldName."=".$fieldValue."<br />\n";
+
+ // Add the text field
+ $this->addInputTextField($fieldName, $fieldValue);
+ }
+
/**
* Add a password input tag to the form or throw an exception if it is not
* yet opened. The field's name will be set as id.
*
* @param $fieldName Input field name
- * @param $fieldSize Input size
- * @param $fieldMaxLength Input max length
* @param $fieldValue Input default value (default: empty)
* @return void
* @throws FormClosedException If the form is not yet opened
*/
- public function addInputPasswordField ($fieldName, $fieldSize, $fieldMaxLength, $fieldValue = "") {
+ public function addInputPasswordField ($fieldName, $fieldValue = "") {
// Is the form opened?
if ($this->formOpened === false) {
// Throw an exception
throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
- }
+ } // END - if
// Generate the content
- $inputContent = sprintf("<input type=\"password\" class=\"password\" id=\"%s\" name=\"%s\" size=\"%d\" maxlength=\"%d\" value=\"%s\" />",
- $fieldName, $fieldName, $fieldSize, $fieldMaxLength, $fieldValue);
+ $inputContent = sprintf("<input type=\"password\" class=\"password\" id=\"%s\" name=\"%s\" value=\"%s\" />",
+ $fieldName,
+ $fieldName,
+ $fieldValue
+ );
// And add it
$this->addContent($inputContent);
if ($this->formOpened === false) {
// Throw an exception
throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
- }
+ } // END - if
// Generate the content
$inputContent = sprintf("<input type=\"hidden\" name=\"%s\" value=\"%s\" />",
if ($this->formOpened === false) {
// Throw an exception
throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
- }
+ } // END - if
// Set wether the check box is checked...
$checked = " checked=\"checked\"";
if ($this->formOpened === false) {
// Throw an exception
throw new FormClosedException (array($this, "reset"), self::EXCEPTION_CLOSED_FORM);
- }
+ } // END - if
// Generate the content
$inputContent = sprintf("<input type=\"reset\" class=\"reset_button\" id=\"%s_reset\" value=\"%s\" />",
if ($this->formOpened === false) {
// Throw an exception
throw new FormClosedException (array($this, "submit"), self::EXCEPTION_CLOSED_FORM);
- }
+ } // END - if
// Generate the content
$inputContent = sprintf("<input type=\"submit\" class=\"submit_button\" id=\"%s_submit\" name=\"%s_button\" value=\"%s\" />",
if ($this->formOpened === false) {
// Throw exception here
throw new FormClosedException(array($this, $groupName), self::EXCEPTION_CLOSED_FORM);
- }
+ } // END - if
// At least the group name should be set
if ((empty($groupName)) && ($this->groupOpened === false)) {
// Throw exception here
throw new EmptyVariableException(array($this, 'groupName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
- }
+ } // END - if
// Initialize content with closing div by default
$content = " </div>\n</div><!-- Group - CLOSE //-->";
if ($this->subGroupOpened === true) {
// Close it here
$this->addFormSubGroup("", "");
- }
+ } // END - if
// Add the content
$this->addContent($content);
// All call it again if the group name is not empty
if (!empty($groupName)) {
$this->addFormGroup($groupName, $groupText);
- }
+ } // END - if
}
}
if ($this->groupOpened === false) {
// Throw exception here
throw new FormGroupClosedException(array($this, $subGroupName), self::EXCEPTION_UNEXPECTED_CLOSED_GROUP);
- }
+ } // END - if
// At least the sub group name should be set
if ((empty($subGroupName)) && ($this->subGroupOpened === false)) {
// Throw exception here
throw new EmptyVariableException(array($this, 'groupName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
- }
+ } // END - if
// Initialize content with closing div by default
$content = " </div>\n</div><!-- Sub group- CLOSE //-->";
// All call it again if sub group name is not empty
if (!empty($subGroupName)) {
$this->addFormSubGroup($subGroupName, $subGroupText);
- }
+ } // END - if
}
}
if ($this->formOpened === false) {
// Throw an exception
throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
- }
+ } // END - if
// Set the block type
$block = "div";
if ($this->formOpened === false) {
// Throw an exception
throw new FormClosedException (array($this, "form_notes"), self::EXCEPTION_CLOSED_FORM);
- }
+ } // END - if
// Is a group open?
if ($this->groupOpened === true) {
// Then automatically close it here
- $this->addFormGroup("unknown", "");
- }
+ $this->addFormGroup("", "");
+ } // END - if
// Generate the content
$inputContent = sprintf(" <div id=\"form_note\">
* @return $required Wether the email address is required
*/
public function ifRegisterRequiresEmailVerification () {
- $required = ($this->getConfigInstance()->readConfig("register_requires_email") == "Y");
+ $required = ($this->getConfigInstance()->readConfig('register_requires_email') == "Y");
return $required;
}
* @return $required Wether profile shall be asked
*/
public function ifRegisterIncludesProfile () {
- $required = ($this->getConfigInstance()->readConfig("register_includes_profile") == "Y");
+ $required = ($this->getConfigInstance()->readConfig('register_includes_profile') == "Y");
return $required;
}
* @return $required Wether personal data shall be asked
*/
public function ifRegisterIncludesPersonaData () {
- $required = ($this->getConfigInstance()->readConfig("register_personal_data") == "Y");
+ $required = ($this->getConfigInstance()->readConfig('register_personal_data') == "Y");
return $required;
}
+ /**
+ * Checks wether email addresses can only be once used
+ *
+ * @return $isUnique
+ */
+ public function ifEmailMustBeUnique () {
+ $isUnique = ($this->getConfigInstance()->readConfig('register_email_unique') == "Y");
+ return $isUnique;
+ }
+
/**
* Checks wether the specified chat protocol is enabled in this form
*
return $required;
}
+ /**
+ * Checks wether login is enabled or disabled
+ *
+ * @return $isEnabled Wether the login is enabled or disabled
+ */
+ public function ifLoginIsEnabled () {
+ $isEnabled = ($this->getConfigInstance()->readConfig('login_enabled') == "Y");
+ return $isEnabled;
+ }
+
+ /**
+ * Checks wether login shall be done by username
+ *
+ * @return $isEnabled Wether the login shall be done by username
+ */
+ public function ifLoginWithUsername () {
+ $isEnabled = ($this->getConfigInstance()->readConfig('login_type') == "username");
+ return $isEnabled;
+ }
+
+ /**
+ * Checks wether login shall be done by email
+ *
+ * @return $isEnabled Wether the login shall be done by email
+ */
+ public function ifLoginWithEmail () {
+ $isEnabled = ($this->getConfigInstance()->readConfig('login_type') == "email");
+ return $isEnabled;
+ }
+
+ /**
+ * Checks wether guest login is allowed
+ *
+ * @return $isAllowed Wether guest login is allowed
+ */
+ public function ifGuestLoginAllowed () {
+ $isAllowed = ($this->getConfigInstance()->readConfig('guest_login_allowed') == "Y");
+ return $isAllowed;
+ }
+
+ /**
+ * Checks wether the email address change must be confirmed
+ *
+ * @return $requireConfirm Wether email change must be confirmed
+ */
+ public function ifEmailChangeRequireConfirmation () {
+ $requireConfirm = ($this->getConfigInstance()->readConfig('email_change_confirmation') == "Y");
+ return $requireConfirm;
+ }
+
+ /**
+ * Checks wether the rules has been updated
+ *
+ * @return $rulesUpdated Wether rules has been updated
+ */
+ public function ifRulesHaveChanged () {
+ /* @TODO Implement check if rules have been changed */
+ return false;
+ }
+
+ /**
+ * Checks wether email change is allowed
+ *
+ * @return $emailChange Wether changing email address is allowed
+ */
+ public function ifEmailChangeAllowed () {
+ $emailChange = ($this->getConfigInstance()->readConfig('email_change_allowed') == "Y");
+ return $emailChange;
+ }
+
/**
* Flushs the content out (not yet secured against open forms, etc.!) or
* throw an exception if it is not yet closed
if ($this->formOpened === true) {
// Throw an exception
throw new FormOpenedException ($this, self::EXCEPTION_OPENED_FORM);
- }
+ } // END - if
// Send content to template engine
$this->getTemplateInstance()->assignVariable($this->formName, $this->getContent());
}
+
+ /**
+ * Getter for direct field values
+ *
+ * @param $fieldName Name of the field we shall fetch
+ * @return $fieldValue Value from field
+ */
+ public function getField ($fieldName) {
+ // Get the field value
+ $fieldValue = call_user_func_array(array($this->valueInstance, "getField"), array($fieldName));
+
+ // Return it
+ return $fieldValue;
+ }
}
// [EOF]
projects / shipsimu.git / blobdiff