", $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 } } /** * Add text surrounded by a span block when there is a group opened before * or else by a div block. * * @param $fieldName Field name * @param $fieldText Text for the field * @return void * @throws FormClosedException If the form is not yet opened */ public function addFieldText ($fieldName, $fieldText) { // 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 the block type $block = 'div'; if ($this->ifGroupOpenedPreviously()) $block = 'span'; // Generate the content $inputContent = sprintf(" <%s id=\"%s_text\"> %s ", $block, $fieldName, $fieldText, $block ); // 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(" ", $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("%s\n", $firstEntry ); } // END - if // Construct the opening select tag $content = sprintf("\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(""); } } /** * 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("%s\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("%s\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 = Registry::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', 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; } /** * 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())."
\n"; $this->getTemplateInstance()->assignVariable($this->getFormName(), $this->renderContent()); } } // [EOF] ?>