Changeset 1278

Timestamp:

11/08/07 20:18:04 (1 year ago)

Author:

rho

Message:

close #135, now loads templates on demand. Added new function
templates_add_contenxt()

Sign-off-by: Rolando Espinoza La Fuente <rho@prosoftpeople.com>

Files:

• devel/lib/templates.php (modified) (2 diffs)
• devel/mod/blog/default_template.php (modified) (1 diff)
• devel/mod/commentwall/lib.php (modified) (1 diff)
• devel/mod/community/default_template.php (modified) (1 diff)
• devel/mod/contenttoolbar/default_template.php (modified) (1 diff)
• devel/mod/friend/default_template.php (modified) (1 diff)
• devel/mod/generic_comments/lib.php (modified) (1 diff)
• devel/mod/widget/init.php (modified) (1 diff)
• devel/units/templates/default_template.php (modified) (2 diffs)

devel/lib/templates.php

@@ -681 +681 @@
-            $template_name = $t;
-        }
+
+        // TODO: Load templates on demand with backward compatibility
+        templates_load_context($parameter['context']);
-
-    // Grab the template content
@@ -1506 +1509 @@
-}
-
+/**
+ * Adds new template context
+ * @param string $context  Context identificator
+ * @param string $tpl      Template path relative to dirroot or inline template
+ * @param bool   $is_file  Template is file or inline
+ * @param bool   $override To override existing context
+ */
+function templates_add_context($context, $tpl, $is_file=true, $override=false) {
+    // TODO: this function should go int mod's?
+    global $template, $template_files, $CFG;
+
+    if (!isset($template)) $template = array();
+    if (!isset($template_files)) $template_files = array();
+
+    if (!empty($context)) {
+        // clean file path string
+        if ($is_file) {
+            // FIXME: backward compatiblity, allow templatesroot full path
+            if (substr_count($tpl, $CFG->templatesroot) > 0) {
+                $file_path = $tpl;
+            } else {
+                //$file_path = $CFG->dirroot . clean_filename($tpl);
+                // clean_filename replaces / directory separator
+                $file_path = $CFG->dirroot . $tpl;
+            }
+        }
+
+        if ($is_file) {
+            if ($override) {
+                $template_files[$context] = array();
+            }
+
+            $template_files[$context][] = $file_path;
+        } else {
+            // inline template, backwards compatibility
+            if (!$override && isset($template[$context])) {
+                // append to existing context
+                $template[$context] .= $tpl;
+            } else {
+                $template[$context] = $tpl;
+            }
+        }
+    }
+}
+
+/**
+ * Load context if template is file 
+ * @param string $context Context identificator
+ */
+function templates_load_context($context) {
+    // TOOD: review check
+    // currently check if starts with $CFG->dirrot and is file readable
+    global $template, $template_files, $CFG;
+
+    static $loaded;
+
+    if (!isset($loaded)) $loaded = array();
+    if (!isset($template)) $template = array();
+    if (!isset($template_files)) $template_files = array();
+
+    if (!isset($loaded[$context])) {
+        if (isset($template_files[$context])) {
+            if (!isset($template[$context])) {
+                $template[$context] = '';
+            }
+
+            // load templates from files
+            foreach ($template_files[$context] as $k => $tpl) {
+                // TODO: check again if is readable?
+                $template[$context] .= @file_get_contents($tpl);
+                //print_object('Loaded: ' . $tpl);
+            }
+        } else {
+            // do nothing if not file
+        }
+
+        $loaded[$context] = true;
+    }
+}
-
-?>

devel/mod/blog/default_template.php

