#
# This file is part of wfpl.
#
-# wfpl 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 2, or (at your option)
+# 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
-# General Public License for more details.
+# 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 General Public License
-# along with wfpl; see the file COPYING. If not, write to the
-# Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
-# MA 02111-1307, USA.
+# 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 file contains basic encodings
+# This file contains basic encodings. These are used by the encoder. You can
+# specify any template tag to be encoded with this syntax: ~variable.encoding~
+#
+# this example: <p>~foo.html~</p>
+# will encode foo (using enc_html()) before displaying it, so that characters
+# such as < will display properly.
+
# encode for putting within double-quotes in SQL
function enc_sql($str) {
return $str;
}
-# encode for output in html. does nothing with whitespace
+# Encode for output in html. does nothing with whitespace
+#
+# Example: <p>~foo.html~</p>
function enc_html($str) {
$str = str_replace('&', '&', $str);
$str = str_replace('<', '<', $str);
}
-# html attributes (eg <input value="...."
+# HTML attribute.
+#
+# Example: <input name="foo" value="~foo.attr~">
function enc_attr($str) {
$str = str_replace('&', '&', $str);
$str = str_replace('"', '"', $str);
return $str;
}
-# this is a stupid hack to work around html's stupid syntax for checkboxes
+# URI agument value.
+#
+# Example: <a href="http://example.com?foo=~foo.url_val.attr~">http://example.com?foo=~foo.url_val~</a>
+function enc_url_val($str) {
+ return rawurlencode($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') {
return '" checked="checked';
return '';
}
}
-
+# add a tab at the begining of each non-empty line
+function enc_tab($str) {
+ $lines = explode("\n", $str);
+ $out = '';
+ foreach($lines as $line) {
+ if($line) {
+ $out .= "\t$line";
+ }
+ $out .= "\n";
+ }
+
+ # remove the extra newline added above
+ return substr($out, 0, -1);
+}
+
+function enc_upper($str) {
+ return strtoupper($str);
+}
+
+
+# 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 = '';
+
+ return encode_options($str, $states_assoc, $use_keys = true);
+}
+
+
+define('PULLDOWN_ARRAY', 0); define('PULLDOWN_HASH', 1); define('PULLDOWN_2D', 2);
+
+function pulldown_options_to_hash($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;
+ }
+ return $new_options;
+ break;
+ case PULLDOWN_2D:
+ $new_options = array();
+ foreach($options as $opt) {
+ $new_options[$opt[0]] = $opt[1];
+ }
+ return $new_options;
+ break;
+ default:
+ die('unknown value: "' . print_r($keys_from) . '" passed in $keys_from parameter');
+ }
+}
+
+
+# call this function before you run() the template so enc_options() knows what
+# to do
+#
+# Parameters:
+#
+# name: the name of the html control
+#
+# options: an array of options to display in the pulldown/selectbox
+#
+# keys_from: Set to one of:
+# PULLDOWN_ARRAY: (default) values of $options are displayd and posted
+# PULLDOWN_HASH: values of $options are display, keys are posted
+# PULLDOWN_2D: $options is a 2 dimensional array.
+# $options[0][1] is displayed, $options[0][0] is posted.
+# $options[1][1] is displayed, $options[1][0] is posted.
+#
+# 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);
+ $GLOBALS[$name . '_options'] = array();
+ $GLOBALS[$name . '_options']['options'] = $options;
+ $GLOBALS[$name . '_options']['multiple'] = $multiple;
+}
+
+# output a bunch of <option> tags
+function enc_options($values, $name) {
+ if(!isset($GLOBALS[$name . '_options'])) {
+ die('pulldown() must be called before this template can be run. See code/wfpl/encode.php');
+ }
+ if($GLOBALS[$name . '_options']['multiple']) { # FIXME test this
+ $values = explode(', ', $values);
+ }
+ return encode_options($values, $GLOBALS[$name . '_options']['options'], PULLDOWN_HASH);
+}
+
+# use this function along with a special template to generate the html for pulldowns and multiple select boxes.
+#
+# Parameters:
+#
+# selected: can be a string or (for multiple-selects) an array
+#
+# options, keys_from: see documentation for pulldown() above
+function encode_options($selected, $options, $keys_from) {
+ if(!is_array($selected)) {
+ $selected = array($selected);
+ }
+
+ $options = pulldown_options_to_hash($options, $keys_from);
+
+ $out = '';
+ foreach($options as $value => $display) {
+ $out .= '<option';
+
+ if(in_array($value, $selected, $strict = true)) {
+ $out .= ' selected="selected"';
+ }
+
+ if($value !== $display) {
+ $out .= ' value="';
+ $out .= enc_attr($value);
+ $out .= '"';
+ }
+
+ $out .= '>';
+
+ $out .= enc_html($display);
+
+ $out .= "</option>\n";
+ }
+
+ return $out;
+}
+
+?>
Got questions, comments, patches, etc.? Contact Jason Woofenden