<?php
// Own namespace
namespace Org\Mxchange\CoreFramework\Helper;

// Import framework stuff
use Org\Mxchange\CoreFramework\Database\Frontend\User\UserDatabaseWrapper;
use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
use Org\Mxchange\CoreFramework\Generic\NullPointerException;
use Org\Mxchange\CoreFramework\Helper\Template\HelpableTemplate;
use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
use Org\Mxchange\CoreFramework\Template\CompileableTemplate;

// Import SPL stuff
use \InvalidArgumentException;

/**
 * A helper for constructing web forms
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.shipsimu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate {
	/**
	 * Whether the form tag is opened (keep at false or else your forms will
	 * never work!)
	 */
	private $formOpened = false;

	/**
	 * Name of current form
	 */
	private $formName = '';

	/**
	 * Id of current form
	 */
	private $formId = '';

	/**
	 * Whether form tag is enabled (default: true)
	 */
	private $formEnabled = true;

	// Class Constants
	const EXCEPTION_FORM_NAME_INVALID       = 0x120;
	const EXCEPTION_CLOSED_FORM             = 0x121;
	const EXCEPTION_OPENED_FORM             = 0x122;
	const EXCEPTION_UNEXPECTED_CLOSED_GROUP = 0x123;

	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates the helper class with the given template engine instance and form name
	 *
	 * @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			Whether include the form tag
	 * @return	$helperInstance		A preparedf instance of this helper
	 */
	public static final function createHtmlFormHelper (CompileableTemplate $templateInstance, $formName, $formId = false, $withForm = true) {
		// Get new instance
		$helperInstance = new HtmlFormHelper();

		// Set template instance
		$helperInstance->setTemplateInstance($templateInstance);

		// Is the form id not set?
		if ($formId === false) {
			// Use form id from form name
			$formId = $formName;
		} // END - if

		// Set form name
		$helperInstance->setFormName($formName);

		// A form-less field may say 'false' here...
		if ($withForm === true) {
			// Create the form
			$helperInstance->addFormTag($formName, $formId);
		} else {
			// Disable form
			$helperInstance->enableForm(false);
		}

		// Return the prepared instance
		return $helperInstance;
	}

	/**
	 * Add the form tag or close it an already opened form tag
	 *
	 * @param	$formName	Name of the form (default: false)
	 * @param	$formId		Id of the form (attribute 'id'; default: false)
	 * @return	void
	 * @throws	InvalidFormNameException	If the form name is invalid ( = false)
	 * @todo	Add some unique PIN here to bypass problems with some browser and/or extensions
	 */
	public function addFormTag ($formName = false, $formId = false) {
		// When the form is not yet opened at least form name must be valid
		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 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\" id=\"%s_form\">",
				$formName,
				$this->getConfigInstance()->getConfigEntry('base_url'),
				$this->getConfigInstance()->getConfigEntry('form_action'),
				$this->getConfigInstance()->getConfigEntry('form_method'),
				$this->getConfigInstance()->getConfigEntry('form_target'),
				$formId
			);

			// Open the form and remeber the form name and id
			$this->formName = $formName;
			$this->formId = $formId;
			$this->formOpened = true;

			// Add it to the content
			$this->addHeaderContent($formContent);
		} else {
			// Add the hidden field required to identify safely this form
			$this->addInputHiddenField('form', $this->getFormName());

			// Is a group open?
			if ($this->ifGroupOpenedPreviously()) {
				// Then automatically close it here
				$this->addFormGroup();
			} // END - if

			// Simply close it
			$this->formOpened = false;

			// Add it to the content
			$this->addFooterContent($formContent);
		}
	}

	/**
	 * 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	$fieldValue		Input default value (default: empty)
	 * @return	void
	 * @throws	FormClosedException		If the form is not yet opened
	 */
	public function addInputTextField ($fieldName, $fieldValue = '') {
		// Is the form opened?
		if (($this->formOpened === false) && ($this->formEnabled === true)) {
			// Throw an exception
			throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
		} // END - if

		// Generate the content
		$inputContent = sprintf('<input type="text" class="form-control" id="%s_%s_field" name="%s" value="%s" />',
			$this->getFormId(),
			$fieldName,
			$fieldName,
			$fieldValue
		);

		// And add it maybe with a 'li' tag
		$this->addContentToPreviousGroup($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 = $this->getValueField($fieldName);
		//* DEBUG: */ print __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	$fieldValue		Input default value (default: empty)
	 * @return	void
	 * @throws	FormClosedException		If the form is not yet opened
	 */
	public function addInputPasswordField ($fieldName, $fieldValue = '') {
		// Is the form opened?
		if (($this->formOpened === false) && ($this->formEnabled === true)) {
			// Throw an exception
			throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
		} // END - if

		// Generate the content
		$inputContent = sprintf('<input type="password" class="form-control" id="%s_%s_field" name="%s" value="%s" />',
			$this->getFormId(),
			$fieldName,
			$fieldName,
			$fieldValue
		);

		// And add it
		$this->addContentToPreviousGroup($inputContent);
	}

	/**
	 * Add a hidden 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	$fieldValue		Input default value (default: empty)
	 * @return	void
	 * @throws	FormClosedException		If the form is not yet opened
	 */
	public function addInputHiddenField ($fieldName, $fieldValue = '') {
		// Is the form opened?
		if (($this->formOpened === false) && ($this->formEnabled === true)) {
			// 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" />',
			$fieldName,
			$fieldValue
		);

		// And add it
		$this->addContentToPreviousGroup($inputContent);
	}

	/**
	 * Add a hidden input tag to the form with pre-loaded default value
	 *
	 * @param	$fieldName	Input field name
	 * @return	void
	 */
	public function addInputHiddenFieldWithDefault ($fieldName) {
		// Get the value from instance
		$fieldValue = $this->getValueField($fieldName);
		//* DEBUG: */ print __METHOD__.':'.$fieldName.'='.$fieldValue."<br />\n";

		// Add the text field
		$this->addInputHiddenField($fieldName, $fieldValue);
	}

	/**
	 * Add a hidden input tag to the form with configuration value
	 *
	 * @param	$fieldName	Input field name
	 * @param	$prefix		Prefix for configuration without trailing _
	 * @return	void
	 */
	public function addInputHiddenConfiguredField ($fieldName, $prefix) {
		// Get the value from instance
		$fieldValue = $this->getConfigInstance()->getConfigEntry("{$prefix}_{$fieldName}");
		//* DEBUG: */ print __METHOD__.':'.$fieldName.'='.$fieldValue."<br />\n";

		// Add the text field
		$this->addInputHiddenField($fieldName, $fieldValue);
	}

	/**
	 * Add a checkbox 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	$fieldChecked	Whether the field is checked (defaut: checked)
	 * @return	void
	 * @throws	FormClosedException		If the form is not yet opened
	 */
	public function addInputCheckboxField ($fieldName, $fieldChecked = true) {
		// Is the form opened?
		if (($this->formOpened === false) && ($this->formEnabled === true)) {
			// Throw an exception
			throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
		} // END - if

		// Set whether the check box is checked...
		$checked = ' checked="checked"';
		if ($fieldChecked === false) $checked = ' ';

		// Generate the content
		$inputContent = sprintf('<input type="checkbox" name="%s" class="checkbox" id="%s_%s_field" value="1"%s />',
			$this->getFormId(),
			$fieldName,
			$fieldName,
			$checked
		);

		// And add it
		$this->addContentToPreviousGroup($inputContent);
	}

	/**
	 * Add a reset 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	$buttonText		Text displayed on the button
	 * @return	void
	 * @throws	FormClosedException		If the form is not yet opened
	 */
	public function addInputResetButton ($buttonText) {
		// Is the form opened?
		if (($this->formOpened === false) && ($this->formEnabled === true)) {
			// 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" />',
			$this->getFormId(),
			$buttonText
		);

		// And add it
		$this->addContentToPreviousGroup($inputContent);
	}

	/**
	 * Add a reset 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	$buttonText		Text displayed on the button
	 * @return	void
	 * @throws	FormClosedException		If the form is not yet opened
	 */
	public function addInputSubmitButton ($buttonText) {
		// Is the form opened?
		if (($this->formOpened === false) && ($this->formEnabled === true)) {
			// 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_submit" value="%s" />',
			$this->getFormId(),
			$this->getFormId(),
			$buttonText
		);

		// And add it
		$this->addContentToPreviousGroup($inputContent);
	}

	/**
	 * Add a form group or close an already opened and open a new one
	 *
	 * @param	$groupId	Name of the group or last opened if empty
	 * @param	$groupText	Text including HTML to show above this group
	 * @return	void
	 * @throws	FormClosedException		If no form has been opened before
	 * @throws	InvalidArgumentException	If $groupId is not set
	 */
	public function addFormGroup ($groupId = '', $groupText = '') {
		// Is a form opened?
		if (($this->formOpened === false) && ($this->formEnabled === true)) {
			// Throw exception here
			throw new FormClosedException(array($this, $groupId), self::EXCEPTION_CLOSED_FORM);
		} elseif ((empty($groupId)) && ($this->ifGroupOpenedPreviously() === false)) {
			// Throw exception here
			throw new InvalidArgumentException('Parameter "groupId" is empty but group is not closed');
		} elseif (empty($groupId)) {
			// Close the last opened
			$groupId = $this->getPreviousGroupId();
		}

		// Same group to open?
		if (($this->ifGroupOpenedPreviously() === false) && ($groupId === $this->getPreviousGroupId())) {
			// Abort here silently
			return false;
		} // END - if

		// Initialize content with closing div by default
		$content = "	</div>\n</div><!-- Group - CLOSE //-->";

		// Is this group opened?
		if ($this->ifGroupOpenedPreviously() === false) {
			// Begin the div/span blocks
			$content = sprintf("<!-- Group %s - OPEN //-->
<div class=\"group_box\" id=\"%s_group_box\">
	<span class=\"group_text\" id=\"%s_group_text\">
		%s
	</span>
	<div class=\"group_field\" id=\"%s_group_field\">",
				$groupId,
				$groupId,
				$groupId,
				$groupText,
				$groupId
			);

			// Switch the state
			$this->openGroupByIdContent($groupId, $content, "div");
		} else {
			// Is a sub group opened?
			if ($this->ifSubGroupOpenedPreviously()) {
				// Close it here
				$this->addFormSubGroup();
			} // END - if

			// Get previous group id
			$prevGroupId = $this->getPreviousGroupId();

			// Switch the state
			$this->closePreviousGroupByContent($content);

			// All call it again if group name is not empty
			if ((!empty($groupId)) && ($groupId != $prevGroupId)) {
				//* DEBUG: */ echo $groupId.'/'.$prevGroupId."<br />\n";
				$this->addFormGroup($groupId, $groupText);
			} // END - if
		}
	}

	/**
	 * Add a form sub group or close an already opened and open a new one or
	 * throws an exception if no group has been opened before or if sub group
	 * name is empty.
	 *
	 * @param	$subGroupId		Name of the group or last opened if empty
	 * @param	$subGroupText	Text including HTML to show above this group
	 * @return	void
	 * @throws	FormFormClosedException		If no group has been opened before
	 * @throws	InvalidArgumentException		If $subGroupId is not set
	 */
	public function addFormSubGroup ($subGroupId = '', $subGroupText = '') {
		// Is a group opened?
		if ($this->ifGroupOpenedPreviously() === false) {
			// Throw exception here
			throw new FormFormClosedException(array($this, $subGroupId), self::EXCEPTION_UNEXPECTED_CLOSED_GROUP);
		} elseif ((empty($subGroupId)) && ($this->ifSubGroupOpenedPreviously() === false)) {
			// Throw exception here
			throw new InvalidArgumentException('Parameter "subGroupId" is empty but sub-group is not closed');
		} elseif (empty($subGroupId)) {
			// Close the last opened
			$subGroupId = $this->getPreviousSubGroupId();
		}

		// Same sub group to open?
		if (($this->ifSubGroupOpenedPreviously() === false) && ($subGroupId == $this->getPreviousSubGroupId())) {
			// Abort here silently
			return false;
		} // END - if

		// Initialize content with closing div by default
		$content = "	</div>\n</div><!-- Sub group- CLOSE //-->";

		// Is this group opened?
		if ($this->ifSubGroupOpenedPreviously() === false) {
			// Begin the span block
			$content = sprintf("<!-- Sub group %s - OPEN //-->
<div class=\"subgroup_box\" id=\"%s_subgroup_box\">
	<span class=\"subgroup_text\" id=\"%s_subgroup_text\">
		%s
	</span>
	<div class=\"subgroup_field\" id=\"%s_subgroup_field\">",
				$subGroupId,
				$subGroupId,
				$subGroupId,
				$subGroupText,
				$subGroupId
			);

			// Switch the state and remeber the name
			$this->openSubGroupByIdContent($subGroupId, $content, "div");
		} else {
			// Get previous sub group id
			$prevSubGroupId = $this->getPreviousSubGroupId();

			// Switch the state
			$this->closePreviousSubGroupByContent($content);

			// All call it again if sub group name is not empty
			if ((!empty($subGroupId)) && ($subGroupId != $prevSubGroupId)) {
				$this->addFormSubGroup($subGroupId, $subGroupText);
			} // END - if
		}
	}

	/**
	 * Adds text surrounded by a label tag for given form field
	 *
	 * @param	$fieldName		Field name
	 * @param	$fieldText		Text for the field
	 * @param	$fieldTitle		Optional title for label tag
	 * @return	void
	 * @throws	FormClosedException		If the form is not yet opened
	 */
	public function addFieldLabel ($fieldName, $fieldText, $fieldTitle = '') {
		// Is the form opened?
		if (($this->formOpened === false) && ($this->formEnabled === true)) {
			// Throw an exception
			throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
		} // END - if

		// Default is no title attribute
		$titleAttribute = '';

		// Is title given?
		if (!empty($fieldTitle)) {
			// Create title attribute
			$titleAttribute = sprintf(' title="%s" data-toggle="tooltip"', $fieldTitle);
		} // END - if

		// Generate the content
		$inputContent = sprintf('<label class="control-label" for="%s_%s_field"%s>
	%s
</label>',
			$this->getFormId(),
			$fieldName,
			$titleAttribute,
			$fieldText
		);

		// And add it
		$this->addContentToPreviousGroup($inputContent);
	}

	/**
	 * Add text (notes) surrounded by a div block. Still opened groups or sub
	 * groups will be automatically closed.
	 *
	 * @param	$noteId		Id for this note
	 * @param	$formNotes	The form notes we shell addd
	 * @return	void
	 * @throws	FormClosedException		If the form is not yet opened
	 */
	public function addFormNote ($noteId, $formNotes) {
		// Is the form opened?
		if (($this->formOpened === false) && ($this->formEnabled === true)) {
			// Throw an exception
			throw new FormClosedException (array($this, 'form_notes'), self::EXCEPTION_CLOSED_FORM);
		} // END - if

		// Generate the content
		$inputContent = sprintf("	<div id=\"form_note_%s\">
		%s
	</div>",
			$noteId,
			$formNotes
		);

		// And add it
		$this->addContentToPreviousGroup($inputContent);
	}

	/**
	 * Adds a selection box as a sub group to the form. Do not box this into
	 * another sub group. Sub-sub groups are not (yet) supported.
	 *
	 * @param	$selectId		Id of the selection box
	 * @param	$firstEntry		Content to be added as first non-selectable entry
	 * @return	void
	 * @throws	FormClosedException		If the form is not yet opened
	 */
	public function addInputSelectField ($selectId, $firstEntry) {
		// Is the form group opened?
		if (($this->formOpened === false) && ($this->formEnabled === true)) {
			// Throw an exception
			throw new FormClosedException (array($this, 'form_notes'), self::EXCEPTION_CLOSED_FORM);
		} // END - if

		// Shall we close or open the sub group?
		if (($this->ifSubGroupOpenedPreviously() === false) && ($this->getPreviousSubGroupId() !== $selectId)) {
			// Initialize first entry (which might be non-selectable if content is provided
			if (!empty($firstEntry)) {
				// Add selection around it
				$firstEntry = sprintf("<option value=\"invalid\" disabled=\"disabled\">%s</option>\n",
					$firstEntry
				);
			} // END - if

			// Construct the opening select tag
			$content = sprintf("<select class=\"select_box\" id=\"%s_%s\" name=\"%s\">\n%s",
				$this->getFormName(),
				$selectId,
				$selectId,
				$firstEntry
			);

			// Open the sub group
			$this->openSubGroupByIdContent($selectId, $content, "select");
		} elseif ($this->getPreviousSubGroupId() != $selectId) {
			// Something went wrong!
			$this->debugInstance(__METHOD__."(): Previous sub group id {$this->getPreviousSubGroupId()} does not match current id {$selectId}.");
		} else {
			// Close the sub group
			$this->closePreviousSubGroupByContent("</select>");
		}
	}

	/**
	 * Adds a non-selectable sub option to a previously added selection box.
	 * This method does *not* validate if there is already a sub option added
	 * with the same name. We need to finish this here!
	 *
	 * @param	$subName	Name of the sub action
	 * @param	$subValue	Value of the sub action
	 * @return	void
	 * @throws	HelperNoPreviousOpenedSubGroupException	If no previously opened sub group was found
	 * @todo	Add checking if sub option is already added
	 */
	public function addSelectSubOption ($subName, $subValue) {
		// Is there a sub group (shall be a selection box!)
		if ($this->ifSubGroupOpenedPreviously() === false) {
			// Then throw an exception here
			throw new HelperNoPreviousOpenedSubGroupException(array($this, $content), self::EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED);
		} // END - if

		// Render the content
		$content = sprintf("<option value=\"invalid\" class=\"suboption suboption_%s\" disabled=\"disabled\">%s</option>\n",
			$subName,
			$subValue
		);

		// Add the content to the previously opened sub group
		$this->addContentToPreviousGroup($content);
	}

	/**
	 * Adds a selectable option to a previously added selection box. This method
	 * does *not* validate if there is already a sub option added with the same
	 * name. We need to finish this here!
	 *
	 * @param	$optionName	Name of the sub action
	 * @param	$optionValue	Value of the sub action
	 * @return	void
	 * @throws	HelperNoPreviousOpenedSubGroupException	If no previously opened sub group was found
	 * @todo	Add checking if sub option is already added
	 */
	public function addSelectOption ($optionName, $optionValue) {
		// Is there a sub group (shall be a selection box!)
		if ($this->ifSubGroupOpenedPreviously() === false) {
			// Then throw an exception here
			throw new HelperNoPreviousOpenedSubGroupException(array($this, $content), self::EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED);
		} // END - if

		// Render the content
		$content = sprintf("<option value=\"%s\" class=\"option option_%s\">%s</option>\n",
			$optionName,
			$optionName,
			$optionValue
		);

		// Add the content to the previously opened sub group
		$this->addContentToPreviousGroup($content);
	}

	/**
	 * Adds a pre-configured CAPTCHA
	 *
	 * @return	void
	 */
	public function addCaptcha () {
		// Init instance
		$extraInstance = NULL;

		try {
			// Get last executed pre filter
			$extraInstance = GenericRegistry::getRegistry()->getInstance('extra');
		} catch (NullPointerException $e) {
			// Instance in registry is not set (NULL)
			// @TODO We need to log this later
		}

		// Get a configured instance
		$captchaInstance = ObjectFactory::createObjectByConfiguredName($this->getFormName() . '_captcha_class', array($this, $extraInstance));

		// Initiate the CAPTCHA
		$captchaInstance->initiateCaptcha();

		// Render the CAPTCHA code
		$captchaInstance->renderCode();

		// Get the content and add it to the helper
		$this->addContentToPreviousGroup($captchaInstance->renderContent());
	}

	/**
	 * Enables/disables the form tag usage
	 *
	 * @param	$formEnabled	Whether form is enabled or disabled
	 * @return	void
	 */
	public final function enableForm ($formEnabled = true) {
		$this->formEnabled = (bool) $formEnabled;
	}

	/**
	 * Setter for form name
	 *
	 * @param	$formName	Name of this form
	 * @return	void
	 */
	public final function setFormName ($formName) {
		$this->formName = (string) $formName;
	}

	/**
	 * Getter for form name
	 *
	 * @return	$formName	Name of this form
	 */
	public final function getFormName () {
		return $this->formName;
	}

	/**
	 * Setter for form id
	 *
	 * @param	$formId	Id of this form
	 * @return	void
	 */
	public final function setFormId ($formId) {
		$this->formId = (string) $formId;
	}

	/**
	 * Getter for form id
	 *
	 * @return	$formId	Id of this form
	 */
	public final function getFormId () {
		return $this->formId;
	}

	/**
	 * Checks whether the registration requires a valid email address
	 *
	 * @return	$required	Whether the email address is required
	 */
	public function ifRegisterRequiresEmailVerification () {
		$required = ($this->getConfigInstance()->getConfigEntry('register_requires_email') == 'Y');
		return $required;
	}

	/**
	 * Checks whether profile data shall be asked
	 *
	 * @return	$required	Whether profile data shall be asked
	 */
	public function ifRegisterIncludesProfile () {
		$required = ($this->getConfigInstance()->getConfigEntry('register_includes_profile') == 'Y');
		return $required;
	}

	/**
	 * Checks whether 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');
		return $isSecured;
	}

	/**
	 * Checks whether personal data shall be asked
	 *
	 * @return	$required	Whether personal data shall be asked
	 */
	public function ifRegisterIncludesPersonaData () {
		$required = ($this->getConfigInstance()->getConfigEntry('register_personal_data') == 'Y');
		return $required;
	}

	/**
	 * Checks whether for birthday shall be asked
	 *
	 * @return	$required	Whether birthday shall be asked
	 */
	public function ifProfileIncludesBirthDay () {
		$required = ($this->getConfigInstance()->getConfigEntry('profile_includes_birthday') == 'Y');
		return $required;
	}

	/**
	 * Checks whether email addresses can only be once used
	 *
	 * @return	$isUnique
	 */
	public function ifEmailMustBeUnique () {
		$isUnique = ($this->getConfigInstance()->getConfigEntry('register_email_unique') == 'Y');
		return $isUnique;
	}

	/**
	 * Checks whether the specified chat protocol is enabled in this form
	 *
	 * @return	$required	Whether the specified chat protocol is enabled
	 */
	public function ifChatEnabled ($chatProtocol) {
		$required = ($this->getConfigInstance()->getConfigEntry('chat_enabled_' . $chatProtocol) == 'Y');
		return $required;
	}

	/**
	 * Checks whether login is enabled or disabled
	 *
	 * @return	$isEnabled	Whether the login is enabled or disabled
	 */
	public function ifLoginIsEnabled () {
		$isEnabled = ($this->getConfigInstance()->getConfigEntry('login_enabled') == 'Y');
		return $isEnabled;
	}

	/**
	 * Checks whether 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");
		return $isEnabled;
	}

	/**
	 * Checks whether 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");
		return $isEnabled;
	}

	/**
	 * Checks whether guest login is allowed
	 *
	 * @return	$isAllowed	Whether guest login is allowed
	 */
	public function ifGuestLoginAllowed () {
		$isAllowed = ($this->getConfigInstance()->getConfigEntry('guest_login_allowed') == 'Y');
		return $isAllowed;
	}

	/**
	 * Checks whether the email address change must be confirmed
	 *
	 * @return	$requireConfirm		Whether email change must be confirmed
	 */
	public function ifEmailChangeRequireConfirmation () {
		$requireConfirm = ($this->getConfigInstance()->getConfigEntry('email_change_confirmation') == 'Y');
		return $requireConfirm;
	}

	/**
	 * Checks whether the rules has been updated
	 *
	 * @return	$rulesUpdated	Whether rules has been updated
	 * @todo	Implement check if rules have been changed
	 */
	public function ifRulesHaveChanged () {
		return false;
	}

	/**
	 * Checks whether email change is allowed
	 *
	 * @return	$emailChange	Whether changing email address is allowed
	 */
	public function ifEmailChangeAllowed () {
		$emailChange = ($this->getConfigInstance()->getConfigEntry('email_change_allowed') == 'Y');
		return $emailChange;
	}

	/**
	 * Checks whether 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'));
		return $isUnconfirmed;
	}

	/**
	 * Checks whether 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'));
		return $isUnconfirmed;
	}

	/**
	 * Checks whether 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'));
		return $isUnconfirmed;
	}

	/**
	 * Checks whether the refill page is active which should be not the default
	 * on non-web applications.
	 *
	 * @return	$refillActive	Whether the refill page is active
	 */
	public function ifRefillPageActive () {
		$refillActive = ($this->getConfigInstance()->getConfigEntry('refill_page_active') == 'Y');
		return $refillActive;
	}

	/**
	 * Flushs the content out (not yet secured against open forms, etc.!) or
	 * close the form automatically
	 *
	 * @return	void
	 * @throws	FormOpenedException		If the form is still open
	 */
	public function flushContent () {
		// Is the form still open?
		if (($this->formOpened === true) && ($this->formEnabled === true)) {
			// Close the form automatically
			$this->addFormTag();
		} elseif ($this->formEnabled === false) {
			if ($this->ifSubGroupOpenedPreviously()) {
				// Close sub group
				$this->addFormSubGroup();
			} elseif ($this->ifGroupOpenedPreviously()) {
				// Close group
				$this->addFormGroup();
			}
		}

		// Send content to template engine
		//* DEBUG: */ print __METHOD__.": form=".$this->getFormName().", size=".strlen($this->renderContent())."<br />\n";
		$this->getTemplateInstance()->assignVariable($this->getFormName(), $this->renderContent());
	}

}