---------------------------------------------------------------------------------------------------------------
-
- DsForm Changelog:
-
---------------------------------------------------------------------------------------------------------------

ECRS:

   1) Add support for multiple forms on page with reCAPTCHA.  Will involve needing to name the v2 and v3
      using the form ID (multiple forms on a page would have unique IDs).  The hidden response fields
      should also prepend the form IDs to ensure they're unique so jQuery updates the correct field.
      Things to remember to change:
         - V3 action
         - g-recaptcha-v3-response
         - V2 callback used in grecaptcha.render('g-recaptcha', { 'sitekey' : '%s' });
            Note: this is only used when V2 and V3 are on at the same time
         - V2 callback used in the data attribute
            Note: this is only used for V2 (not V3)
         - Search other magic strings for opportunities to make them unique based on form ID

---------------------------------------------------------------------------------------------------------------

1.13.05  03-19-24 RML

         1) BUG FIX: Field values used to be sent through trim(stripslashes()) and no longer are. It was causing
                     data loss when backslashes were removed.

         UPGRADING FROM PREVIOUS VERSION:
            We suspect no concerns. Downstream use should not assume stripslashes()

---------------------------------------------------------------------------------------------------------------

1.13.04  01-05-24 TML

         1) BUG FIX: Max file upload sizes of 1G or larger were breaking MAX_FILE_SIZE hidden value as the 'G'
                     was not handled when converting to bytes.

         UPGRADING FROM PREVIOUS VERSION:
            No concerns

---------------------------------------------------------------------------------------------------------------

1.13.03  09-27-23 RML

         1) BUG FIX / Enhancement: Inputs are labeled so you can click the text and select the radio or checkbox.

         UPGRADING FROM PREVIOUS VERSION:
            No concerns UNLESS you override <LABEL> styling in CSS

---------------------------------------------------------------------------------------------------------------

1.13.02  02-06-23 TML

         1) BUG FIX: The URL fields cannot lowercase the values since some URL's are case-sensitive (like YouTube)

         UPGRADING FROM PREVIOUS VERSION:
            No concerns

---------------------------------------------------------------------------------------------------------------

1.13.01  10-24-22 TML

         1) BUG FIX: When a field group watches another field looking for a string with a single quote,
                     failure to escape caused JS errors breaking the entire form.

         UPGRADING FROM PREVIOUS VERSION:
            No concerns

---------------------------------------------------------------------------------------------------------------

1.13.00  08-03-22 TML

         1) NEW: Implemented Google reCAPTCHA v3 while keeping and refactoring v2.  You may use them
                 independently or use both at the same time by calling the two new methods:
                 AddReCaptchaV2() and AddReCaptchaV3().  For v3 you may specify a custom score threshold
                 and you may disable debugging if debug@digisage.com should not receive debugging emails
                 for submissions that do not meet the required score.  Also, for sites with a global include
                 using reCAPTCHA v3, on all pages that do NOT use DsForm the following static function
                 should be called inside the HEAD tag or in the footer: DsForm::OutputReCaptchaV3Tracker().
                 This outputs the reCAPTCHA api.js script helping train the invisible CAPTCHA on user habits.
                 If the second argument is set to hide the badge, it will also output a <style> tag.

         UPGRADING FROM PREVIOUS VERSION:
            No concerns, a backwards compatible AddCaptcha() method exists which calls AddReCaptchaV2()

---------------------------------------------------------------------------------------------------------------

1.12.16  07-09-21 TML

         1) BUG FIX: Dollar input fields loading an initial value of $0 was broken. Updated from
                     using empty() to use strlen() to determine if output is needed.

         UPGRADING FROM PREVIOUS VERSION:
            No concerns

---------------------------------------------------------------------------------------------------------------

1.12.15  06-06-21 TML

         1) NEW: Field type TYPE_DOLLARS_RANGE and TYPE_DOLLARSANDCENTS_RANGE to allow use of the range field
                  types within the context of currency.

         UPGRADING FROM PREVIOUS VERSION:
            No concerns

---------------------------------------------------------------------------------------------------------------

1.12.14  05-18-21 RML

         1) NEW: New method DisableErrorHashJump() which removes the code to scroll to the error div

         2) NEW: New method DisableScriptAndStyleIncludes() which will cause DsForm to NOT output any
            script or CSS tags and assumes the caller will handle DS includes

         UPGRADING FROM PREVIOUS VERSION:
            No concerns.

---------------------------------------------------------------------------------------------------------------

1.12.13  01-30-21 TML

         1) Added input field types so mobile devices show appropriate keyboard for number fields

          UPGRADING FROM PREVIOUS VERSION:
                      No concerns.

