added enc_url_val() UNTESTED

[wfpl.git] / encode.php

diff --git a/encode.php b/encode.php
index 90ec6c8..ab2c271 100644 (file)
--- a/encode.php
+++ b/encode.php
@@ -4,24 +4,39 @@
 #
 #  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) {
+       $str = str_replace("\\", "\\\\", $str);
+       $str = str_replace('"', "\\\"", $str);
+       return $str;
+}
 
+# Encode for output in html. does nothing with whitespace
+#
+# Example: <p>~foo.html~</p>
 function enc_html($str) {
        $str = str_replace('&', '&amp;', $str);
        $str = str_replace('<', '&lt;', $str);
@@ -30,11 +45,48 @@ function enc_html($str) {
 }
 
 
-# html attributes (eg  <input value="...."
+# HTML attribute.
+#
+# Example: <input name="foo" value="~foo.attr~">
 function enc_attr($str) {
        $str = str_replace('&', '&amp;', $str);
        $str = str_replace('"', '&quot;', $str);
        return $str;
 }
 
+# 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';
+       } else {
+               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);
+}
 
+?>