FormGenerator::adjustColHeight() - Code Metrics - Inspection of "bind to input added" - Stefanius67/Formgenerator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 1f9a40...3e1577 )

by Stefan

created 2021-02-12 17:37 UTC

FormGenerator::adjustColHeight() A

↳ Parent: FormGenerator

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	5
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php
declare(strict_types=1);

namespace SKien\Formgenerator;

use SKien\Config\ConfigInterface;
use SKien\Config\NullConfig;

/**
 * Container for all form elements.
 *
 * #### History
 * - *2020-05-12*   initial version
 * - *2021-01-07*   PHP 7.4
 *
 * @package Formgenerator
 * @version 1.1.0
 * @author Stefanius <[email protected]>
 * @copyright MIT License - see the LICENSE file for details
 */
class FormGenerator extends FormCollection
{
    /** @var int last tab position in the form   */
    protected int $iLastTabindex = 0;
    /** @var bool set the whole form to readonly  */
    protected bool $bReadOnly = false;
    /** @var bool set debug mode to output more information  */
    protected bool $bDebugMode = false;
    /** @var bool set dialog mode (form runs in dynamic created iframe)  */
    protected bool $bIsDialog = false;
    /** @var int explicit width of the form in pixel  */
    protected int $iWidth = -1;
    /** @var FormFlags global flags for all form elements  */
    protected FormFlags $oGlobalFlags;
    /** @var string JS function for onsubmit  */
    protected string $strOnSubmit = '';
    /** @var string JS function for oncancel  */
    protected string $strOnCancel = '';
    /** @var array config values to pass as object to JS */
    protected array $aConfigForJS = [];
    /** @var array elements that creates dynamic CSS styles */
    protected array $aStyleElements = [];
    /** @var string path to the images  */
    protected string $strImgPath = '';
    /** @var string URL params for the form action  */
    protected string $strAction;
    /** @var string form target  */
    protected string $strFormTarget = '';
    /** @var FormDataInterface data provider     */
    protected FormDataInterface $oData;
    /** @var ConfigInterface configuration     */
    protected ConfigInterface $oConfig;

    /**
     * Create a FormGenerator.
     * Set some values to default.
     */
    public function __construct(?FormDataInterface $oData, string $strID = 'FormGenerator') 
    {
        $this->oFG = $this;
        $this->oData = $oData ?? new NullFormData();
        $this->oConfig = new NullConfig();
        $this->oGlobalFlags = new FormFlags();
        $this->strID = $strID;
        $this->strOnSubmit = "validateForm();";
        $this->strOnCancel = "javascript:history.back();";
        $this->strAction = $_SERVER['PHP_SELF'];
        if (isset($_SERVER['QUERY_STRING'])) {
            $this->strAction .= '?' . $_SERVER['QUERY_STRING'];
        }
        $this->bDebugMode = (error_reporting() & (E_USER_ERROR | E_USER_WARNING)) != 0; 
    }
    
    /**
     * @return \SKien\Formgenerator\FormDataInterface
     */
    public function getData() : FormDataInterface
    {
        return $this->oData;
    }
    
    /**
     * @return \SKien\Config\ConfigInterface
     */
    public function getConfig() : ConfigInterface
    {
        return $this->oConfig;
    }
    
    /**
     * @param \SKien\Formgenerator\FormDataInterface $oData
     */
    public function setData(FormDataInterface $oData) : void
    {
        $this->oData = $oData;
    }
    
    /**
     * @param \SKien\Config\ConfigInterface $oConfig
     */
    public function setConfig(ConfigInterface $oConfig) : void
    {
        $this->oConfig = $oConfig;
    }
    
    /**
     * Set the action executed when submit the form.
     * If not changed here, <i><b>$_SERVER['QUERY_STRING']</b></i> is used.
     * @param string $strAction (default = '')
     */
    public function setAction(string $strAction) : void
    {
        $this->strAction = $strAction;
    }

    /**
     * Set the path to images.
     * @param string $strPath
     */
    public function setImagePath(string $strPath) : void 
    {
        $this->strImgPath = $strPath;
    }