---------------------------------------------------------------------------------------------------------------

1.12.12  09-21-20 RML

         1) Removed the DNS (MX and A record checks) when validating email addresses.
            We just validate format now.

         2) Did some small cleanup of the mClientSideSubmitEvent variable for code clarity.
            No change in functionality.

          UPGRADING FROM PREVIOUS VERSION:
                      No concerns.

---------------------------------------------------------------------------------------------------------------

1.12.11  08-12-20 TML

         1) Updated the JS in this file to use jQuery vs. $ for better WP compatibility

         2) Updated CSS to support long checkbox/radio text without dropping under the input

         3) BUG FIX: wrapped unset() of session variable with isset()

---------------------------------------------------------------------------------------------------------------

1.12.10  06-19-20 TML & RML

         1) BUG FIX:  Bug fix to preg_replace() calls using \d for digits. Uses 0-9 now.

         2) BUG FIX:  Removed get_magic_quotes_gpc(), now deprecated in PHP 7.4.

         3) BUG FIX:  Removed custom functions calls in clientside's doBulkFormValidation().
                      These custom functions do not exist for the incoming AJAX request.

---------------------------------------------------------------------------------------------------------------

1.12.9  05-31-20 RML

         1) BUG FIX:  Bug fix to SpecialCharsToEntities() which is used by EscAttr.
                      It was double-encoding so htmlentities didn't come out correctly.

---------------------------------------------------------------------------------------------------------------

1.12.8  05-21-20 TML

         1) BUG FIX:  Added new internal function to escape attributes and updated all field outputs
                      to properly escape their values.

---------------------------------------------------------------------------------------------------------------

1.12.7  03-08-20 TML

         1) NEW:      New TYPE_TIME field which outputs a HTML5 input type "time" (masked hours, minutes, am/pm)

         2) NEW:      New TYPE_DECIMAL_RANGE field which is exactly the same as its integer version, but allows
                      decimal values and you can include a parameter of 'num_decimals' to control how many
                      decimal points are shown (validate function will format the number)

---------------------------------------------------------------------------------------------------------------

1.12.6  06-10-19 TML

         1) NEW:      Calling AddCustomClientSideAddRepeaterCallback() with a javascript function name will allow
                      custom client-side function to run immediately after cloning repeating fields into place.

---------------------------------------------------------------------------------------------------------------

1.12.5  06-01-19 TML

         1) BUG FIX:  Use of follow-up fields inside a repeater was never fully implemented.
                      This revision completes all the unfinished sections.

---------------------------------------------------------------------------------------------------------------

1.12.4  04-25-19 TML

         1) NEW:      Calling AddPriorityCustomClientSideValidation() with a javascript function name will allow
                      custom client-side validation to occur when the form is submitted.  The priority calls
                      will be run prior to DsForm's own client-side validation and will skip remaining
                      validation if false is returned.

         2) NEW:      Calling AddCustomClientSidePreSubmitCallback() with a javascript function name will allow
                      custom client-side function to run immediately prior to submitting the form.
                      Use case:  Authorize.net Accept.JS needs you to clear all card data prior to submission.

         3) UPDATE:   Updated the JS files to use jQuery vs. $ for better WP compatibility

          UPGRADING FROM PREVIOUS VERSION:
                      No concerns.

---------------------------------------------------------------------------------------------------------------

1.12.3 (patch 4)  02-08-19 RML

         1) NEW:      Added a class to inside DIV of a read only field so we can target it for spacing issues.

          UPGRADING FROM PREVIOUS VERSION:
                      No concerns.

---------------------------------------------------------------------------------------------------------------

1.12.3 (patch 3)  02-07-19 RML

         1) BUG FIX:  Bad false comparison in inc-form-validation.php's validateDate() where it was
                      coercing 1/1/1970 (which is epoch 0) into false.

          UPGRADING FROM PREVIOUS VERSION:
                      No concerns.

---------------------------------------------------------------------------------------------------------------

1.12.3 (patch 2)  02-06-19 TML

         1) BUG FIX:  Bad is_array() call from Patch 1 was breaking repeating fields.

          UPGRADING FROM PREVIOUS VERSION:
                      No concerns.

---------------------------------------------------------------------------------------------------------------

1.12.3 (patch 1)  01-31-19 TML

         1) BUG FIX:  Updating to be more defensive on usage of count() on variables that may not be countable.
                      Fix required for PHP 7.2+

          UPGRADING FROM PREVIOUS VERSION:
                      No concerns.

---------------------------------------------------------------------------------------------------------------

1.12.3  10-11-18 RML & TML

         1) BUG FIX:  Updated CropPhoto() to allow PNG files (previously treated as not supported).  Also
                      the resample calL was not using the original width/height causing resize portion
                      to not work correctly.

          UPGRADING FROM PREVIOUS VERSION:
                      No concerns.

