JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
metaform capitalizes default captions, added tem::load_str()
[wfpl.git] / template.php
index 3c0e1e0..28b4814 100644 (file)
@@ -4,20 +4,19 @@
 #
 #  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 generally useful template handling code. It is wrapped in
@@ -37,7 +36,8 @@
 # them is run
 
 require_once('code/wfpl/encode.php');
-require_once('code/wfpl/misc.php'); # to get read_whole_file()
+require_once('code/wfpl/misc.php');
+require_once('code/wfpl/file.php');
 
 class tem {
        var $keyval;        # an array containing key/value pairs 
@@ -130,46 +130,69 @@ class tem {
                } #repeat
        }
 
+       # like load() except you pass a string instead of a filename
+       function load_str($str) {
+               $this->template = '';
+               $parents = array('top_level_subs' => array());
+               $parent = 'top_level_subs';
+               $this->_load($str, $this->template, $parents, $parent);
+       }
+
        # This is useful when you have sub-templates that you want to mess with
        # before the main template is run. But can also be used to simply specify
        # the filename ahead of time.
        function load($filename) {
                $this->filename = $filename;
-               $tmp = read_whole_file($filename);
-               $this->template = '';
-               $parents = array('top_level_subs' => array());
-               $parent = 'top_level_subs';
-               $this->_load($tmp, $this->template, $parents, $parent);
+               $this->load_str(read_whole_file($filename));
        }
                
        # Run the template. Pass a filename, or a string, unless you've already
        # specified a template with load()
        function run($templ = false) {
+               $template_string = $this->template;
+               $template_file = $this->file;
                if($templ !== false) {
                        if(strlen($templ) < 150 && file_exists($templ)) {
-                               $this->filename = $templ;
-                               unset($this->template);
+                               $template_file = $templ;
+                               unset($template_string);
                        } else {
-                               $this->template = $templ;
+                               $template_string = $templ;
                        }
                }
 
-               if(!$this->template) {
-                       if(!$this->filename) {
+               if(!$template_string) {
+                       if(!$template_file) {
                                print "sorry, no template to run\n";
                                exit(1);
                        }
 
-                       $this->template = read_whole_file($this->filename);
+                       $template_string = read_whole_file($template_file);
                }
                
-               return template_run($this->template, $this->keyval);
+               return template_run($template_string, $this->keyval);
        }       
 
        # same as run() except the output is print()ed
        function output($templ = false) {
                print($this->run($templ));
        }
+
+       # return the contents of the top-level sub-templates
+       #
+       # this does not run the sub-templates, so if you've not called tem_sub() on them, they will be blank.
+       #
+       # Return a hash.
+       #     keys: name of top level sub-template.
+       #     values: contents of said sub-template.
+       function top_subs() {
+               $ret = array();
+               if(isset($this->sub_subs['top_level_subs'])) {
+                       foreach($this->sub_subs['top_level_subs'] as $name) {
+                               $ret[$name] = $this->get($name);
+                       }
+               }
+               return $ret;
+       }
 }
 
 # Below are functions so you can use the above class without allocating or
@@ -241,5 +264,9 @@ function template_run($template, &$keyval) {
        return preg_replace_callback(array('|<!--~([^~]*)~-->|', '|~([^~]*)~|', '|<span class="template">([^<]*)</span>|', '|<p class="template">([^<]*)</p>|'), 'template_filler', $template);
 }
 
+function tem_top_subs() {
+       tem_init();
+       return $GLOBALS['wfpl_template']->top_subs();
+}
 
 ?>