How-To Cache Templates

[puertoblack2003]

Originally Posted by Princeton

add the template to the cache_templates hook (plugin):

$globaltemplates[] = 'Marquee_Text';

thank you sir that worked ...

[puertoblack2003]

good day,

i using that method to cache template i implented a postbit marqee hack and for some reason that method won't work.

$globaltemplates[] = 'Postbit_Marquee';

this error is being shown in showthread any idea's to fix problem...

thanks in advance.

[MRGTB]

I just cant get my head around adding "cache" to a product, to cache the templates.

Will you do me a favour Princeton or anybody else who knows how to do this. Take a look at my product code and add the cache code for me. So I can just paste it back in my XML file.

<?xml version="1.0" encoding="ISO-8859-1"?>

<product productid="ed2k_links_hack" active="1">
	<title>eD2K Links Hack</title>
	<description>This will let you add eD2K Links to your forum board.</description>
	<version>1.0.0</version>
	<url>http://www.ed2k.biz</url>
	<dependencies><dependency dependencytype="vbulletin" minversion="3.6.0" maxversion="" />
	</dependencies>
	<codes></codes>
	<templates>
		<template name="ed2k" templatetype="template" date="1133098897" username="eD2K" version="3.6.0"><![CDATA[<script type="text/javascript">
<!--
function checkAll(str,checked) {
	var a = document.getElementsByName(str);
	var n = a.length;
	for (var i = 0; i < n; i++) {
		a[i].checked = checked;
	}
	em_size(str);
}
function download(str, i, first) {
	var a = document.getElementsByName(str);
	var n = a.length;
	for (var i = i; i < n; i++) {
		if(a[i].checked) {
			window.location=a[i].value;
			if (first)
				timeout = 6000;
			else
				timeout = 500;
			i++;
			window.setTimeout("download('"+str+"', "+i+", 0)", timeout);
			break;
		}
	}
}
function copy(str) {
	var a = document.getElementsByName(str);
	var n = a.length;
	var ed2kcopy = document.getElementById("ed2kcopy_"+str)
	ed2kcopy.innerHTML = ""
	for (var i = 0; i < n; i++) {
		if(a[i].checked)
		{
			ed2kcopy.innerHTML += a[i].value;
			ed2kcopy.innerHTML += "<br />";
		}
	}
		var rng = document.body.createTextRange();
		rng.moveToElementText(ed2kcopy)
		rng.scrollIntoView();
		rng.select();
		rng.execCommand("Copy");
		rng.collapse(false);
}
function em_size(str) {
	var a = document.getElementsByName(str);
	var n = a.length;
	try {
		var input_checkall = document.getElementById("checkall_"+str);
		var size = 0;
		input_checkall.checked = true ;
		for (var i=0; i < n; i++) {
			if (a[i].checked) {
				var piecesArray = a[i].value.split( "|" );
				size += piecesArray[3]*1;
			} else {
				input_checkall.checked = false;
			}
		}
		test = document.getElementById("size_"+str);
		test.innerHTML = gen_size(size, 3, 2);
	} catch (e) {
	}
}
function gen_size(val, li, sepa ) {
	sep = Math.pow(10, sepa);
	li = Math.pow(10, li);
	retval  = val;
	unit	= 'Bytes';
	if (val >= li*1000000000) {
		val = Math.round( val / (1099511627776/sep) ) / sep;
		unit  = 'TB';
	} else if (val >= li*1000000) {
		val = Math.round( val / (1073741824/sep) ) / sep;
		unit  = 'GB';
	} else if (val >= li*1000) {
		val = Math.round( val / (1048576/sep) ) / sep;
		unit  = 'MB';
	} else if (val >= li) {
		val = Math.round( val / (1024/sep) ) / sep;
		unit  = 'KB';
	}
	return val + unit;
}
// -->
</script>
<br /><table class="tborder" cellpadding="5" cellspacing="1" border="0" width="100%" align="center">
  <thead><tr><td class="tcat" colspan="2">eD2K Links</td></tr></thead><tbody>

$ed2kbit

<tr align="left" class="alt$key2"><td width="80%" align="left"><input type="checkbox" id="checkall_ed2k$rand" onclick="checkAll('ed2k$rand',this.checked)" checked="checked"/><label for="checkall_ed2k$rand">Select All</label>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<input type="button" value="Download Selected" onclick="download('ed2k$rand',0,1)" /> <input type="button" value="Copy Selected" onclick="copy('ed2k$rand')" /><div id="ed2kcopy_ed2k$rand" style="position:absolute;height:0px;width:0px;overflow:hidden;"></div></td><td align="center" id="size_ed2k$rand">Total Size: $total</td></tr></tbody></table>]]></template>
		<template name="ed2kbit" templatetype="template" date="1133028805" username="eD2K" version="3.6.0"><![CDATA[<tr align="left" class="alt$key1"><td width="80%" align="left"><input type="checkbox" name="ed2k$rand" value="$ed2k" onclick="em_size('ed2k$rand');" checked="checked" /><a href="$ed2k">$ed2k_array[2]</a></td><td align="center">$totalper</td></tr>]]></template>
	</templates>
	<plugins>
		<plugin active="1">
			<title>eD2K Links Hack</title>
			<hookname>bbcode_fetch_tags</hookname>
			<phpcode><![CDATA[if ($vbulletin->options['allowedbbcodes'] & ALLOW_BBCODE_URL)
		{
// [ED2K]
   $tag_list['no_option']['ed2k'] = array(
    'callback' => 'handle_ed2k_links',

   );
}]]></phpcode>
		</plugin>
	</plugins>
	<phrases>
	</phrases>
	<options>
	</options>