---------------------------------------------------------------------------------------------------------------

1.12.2  10-09-17 RML & TML

         1) CHANGE:   Added feature so the post variables are not processed unless it is for "you".
                      This allows multiple DSForms to exist on the same page without every one of them
                      looking at the post variables as if they were all posted to.

          UPGRADING FROM PREVIOUS VERSION:
                      No concerns.

---------------------------------------------------------------------------------------------------------------

1.12.1  10-04-17 TML

         1) CHANGE:   Replaced TinyMCE MoxieManager with "Responsive Filemanager".  Be sure to edit
                      config.php for file paths.

---------------------------------------------------------------------------------------------------------------

1.12.0  06-05-17 RML & TML

         1) CHANGE:   Removed auto-injection of jQuery and jQueryUI. This removed the second argument on the
                      constructor. DsForm now assumes you'll supply your own jQuery and jQuery UI.

                      DsForm WILL auto-include it's own minified dsform-1.12.0.min.js which is a concat/minify
                      of dsform.js and jquery.dirtyforms.js

         2) NEW:      Added new feature for Google's reCAPTCHA.  To add a CAPTCHA to your form, simply call this
                      and pass in the keys Google needs:

                         $form->AddCaptcha(RECAPTCHA_SITE_KEY, RECAPTCHA_SECRET_KEY);

         3) BUG FIX:  Last year a single batch client side validation was added to replace a single AJAX
                      request for every single field on the page.  This change removed all "on submit"
                      code from being output which broke the input button text replacement functionality
                      which aims to prevent multiple submission clicks by hiding the input button and
                      replacing it with the provided method.

          UPGRADING FROM PREVIOUS VERSION:
                      Constructor has changed.  Anyone using earlier versions will need the second argument
                      removed.

---------------------------------------------------------------------------------------------------------------

1.11.5  04-07-16 TML

         1) UPDATE:   Allow a single client-side validation ajax call when form is submitted instead of
                      triggering every fields' event causing one ajax call per field with validation.

         2) BUG FIX:  When custom server-side validation finds an error and the form contains a repeatable
                      group where 1 or more items were clicked to be removed, the removed sections were
                      showing again even though the hidden is_deleted was YES and ultimately it would be
                      discarded once getting to processing.  New fix checks all is_deleted fields for YES
                      and clicks the remove link again to hide the contents and show that it will be removed.

         3) BUG FIX:  DirtyForms was throwing an error "TypeError: dirtyForms.dialog.open is not a function"

          UPGRADING FROM PREVIOUS VERSION:
                      While there is no major concern, the update for client-side validation calls
                      may cause issues depending on the complexity of forms.  Be sure to test individual
                      field validation and full form on submit validation to make sure there are no issues.

---------------------------------------------------------------------------------------------------------------

1.11.4  04-06-16 RML & TML

         1) BUG FIX:  RML: Making sure you don't ever call number_format() when the value is empty.

         2) BUG FIX:  RML: Fix placement of the closing tag inside $showCents if statements

         3) BUG FIX:  TML: When having a repeatable that is not inside a fieldset, the remove links do not work.

          UPGRADING FROM PREVIOUS VERSION:
                      There was a change to the forms.css file to add padding-top: 15px; to
                      form.dsform .repeatable-pending-remove to help it stand out. If upgrading a form using
                      repeatable fields, you may want to apply this change or at least test how it looks.

---------------------------------------------------------------------------------------------------------------

1.11.3  03-09-16 RML

         1) UPDATE:   Added automatic call to AuthenticateTinyMceMoxieManager() when rendering a textarea
                      that includes TinyMCE

          UPGRADING FROM PREVIOUS VERSION:
                      No concerns.

---------------------------------------------------------------------------------------------------------------

1.11.2  03-03-16 TML

         1) BUG FIX:  If using TYPE_MULTIPLE_FILES and its required the client-side checking was always
                      failing.  Standard FILE type fields are being ignored from client-side checking so
                      we added TYPE_MULTIPLE_FILES to the list of types to be handled by server-side only.

---------------------------------------------------------------------------------------------------------------

1.11.1  02-29-16 RML

         1) UPDATE:   The form tag now as class="dsform" output every time for easy CSS targeting.
         2) BUG FIX:  The email validation in inc-form-validation.php used an older REGEX.  There was a bug
                      where it wouldn't accept a hyphen in the account portion.  I changed the validation to use
                      PHP's filter_var() instead of a REGEX

          UPGRADING FROM PREVIOUS VERSION:
          * Search for CSS using a class of "dsform" to see if you'll have conflicts
            because our form tag has that class now.

 ---------------------------------------------------------------------------------------------------------------

