JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
metaform: add radio button support
[wfpl.git] / encode.php
index 273d026..835f7cb 100644 (file)
@@ -17,9 +17,9 @@
 
 
 # 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~
+# specify any template tag to be encoded with this syntax: ~variable encoding~
 #
-# this example: <p>~foo.html~</p>
+# this example: <p>~foo html~</p>
 # will encode foo (using enc_html()) before displaying it, so that characters
 # such as < will display properly.
 
@@ -43,7 +43,7 @@ function enc_sql($str) {
 
 # Encode for output in html. does nothing with whitespace
 #
-# Example: <p>~foo.html~</p>
+# Example: <p>~foo html~</p>
 function enc_html($str) {
        $str = str_replace('&', '&amp;', $str);
        $str = str_replace('<', '&lt;', $str);
@@ -51,19 +51,19 @@ function enc_html($str) {
        return $str;
 }
 
-# Encode for output in html. Convert newlines to <br />
+# Encode for output in html. Convert newlines to <br>
 #
-# Example: <p>~foo.htmlbr~</p>
+# Example: <p>~foo htmlbr~</p>
 function enc_htmlbr($str) {
        $str = enc_html($str);
-       $str = str_replace("\n", "<br />\n", $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;
+# newlines to <br> and spaces at the begining of lines to &nbsp;&nbsp;
 #
-# Example: <p>~foo.htmlbrtab~</p>
+# 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);');
@@ -71,9 +71,18 @@ function enc_htmlbrtab($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>
+# Example: <option value="12">~foo htmlnbsp~</option>
 function enc_htmlnbsp($str) {
        $str = enc_html($str);
        $str = str_replace(' ', '&nbsp;', $str);
@@ -83,7 +92,7 @@ function enc_htmlnbsp($str) {
 
 # HTML attribute.
 #
-# Example: <input name="foo" value="~foo.attr~">
+# Example: <input name="foo" value="~foo attr~">
 function enc_attr($str) {
        $str = str_replace('&', '&amp;', $str);
        $str = str_replace('"', '&quot;', $str);
@@ -92,7 +101,7 @@ function enc_attr($str) {
 
 # URI agument value.
 #
-# Example:  <a href="http://example.com?foo=~foo.url_val.attr~">http://example.com?foo=~foo.url_val~</a>
+# 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);
 }
@@ -109,7 +118,7 @@ function enc_url_path($str) {
 #
 # Place the template marker just before a " somewhere.
 #
-# Example: <input type="checkbox" name="foo~foo.checked~">
+# Example: <input type="checkbox" name="foo~foo checked~">
 function enc_checked($str) {
        if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
                return '" checked="checked';
@@ -118,9 +127,8 @@ function enc_checked($str) {
        }
 }
 
-# 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~
+# normally, checkboxes values from get/post to 0 or 1, and stored in the database this way. enc_yesno() can be used in your templates to display this as "Yes" or "No".
+# Example template:  Subscribe to mailing list?: ~subscribe yesno~
 function enc_yesno($str) {
        if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
                return 'Yes';
@@ -260,7 +268,7 @@ function pulldown($name, $options, $keys_from = PULLDOWN_ARRAY, $multiple = fals
 # 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');
+               die("pulldown('$name') 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);
@@ -268,6 +276,54 @@ function enc_options($values, $name) {
        return encode_options($values, $GLOBALS[$name . '_options']['options'], PULLDOWN_2D);
 }
 
+function enc_radio_n($str, $name, $n) {
+       if(!isset($GLOBALS[$name . '_options'])) {
+               die("pulldown('$name') must be called before this template can be run. See code/wfpl/encode.php");
+       }
+
+       if(!isset($GLOBALS[$name . '_options']['options'][$n])) {
+               die("Template error: pulldown('$name') does not have element # $n");
+       }
+
+       $value = enc_attr($GLOBALS[$name . '_options']['options'][$n][0]);
+
+       if($str === $value) {
+               $value .= '" checked="checked';
+       }
+
+       return $value;
+}
+function enc_radio_0($str, $name) { return enc_radio_n($str, $name, 0); }
+function enc_radio_1($str, $name) { return enc_radio_n($str, $name, 1); }
+function enc_radio_2($str, $name) { return enc_radio_n($str, $name, 2); }
+function enc_radio_3($str, $name) { return enc_radio_n($str, $name, 3); }
+function enc_radio_4($str, $name) { return enc_radio_n($str, $name, 4); }
+function enc_radio_5($str, $name) { return enc_radio_n($str, $name, 5); }
+function enc_radio_6($str, $name) { return enc_radio_n($str, $name, 6); }
+function enc_radio_7($str, $name) { return enc_radio_n($str, $name, 7); }
+
+
+function enc_radio_caption_n($str, $name, $n) {
+       if(!isset($GLOBALS[$name . '_options'])) {
+               die("pulldown('$name') must be called before this template can be run. See code/wfpl/encode.php");
+       }
+
+       if(!isset($GLOBALS[$name . '_options']['options'][$n])) {
+               die("Template error: pulldown('$name') does not have element #$n");
+       }
+
+       return $GLOBALS[$name . '_options']['options'][$n][1];
+}
+function enc_radio_caption_0($str, $name) { return enc_radio_caption_n($str, $name, 0); }
+function enc_radio_caption_1($str, $name) { return enc_radio_caption_n($str, $name, 1); }
+function enc_radio_caption_2($str, $name) { return enc_radio_caption_n($str, $name, 2); }
+function enc_radio_caption_3($str, $name) { return enc_radio_caption_n($str, $name, 3); }
+function enc_radio_caption_4($str, $name) { return enc_radio_caption_n($str, $name, 4); }
+function enc_radio_caption_5($str, $name) { return enc_radio_caption_n($str, $name, 5); }
+function enc_radio_caption_6($str, $name) { return enc_radio_caption_n($str, $name, 6); }
+function enc_radio_caption_7($str, $name) { return enc_radio_caption_n($str, $name, 7); }
+
+
 # use this function along with a special template to generate the html for pulldowns and multiple select boxes.
 #
 # Parameters:
@@ -293,7 +349,7 @@ function encode_options($selected, $options, $keys_from) {
                        $out .= ' selected="selected"';
                }
 
-               if($value !== $display) {
+               if($value !== $display || strpos($value, ' ') !== false) {
                        $out .= ' value="';
                        $out .= enc_attr($value);
                        $out .= '"';
@@ -342,4 +398,40 @@ function enc_evenodd($values, $name) {
        }
 }
 
-?>
+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';
+}