    /**
     * Get the path to the StdImages  (<b>WITHOUT trailing DIRECTORY_SEPARATOR!</b>).
     * If no directory set, the subdirectory 'StdImages' of this sourcefile is used. 
     * @return string current image path
     */
    public function getImagePath() : string
    {
        if ($this->strImgPath == '') {
            $this->strImgPath = str_replace(rtrim($_SERVER['DOCUMENT_ROOT'], DIRECTORY_SEPARATOR), '', __DIR__);
            $this->strImgPath .= DIRECTORY_SEPARATOR . 'StdImages';
        }
        return rtrim($this->strImgPath, DIRECTORY_SEPARATOR);
    }
    
    /**
     * Get filename for predifined standard images
     * @param int $iImage
     * @return array
     */
    public function getStdImage(int $iImage) : array
    {
        $aImageMap = [
            FormImage::IMG_DELETE      => ['Delete', 'delete.png', 'Delete content'],
            FormImage::IMG_SEARCH      => ['Search', 'search.png', 'Select'],
            FormImage::IMG_BROWSE      => ['Browse', 'browse.png', 'Browse on server'],
            FormImage::IMG_DATE_PICKER => ['DatePicker', 'datepicker.png', 'Select date'],
            FormImage::IMG_TIME_PICKER => ['TimePicker', 'timepicker.png', 'Select time'],
            FormImage::IMG_DTU         => ['InsertDTU', 'insert_dtu.png', 'insert current date, time and user'],
        ];
        
        if (!isset($aImageMap[$iImage])) {
            return ['', ''];
        }
        $aImage = $aImageMap[$iImage];
        $strImage = $this->getImagePath() . DIRECTORY_SEPARATOR;
        $strImage .= $this->getConfig()->getString('Images.StdImages.' . $aImage[0] . '.Image', $aImage[1]);
        $strTitle = $this->getConfig()->getString('Images.StdImages.' . $aImage[0] . '.Text', $aImage[2]);
        
        return [$strImage, $strTitle];
    }
    
    /**
     * Get the global flags.
     * @return int
     */
    public function getGlobalFlags() : int
    {
        return $this->oGlobalFlags->getFlags();
    }
    
    /**
     * Set the target
     * @param string $strFormTarget
     */
    public function setTarget(string $strFormTarget) : void 
    {
        $this->strFormTarget = $strFormTarget;
    }
    
    /**
     * Set explicit width of the form.
     * @param int $iWidth    width (-1 for default)
     */
    public function setFormWidth(int $iWidth) : void 
    {
        $this->iWidth = $iWidth;
    }
    
    /**
     * Sets the whole form to readonly. 
     * All elements of the form set to disabled, Save/Cancel-Buttons are replaced 
     * with Close-Button
     * @param bool $bReadOnly
     */
    public function setReadOnly(bool $bReadOnly) : void 
    {
        $this->bReadOnly = $bReadOnly;
        if ($bReadOnly) {
            $this->oGlobalFlags->add(FormFlags::READ_ONLY);
        } else {
            $this->oGlobalFlags->remove(FormFlags::READ_ONLY);
        }
    }
    
    /**
     * Adjust the height of the two specified columns.
     * If we have two columns containing fieldset, the height pf both (... and the border) 
     * usually differs dependent on the contents. To prettify the output, the height of the 
     * smaller columns is set to the height of the bigger one.
     * @param string $strCol1
     * @param string $strCol2
     */
    public function adjustColHeight(string $strCol1, string $strCol2) : void
    {
        $strScript = "window.addEventListener('load', function () {";  
        $strScript .= "adjustColumnHeight('" . $strCol1 . "', '" . $strCol2 . "');});";
        $this->add(new FormScript($strScript));
    }
    
    /**
     * Sets the debug mode to output more information.
     * Especialy for some elements, that need additional JS it can be helpfull to
     * turn on the debug mode. 
     * @param bool $bDebugMode
     */
    public function setDebugMode(bool $bDebugMode) : void
    {
        // Even if we plan to integrate a logger, we keep the debug mode alive because the 
        // logger do not cover the JS side (missing scripts, ...) and developers often 
        // forget to take a look at the Browser console.
        $this->bDebugMode = $bDebugMode;
    }
    