</product>

[pedroenf]

Thanks for the explanation. It worked for me too.

[RedTyger]

If you have a lot of templates which may not necessarily be used, you can save resources that would be used to cache unneeded templates by instead caching them dynamically based on whether or not they are needed. This does assume a bit of knowledge, but it's commented for clarity.

Let's say you have 10 templates, all of which can be enabled or disabled individually via a yesno option in your plugin. I'll just display 3 for the example.

PHP Code:

<plugin active="1" executionorder="5">
<title>Example</title>
<hookname>cache_templates</hookname>
<phpcode><![CDATA[
// Do nothing if the plugin is not globally enabled via your own plugin's yesno. You can leave this out entirely if you don't provide your own onoff switch
if ($vbulletin->options['myplugin_isenabled'])
{
    // If option1 is enabled, add the template to a custom array, not the globaltemplates array. The array will be created by the adding if it doesn't already exist
    if ($vbulletin->options['option1_isenabled'])
    {
        $mytemplates[] = 'mytemplate1';
    }
    
    // Do the same for every template that has a yesno on/off switch
    if ($vbulletin->options['option2_isenabled'])
    {
        $mytemplates[] = 'mytemplate2';
    }
    
    // It doesn't have to be a switch, just something that needs to be true for your template to appear
    if (in_array($what, $ever)
    {
        $mytemplates[] = 'mytemplate3';
    }

    // If there are more than 0 templates that are going to be used, merge everything that's been added to your custom array with the globaltemplates cache
    if (count($mytemplates) > 0)
    {
        $globaltemplates = array_merge($globaltemplates, $mytemplates);
    }
}
]]></phpcode>
</plugin> 


The only problem with this is that if you have only one template needed, merging the arrays instead of just adding yours on (using $globaltemplates[] instead of $mytemplates) is wasteful of resources. However if you're using lots of templates this should not be an issue.

I would suggest using the microstats plugin to easily check everything is caching as it should.

[Mudvayne]

I need a little help.

PHP Code:

                if (THIS_SCRIPT == 'showthread' AND $vbulletin->options['quickreply'] > 0)
            {
                $globaltemplates = array_merge($globaltemplates, array(
                'quickreply_addon',
                ));
            } 


This does catch template only in show thread page. But I need to cache the quickreply_addon template in new thread, new reply, pm reply/forward & infraction window too. What 'll be the code? Waiting for help.

[Princeton]

THIS_SCRIPT changes from file to file ...

at the top of any file you will find THIS_SCRIPT defined ... this is the value that needs to be used on the conditional

[Mudvayne]

I used another plugin to cache this template with this code.

$globaltemplates = array_merge($globaltemplates, array('quickreply_addon'));

[thincom2000]

When writing my plugin code, the following doesn't work in the cache_templates hook (queries still added for uncached templates):

PHP Code:

$globaltemplates[] = 'my_extra_template'; 


But the following does:

PHP Code:

$globaltemplates = array_merge( $globaltemplates, array( 'my_extra_template' ) ); 


OR

PHP Code:

global $globaltemplates;

$globaltemplates[] = 'my_extra_template'; 


Also if I don't add the following to the parse_templates hook I get a spike in page generation time and server load:

PHP Code:

eval('$my_extra_template = "' . fetch_template('my_extra_template') . '";'); 


[Xplorer4x4]

Originally Posted by Icy

I need a little help.

PHP Code:

                if (THIS_SCRIPT == 'showthread' AND $vbulletin->options['quickreply'] > 0)
            {
                $globaltemplates = array_merge($globaltemplates, array(
                'quickreply_addon',
                ));
            } 


This does catch template only in show thread page. But I need to cache the quickreply_addon template in new thread, new reply, pm reply/forward & infraction window too. What 'll be the code? Waiting for help.

This does not even cache the template on showthread for me. Can any one tell me why this is not caching on show thread? I been working for an hour atleast trying to cache this and it does not seem to work.