@@ -47 +47 @@
-    );
-
-$template['weblogpost'] = file_get_contents(dirname(__FILE__)."/templates/blog_post.html"
-$template['weblogcomments'] = file_get_contents(dirname(__FILE__)."/templates/blog_comments.html"
-$template['weblogcomment'] = file_get_contents(dirname(__FILE__)."/templates/blog_comment.html"
+templates_add_context('weblogpost', 'mod/blog/templates/blog_post.html'
+templates_add_context('weblogcomments', 'mod/blog/templates/blog_comments.html'
+templates_add_context('weblogcomment', 'mod/blog/templates/blog_comment.html'
-?>

devel/mod/commentwall/lib.php

@@ -19 +19 @@
-                
-                // Define some templates
-               $template['commentwallobject'] = file_get_contents($CFG->dirroot . "mod/commentwall/template"
-               $template['commentwallfooter'] = file_get_contents($CFG->dirroot . "mod/commentwall/footer"
-               $template['css'] .= file_get_contents($CFG->dirroot . "mod/commentwall/css"
+        templates_add_context('commentwallobject', 'mod/commentwall/template'
+        templates_add_context('commentwallfooter', 'mod/commentwall/footer'
+        templates_add_context('css', 'mod/commentwall/css'
-                
-                // Set up the database

devel/mod/community/default_template.php

@@ -53 +53 @@
-    );
-
-$template["community_members"] = "<div id=\"networktable\"><table width=\"80%\" cellspacing=\"5\"><tr>{{members}}</tr></table></div>"
-$template["community_member"] = file_get_contents(dirname(__FILE__)."/templates/community_member_view.html"
-$template["community_membership"] = file_get_contents(dirname(__FILE__)."/templates/community_membership_view.html"
-$template["community_create"] = file_get_contents(dirname(__FILE__)."/templates/community_create.html"
+templates_add_context('community_members', "<div id=\"networktable\"><table width=\"80%\" cellspacing=\"5\"><tr>{{members}}</tr></table></div>", false)
+templates_add_context('community_member', 'mod/community/templates/community_member_view.html'
+templates_add_context('community_membership', 'mod/community/templates/community_membership_view.html'
+templates_add_context('community_create', 'mod/community/templates/community_create.html'
-
-?>

devel/mod/contenttoolbar/default_template.php

@@ -40 +40 @@
-);
-
-$template["contenttoolbar"] = file_get_contents(dirname(__FILE__)."/templates/contenttoolbar.html"
-$template["video_wizard"] = file_get_contents(dirname(__FILE__)."/templates/video_wizard.html"
+templates_add_context('contenttoolbar', 'mod/contenttoolbar/templates/contenttoolbar.html'
+templates_add_context('video_wizard', 'mod/contenttoolbar/templates/video_wizard.html'
-?>

devel/mod/friend/default_template.php

@@ -31 +31 @@
-    );
-
-$template['friends_friends'] = "<div id=\"networktable\"><table width=\"80%\" cellspacing=\"5\"><tr>{{friends}}</tr></table></div>"
-$template['friends_friend'] = file_get_contents(dirname(__FILE__)."/templates/friends_friend.html"
+templates_add_context('friends_friends', "<div id=\"networktable\"><table width=\"80%\" cellspacing=\"5\"><tr>{{friends}}</tr></table></div>", false)
+templates_add_context('friends_friend', 'mod/friend/templates/friends_friend.html'
-?>

devel/mod/generic_comments/lib.php

@@ -30 +30 @@
-                river_register_friendlyname_hook('file::file', 'generic_comments_get_friendly_name');
-        }
-
-
-
-
+
+
+
-
-}

devel/mod/widget/init.php

@@ -2 +2 @@
-
-    global $CFG, $template;
-$template['css'] .= file_get_contents($CFG->dirroot . "mod/widget/css"
+templates_add_context('css', 'mod/widget/css'
-
-?>

devel/units/templates/default_template.php

@@ -13 +13 @@
-                                    );
-
-$template['css'] = file_get_contents($CFG->templatesroot . "Default_Template/css"
+templates_add_context('css', $CFG->templatesroot . 'Default_Template/css'
-
-    $template_definition[] = array(
@@ -30 +30 @@
-                                    );
-    
-$template['pageshell'] = file_get_contents($CFG->templatesroot . "Default_Template/pageshell"
-
-$template['frontpage_loggedout'] = file_get_contents($CFG->templatesroot . "Default_Template/frontpage_loggedout"
-$template['frontpage_loggedin'] = file_get_contents($CFG->templatesroot . "Default_Template/frontpage_loggedin"
+templates_add_context('pageshell', $CFG->templatesroot . 'Default_Template/pageshell'
+
+templates_add_context('frontpage_loggedout', $CFG->templatesroot . 'Default_Template/frontpage_loggedout'
+templates_add_context('frontpage_loggedin', $CFG->templatesroot . 'Default_Template/frontpage_loggedin'
-
-    $template_definition[] = array(