X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=framework%2Fmain%2Fclasses%2Fhelper%2Fhtml%2Fforms%2Fclass_HtmlFormHelper.php;h=967ad93fcfd882feffe46811a82cd9a2e3802d35;hp=53e624be4ce60ca17601b5edab4d7f1a0cda9ad5;hb=refs%2Fheads%2Fmaster;hpb=f57dd51863ec9baacba447d76b46d5c709b9b02e diff --git a/framework/main/classes/helper/html/forms/class_HtmlFormHelper.php b/framework/main/classes/helper/html/forms/class_HtmlFormHelper.php index 53e624be..967ad93f 100644 --- a/framework/main/classes/helper/html/forms/class_HtmlFormHelper.php +++ b/framework/main/classes/helper/html/forms/class_HtmlFormHelper.php @@ -3,11 +3,12 @@ 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\Bootstrap\FrameworkBootstrap; +use Org\Mxchange\CoreFramework\Database\Frontend\User\UserDatabaseFrontend; +use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory; use Org\Mxchange\CoreFramework\Generic\NullPointerException; use Org\Mxchange\CoreFramework\Helper\Template\HelpableTemplate; -use Org\Mxchange\CoreFramework\Registry\GenericRegistry; +use Org\Mxchange\CoreFramework\Registry\Object\ObjectRegistry; use Org\Mxchange\CoreFramework\Template\CompileableTemplate; // Import SPL stuff @@ -18,7 +19,7 @@ use \InvalidArgumentException; * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.shipsimu.org * @@ -68,7 +69,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * * @return void */ - protected function __construct () { + private function __construct () { // Call parent constructor parent::__construct(__CLASS__); } @@ -82,7 +83,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @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) { + public static final function createHtmlFormHelper (CompileableTemplate $templateInstance, string $formName, string $formId = NULL, bool $withForm = true) { // Get new instance $helperInstance = new HtmlFormHelper(); @@ -90,10 +91,10 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { $helperInstance->setTemplateInstance($templateInstance); // Is the form id not set? - if ($formId === false) { + if (is_null($formId)) { // Use form id from form name $formId = $formName; - } // END - if + } // Set form name $helperInstance->setFormName($formName); @@ -120,12 +121,12 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @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) { + public function addFormTag (string $formName = NULL, string $formId = NULL) { // When the form is not yet opened at least form name must be valid - if (($this->formOpened === false) && ($formName === false)) { + if (($this->formOpened === false) && (is_null($formName))) { // Thrown an exception throw new InvalidFormNameException ($this, self::EXCEPTION_FORM_NAME_INVALID); - } // END - if + } // Close the form is default $formContent = ''; @@ -135,10 +136,10 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { // Add HTML code $formContent = sprintf("
", $formName, - $this->getConfigInstance()->getConfigEntry('base_url'), - $this->getConfigInstance()->getConfigEntry('form_action'), - $this->getConfigInstance()->getConfigEntry('form_method'), - $this->getConfigInstance()->getConfigEntry('form_target'), + FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('base_url'), + FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('form_action'), + FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('form_method'), + FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('form_target'), $formId ); @@ -157,7 +158,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { if ($this->ifGroupOpenedPreviously()) { // Then automatically close it here $this->addFormGroup(); - } // END - if + } // Simply close it $this->formOpened = false; @@ -176,12 +177,12 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @return void * @throws FormClosedException If the form is not yet opened */ - public function addInputTextField ($fieldName, $fieldValue = '') { + public function addInputTextField (string $fieldName, string $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('', @@ -201,7 +202,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @param $fieldName Input field name * @return void */ - public function addInputTextFieldWithDefault ($fieldName) { + public function addInputTextFieldWithDefault (string $fieldName) { // Get the value from instance $fieldValue = $this->getValueField($fieldName); //* DEBUG: */ print __METHOD__.':'.$fieldName.'='.$fieldValue."
\n"; @@ -219,12 +220,12 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @return void * @throws FormClosedException If the form is not yet opened */ - public function addInputPasswordField ($fieldName, $fieldValue = '') { + public function addInputPasswordField (string $fieldName, string $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('', @@ -247,12 +248,12 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @return void * @throws FormClosedException If the form is not yet opened */ - public function addInputHiddenField ($fieldName, $fieldValue = '') { + public function addInputHiddenField (string $fieldName, string $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('', @@ -270,7 +271,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @param $fieldName Input field name * @return void */ - public function addInputHiddenFieldWithDefault ($fieldName) { + public function addInputHiddenFieldWithDefault (string $fieldName) { // Get the value from instance $fieldValue = $this->getValueField($fieldName); //* DEBUG: */ print __METHOD__.':'.$fieldName.'='.$fieldValue."
\n"; @@ -286,9 +287,9 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @param $prefix Prefix for configuration without trailing _ * @return void */ - public function addInputHiddenConfiguredField ($fieldName, $prefix) { + public function addInputHiddenConfiguredField (string $fieldName, string $prefix) { // Get the value from instance - $fieldValue = $this->getConfigInstance()->getConfigEntry("{$prefix}_{$fieldName}"); + $fieldValue = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry("{$prefix}_{$fieldName}"); //* DEBUG: */ print __METHOD__.':'.$fieldName.'='.$fieldValue."
\n"; // Add the text field @@ -304,21 +305,20 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @return void * @throws FormClosedException If the form is not yet opened */ - public function addInputCheckboxField ($fieldName, $fieldChecked = true) { + public function addInputCheckboxField (string $fieldName, bool $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 = ' '; + $checked = ($fieldChecked ? ' checked="checked"' : ' '); // Generate the content $inputContent = sprintf('', - $this->getFormId(), $fieldName, + $this->getFormId(), $fieldName, $checked ); @@ -335,12 +335,12 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @return void * @throws FormClosedException If the form is not yet opened */ - public function addInputResetButton ($buttonText) { + public function addInputResetButton (string $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('', @@ -360,12 +360,12 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @return void * @throws FormClosedException If the form is not yet opened */ - public function addInputSubmitButton ($buttonText) { + public function addInputSubmitButton (string $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('', @@ -387,7 +387,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @throws FormClosedException If no form has been opened before * @throws InvalidArgumentException If $groupId is not set */ - public function addFormGroup ($groupId = '', $groupText = '') { + public function addFormGroup (string $groupId = '', string $groupText = '') { // Is a form opened? if (($this->formOpened === false) && ($this->formEnabled === true)) { // Throw exception here @@ -404,7 +404,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { if (($this->ifGroupOpenedPreviously() === false) && ($groupId === $this->getPreviousGroupId())) { // Abort here silently return false; - } // END - if + } // Initialize content with closing div by default $content = " \n"; @@ -432,7 +432,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { if ($this->ifSubGroupOpenedPreviously()) { // Close it here $this->addFormSubGroup(); - } // END - if + } // Get previous group id $prevGroupId = $this->getPreviousGroupId(); @@ -444,7 +444,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { if ((!empty($groupId)) && ($groupId != $prevGroupId)) { //* DEBUG: */ echo $groupId.'/'.$prevGroupId."
\n"; $this->addFormGroup($groupId, $groupText); - } // END - if + } } } @@ -459,7 +459,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @throws FormFormClosedException If no group has been opened before * @throws InvalidArgumentException If $subGroupId is not set */ - public function addFormSubGroup ($subGroupId = '', $subGroupText = '') { + public function addFormSubGroup (string $subGroupId = '', string $subGroupText = '') { // Is a group opened? if ($this->ifGroupOpenedPreviously() === false) { // Throw exception here @@ -476,7 +476,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { if (($this->ifSubGroupOpenedPreviously() === false) && ($subGroupId == $this->getPreviousSubGroupId())) { // Abort here silently return false; - } // END - if + } // Initialize content with closing div by default $content = " \n"; @@ -509,7 +509,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { // All call it again if sub group name is not empty if ((!empty($subGroupId)) && ($subGroupId != $prevSubGroupId)) { $this->addFormSubGroup($subGroupId, $subGroupText); - } // END - if + } } } @@ -522,12 +522,12 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { * @return void * @throws FormClosedException If the form is not yet opened */ - public function addFieldLabel ($fieldName, $fieldText, $fieldTitle = '') { + public function addFieldLabel (string $fieldName, string $fieldText, string $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 = ''; @@ -536,7 +536,7 @@ class HtmlFormHelper extends BaseHtmlHelper implements HelpableTemplate { if (!empty($fieldTitle)) { // Create title attribute $titleAttribute = sprintf(' title="%s" data-toggle="tooltip"', $fieldTitle); - } // END - if + } // Generate the content $inputContent = sprintf('