3 # Copyright (C) 2005 Jason Woofenden
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19 # This file contains basic encodings. These are used by the encoder. You can
20 # specify any template tag to be encoded with this syntax: ~variable.encoding~
22 # this example: <p>~foo.html~</p>
23 # will encode foo (using enc_html()) before displaying it, so that characters
24 # such as < will display properly.
26 function enc_cap($str) {
31 function enc_jsdq($str) {
33 $str = str_replace("\n", "\\n", $str);
34 return str_replace("\r", "\\r", $str);
37 # encode for putting within double-quotes in SQL
38 function enc_sql($str) {
39 $str = str_replace("\\", "\\\\", $str);
40 $str = str_replace('"', "\\\"", $str);
44 # Encode for output in html. does nothing with whitespace
46 # Example: <p>~foo.html~</p>
47 function enc_html($str) {
48 $str = str_replace('&', '&', $str);
49 $str = str_replace('<', '<', $str);
50 $str = str_replace('>', '>', $str);
54 # Encode for output in html. Convert newlines to <br />
56 # Example: <p>~foo.htmlbr~</p>
57 function enc_htmlbr($str) {
58 $str = enc_html($str);
59 $str = str_replace("\n", "<br />\n", $str);
63 # Encode for output in html. Preserves newlines and indentation by converting
64 # newlines to <br /> and spaces at the begining of lines to
66 # Example: <p>~foo.htmlbrtab~</p>
67 function enc_htmlbrtab($str) {
68 $str = enc_htmlbr($str);
69 $space_to_nbsp = create_function('$matches', 'return str_repeat(\' \', strlen($matches[0]) * 2);');
70 $str = preg_replace_callback("|^ *|m", $space_to_nbsp, $str);
74 # Encode for output in html. Spaces converted to
76 # Example: <option value="12">~foo.htmlnbsp~</option>
77 function enc_htmlnbsp($str) {
78 $str = enc_html($str);
79 $str = str_replace(' ', ' ', $str);
86 # Example: <input name="foo" value="~foo.attr~">
87 function enc_attr($str) {
88 $str = str_replace('&', '&', $str);
89 $str = str_replace('"', '"', $str);
95 # Example: <a href="http://example.com?foo=~foo.url_val.attr~">http://example.com?foo=~foo.url_val~</a>
96 function enc_url_val($str) {
97 return rawurlencode($str);
101 function enc_url_path($str) {
102 $str = rawurlencode($str);
103 $str = str_replace('%2F', '/', $str);
108 # This is a hack to work around html's stupid syntax for checkboxes.
110 # Place the template marker just before a " somewhere.
112 # Example: <input type="checkbox" name="foo~foo.checked~">
113 function enc_checked($str) {
114 if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
115 return '" checked="checked';
121 # checkboxe values are stored in the db and handled in php as 0 or 1. When you
122 # want it displayed as "Yes" or "No" use this:
123 # Example: (displaying values from a form submission) Over 60?: ~over_60.yesno~
124 function enc_yesno($str) {
125 if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
133 # add a tab at the begining of each non-empty line
134 function enc_tab($str) {
135 $lines = explode("\n", $str);
137 foreach($lines as $line) {
144 # remove the extra newline added above
145 return substr($out, 0, -1);
148 function enc_upper($str) {
149 return strtoupper($str);
152 # pass date in the form 2008-05-23
153 # ercodes date as 05/23/2008
154 function enc_mmddyyyy($yyyy_mm_dd) {
155 if($yyyy_mm_dd == '') {
158 if(strlen($yyyy_mm_dd) != 10) {
159 return date('m/d/Y');
161 return substr($yyyy_mm_dd, 5, 2) . '/' . substr($yyyy_mm_dd, 8, 2) . '/' . substr($yyyy_mm_dd, 0, 4);
164 # depricated. call enc_mmddyyyy() instead
165 function enc_mdy($str) {
166 return enc_mmddyyyy($str);
169 function enc_mmddyyyyhhmm($seconds) {
170 return date('m/d/Y g:ia', (int)$seconds);
175 function enc_hhmm($str) {
176 if(strlen($str) == 0) {
179 $hours = floor($str);
180 $minutes = round(($str - $hours) * 60);
181 $str = sprintf("%d:%02d", $hours, $minutes);
186 # returns hh:mm followed by "am" or "pm" with no space
187 function enc_12hr($str) {
188 if(strlen($str) == 0) {
191 $hours = floor($str);
192 $minutes = round(($str - $hours) * 60);
200 $str = sprintf("%d:%02d", $hours, $minutes);
208 define('PULLDOWN_ARRAY', 0); define('PULLDOWN_HASH', 1); define('PULLDOWN_2D', 2);
210 function pulldown_options_to_2d($options, $keys_from) {
211 # convert other types of input to value=>display hash
214 $new_options = array();
215 foreach($options as $value => $display) {
216 $new_options[] = array($value, $display);
220 $new_options = array();
221 foreach($options as $opt) {
222 $new_options[] = array($opt, $opt);
230 die('pulldown_options_to_2d(): unknown value: "' . print_r($keys_from) . '" passed in $keys_from parameter');
235 # call this function before you run() the template so enc_options() knows what
240 # name: the name of the html control
242 # options: an array of options to display in the pulldown/selectbox
244 # keys_from: Set to one of:
245 # PULLDOWN_ARRAY: (default) values of $options are displayd and posted
246 # PULLDOWN_HASH: values of $options are display, keys are posted
247 # PULLDOWN_2D: $options is a 2 dimensional array.
248 # $options[0][1] is displayed, $options[0][0] is posted.
249 # $options[1][1] is displayed, $options[1][0] is posted.
251 # multiple: UNTESTED set to true for multiple-select boxes.
253 function pulldown($name, $options, $keys_from = PULLDOWN_ARRAY, $multiple = false) {
254 $options = pulldown_options_to_2d($options, $keys_from);
255 $GLOBALS[$name . '_options'] = array();
256 $GLOBALS[$name . '_options']['options'] = $options;
257 $GLOBALS[$name . '_options']['multiple'] = $multiple;
260 # output a bunch of <option> tags
261 function enc_options($values, $name) {
262 if(!isset($GLOBALS[$name . '_options'])) {
263 die('pulldown() must be called before this template can be run. See code/wfpl/encode.php');
265 if($GLOBALS[$name . '_options']['multiple']) { # FIXME test this
266 $values = explode(', ', $values);
268 return encode_options($values, $GLOBALS[$name . '_options']['options'], PULLDOWN_2D);
271 # use this function along with a special template to generate the html for pulldowns and multiple select boxes.
275 # selected: can be a string or (for multiple-selects) an array
277 # options, keys_from: see documentation for pulldown() above
278 function encode_options($selected, $options, $keys_from) {
279 if(!is_array($selected)) {
280 $selected = array($selected);
283 if($keys_from != PULLDOWN_2D) {
284 $options = pulldown_options_to_2d($options, $keys_from);
288 foreach($options as $valdisp) {
289 list($value, $display) = $valdisp;
292 if(in_array($value, $selected)) {
293 $out .= ' selected="selected"';
296 if($value !== $display) {
298 $out .= enc_attr($value);
304 $out .= enc_htmlnbsp($display);
306 $out .= "</option>\n";
312 $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");
315 function enc_states($str) {
318 return encode_options($str, $GLOBALS['wfpl_states_assoc'], PULLDOWN_HASH);
321 $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");
324 function enc_provinces($str) {
327 return encode_options($str, $GLOBALS['wfpl_provinces_assoc'], PULLDOWN_HASH);
330 # returns "odd", then "even", then "odd" etc.
331 function enc_evenodd($values, $name) {
332 if(!isset($GLOBALS['wfpl_even_odds'])) {
333 $GLOBALS['wfpl_even_odds'] = array();
336 if($GLOBALS['wfpl_even_odds'][$name]) {
337 $GLOBALS['wfpl_even_odds'][$name] = false;
340 $GLOBALS['wfpl_even_odds'][$name] = true;