1.11.0  11-17-15 to 01-21-16 TML

         1) UPDATE:   Updated to use a different version of DirtyForm (called Dirty Forms now, with an S)
                      This version allows it to work with TinyMCE and is actively being developed.

         2) NEW:      Created new input type called PHOTO_W_CROPPING and an associated settings method called
                      SetPhotoWithCroppingOptions() used to set the desired cropped width and height.

         3) BUG FIX:  Fields TYPE_DOLLARS and TYPE_DOLLARSANDCENTS are now showing a $ when populated.

         4) NEW:      Created ability to provide an array of group names and array values to create a
                      a drop-down with option groups.  Array to pass into AddDropdown() should resemble:

                         array('Group Name 1' => array('key1' => 'value1',
                                                       'key2' => 'value2',
                                                       ...),
                               'Group Name 2' => array('key1' => 'value1',
                                                       'key2' => 'value2',
                                                       ...)
                               ...)

         5) BUG FIX:  Fixed SetMaxLength(), SetSize() and Set2dFieldDimensions() to be called within the
                      repeatable field loop and be applied to all fields within the repeatable area.

          UPGRADING FROM PREVIOUS VERSION:
          * Forms using this previously most likely have custom JS in the page that looks for
            .hasClass('form-has-changed') however this new version has a modal dialog built in.

---------------------------------------------------------------------------------------------------------------

1.10.6  10-23-15 TML

         1) NEW:      Created a new type for multiple file upload (TYPE_MULTIPLE_FILES)
                      Modern browsers (and IE9+) supports the multiple="multiple" attribute
                      to the FILE input type.

---------------------------------------------------------------------------------------------------------------

1.10.5  08-07-15 RML & TML (modified 08-12-15)

         1) UPDATE:   Fixed a bug where the remove link on repeatable field groups would remove field groups from
                      all of the fieldgroup sets when there was more than one repeatable field group.
                      No upgrade concerns.
         1.1) UPDATE: Still seeing issues with remove link when 2+ repeatable areas on a single page.
                      Updated event for clicking remove link to only fire for specific repeatable regions.

         2) UPDATE:   Updated MAX_FILE_SIZE to be the same as the 'upload_max_filesize' value set by PHP.

---------------------------------------------------------------------------------------------------------------

1.10.4  01-28-15 RML

         1) UPDATE:   Added method NoStyleTags() which stops the output of style tags.  This lets you control more
                      with CSS while maintaining backwards compatibility.

---------------------------------------------------------------------------------------------------------------

1.10.3  12-06-14 RML

         1) BUG FIX:  Fixed function_exists() bug in clientside-form-validation.php

---------------------------------------------------------------------------------------------------------------

1.10.2  09-09-14 RML

         1) BUG FIX:  Added function_exists() in clientside-form-validation.php to stop posting bots from
                      attempting to run invalid functions.

         2) BUG FIX:  Added additional checking of currentPage to ensure posting bots can't send in an invalid page

         3) MISC:     Misc simple code reformatting and spell checking.

---------------------------------------------------------------------------------------------------------------

1.10.1  04-25-14 TML

         1) BUG FIX: When using TincyMCE alignment icons the previous DsForm versions was only
                     applying the style to IMG tags.  This was updated to include more tags.
                     ** Includes new styles put in forms.css

         2) BUG FIX: Default height/width for text areas corrected to be px values not row/col values

---------------------------------------------------------------------------------------------------------------

1.10.0  11-08-13 RML & 11-19-13 TML

         1) RML UPDATE:  Set2dFieldDimensions() now sets in pixels like SetSize() does.
                         NOTE: This does NOT have an effect on a rich textarea.  Those dimensions must be sent
                               in as arguments 3 and 4 to SetRichEditorOptions() as numbers. i.e.
                               Set2dFieldDimensions() is only useful on "plain" textareas

         2) RML UPDATE:  Updated to TinyMCE 4.x and added support for the Enterprise MoxyManager (SPS reference site)

         3) TML BUG FIX: When using a FILE or PHOTO field type, the client-side validation is attempting to look
                         for the error inside the $_FILE array which is not created until the form is posted.
                         Clientside checks are ignored for file input fields and are handled via server-side only.

---------------------------------------------------------------------------------------------------------------

1.09  03-12-13 TML

       1) BUG FIX:  The remove link updates in version 1.08 introduced a bug that assumed the repeatable
                    groups were called "option-choices" which meant any other name would break the remove
                    links.  A fix was put in that uses the $groupName variable instead of hard-coding.

       2) UPDATE:   Added a class attribute to hidden input tag outputs (the ID field is also used for
                    the CLASS name). This will let us use watch groups on a hidden value that is updated.
                    A watch group takes an argument that is the class to watch for and we previously
                    the hidden input tag had no class attribute to attach to.

