JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
xhtml -> html5
[wfpl.git] / encode.php
index b73a0ec..07bd2f8 100644 (file)
@@ -2,30 +2,31 @@
 
 #  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
-# 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.
 
+function enc_cap($str) {
+       $str = ucfirst($str);
+       return $str;
+}
 
 function enc_jsdq($str) {
        $str = enc_sql($str);
@@ -42,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);
@@ -50,18 +51,38 @@ 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.html~</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;
+#
+# 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>
+# Example: <option value="12">~foo htmlnbsp~</option>
 function enc_htmlnbsp($str) {
        $str = enc_html($str);
        $str = str_replace(' ', '&nbsp;', $str);
@@ -71,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);
@@ -80,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);
 }
@@ -97,15 +118,26 @@ 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 == 'Yes') {
+       if($str && $str !== 'No' && $str !== 'False' && $str !== 'false') {
                return '" checked="checked';
        } else {
                return '';
        }
 }
 
+# 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';
+       } else {
+               return 'No';
+       }
+}
+
+
 # add a tab at the begining of each non-empty line
 function enc_tab($str) {
        $lines = explode("\n", $str);
@@ -125,10 +157,59 @@ function enc_upper($str) {
        return strtoupper($str);
 }
 
-function enc_ddmmyyyyhhmm($seconds) {
+# 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);
+}
+
+# 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;
+}
+
+# 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;
+}
+
 
 
 
@@ -220,7 +301,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 .= '"';
@@ -269,4 +350,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';
+}