    /**
     * Get state of the debug mode.
     * @return bool
     */
    public function getDebugMode() : bool
    {
        return $this->bDebugMode;
    }
    
    /**
     * Specify the form as an 'Dialog'.
     * Dialog means, the form runs inside of an dynamic iframe created in the
     * dialog - DIV of the parent. <br/>
     * The cancel can easy be done by clear the content of that dialog-DIV.
     */
    public function setDialog(bool $bDialog) : void
    {
        $this->bIsDialog = $bDialog;
    }
    
    /**
     * Check, if form runs in dialog (dynamic created iframe).
     * @return bool
     */
    public function isDialog() : bool
    {
        return $this->bIsDialog;
    }
    
    /**
     * Add any element to the form.
     * @param FormElement $oElement
     */
    public function addElement(FormElement $oElement) : void 
    {
        $this->iLastTabindex += $oElement->setTabindex($this->iLastTabindex + 1);
        if ($oElement->bCreateStyle) {
            $this->aStyleElements[] = $oElement;
        }
    }
    
    /**
     * Add a key to the config passed to JS.
     * @param string $strKey
     * @param mixed $value
     */
    public function addConfigForJS(string $strKey, $value) : void
    {
        $this->aConfigForJS[$strKey] = $value;
    }
    
    /**
     * Create HTML for defined form.
     * @return string
     */
    public function getForm() : string
    {
        $strHTML = PHP_EOL;
        
        $strHTML .= '<form';
        if (!empty($this->strAction)) {
            $strHTML .= ' action="';
            $strHTML .= $this->strAction . '"';
        }
        if (!empty($this->strFormTarget)) {
            $strHTML .= ' target="' . $this->strFormTarget . '"';
        }
        if ($this->aAttrib != null) {
            foreach ($this->aAttrib as $strName => $strValue) {
                $strHTML .= ' ' . $strName . '="' . $strValue . '"';
            }
        }
        $strHTML .= $this->buildStyle();
        $strHTML .= ' method="post" id=' . $this->strID . ' onsubmit="return ' . $this->strOnSubmit . '">' . PHP_EOL;
        $strHTML .= '<div id=errorPopup onclick="this.style.display = \'none\';"></div>' . PHP_EOL;
        $iCnt = count($this->aChild);
        for ($i = 0; $i < $iCnt; $i++) {
            $strHTML .= $this->aChild[$i]->GetHTML();
        }
        
        $strHTML .= '</form>' . PHP_EOL;
        $strHTML .= PHP_EOL;
        
        return $strHTML;
    }
    
    /**
     * Build needed configuration for JS scripts.
     * - for validation
     * - scripts of all childs that have own script
     * @return string
     */
    public function getScript() : string
    {
        // set some general configurations
        $this->aConfigForJS['DebugMode'] = $this->getDebugMode();
        $this->aConfigForJS['FormDataValidation'] = $this->oConfig->getArray('FormDataValidation');
        $this->aConfigForJS['FormDataValidation']['formID'] = $this->strID;
        $this->aConfigForJS['JavaScript'] = $this->oConfig->getArray('JavaScript');
        
        $strScript = 'var g_oConfigFromPHP = ' . json_encode($this->aConfigForJS) . ';';
        return $strScript;
    }
    
