Adding template cache handling #146

Broatcast · 2017-03-21T20:49:24Z

Adding some examples to the template handling for the template cache system.

JoshHarmon

Hopefully this doesn't come off too much as me being a grammar pedant, but I feel there are a few changes that should be made before this page gets pulled into the docs.

Otherwise, great work! Thanks for submitting it!

JoshHarmon · 2017-03-22T03:26:23Z

1.8/development/plugins/creating-modifying-templates.md

@@ -94,3 +94,46 @@ global $user;

 $user['favorite_colour'] = 'Blue';
 ```
+
+## Caching Templates
+Don't forget to cache the template. This is important for pages with big load and prevent the database server from extra querys.


querys --> queries

JoshHarmon · 2017-03-22T03:28:09Z

1.8/development/plugins/creating-modifying-templates.md

+Don't forget to cache the template. This is important for pages with big load and prevent the database server from extra querys.
+
+### Caching a template
+An simple way to cache an template only at the place where it's needed, is to use the `THIS_SCRIPT` definition.


"An simple way" --> "A simple way"

The general rule for a vs. an is that if the word after it starts with a vowel, an is used. Otherwise, a is typically used.

Also, the comma here isn't necessary. "is to use..." is still part of the same clause.

JoshHarmon · 2017-03-22T03:31:08Z

1.8/development/plugins/creating-modifying-templates.md

+}
+```
+
+### Testing if the template get cached


"gets cached" or "got cached" or "templates get cached"

JoshHarmon · 2017-03-22T03:32:20Z

1.8/development/plugins/creating-modifying-templates.md

+
+### Testing if the template get cached
+You can simply test if the templates get cached correctly or not. Open the page where they should get cached and add a `?debug&debug=1` or `&debug&debug=1` to the url into the browser.
+Now you see the `MyBB Debug Information` page. The first table called `Page Generation Statistics` contain a row with the template cache information. 


"the first table ... contain" --> "the first table ... contains"

JoshHarmon · 2017-03-22T03:34:38Z

1.8/development/plugins/creating-modifying-templates.md

+You can simply test if the templates get cached correctly or not. Open the page where they should get cached and add a `?debug&debug=1` or `&debug&debug=1` to the url into the browser.
+Now you see the `MyBB Debug Information` page. The first table called `Page Generation Statistics` contain a row with the template cache information. 
+
+#### There is an template that not get cached:


Consider changing to "If a template does not get cached" or something and remove the colon. Headings don't need colons at the end of them.

JoshHarmon · 2017-03-22T03:36:08Z

1.8/development/plugins/creating-modifying-templates.md

+
+#### There is an template that not get cached:
+`No. Templates Used: 90 (89 Cached / 1 Manually Loaded)`
+This means there is 1 template that need an extra select query to the database to get loaded. At the botton you see the `Template Statistics` and now can control wich templates get not cached. All template names in `Templates Requiring Additional Calls (Not Cached at Startup) - 1 Total` are not cached, so you should correct your code.


"template that need an extra select query" --> "template that needs an extra select query"

Typo: "wich" --> "which"

"get not cached" --> "don't get cached" or "are not cached" or similar.

JoshHarmon · 2017-03-22T03:37:37Z

1.8/development/plugins/creating-modifying-templates.md

+`No. Templates Used: 90 (89 Cached / 1 Manually Loaded)`
+This means there is 1 template that need an extra select query to the database to get loaded. At the botton you see the `Template Statistics` and now can control wich templates get not cached. All template names in `Templates Requiring Additional Calls (Not Cached at Startup) - 1 Total` are not cached, so you should correct your code.
+
+#### If you do all right and the templates get cached at tho correct place it looks similar to:


Perhaps change to something like: "How to determine if templates are being cached correctly"

Headings shouldn't be the dependent clause of what would otherwise be sentences.

Broatcast · 2017-03-22T15:09:42Z

Big thx @JoshHarmon ... like i sayed english is not my main language and i'am feel my english stills realy bad... so yes please some one correct my gramma and other failures ;)

@JoshHarmon

Correcting typos and gramma, thx to @JoshHarmon

JoshHarmon · 2017-03-23T14:40:13Z

Looks good to me! Just have to wait and see if any team members stop by and have any feedback before pulling it in.

Shade-

These are some corrections I would like you to apply before merging. Not to be offensive, but the language you used did not look very professional and some information was missing, so I have rewritten most of the commit on top of your base.

Shade- · 2017-03-23T15:25:38Z

1.8/development/plugins/creating-modifying-templates.md

