Adding a variable to a retPlan "entries" database (expenses,income,assets,invests)

1) Create the variable in the mysql table
   in  retPlanInit.inc, find the appropriate sql="create table ... " statement and add the desired variable.
   You will have to regenerate the retplan mysql database.

       Hint: for temporary work, you can add a variable (using phpVarAdmin) to an existing table in the retPlan database

   Note:    Keep Track of Its Exact Name!

2) In retPlan_xxxx.inc (where xxx is one of expenses, income, assets, or invest), make the following changes

  a) In the  ::::: add xxx:::: section   (use to display the add a single xxx form)

    Add a <tr> with an <input> statement.
       The name (and id) attributes of this <input> should be structured as name="xxxVarname"
       (and  id="ixxxVarname").
       Example:
             <input type="checkbox" value="1" name="assetInflTrack" id="iassetInflTrack" title="some stuff">
       Note that the id could be used in a <label> statement (otherwise, it is not currently used).
       Also note tha the name does NOT have to be the same as the mysql varname (that you will be saving
       these values to)

       Hint: you can use the following "onChange" functions within the <input> statement
          onChange="checkIsNumber(this)"   -- if entered value is not a number, an alert error message is displayed
          onChange="checkIsNameString(this)"    -- check for a 1-word name with alphanumerics (and _) characters only
          onChange="checkAllowed(this,'v1,v2,...')" -- check if entered values is v1, or v2, or ...

    b) In the "add bulk xxx " section       (used to display the bulk entries table, and csv entry area)
       In the "bulkEntriesTable_table_xxx" table, add a
            <th>varname</th>
       in a reasonable spot  -- keep track of this spot, you will need to match locations in 4.b.ii below
       The varname can be descripitve

    c) in the <!--  csv entry for bulk   --> section
        Find the "specify xxx entries, and add a variable to the <b>Format:</b>.
        The varname can be descriptive.
        It really SHOULD be in the same spot (relative to other variables) as  the <th>
        specified in (b) above!

    d) In the <input ... onClick="copyCsvEntriesTo table( ..." below this, change the last argument
       in the copyCsvEntriesToTable function -- increment it by 1

    e) in the <!-- examples of csv entries --> section
       Insert a value in each of the example rows. BE SURE it is in the same column (in the same
       comma seperated position) as used in (c) above!

    f) Optionally: add a  description in the :::: description of   xxx   :: section in retPlan_help.inc
       (i.e;   add a new <li>).

3) In retPlan_util.inc

  a)  In the displayxxxEntriesTablefunction    -- this is used to "view" the current xxx entries
      i) Find "columns of the   xxx table" section ($hdrs. lines follow it)
         Add $hdrs.= line, containing <th>varname</tt>(it doesn't have to be the actual variable name)

      ii) Below the "// add row for this xxx", add a
           $aline.=' <td>$avv['VARNAMEM']></td> --
         be sure it is in the same position as <th> (in i) above).
         AND VARNAMEM MUST BE AN UPPERCASE OF THE NAME USED IN STEP 1 (that is: the name of the mysql variable).
         For example $avv['INFADJUST']
         Note: you don't have to use this $avv['VARNAMEM'] -- you can display (in the <td>) anything 
         (i.e.; you can display a modification of the value of $avv['VARNAMEM']
         
  b) In the exportEntries function

     Find the `if $atable='xxx'` section

     a) To the hlist, add the name of the variable -- this MUST be the mysql variable (specified in 1)
        The order MUST match the order of this variable that you specified in 2b
     b) To the hdrline, add the variable name (or short description). This is used as a comment in
       export files, so should (but doesn't have to be) correctly aligned

 c) In the addAnxxx function
    i) Add a $amyVar=trim(extractRequestVar('xxxVarname',defval))
       where xxxVarname MUST be the name="xxxVarname" specified in (2a).

       If you were clever in what you allow in the <input> statement in 2a, you can modify the $amyVar variable.
       

    ii) Add a $bamyVar=mysqli_real_escape_string($link,$amyVar);

      Note: of course, instead of $amyVar (and $bamyVar), you should use a more descriptive  (and unique) variable name
            for this new variable.

    iii) In the sql="replace into ... " line, insert the VARNAMEM of the mysql variable (as specified in (1a))
    iv) In the same location on the next line, add a `,'$bamyVar'`
        That is, include `$bamyVar` in the csv on between the (...) on the next line -- and it MUST be in the
        same relative location as the VARNAMEM you just inserted in the "replace into" lie

 d) In the addBulkxxx function
     i) As with 3c : change the replace into line (add the variable name),
     
     ii) In the
         IF (COUNT($ALINE2)<JJ) {
        add 1 to jj (so if jj=12, jj becomes 13)
        And change the error mesage below to match the new variable order (i.e.; the same order as specified in 2b
     ii) In the  for ($iv=0;$iv<count($ventries);$iv++) section
         Read the variable using $aline[m], where m corresponds to the spot specified in (2b) and in (4.b.ii)
         Modify this using mysqli_real_escape_string
     iv) In the $tt="..." line, add this modified variable (in the same spot as you used in (i) above)
     
       Note: the location of the mysql variable name in 3.d.i (and in 3.d.iv) doesn't matter -- just so long as the
       location is the same in both places.
       
     v) For all $aline2[m] after this, add 1 to the value of m (so a $aline2[9] should becomd $aline2[10])

     vi) Add 1 to the mm in    $goo=array_slice($aline2,mm);

4) In retPlan.js

  a) Find the modifyTableEntries function
     Find the `if (atable=="xxx")` section (there is one for each of the 4 types of entries)
     Find the copyCsvEntriesToTable line
       Change the number befor the ',data)' to be new new number of variables. That is, increase the current number by
       one (so if the prior value was 12, change it to 13)

  b) Find the useBulkEntriesTable_newrow function
     Find the `if (atable=='expenses')`  section  (there is one for each of the 4 types of entries)

     i) Change the `if nodefs==1 ..` line
            Add the default value for this new variable in the proper place --  as specified in (2b).
       This specifies the default values (used when you click the "Add another row to the table" button)

     ii) In the v0+='.. lines below this,  add a
        v0+='<td><input name="avarname" value="'+defvals[n]+'" > </td>'
     where
        avarname can be different than the variable name.
        the "n" MUST match the location in defvals.

        BE SURE THIS IS IN THE SAME SPOT as the <th> added in 2.b above

          Hint: add one to the existing defval[n] of the v0 preceding this  new entry

          As with 2a, you can specify several useful onChange= attributes in the <input>.
          But be sure to escape ` characters:
           Example:     onChange="checkAllowed(this,\'0,1\')"

      iv) In all v0+ .. lines following this new entry, update (by 1) the defval[n]'s
       v) The last v0, with the "defvals.slice(m)" --  add one to m (this allows the description to have commas)

     Thus: you are adding a column in the bulk table, and it must be in the same location (the same <td> in the <tr>)
     as the column descriptor specified in 2b. And, the default value must match the spot in the defval array.