---------------------------------------------------------------------------------------------------------------

1.08  01-19-13 TML

       1) UPDATE:   Redesigned the use of the "Remove Link" since its current implementation was not very
                    practical.  If a remove link argument is specified in the StartRepeatableFieldGroup()
                    call it will be placed inside each repeating group (instead of at the end as it was
                    previously).

       2) UPDATE:   Since most uses of a repeatable group involves wrapping each group in a fieldset
                    and the new delete link is outside of this user defined fieldset, the fieldset is
                    now built into the repeatable group and is enabled by giving it a title which is
                    the last argument in StartRepeatableFieldGroup()

       3) BUG FIX:  TYPE_INTEGER, TYPE_DOLLAR and TYPE_DOLLARSANDCENTS all did not accept a negative
                    value previously.  Special handling put in place for TYPE_INTEGER and the regex
                    used for currency was updated to allow a minus sign.
             REV'D  On 3/7/2013 this bug fix was modified to fix newly introduced bug. If validating
                    an empty field, it was trying to access index 0 of an empty string to look for
                    the negative sign which caused an exception.

       4) UPDATE:   Updated follow-up fields for a drop-down to use a change() event so it shows
                    immediately.

       UPGRADING FROM PREVIOUS VERSION:
          * Forms using repeatable fields with a REMOVE link specified will see a change in behavior.
            Nothing should break unless special remove code was used in the integrating page.

---------------------------------------------------------------------------------------------------------------

1.07  11-14-12 TML

       1) NEW:      Changed error DIVs to fade away slowly instead of abruptly disappearing
       2) BUG FIX:  All current error DIVs are hidden prior to clientside validation starting
                    to clear errors not re-checked (if focus is still there) prior to the input
                    button being clicked.  Bug was causing a hash tag jump and failure on form
                    even though the error was already corrected.
       3) UPDATE:   Updated jQuery include versions to 1.8.2 and jQuery UI 1.9.1

---------------------------------------------------------------------------------------------------------------

1.06  10-24-12 TML & RML

       1) NEW:      Added new field types for URL and URLNOHTTP
       2) UPDATED:  Changed size settings to be "style" attribute "width" values instead of for the "size" attribute.
                    They are now set as PX values.
       3) BUG FIX:  Added a DIV wrapper for the first set of fields within a repeatable group to
                    match the wrapper found on 2 through n.
       4) UPDATED:  Added session authentication for TinyMCE ImageManager so that it doesn't have to be remembered.
                    Only put in session if one or more rich text editors are in form.
       5) BUG FIX:  Moved the dirty form JS include outside of the "is jQuery included" condition since often times we
                    don't include jQuery because all pages of a site have it, but the dirtyform call fails.  It's
                    unlikely the dirtyform JS library will be included by the site without it being part of DsForm.
       6) BUG FIX:  Changed mJsFieldType for TYPE_DATE to be "date" to use change() event instead of blur() like others.
       7) NEW:      Added ability to provide HTML that appears in the label (after the label text) and before the input
                    field inside the input container.  For use with AddFieldHtml() the new constants are:
                    FIELD_HTML_BEFORE_INPUT_FIELD and FIELD_HTML_INSIDE_LABEL
       8) NEW:      Added new method called SetJavaScriptLevel() which takes a JAVASCRIPT constant of:
                    JAVASCRIPT_FORCE - shows a <noscript> warning stating they MUST turn on JavaScript and does
                                       not show the form (via an in-line style attribute of display: none)
                    JAVASCRIPT_WARN  - DEFAULT - shows a <noscript> warning stating that JavaScript is
                                       recommended and the form is shown
                    JAVASCRIPT_NONE  - does not show a <noscript> tag and the form is shown
       9) NEW:      Added new field type for READONLY
       10) BUG FIX: Button click tracking was removing the wrong attribute name
       11) NEW:     Added second argument to StartFieldSet() of $idForTag to assign a particular CSS ID
       12) BUG FIX: Moved the declaration of "var numClones" from the docReady scope global scope by
                    declaring it in the head content.  This allows functions in the dsforms.js to reference
                    it during clientside validation on submit.  Prior to fix, the JS error was causing
                    the form to submit even though errors were present.

       UPGRADING FROM PREVIOUS VERSION:
          * If setting manual sizes (using SetSize() for example), the width values will need to be adjusted

---------------------------------------------------------------------------------------------------------------