@@ -94,3 +94,46 @@ global $user;

 $user['favorite_colour'] = 'Blue';
 ```
+
+## Caching Templates
+Don't forget to cache the template. This is important for pages with big load and prevent the database server from extra queries.


Caching templates is important to optimize the load on your server's database and to avoid performing extra queries.

Shade- · 2017-03-23T15:46:26Z

1.8/development/plugins/creating-modifying-templates.md

+Don't forget to cache the template. This is important for pages with big load and prevent the database server from extra queries.
+
+### Caching a template
+A simple way to cache an template only at the place where it's needed is to use the `THIS_SCRIPT` definition.


In order to cache a template you just need to add it to the $templatelist variable, a coma-separated list of templates which is then used by MyBB's core to fetch templates using a single database query. The aforementioned fetch occurs in global.php and the only hook available before is global_start. A proper way to cache a template would then be:

$plugins->run_hooks('global_start', 'myplugin_cache_templates'); function myplugin_cache_templates() { global $templatelist; if(isset($templatelist)) { $templatelist .= ','; } else { $templatelist = ''; } $templatelist .= 'hello_world_template'; }

You typically use templates in specific locations. You can avoid caching templates globally and cache them in certain pages by checking against the THIS_SCRIPT definition. For example, a template might be needed just in the postbit, therefore you can check if the user is watching showthread.php or not:

if(THIS_SCRIPT == 'showthread.php') { // Cache templates }

Shade- · 2017-03-23T23:11:46Z

1.8/development/plugins/creating-modifying-templates.md

+```
+
+### Testing if the template gets cached
+You can simply test if the templates get cached correctly or not. Open the page where they should get cached and add a `?debug&debug=1` or `&debug&debug=1` to the url into the browser.


You can test whether if templates get cached correctly or not with ease by opening the page where they should be cached and appending the ?debug=1 query string to the URL. Use &debug=1 if there are already other query strings in place. The resulting MyBB Debug Information page contains a table called Page Generation Statistics which has a row with the template cache information.

Note that only administrators can access the debug page, so ensure you are logged in with an administrator account.

Shade- · 2017-03-23T23:16:30Z

1.8/development/plugins/creating-modifying-templates.md

+
+#### If a template does not get cached
+`No. Templates Used: 90 (89 Cached / 1 Manually Loaded)`
+This means there is 1 template that needs an extra select query to the database to get loaded. At the botton you see the `Template Statistics` and now can control which templates don't get cached. All template names in `Templates Requiring Additional Calls (Not Cached at Startup) - 1 Total` are not cached, so you should correct your code.


A template not cached is added to the Manually Loaded count. An extra select query to the database is performed for every template in such list. The complete list of templates requiring additional calls is located within the Template Statistics section.

Shade- · 2017-03-23T23:17:08Z

1.8/development/plugins/creating-modifying-templates.md

+`No. Templates Used: 90 (89 Cached / 1 Manually Loaded)`
+This means there is 1 template that needs an extra select query to the database to get loaded. At the botton you see the `Template Statistics` and now can control which templates don't get cached. All template names in `Templates Requiring Additional Calls (Not Cached at Startup) - 1 Total` are not cached, so you should correct your code.
+
+#### How to determine if templates are being cached correctly


This is not necessary IMHO.

Ben-MyBB · 2018-02-18T21:33:57Z

@Broatcast Could you update your PR?

Broatcast · 2018-02-18T21:47:26Z

I will update it in a few days ;)

Adding template cache handling

b64331b

Adding some examples to the template handling for the template cache system.

JoshHarmon reviewed Mar 22, 2017

View reviewed changes

Update creating-modifying-templates.md

ca5e759

Correcting typos and gramma, thx to @JoshHarmon

Shade- reviewed Mar 23, 2017

View reviewed changes

Ben-MyBB added the s:in-progress label Feb 18, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding template cache handling #146

Adding template cache handling #146

Broatcast commented Mar 21, 2017

JoshHarmon left a comment

JoshHarmon Mar 22, 2017

JoshHarmon Mar 22, 2017

JoshHarmon Mar 22, 2017

JoshHarmon Mar 22, 2017

JoshHarmon Mar 22, 2017

JoshHarmon Mar 22, 2017

JoshHarmon Mar 22, 2017

Broatcast commented Mar 22, 2017

JoshHarmon commented Mar 23, 2017

Shade- left a comment

Shade- Mar 23, 2017

Shade- Mar 23, 2017 •

edited

Loading

Shade- Mar 23, 2017 •

edited

Loading

Shade- Mar 23, 2017

Shade- Mar 23, 2017

Ben-MyBB commented Feb 18, 2018

Broatcast commented Feb 18, 2018

Adding template cache handling #146

Are you sure you want to change the base?

Adding template cache handling #146

Conversation

Broatcast commented Mar 21, 2017

JoshHarmon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Broatcast commented Mar 22, 2017

JoshHarmon commented Mar 23, 2017

Shade- left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shade- Mar 23, 2017 • edited Loading

Choose a reason for hiding this comment

Shade- Mar 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ben-MyBB commented Feb 18, 2018

Broatcast commented Feb 18, 2018

Shade- Mar 23, 2017 •

edited

Loading

Shade- Mar 23, 2017 •

edited

Loading