From 1a0a67742c8791fe059c455beccfad162996c34b Mon Sep 17 00:00:00 2001 From: anuko Date: Wed, 1 Mar 2017 18:43:30 +0000 Subject: [PATCH] Added a comment explaining the purpose of safe functions. --- WEB-INF/lib/form/FormElement.class.php | 24 ++++++++++++++---------- WEB-INF/templates/footer.tpl | 2 +- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/WEB-INF/lib/form/FormElement.class.php b/WEB-INF/lib/form/FormElement.class.php index c6182d3a..cf43b8d0 100644 --- a/WEB-INF/lib/form/FormElement.class.php +++ b/WEB-INF/lib/form/FormElement.class.php @@ -46,17 +46,21 @@ class FormElement { function getName() { return $this->name; } function getClass() { return $this->class; } - - // TODO: refactoring ongoing down from here. - function setFormName($name) { $this->form_name = $name; } - function getFormName() { return $this->form_name; } - - function setValue($value) { $this->value = $value; } - function getValue() { return $this->value; } - - function setValueSafe($value) { $this->value = $value;} - function getValueSafe() { return $this->value; } + function setFormName($name) { $this->form_name = $name; } + function getFormName() { return $this->form_name; } + + function setValue($value) { $this->value = $value; } + function getValue() { return $this->value; } + + // Safe function variations are used to store/read values in/from user session for further reuse. + // They may convert data in derived classes to some standard form. For example, floats are stored + // with a dot delimiter (not comma), and dates are stored in DB_DATEFORMAT. + // This allows to reuse data in session even when user changes the deliminter or date format. + function setValueSafe($value) { $this->value = $value;} + function getValueSafe() { return $this->value; } + + // TODO: refactoring ongoing down from here. function setId($id) { $this->id = $id; } function getId() { return $this->id; } diff --git a/WEB-INF/templates/footer.tpl b/WEB-INF/templates/footer.tpl index 383e2a84..06b606c7 100644 --- a/WEB-INF/templates/footer.tpl +++ b/WEB-INF/templates/footer.tpl @@ -12,7 +12,7 @@
-
 Anuko Time Tracker 1.10.38.3610 | Copyright © Anuko | +  Anuko Time Tracker 1.10.38.3611 | Copyright © Anuko | {$i18n.footer.credits} | {$i18n.footer.license} | {$i18n.footer.improve} -- 2.20.1