JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
FIXED format_decimal(), and format_dollars/money()
[wfpl.git] / encode.php
index 38b09bd..63ff5ce 100644 (file)
@@ -2,21 +2,18 @@
 
 #  Copyright (C) 2005 Jason Woofenden
 #
-#  This file is part of wfpl.
-#
-#  wfpl is free software; you can redistribute it and/or modify it under the
-#  terms of the GNU Lesser General Public License as published by the Free
-#  Software Foundation; either version 2.1 of the License, or (at your option)
-#  any later version.
-#
-#  wfpl is distributed in the hope that it will be useful, but WITHOUT ANY
-#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-#  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
-#  more details.
-#
-#  You should have received a copy of the GNU Lesser General Public License
-#  along with wfpl; if not, write to the Free Software Foundation, Inc., 51
-#  Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#  
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#  
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
 # This file contains basic encodings. These are used by the encoder. You can
 # will encode foo (using enc_html()) before displaying it, so that characters
 # such as < will display properly.
 
+function enc_cap($str) {
+       $str = ucfirst($str);
+       return $str;
+}
+
+function enc_jsdq($str) {
+       $str = enc_sql($str);
+       $str = str_replace("\n", "\\n", $str);
+       return str_replace("\r", "\\r", $str);
+}
 
 # encode for putting within double-quotes in SQL
 function enc_sql($str) {
@@ -44,6 +51,44 @@ function enc_html($str) {
        return $str;
 }
 
+# Encode for output in html. Convert newlines to <br />
+#
+# Example: <p>~foo.htmlbr~</p>
+function enc_htmlbr($str) {
+       $str = enc_html($str);
+       $str = str_replace("\n", "<br />\n", $str);
+       return $str;
+}
+
+# Encode for output in html. Preserves newlines and indentation by converting
+# newlines to <br /> and spaces at the begining of lines to &nbsp;&nbsp;
+#
+# Example: <p>~foo.htmlbrtab~</p>
+function enc_htmlbrtab($str) {
+       $str = enc_htmlbr($str);
+       $space_to_nbsp = create_function('$matches', 'return str_repeat(\'&nbsp;\', strlen($matches[0]) * 2);');
+       $str = preg_replace_callback("|^ *|m", $space_to_nbsp, $str);
+       return $str;
+}
+
+# Encode for output in html. Spaces converted to &nbsp; and \n to <br />
+#
+# Example: <option value="12">~foo.htmlbrnbsp~</option>
+function enc_htmlbrnbsp($str) {
+       $str = enc_htmlbr($str);
+       $str = str_replace(' ', '&nbsp;', $str);
+       return $str;
+}
+
+# Encode for output in html. Spaces converted to &nbsp;
+#
+# Example: <option value="12">~foo.htmlnbsp~</option>
+function enc_htmlnbsp($str) {
+       $str = enc_html($str);
+       $str = str_replace(' ', '&nbsp;', $str);
+       return $str;
+}
+
 
 # HTML attribute.
 #
@@ -61,19 +106,39 @@ function enc_url_val($str) {
        return rawurlencode($str);
 }
 
+# FIXME
+function enc_url_path($str) {
+       $str = rawurlencode($str);
+       $str = str_replace('%2F', '/', $str);
+       return $str;
+}
+
+
 # This is a hack to work around html's stupid syntax for checkboxes.
 #
 # Place the template marker just before a " somewhere.
 #
 # Example: <input type="checkbox" name="foo~foo.checked~">
 function enc_checked($str) {
-       if($str == 'Yes') {
+       if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
                return '" checked="checked';
        } else {
                return '';
        }
 }
 
+# checkboxe values are stored in the db and handled in php as 0 or 1. When you
+# want it displayed as "Yes" or "No" use this:
+# Example: (displaying values from a form submission)  Over 60?: ~over_60.yesno~
+function enc_yesno($str) {
+       if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
+               return 'Yes';
+       } else {
+               return 'No';
+       }
+}
+
+
 # add a tab at the begining of each non-empty line
 function enc_tab($str) {
        $lines = explode("\n", $str);
@@ -93,39 +158,85 @@ function enc_upper($str) {
        return strtoupper($str);
 }
 
+# pass date in the form 2008-05-23
+# ercodes date as 05/23/2008
+function enc_mmddyyyy($yyyy_mm_dd) {
+       if($yyyy_mm_dd == '') {
+               return '';
+       }
+       if(strlen($yyyy_mm_dd) != 10) {
+               return date('m/d/Y');
+       }
+       return substr($yyyy_mm_dd, 5, 2) . '/' . substr($yyyy_mm_dd, 8, 2) . '/' . substr($yyyy_mm_dd, 0, 4);
+}
 
-# display <option>s
-function enc_states($str) {
-       $states_assoc = array("AL" => "Alabama", "AK" => "Alaska", "AZ" => "Arizona", "AR" => "Arkansas", "CA" => "California", "CO" => "Colorado", "CT" => "Connecticut", "DE" => "Delaware", "FL" => "Florida", "GA" => "Georgia", "HI" => "Hawaii", "ID" => "Idaho", "IL" => "Illinois", "IN" => "Indiana", "IA" => "Iowa", "KS" => "Kansas", "KY" => "Kentucky", "LA" => "Louisiana", "ME" => "Maine", "MD" => "Maryland", "MA" => "Massachusetts", "MI" => "Michigan", "MN" => "Minnesota", "MS" => "Mississippi", "MO" => "Missouri", "MT" => "Montana", "NE" => "Nebraska", "NV" => "Nevada", "NH" => "New Hampshire", "NJ" => "New Jersey", "NM" => "New Mexico", "NY" => "New York", "NC" => "North Carolina", "ND" => "North Dakota", "OH" => "Ohio", "OK" => "Oklahoma", "OR" => "Oregon", "PA" => "Pennsylvania", "RI" => "Rhode Island", "SC" => "South Carolina", "SD" => "South Dakota", "TN" => "Tennessee", "TX" => "Texas", "UT" => "Utah", "VT" => "Vermont", "VA" => "Virginia", "WA" => "Washington", "DC" => "Washington, DC", "WV" => "West Virginia", "WI" => "Wisconsin", "WY" => "Wyoming");
-       $ret = '';
+# depricated. call enc_mmddyyyy() instead
+function enc_mdy($str) {
+       return enc_mmddyyyy($str);
+}
+
+function enc_mmddyyyyhhmm($seconds) {
+       return date('m/d/Y g:ia', (int)$seconds);
+}
+
+# takes decimal
+# returns hh:mm
+function enc_hhmm($str) {
+       if(strlen($str) == 0) {
+               return '';
+       }
+       $hours = floor($str);
+       $minutes = round(($str - $hours) * 60);
+       $str = sprintf("%d:%02d", $hours, $minutes);
+       return $str;
+}
 
-       return encode_options($str, $states_assoc, $use_keys = true);
+# takes decimal
+# returns hh:mm followed by "am" or "pm" with no space
+function enc_12hr($str) {
+       if(strlen($str) == 0) {
+               return '';
+       }
+       $hours = floor($str);
+       $minutes = round(($str - $hours) * 60);
+       $suffix = 'am';
+       if($hours >= 12.0) {
+               $suffix = 'pm';
+               if($hours > 12.0) {
+                       $hours -= 12.0;
+               }
+       }
+       $str = sprintf("%d:%02d", $hours, $minutes);
+       $str .= $suffix;
+       return $str;
 }
 
 
+
+
 define('PULLDOWN_ARRAY', 0); define('PULLDOWN_HASH', 1); define('PULLDOWN_2D', 2);
 
-function pulldown_options_to_hash($options, $keys_from) {
+function pulldown_options_to_2d($options, $keys_from) {
        # convert other types of input to value=>display hash
        switch($keys_from) {
                case PULLDOWN_HASH:
-                       return $options;
-               case PULLDOWN_ARRAY:
                        $new_options = array();
-                       foreach($options as $opt) {
-                               $new_options[$opt] = $opt;
+                       foreach($options as $value => $display) {
+                               $new_options[] = array($value, $display);
                        }
                        return $new_options;
-               break;
-               case PULLDOWN_2D:
+               case PULLDOWN_ARRAY:
                        $new_options = array();
                        foreach($options as $opt) {
-                               $new_options[$opt[0]] = $opt[1];
+                               $new_options[] = array($opt, $opt);
                        }
                        return $new_options;
                break;
+               case PULLDOWN_2D:
+                       return $options;
+               break;
                default:
-                       die('unknown value: "' . print_r($keys_from) . '" passed in $keys_from parameter');
+                       die('pulldown_options_to_2d(): unknown value: "' . print_r($keys_from) . '" passed in $keys_from parameter');
        }
 }
 
@@ -149,7 +260,7 @@ function pulldown_options_to_hash($options, $keys_from) {
 #   multiple: UNTESTED set to true for multiple-select boxes. 
 
 function pulldown($name, $options, $keys_from = PULLDOWN_ARRAY, $multiple = false) {
-       $options = pulldown_options_to_hash($options, $keys_from);
+       $options = pulldown_options_to_2d($options, $keys_from);
        $GLOBALS[$name . '_options'] = array();
        $GLOBALS[$name . '_options']['options'] = $options;
        $GLOBALS[$name . '_options']['multiple'] = $multiple;
@@ -163,7 +274,7 @@ function enc_options($values, $name) {
        if($GLOBALS[$name . '_options']['multiple']) { # FIXME test this
                $values = explode(', ', $values);
        }
-       return encode_options($values, $GLOBALS[$name . '_options']['options'], PULLDOWN_HASH);
+       return encode_options($values, $GLOBALS[$name . '_options']['options'], PULLDOWN_2D);
 }
 
 # use this function along with a special template to generate the html for pulldowns and multiple select boxes.
@@ -178,13 +289,16 @@ function encode_options($selected, $options, $keys_from) {
                $selected = array($selected);
        }
 
-       $options = pulldown_options_to_hash($options, $keys_from);
+       if($keys_from != PULLDOWN_2D) {
+               $options = pulldown_options_to_2d($options, $keys_from);
+       }
 
        $out = '';
-       foreach($options as $value => $display) {
+       foreach($options as $valdisp) {
+               list($value, $display) = $valdisp;
                $out .= '<option';
 
-               if(in_array($value, $selected, $strict = true)) {
+               if(in_array($value, $selected)) {
                        $out .= ' selected="selected"';
                }
 
@@ -196,7 +310,7 @@ function encode_options($selected, $options, $keys_from) {
                        
                $out .= '>';
 
-               $out .= enc_html($display);
+               $out .= enc_htmlnbsp($display);
 
                $out .= "</option>\n";
        }
@@ -204,4 +318,73 @@ function encode_options($selected, $options, $keys_from) {
        return $out;
 }
 
-?>
+$GLOBALS['wfpl_states_assoc'] = array("AL" => "Alabama", "AK" => "Alaska", "AZ" => "Arizona", "AR" => "Arkansas", "CA" => "California", "CO" => "Colorado", "CT" => "Connecticut", "DE" => "Delaware", "FL" => "Florida", "GA" => "Georgia", "HI" => "Hawaii", "ID" => "Idaho", "IL" => "Illinois", "IN" => "Indiana", "IA" => "Iowa", "KS" => "Kansas", "KY" => "Kentucky", "LA" => "Louisiana", "ME" => "Maine", "MD" => "Maryland", "MA" => "Massachusetts", "MI" => "Michigan", "MN" => "Minnesota", "MS" => "Mississippi", "MO" => "Missouri", "MT" => "Montana", "NE" => "Nebraska", "NV" => "Nevada", "NH" => "New Hampshire", "NJ" => "New Jersey", "NM" => "New Mexico", "NY" => "New York", "NC" => "North Carolina", "ND" => "North Dakota", "OH" => "Ohio", "OK" => "Oklahoma", "OR" => "Oregon", "PA" => "Pennsylvania", "RI" => "Rhode Island", "SC" => "South Carolina", "SD" => "South Dakota", "TN" => "Tennessee", "TX" => "Texas", "UT" => "Utah", "VT" => "Vermont", "VA" => "Virginia", "WA" => "Washington", "DC" => "Washington, DC", "WV" => "West Virginia", "WI" => "Wisconsin", "WY" => "Wyoming");
+
+# display <option>s
+function enc_states($str) {
+       $ret = '';
+
+       return encode_options($str, $GLOBALS['wfpl_states_assoc'], PULLDOWN_HASH);
+}
+
+$GLOBALS['wfpl_provinces_assoc'] = array("AB" => "Alberta", "BC" => "British Columbia", "MB" => "Manitoba", "NF" => "Newfoundland", "NB" => "New Brunswick", "NS" => "Nova Scotia", "NT" => "Northwest Territories", "NU" => "Nunavut", "ON" => "Ontario", "PE" => "Prince Edward Island", "QC" => "Quebec", "SK" => "Saskatchewan", "YT" => "Yukon Territory");
+
+# display <option>s
+function enc_provinces($str) {
+       $ret = '';
+
+       return encode_options($str, $GLOBALS['wfpl_provinces_assoc'], PULLDOWN_HASH);
+}
+
+# returns "odd", then "even", then "odd" etc.
+function enc_evenodd($values, $name) {
+       if(!isset($GLOBALS['wfpl_even_odds'])) {
+               $GLOBALS['wfpl_even_odds'] = array();
+       }
+
+       if($GLOBALS['wfpl_even_odds'][$name]) {
+               $GLOBALS['wfpl_even_odds'][$name] = false;
+               return 'even';
+       } else {
+               $GLOBALS['wfpl_even_odds'][$name] = true;
+               return 'odd';
+       }
+}
+
+function enc_image_src($str) {
+       list($src, $width, $height, $a, $b, $c) = explode(' ', $str);
+       return $src;
+}
+
+function enc_image_width($str) {
+       list($src, $width, $height, $a, $b, $c) = explode(' ', $str);
+       return $width;
+}
+
+function enc_image_height($str) {
+       list($src, $width, $height, $a, $b, $c) = explode(' ', $str);
+       return $height;
+}
+
+function enc_thumb_src($str) {
+       list($a, $b, $c, $src, $width, $height) = explode(' ', $str);
+       return $src;
+}
+
+function enc_thumb_width($str) {
+       list($a, $b, $c, $src, $width, $height) = explode(' ', $str);
+       return $width;
+}
+function enc_thumb_height($str) {
+       list($a, $b, $c, $src, $width, $height) = explode(' ', $str);
+       return $height;
+}
+
+# example template: Length: ~length.html~ day~length.s~
+function enc_s($str) {
+       if($str == '1') {
+               return '';
+       }
+
+       return 's';
+}