1.05b  10-02-12 TML

       1) UPDATE: Modified the is_assoc() function to have a more robust "special case" for associative arrays
                  with 0 / 1 keys for "yes" and "no" values.  Previously the value had to be "yes" or "no"
                  now with this change, the value must contain the word "yes" and "no" somewhere in the value.

---------------------------------------------------------------------------------------------------------------

1.05  03-14-12 RML

       1) UPDATE: Added DIV wrappers (just plain <div>)on the text output next to check-boxes and radio buttons
                  allowing for CSS styling (especially useful for long lines that wrap).

       2) UPDATE: Added an ID to the outer input wrapper. Now, not only does it have class "input-container" but
                  it also has an ID of "input-container-for-FIELD_NAME" allowing you to target those inputs and
                  their labels easily (especially useful for check-boxes and radio buttons).

       3) UPDATE: Removed DsException dependency.  Now using the standard Exception class.

       UPGRADING FROM PREVIOUS VERSION:
          * Moderate concern -- API is fully backward compatible EXCEPT for exceptions thrown
                             -- Must include CSS file from dsform 1.05 or the new DIV will break and put
                                the text below your radio button/check-box

---------------------------------------------------------------------------------------------------------------

1.04  07-20-11 RML & TML

       1) UPDATE: Changed output label so you can set label fields as DsForm::NO_FIELD_LABEL.
                  If set this way the labeling for a field will be skipped.

       2) UPDATE: Added new field type of TYPE_HTML_HEX_COLOR which validates 3 or 6 length
                  colors. e.g. #fff or #ffffff

       3) BUG FIX: Added '+' as a valid character to validation of e-mail addresses (valid in username portion)

       4) BUG FIX: Added proper selector support for CHECKBOX and RADIO fields for client-side validation

       5) UPDATE: Added on-submit client-side validation to spare a round-trip to the server for server-side
                  validation if the individual events weren't triggered while populating the form.
                  NOTE: Ajax calls for client-side validation are NOT ASYNC anymore

       6) UPDATE: Added domain checking to validate e-mail function.  If the regular expression matches, the
                  domain portion of the address is used to find a MX or A record to validate the domain.

       UPGRADING FROM PREVIOUS VERSION:
          * No concerns -- fully backward compatible.

---------------------------------------------------------------------------------------------------------------

1.03  11-20-10 TML

       1) BUG FIX: Removing references to the error messages being RED in the general error box at the top
                   of the page when errors are present.

          UPDATE:  Removing key protection functions

          NEW:     Added new field types of TYPE_STATEORPROVINCEABBREVIATION and TYPE_STATEORPROVINCE
                   Part of this involved moving out states and abbreviations into a global variable
                   which is useful for sites to include this file just to access those.

       UPGRADING FROM PREVIOUS VERSION:
          * Constructor change -- the constructor no longer requires an array with key values.

---------------------------------------------------------------------------------------------------------------

1.02  10-22-10 TML

       1) BUG FIX: Server-side validation errors are now displayed and written on the server side rather
                   than jQuery written that updates the DIV's in the DocReady area.  Now if JavaScript
                   is disabled DsForm can continue to operate in a simple state (no follow-up field
                   or client-side validation support)

---------------------------------------------------------------------------------------------------------------

1.01  10-14-10 RML

       1) BUG FIX: Refactored the way SetRichEditorOptions() is used.  The second argument must be
                   an array of TinyMCE options to override the defaults. All arguments are always strings.
                   if you are passing true or false into TinyMCE DsForm will de-string it for you.
                   e.g. $form->SetRichEditorOptions('your_rich_field', array('tiny_mce_opt1' => 'false',
                                                                             'tiny_mce_opt2' => 'example');

                   Added two new default TinyMCE options to stop relative URL conversion when the
                   "link" button is used in Rich textareas.

---------------------------------------------------------------------------------------------------------------

1.00  09-13-10 TML

       1) BUG FIX: Pressing [ENTER] on a multi-page form in IE will submit to the final page
                   instead of advancing pages.  IE doesn't include the button INPUT in the POST
                   if the button isn't explicitly pressed.  For multi-page forms there's now
                   a hidden INPUT that is used to check against -- this hidden input is on
                   all pages except the final page.

---------------------------------------------------------------------------------------------------------------