    /**
     * Build needed CSS styles.
     * - body, if form width defined (TODO: better set width of form-element??)
     * - styles of all childs that have own styles
     * @return string
     */
    public function getStyle() : string 
    {
        $strStyle = '';
        if ($this->iWidth > 0) {
            $strStyle  = "body { width: " . $this->iWidth . "px;}" . PHP_EOL;
        }
        foreach ($this->aStyleElements as $oElement) {
            $strStyle .= $oElement->getStyle();
        }
        return $strStyle;   
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace SKien\Formgenerator;
5
6			use SKien\Config\ConfigInterface;
7			use SKien\Config\NullConfig;
8
9			/**
10			* Container for all form elements.
11			*
12			* #### History
13			* - 2020-05-12 initial version
14			* - 2021-01-07 PHP 7.4
15			*
16			* @package Formgenerator
17			* @version 1.1.0
18			* @author Stefanius <[email protected]>
19			* @copyright MIT License - see the LICENSE file for details
20			*/
21			class FormGenerator extends FormCollection
22			{
23			/** @var int last tab position in the form */
24			protected int $iLastTabindex = 0;
25			/** @var bool set the whole form to readonly */
26			protected bool $bReadOnly = false;
27			/** @var bool set debug mode to output more information */
28			protected bool $bDebugMode = false;
29			/** @var bool set dialog mode (form runs in dynamic created iframe) */
30			protected bool $bIsDialog = false;
31			/** @var int explicit width of the form in pixel */
32			protected int $iWidth = -1;
33			/** @var FormFlags global flags for all form elements */
34			protected FormFlags $oGlobalFlags;
35			/** @var string JS function for onsubmit */
36			protected string $strOnSubmit = '';
37			/** @var string JS function for oncancel */
38			protected string $strOnCancel = '';
39			/** @var array config values to pass as object to JS */
40			protected array $aConfigForJS = [];
41			/** @var array elements that creates dynamic CSS styles */
42			protected array $aStyleElements = [];
43			/** @var string path to the images */
44			protected string $strImgPath = '';
45			/** @var string URL params for the form action */
46			protected string $strAction;
47			/** @var string form target */
48			protected string $strFormTarget = '';
49			/** @var FormDataInterface data provider */
50			protected FormDataInterface $oData;
51			/** @var ConfigInterface configuration */
52			protected ConfigInterface $oConfig;
53
54			/**
55			* Create a FormGenerator.
56			* Set some values to default.
57			*/
58			public function __construct(?FormDataInterface $oData, string $strID = 'FormGenerator')
59			{
60			$this->oFG = $this;
61			$this->oData = $oData ?? new NullFormData();
62			$this->oConfig = new NullConfig();
63			$this->oGlobalFlags = new FormFlags();
64			$this->strID = $strID;
65			$this->strOnSubmit = "validateForm();";
66			$this->strOnCancel = "javascript:history.back();";
67			$this->strAction = $_SERVER['PHP_SELF'];
68			if (isset($_SERVER['QUERY_STRING'])) {
69			$this->strAction .= '?' . $_SERVER['QUERY_STRING'];
70			}
71			$this->bDebugMode = (error_reporting() & (E_USER_ERROR \| E_USER_WARNING)) != 0;
72			}
73
74			/**
75			* @return \SKien\Formgenerator\FormDataInterface
76			*/
77			public function getData() : FormDataInterface
78			{
79			return $this->oData;
80			}
81
82			/**
83			* @return \SKien\Config\ConfigInterface
84			*/
85			public function getConfig() : ConfigInterface
86			{
87			return $this->oConfig;
88			}
89
90			/**
91			* @param \SKien\Formgenerator\FormDataInterface $oData
92			*/
93			public function setData(FormDataInterface $oData) : void
94			{
95			$this->oData = $oData;
96			}
97
98			/**
99			* @param \SKien\Config\ConfigInterface $oConfig
100			*/
101			public function setConfig(ConfigInterface $oConfig) : void
102			{
103			$this->oConfig = $oConfig;
104			}
105
106			/**
107			* Set the action executed when submit the form.
108			* If not changed here, <i><b>$_SERVER['QUERY_STRING']</b></i> is used.
109			* @param string $strAction (default = '')
110			*/
111			public function setAction(string $strAction) : void
112			{
113			$this->strAction = $strAction;
114			}
115
116			/**
117			* Set the path to images.
118			* @param string $strPath
119			*/
120			public function setImagePath(string $strPath) : void
121			{
122			$this->strImgPath = $strPath;
123			}
124
125			/**
126			* Get the path to the StdImages (<b>WITHOUT trailing DIRECTORY_SEPARATOR!</b>).
127			* If no directory set, the subdirectory 'StdImages' of this sourcefile is used.
128			* @return string current image path
129			*/
130			public function getImagePath() : string
131			{
132			if ($this->strImgPath == '') {
133			$this->strImgPath = str_replace(rtrim($_SERVER['DOCUMENT_ROOT'], DIRECTORY_SEPARATOR), '', __DIR__);
134			$this->strImgPath .= DIRECTORY_SEPARATOR . 'StdImages';
135			}
136			return rtrim($this->strImgPath, DIRECTORY_SEPARATOR);
137			}
138
139			/**
140			* Get filename for predifined standard images
141			* @param int $iImage
142			* @return array
143			*/
144			public function getStdImage(int $iImage) : array
145			{
146			$aImageMap = [
147			FormImage::IMG_DELETE => ['Delete', 'delete.png', 'Delete content'],
148			FormImage::IMG_SEARCH => ['Search', 'search.png', 'Select'],
149			FormImage::IMG_BROWSE => ['Browse', 'browse.png', 'Browse on server'],
150			FormImage::IMG_DATE_PICKER => ['DatePicker', 'datepicker.png', 'Select date'],
151			FormImage::IMG_TIME_PICKER => ['TimePicker', 'timepicker.png', 'Select time'],
152			FormImage::IMG_DTU => ['InsertDTU', 'insert_dtu.png', 'insert current date, time and user'],
153			];
154
155			if (!isset($aImageMap[$iImage])) {
156			return ['', ''];
157			}
158			$aImage = $aImageMap[$iImage];
159			$strImage = $this->getImagePath() . DIRECTORY_SEPARATOR;
160			$strImage .= $this->getConfig()->getString('Images.StdImages.' . $aImage[0] . '.Image', $aImage[1]);
161			$strTitle = $this->getConfig()->getString('Images.StdImages.' . $aImage[0] . '.Text', $aImage[2]);
162
163			return [$strImage, $strTitle];
164			}
165
166			/**
167			* Get the global flags.
168			* @return int
169			*/
170			public function getGlobalFlags() : int
171			{
172			return $this->oGlobalFlags->getFlags();
173			}
174
175			/**
176			* Set the target
177			* @param string $strFormTarget
178			*/
179			public function setTarget(string $strFormTarget) : void
180			{
181			$this->strFormTarget = $strFormTarget;
182			}
183
184			/**
185			* Set explicit width of the form.
186			* @param int $iWidth width (-1 for default)
187			*/
188			public function setFormWidth(int $iWidth) : void
189			{
190			$this->iWidth = $iWidth;
191			}
192
193			/**
194			* Sets the whole form to readonly.
195			* All elements of the form set to disabled, Save/Cancel-Buttons are replaced
196			* with Close-Button
197			* @param bool $bReadOnly
198			*/
199			public function setReadOnly(bool $bReadOnly) : void
200			{
201			$this->bReadOnly = $bReadOnly;
202			if ($bReadOnly) {
203			$this->oGlobalFlags->add(FormFlags::READ_ONLY);
204			} else {
205			$this->oGlobalFlags->remove(FormFlags::READ_ONLY);
206			}
207			}
208
209			/**
210			* Adjust the height of the two specified columns.
211			* If we have two columns containing fieldset, the height pf both (... and the border)
212			* usually differs dependent on the contents. To prettify the output, the height of the
213			* smaller columns is set to the height of the bigger one.
214			* @param string $strCol1
215			* @param string $strCol2
216			*/
217			public function adjustColHeight(string $strCol1, string $strCol2) : void
218			{
219			$strScript = "window.addEventListener('load', function () {";
220			$strScript .= "adjustColumnHeight('" . $strCol1 . "', '" . $strCol2 . "');});";
221			$this->add(new FormScript($strScript));
222			}
223
224			/**
225			* Sets the debug mode to output more information.
226			* Especialy for some elements, that need additional JS it can be helpfull to
227			* turn on the debug mode.
228			* @param bool $bDebugMode
229			*/
230			public function setDebugMode(bool $bDebugMode) : void
231			{
232			// Even if we plan to integrate a logger, we keep the debug mode alive because the
233			// logger do not cover the JS side (missing scripts, ...) and developers often
234			// forget to take a look at the Browser console.
235			$this->bDebugMode = $bDebugMode;
236			}
237
238			/**
239			* Get state of the debug mode.
240			* @return bool
241			*/
242			public function getDebugMode() : bool
243			{
244			return $this->bDebugMode;
245			}
246
247			/**
248			* Specify the form as an 'Dialog'.
249			* Dialog means, the form runs inside of an dynamic iframe created in the
250			* dialog - DIV of the parent. <br/>
251			* The cancel can easy be done by clear the content of that dialog-DIV.
252			*/
253			public function setDialog(bool $bDialog) : void
254			{
255			$this->bIsDialog = $bDialog;
256			}
257
258			/**
259			* Check, if form runs in dialog (dynamic created iframe).
260			* @return bool
261			*/
262			public function isDialog() : bool
263			{
264			return $this->bIsDialog;
265			}
266
267			/**
268			* Add any element to the form.
269			* @param FormElement $oElement
270			*/
271			public function addElement(FormElement $oElement) : void
272			{
273			$this->iLastTabindex += $oElement->setTabindex($this->iLastTabindex + 1);
274			if ($oElement->bCreateStyle) {
275			$this->aStyleElements[] = $oElement;
276			}
277			}
278
279			/**
280			* Add a key to the config passed to JS.
281			* @param string $strKey
282			* @param mixed $value
283			*/
284			public function addConfigForJS(string $strKey, $value) : void
285			{
286			$this->aConfigForJS[$strKey] = $value;
287			}
288
289			/**
290			* Create HTML for defined form.
291			* @return string
292			*/
293			public function getForm() : string
294			{
295			$strHTML = PHP_EOL;
296
297			$strHTML .= '<form';
298			if (!empty($this->strAction)) {
299			$strHTML .= ' action="';
300			$strHTML .= $this->strAction . '"';
301			}
302			if (!empty($this->strFormTarget)) {
303			$strHTML .= ' target="' . $this->strFormTarget . '"';
304			}
305			if ($this->aAttrib != null) {
306			foreach ($this->aAttrib as $strName => $strValue) {
307			$strHTML .= ' ' . $strName . '="' . $strValue . '"';
308			}
309			}
310			$strHTML .= $this->buildStyle();
311			$strHTML .= ' method="post" id=' . $this->strID . ' onsubmit="return ' . $this->strOnSubmit . '">' . PHP_EOL;
312			$strHTML .= '<div id=errorPopup onclick="this.style.display = \'none\';"></div>' . PHP_EOL;
313			$iCnt = count($this->aChild);
314			for ($i = 0; $i < $iCnt; $i++) {
315			$strHTML .= $this->aChild[$i]->GetHTML();
316			}
317
318			$strHTML .= '</form>' . PHP_EOL;
319			$strHTML .= PHP_EOL;
320
321			return $strHTML;
322			}
323
324			/**
325			* Build needed configuration for JS scripts.
326			* - for validation
327			* - scripts of all childs that have own script
328			* @return string
329			*/
330			public function getScript() : string
331			{
332			// set some general configurations
333			$this->aConfigForJS['DebugMode'] = $this->getDebugMode();
334			$this->aConfigForJS['FormDataValidation'] = $this->oConfig->getArray('FormDataValidation');
335			$this->aConfigForJS['FormDataValidation']['formID'] = $this->strID;
336			$this->aConfigForJS['JavaScript'] = $this->oConfig->getArray('JavaScript');
337
338			$strScript = 'var g_oConfigFromPHP = ' . json_encode($this->aConfigForJS) . ';';
339			return $strScript;
340			}
341
342			/**
343			* Build needed CSS styles.
344			* - body, if form width defined (TODO: better set width of form-element??)
345			* - styles of all childs that have own styles
346			* @return string
347			*/
348			public function getStyle() : string
349			{
350			$strStyle = '';
351			if ($this->iWidth > 0) {
352			$strStyle = "body { width: " . $this->iWidth . "px;}" . PHP_EOL;
353			}
354			foreach ($this->aStyleElements as $oElement) {
355			$strStyle .= $oElement->getStyle();
356			}
357			return $strStyle;
358			}
359			}
360

Stefanius67 / Formgenerator

Push — main ( 1f9a40...3e1577 )

FormGenerator::adjustColHeight() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like