class_WebFormHelper.php

Go to the documentation of this file.

<?php
class WebFormHelper extends BaseWebHelper implements HelpableTemplate {
        private $formOpened = false;

        private $formName = "";

        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 function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
        }

        public final static function createWebFormHelper (CompileableTemplate $templateInstance, $formName, $formId = false, $withForm = true) {
                // Get new instance
                $helperInstance = new WebFormHelper();

                // 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;
        }

        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 wether 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\"",
                                $formName,
                                $this->getConfigInstance()->readConfig('base_url'),
                                $this->getConfigInstance()->readConfig('form_action'),
                                $this->getConfigInstance()->readConfig('form_method'),
                                $this->getConfigInstance()->readConfig('form_target')
                        );

                        // Add form id as well
                        $formContent .= sprintf(" id=\"%s_form\"",
                                $formId
                        );

                        // Add close bracket
                        $formContent .= ">";

                        // Open the form and remeber the form name
                        $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);
                }
        }

        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=\"textfield %s_field\" name=\"%s\" value=\"%s\" />",
                        $fieldName,
                        $fieldName,
                        $fieldValue
                );

                // And add it maybe with a "li" tag
                $this->addContentToPreviousGroup($inputContent);
        }

        public function addInputTextFieldWithDefault ($fieldName) {
                // Get the value from instance
                $fieldValue = $this->getValueField($fieldName);
                //* DEBUG: */ echo __METHOD__.":".$fieldName."=".$fieldValue."<br />\n";

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

        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=\"password %s_field\" name=\"%s\" value=\"%s\" />",
                        $fieldName,
                        $fieldName,
                        $fieldValue
                );

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

        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);
        }

        public function addInputHiddenFieldWithDefault ($fieldName) {
                // Get the value from instance
                $fieldValue = $this->getValueField($fieldName);
                //* DEBUG: */ echo __METHOD__.":".$fieldName."=".$fieldValue."<br />\n";

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

        public function addInputHiddenConfiguredField ($fieldName, $prefix) {
                // Get the value from instance
                $fieldValue = $this->getConfigInstance()->readConfig("{$prefix}_{$fieldName}");
                //* DEBUG: */ echo __METHOD__.":".$fieldName."=".$fieldValue."<br />\n";

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

        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 wether the check box is checked...
                $checked = " checked=\"checked\"";
                if ($fieldChecked === false) $checked = " ";

                // Generate the content
                $inputContent = sprintf("<input type=\"checkbox\" name=\"%s\" class=\"checkbox %s_field\" value=\"1\"%s/>",
                        $fieldName,
                        $fieldName,
                        $checked
                );

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

        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->getFormName(),
                        $buttonText
                );

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

        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_button\" value=\"%s\" />",
                        $this->getFormName(),
                        $this->getFormName(),
                        $buttonText
                );

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

        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);
                } // END - if

                // At least the group name should be set
                if ((empty($groupId)) && ($this->ifGroupOpenedPreviously() === false)) {
                        // Throw exception here
                        throw new EmptyVariableException(array($this, 'groupId'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
                } 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
                }
        }

        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);
                } // END - if

                // At least the sub group name should be set
                if ((empty($subGroupId)) && ($this->ifSubGroupOpenedPreviously() === false)) {
                        // Throw exception here
                        throw new EmptyVariableException(array($this, 'subGroupId'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
                } 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
                }
        }

        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
        </%s>",
                        $block,
                        $fieldName,
                        $fieldText,
                        $block
                );

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

        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);
        }

        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>");
                }
        }

        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);
        }

        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);
        }

        public function addCaptcha () {
                // Get last executed pre filter
                $extraInstance = Registry::getRegistry()->getInstance('extra');

                // 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());
        }

        public final function enableForm ($formEnabled = true) {
                $this->formEnabled = (bool) $formEnabled;
        }

        public final function setFormName ($formName) {
                $this->formName = (string) $formName;
        }

        public final function getFormName () {
                return $this->formName;
        }

        public function ifRegisterRequiresEmailVerification () {
                $required = ($this->getConfigInstance()->readConfig('register_requires_email') === "Y");
                return $required;
        }

        public function ifRegisterIncludesProfile () {
                $required = ($this->getConfigInstance()->readConfig('register_includes_profile') === "Y");
                return $required;
        }

        public function ifFormSecuredWithCaptcha () {
                $isSecured = ($this->getConfigInstance()->readConfig($this->getFormName().'_captcha_secured') === "Y");
                return $isSecured;
        }

        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: */ echo __METHOD__.": form=".$this->getFormName().", size=".strlen($this->renderContent())."<br />\n";
                $this->getTemplateInstance()->assignVariable($this->getFormName(), $this->renderContent());
        }
}

// [EOF]
?>