0.99  04-18-10 TML

       !!!!! WARNING !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
       This is NOT backwards compatible.  If upgrading previous version, Read #4 below and update
       all instances of this method call to the new spelling.
       !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

       1) BUG FIX: Moving Cancel button to be printed AFTER the submit button
          making the cancel button always appear to the right.

       2) BUG FIX: Calling htmlentities() on a FILE field causes warnings because it's not a string.
          Values may not be set on FILE fields anyway, so code to do so has been replaced with
          an explanation that browser security prevents population of FILE input fields.

       3) BUG FIX: Some areas dealing with a FILE input type were only looking at TYPE_FILE and did
          not include TYPE_PHOTO in the conditions.  Those areas were updated to include both.

       4) BUG FIX: Fixed spelling AssignIntialValues() to AssignInitialValues()

       5) BUG FIX: The TinyMCE Rich Editor options, when setting it via API breaks the jQuery JS
          code causing the page to not load.  Changed the way the values are output to be sure
          the commas line up properly for a property and do not contain extras.

       6) NEW: When a TYPE_FILE or a TYPE_PHOTO exist on the form AND if an error occurs on the form
          AND if the error is not the file field AND there was a file uploaded using that field,
          a new error is attached to the file noting that an error occurred elsewhere and the file
          will need to be chosen.

---------------------------------------------------------------------------------------------------------------

0.98  03-04-10 RML
       1) BUG FIX: When fields are re-rendered we need to wrap that in htmlentities() so data
          with double quotes does not break.

---------------------------------------------------------------------------------------------------------------

0.97  02-05-10 RML
       1) NEW: Moved cancel button from left to the right side.
       2) NEW: Added SetCalendarOptionsManually() method to allow you to pass raw input into the
          jquery datepicker
       3) NEW: Added a jquery dirty form plugin when BACK_MODE_WARN so we can not warn them if
          there are no changes which will be lost

---------------------------------------------------------------------------------------------------------------

0.96  11-09-09 TML
       1) NEW: Added ability to show checkboxes in multiple columns using a new last parameter
               on AddCheckboxButtons() of $columnsToShow which by default is 1.

---------------------------------------------------------------------------------------------------------------

0.95  11-09-09 TML
       1) NEW: Added ability for cancel button through SetFormCancel() and URL redirect control
               through SetCancelUrlFilterCallback()

       2) BUG FIX: When assigning initial values, if a field in the values array does not exist
                   on the form, ignore the field

       3) BUG FIX: When loading values through AssignInitialValues(), if the value is a date
                   re-assign value as screen-format (m/d/y) instead of MySQL-format (y-m-d)

       4) BUG FIX: Added clone DIV tags around cloned areas that are pre-populated as part of the
                   load.  This allows the 'remove' link to remove all but 1 item should the
                   user want to delete one.

       5) BUG FIX: Changed JS code for removing repeatable clones to allow removal of all but 1 of
                   the cloneable areas.  Previously if editing a record with 10 items at load-time
                   you could not remove any, but could add 11th and remove the 11th.  Now you are
                   able to remove the 10th through 2nd items.  This way you're not forced to always
                   have the same number of items as you first saved the form with.

---------------------------------------------------------------------------------------------------------------

0.94  11-02-09 TML
       1) Bug Fix: Undefined index: watchForNotEmpty -- value was not initialized to false in all
          the custom follow-up field functions

---------------------------------------------------------------------------------------------------------------

0.93  11-02-09 TML/RML
       1) Bug Fix: When going "Back" the "load from post" ignoring form post.  Needed to add "AND"
          when BACK_MODE_WARN then ignore otherwise if BACK_MODE_VALIDATE it needs to load the post

---------------------------------------------------------------------------------------------------------------

0.92  10-29-09 TML
       1) Added functionality using AddFollowUpFieldWhenNotEmpty() which adds a follow-up field without any
          'watch values' and it watches the parent for any value (i.e., not empty) then displays the field

       2) Added ability to remove the last dynamically added repeatable group. Also updated JS code to count
          number of times the "add" link was clicked so the "remove" link can not be clicked past that amount

       3) Updated StartRepeatableFieldGroup to include "removeLinkText" and renamed "linkText" to
          "addLinkText" for clarity

       4) Added MAX_FILE_SIZE hidden form field with a 20 MB limit

       5) Added a DIV around all the buttons with a class of "form-button-container" which is used via CSS to
          control location of buttons

       6) Modified the behavior of replacing buttons with "processing" text to remove all buttons, not
          just the next/submit button

       7) Added new notice when form page has a file upload field, a "File(s) Uploading" message appears when
          next/submit is pressed to let the user know what is happening during large file uploads

       8) JS file (dsform.js): addWatchForFollowupField() added argument to watch for 'not empty' and modified
          function to use this argument

       9) JS File (dsform.js): Added type 'checkbox' to addWatchForToggleGroup() which
          searches all selected boxes and compare to list of watch values

       10) Form Validation (inc-form-validation.php): Updated validateInteger() to strip commas from input
           thereby not erroring out on values such as (4,000)

---------------------------------------------------------------------------------------------------------------

0.91  10-21-09 RML
       1) Bug fix/typo in 0.9 comments above.

       2) Bug fix: Added support for cloned TYPE_DATE fields so the jQuery datepicker works on clones

       3) Bug fix: Added support for cloned TYPE_RICHPARAGRAPH fields so tiny_mcu works on clones

---------------------------------------------------------------------------------------------------------------

0.9   10-19-2009 RML
       1) Added Repeatable Field Groups - Now you can call StartRepeatableFieldGroup() and everything until
       the call to EndRepeatableFieldGroup() will become "repeatable" on both the server and client side.
       It is up the caller to examine the variables properly when processing. e.g. if your repeatable group
       is called "abc" then check the "clone-count-abc" variable to see how many in that group came back.
       Then you can iterate over the count by tacking on the count variable (1-based) to the field name
       e.g. name1, age1 ... name3, age3, etc.

       2) Added AddRawHtml() so you can output HTML w/out having it wrapped in divs and having a clear put after it.

       3) Fixed a bug in renderDropdown() when Multi-select dropdowns had several selections

       4) In performServerSideValidation() - changed the order of checking.  Follow-up fields are now checked before
       Field groups.  This allows a follow-up inside a field group to behave properly.

---------------------------------------------------------------------------------------------------------------

0.8   10-13-2009 TML
       Added another parameter passed into the custom validation callback function which gives
       the function all the fields in an associative array indexed by the page number.
       Added a new function called AssignInitialValues() which takes input of an associative
       array fieldName => fieldValue and assigns the initial values for all the fields in it.
       When populating a large number of fields from a database this method is preferred over
       using the initial value parameter on each field type.

---------------------------------------------------------------------------------------------------------------

0.7   09-25-2009 RML
       Bug fixed where the use of an array of checkboxes with a watched field caused an array to be
       compared to a string.  Added code to search the array if the field watched is an array.

---------------------------------------------------------------------------------------------------------------

0.6   09-25-2009 RML (previous check-in)
       Bug fixed where errors returned by custom processing function caused the page re-display empty.

---------------------------------------------------------------------------------------------------------------

0.5   09-23-2009 TML
       Added new member variables to track the include path and by default the path is
       '/include'.  This value can now be set in scenarios where the absolute path is
       not /include and is set using a new method called 'SetIncludePath()'. This new
       method of setting the site's include path removes the need for mRichEditorPath.
       Also since the path is now a variable the inclusion of the jQuery scripts and
       CSS files has been moved out of the constructor and is now called in RenderForm()
       once the include path is known.

       Added a new feature to hide the submit button and replace it with text when clicked.
       If you want this to happen, simply call 'ReplaceSubmitButtonWithTextOnClick()' passing
       in the text to show.  If text is given, the jQuery click event is attached to the submit
       button and the text is replaced.  To control the formatting of the text shown, use the
       CSS selector "div.submit-button-replacement".

       SetFormProcess() arguments were updated making $redirectUrl an optional parameter.

       The call-back function used for page processing now includes additional arguments for use
       within the processing method.  They are $pageContent, $headContent, and $docReadyCode.  This
       allows our process method to act like DsForm and not redirect away from the site and instead
       write out new content.  After a custom call-back for processing the redirection only occurs
       if a mSuccessUrl value is present (this was the value that is now optional when setting the
       form processing).  If no redirection occurs then it simply does 'return;' and the custom
       callback should have populated the pagecontent, header, and docready values.

       Bug fixed where the FORM tag was not setting its CLASS attribute if it was set by the API.

       Bug fixed adding a div/clear after the closing FORM tag making sure nothing unwanted floats
       into the form.

       Bug fixed by having the $headContent, $docReadyCode, and $pageContent values appended to
       instead of assigned. This allows us to have text already assigned to these variables before
       we even initialize and call DsForm.

       Bug fixed for multi-select items.  The SELECT tag now has "[]" after its name indicated an
       array of values.  Also the attribute multiple="multiple" has been added.

       Bug fixed when calling a custom validation hook.  Previously this call-back function was executed
       regardless of normal error checking and in situations where we use this it shouldn't be.  Example --
       credit card validation and capture is happening even if other form fields get an error.  So the card
       is charged then an error causes the page to reload. They fix the bad data then submit again causing a
       second charge.

       Bug fixed when dealing with an array for YES/NO fields that have 0 => No and 1 => Yes... since
       this associative array looks exactly like a sequential array it's impossible to detect.  We have
       hardcoded this unique situation so is_assoc() will look to see if we're dealing with that case
       and return TRUE.

---------------------------------------------------------------------------------------------------------------

0.3   Many many updates not record by TML and RML

---------------------------------------------------------------------------------------------------------------

0.1   Initial version