ryan

New MarkupCache module

Recommended Posts

MarkupCache is a simple module that enables you to cache any individual parts in a template.

I'm working on a site now that has 500+ cities in a select pulldown generated from ProcessWire pages. Loading 500+ pages and creating the select options on every pageview isn't terribly efficient, but I didn't want to cache the whole template because it needed to support dynamic parameters in the URL. The solution was to cache just the code that generated the select options. Here's an example:

$cache = $modules->get("MarkupCache");
if(!$data = $cache->get("something")) {
     // ... generate your markup in $data ...
     $cache->save($data);
}
echo $data;

I left the markup generation code (the part that gets cached) out of the example above to keep it simple. Below is the same example as above, but filled out with code that finds the pages and generates the markup (the part that gets cached):

$cache = $modules->get("MarkupCache");
if(!$data = $cache->get("city_options")) {
     foreach($pages->find("template=city, sort=name") as $city) {
             $data .= "<option value='{$city->id}'>{$city->title}</option>";
     }
     $cache->save($data);
}
echo $data;

That was an example of a place where this module might be useful, but of course this module can used to cache any snippets of code. By default, it caches the markup for an hour. If you wanted to cache it for a longer or shorter amount of time, you would just specify the number of seconds as a second parameter in the get() call. For example, this would keep a 60-second cache of the data:

$cache->get("city_options", 60)

I hope to have it posted to GitHub soon and it will be included in the ProcessWire distribution. If anyone wants it now, just let me know and I'll post it here or email it to you.

  • Like 9

Share this post


Link to post
Share on other sites

Looks like I forgot to update this before, but wanted to mention that this module is now included in the current ProcessWire distribution (and has been for a little while).

Share this post


Link to post
Share on other sites

The "more" Link in the modules list is dead for this module. (I am running CW 2.2.2)

Share this post


Link to post
Share on other sites

It was a broken redirect. I've fixed the link-- thanks.

Share this post


Link to post
Share on other sites

I was wondering...

Now that the man man from the grim north has extended the image field, can we cache the images??

I could come hande now with all those big image sliders.. :)

Keep it up, Im soon gonna release a lot of stuff.. :)

Bjørn aka ChrisB

@ChrisB_dk

  • Like 1

Share this post


Link to post
Share on other sites
Now that the man man from the grim north has extended the image field, can we cache the images??

I love the way this question is worded, but I don't understand it? :) Can you expand on the question?

Just in case it's related, want to mention that ProcessWire already does cache any image sizes you create with $image->size(), $image->width() or $image->height().

Share this post


Link to post
Share on other sites

Sorry for that, I shouldn't post when I havent sleept in 48 hours.. :)

But you answered the right there.. :) I wanted to cache the images..

And btw, Im loving PW more and more for everyday Im working with it.. Thanks for you hard work..

  • Like 1

Share this post


Link to post
Share on other sites

A stupid question, but I want to get it right: The module chooses the name, with which the cached markup result snippet can be identified later on, automatically by looking at the if-statement?

Share this post


Link to post
Share on other sites
/**
* Save the data to the cache
*
* Must be preceded by a call to get() so that you have set the cache unique name
*
* @param string $data Data to cache
* @return int Number of bytes written to cache, or FALSE on failure. 
*
*/
public function save($data) {
 if(!$this->cache) throw new WireException("You must attempt to retrieve a cache first, before you can save it.");  
 $result = $this->cache->save($data); 
 $this->cache = null;
 return $result; 
}

Does this answer you question?

  • Like 1

Share this post


Link to post
Share on other sites

Hello,

is there a method to delete (expire) only selected cache files other than manually unlinking them?

Thanks,

thomas

Share this post


Link to post
Share on other sites

You can set the cache time to zero:

$cache->get('your_cache_id', 0);
  • Like 1

Share this post


Link to post
Share on other sites

Thanks Wanze, unfortunately I needed wildcards so I had to build my own method. I used your tip in another class ten minutes later though :)

Share this post


Link to post
Share on other sites

Is it possible to disable markup cache expiration at API level when I save certain pages? Hook? Could you please share an example?

Module settings allow only yes/no setup for the whole system but I'd like not to inform module on several page save events while keeping "expire" for all other pages.

Thanks!

P.S. I've checked ProCache docs but it looks too big and UI-oriented for this task.

Share this post


Link to post
Share on other sites

Look at the code provided by Wanze.

Or you could trigger a delete of the cache after Pages::save 

class DeleteMarkupCache extends WireData implements Module {
        public static function getModuleInfo() {
                return array(
                        'title' => 'Delete cache module', 
                        'singular' => true, 
                        'autoload' => true
                        );
        }
        public function init() {
                $this->pages->addHookAfter('save', $this, 'deleteCache'); 
        }
        public function deleteCache($event) {
                $page = $event->arguments[0]; 
                if($page->template != 'wanted-template') return;
                
                // now do your logic.
        }
}
  • Like 2

Share this post


Link to post
Share on other sites

May be my request is not clear enough or I don't understand the answer...

I don't need to trigger delete of the cache - by default it triggers after any page save. This is a default setting in Markup Cache module.

Instead, I need to stop trigger for certain pages. I need to do it at API level in my code, e.g. not in PW core.

Share this post


Link to post
Share on other sites
 by default it triggers after any page save. This is a default setting in Markup Cache module.

MarkupCache, doesn't get triggered upon page save, it has it's own time schedule to expire. (second parameter)

Are you sure you mean MarkupCache and not the Build-in cache (Template Level) ?

Thanks Teppo:

<advertisement>ProcessWire caching explained</advertisement>

Edited by Martijn Geerts

Share this post


Link to post
Share on other sites

In module settings there is a "yes/no" question: "Expire Markup Chaches when pages are saved?"

As far as I understand, if "yes" is enabled then MarkupCache get triggered on page save, and it deletes all cache.

I want to keep "yes" but want to stop trigger MarkupCache (=cache deletes) when some specific pages are saved.

Share this post


Link to post
Share on other sites

Yes, normally every MarkupCache expires on any page save. You can disable this and then build your own caching logic with a hook on save() like Martijn suggested. So you tell it when to expire instead of when not to expire ...

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for pointing that one out. Didn't knew there was that option...

Has it been there from the start ?

Share this post


Link to post
Share on other sites
I want to keep "yes" but want to stop trigger MarkupCache (=cache deletes) when some specific pages are saved.

You can turn that around, should be easier. Set it to "no" and delete the ones you want to expire.

Share this post


Link to post
Share on other sites

@thomas, @martin - thanks!

Looks like the only option is to disable expire Markup Chaches when pages are saved and install module below. And the way to tell it when not to expire instead of when to expire is as below.

class DeleteMarkupCache extends WireData implements Module {        
        public static function getModuleInfo() {
                return array(
                        'title' => 'Delete cache module',
                        'singular' => true,
                        'autoload' => true
                        );
        }
        public function init() {
                $this->pages->addHookAfter('save', $this, 'deleteCache');
        }
        public function deleteCache($event) {

                $page = $event->arguments[0];

                $notExpire = ['template1', 'template2'];
                if(in_array($page->template, $notExpire)) return; 
        
                $cache = $modules->get("MarkupCache");
                $cache->expire();
        }
}

Share this post


Link to post
Share on other sites

Be aware of variable scoping

$modules would be $this->modules

For expiring the cache you should look for the right syntax, as MarkupCache files are separate folders, delete able by its name.

  • Like 1

Share this post


Link to post
Share on other sites

Hi guys,

I am experiencing a bit of trouble with the MarkupCache not cached properly. This is the code,

$cache = wire()->modules->get("MarkupCache");
if(! $someoperation = $cache->get("someoperation", 60 * 15)) {
    $someoperation = " I am some operation ";  
    if(! $expensive_operation = $cache->get("expensive_operation", 60 * 60 * 24)) {        
        $expensive_operation = " Some expensive operation ";
        $cache->save($expensive_operation);
    }
    $someoperation .= $expensive_operation;
    // I am forced to use the get operation again for I have seen if you are not calling the get the value saved is something else
    $cache->get("someoperation", 0);    
    $cache->save($someoperation);
}

Do you guys know what may be the reason the cache could not load ?

I have tried setting the permission from 766 , 777 etc to the folder site/assets/cache/MarkupCache/ .

Not saying this doesn't works always but some times espeically before the time expires or when I do a deploy via Jenkins it could not load the data. I can see the file being created, but it is not loading the data.

What is the use of lastgood file ?

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By BitPoet
      MediaLibrary
      Update: MediaLibrary can now be found in the official module list.
      Out of necessity, I've started to implement a simple media library module.
      The basic mechanism is that it adds a MediaLibrary template with file and image fields. Pages of this type can be added anywhere in the page tree.
      The link and image pickers in CKEditor are extended to allow quick selection of library pages from dropdowns. In the link picker this happens in the MediaLibrary tab, where you can also see a preview of the selected image. In the image picker, simply select a library from the dropdown at the top, everything else is handled by standard functionality.
      I've put the code onto github. This module is compatible with ProcessWire 3.
      Steps to usage:
      Download the module's zip from github (switch to the pw3 branche beforehand if you want to test on PW 3.x) and unpack it into site/modules Click "Modules" -> "Refresh" in the admin Click "Install" for MediaLibrary For testing, create a page with the MediaLibrary template under home (give it an expressive title like 'Global Media') and add some images and files Edit a differnt page with a CKEditor field and add a link and an image to see the MediaLibrary features in action (see the screencap for details) Optionally, go into the module settings for MediaLibrary Note: this module is far from being as elaborate as Kongondo's Media Manager (and doesn't plan to be). If you need a feature-rich solution for integrated media management, give it a look.
      Feel free to change the settings for MediaFiles and MediaImages fields, just keep the type as multiple.
      There are some not-so-pretty hacks for creating and inserting the correct markup, which could probably be changed to use standard input fields, though I'm a bit at a loss right now how to get it to work. I've also still got to take a look at error handling before I can call it fit for production. All feedback and pointers are appreciated (that's also why I post this in the development section).

      Edit 09.03.2016 / version 0.0.4: there's now also a "Media" admin page with a shortcut to quickly add a new library.

      Edit 01.05.2016:
      Version 0.0.8:
      - The module now supports nested media libraries (all descendants of eligible media libraries are also selectable in link/image picker).
      - There's a MediaLibrary::getPageMediaLibraries method you can hook after to modify the array of available libraries.
      - You can switch between (default) select dropdowns or radio boxes in the module configuration of MediaLIbrary to choose libraries.
      Edit 10.10.2018:
      Version 0.1.3:
      - Dropped compatibility for ProcessWire legacy versions by adding namespaces
      - Allow deletion of libraries from the Media overview admin page
      - Added an option to hide media libraries from the page tree (optionally also for superusers)
    • By Robin S
      This module corrects a few things that I find awkward about the "Add New Template" workflow in the PW admin. I opened a wishlist topic a while back because it would good to resolve some of these things in the core, but this module is a stopgap for now.
      Originally I was going to share these as a few standalone hooks, but decided to bundle them together in a configurable module instead.
      Add Template Enhancements
      A module for ProcessWire CMS/CMF. Adds some efficiency enhancements when adding or cloning templates via admin.

      Features
      Derive label from name when new template added: if you like to give each of your templates a label then this feature can save some time. The label can be added automatically when templates are added in admin, in admin/API, or not at all. There are options for underscore/hyphen replacement and capitalisation of the label. Edit template after add: when adding only a single template, the template is automatically opened for editing after it is added. Copy field contexts when cloning: this copies the field contexts (a.k.a. overrides such as column width, label and description) from the source template to the new template when using the "Duplicate/clone this template?" feature on the Advanced tab. Copy field contexts when duplicating fields: this copies the field contexts if you select the "Duplicate fields used by another template" option when adding a new template. Usage
      Install the Add Template Enhancements module.
      Configure the module settings according to what suits you.
       
      https://github.com/Toutouwai/AddTemplateEnhancements
      https://modules.processwire.com/modules/add-template-enhancements/
    • By Mike Rockett
      As I mentioned in this issue, I've create a new textformatter for ParsedownExtraPlugin, which adds some oomph to your markdown.
      Repo: Parsedown Extra Plugin
      Unlike the built-in textformatter for Parsedown and Parsedown Extra, this should be used when you want to use Extra with additional configuration/customisation.
      Some examples:
      ### Test {.heading} - A [external link](https://google.com/){.google} with `google` as a class that opens in a new tab if the config property is set. - [Another link](/page){target=_blank} that opens in a new tab even though it isn't external. ```html .html <p>Test</p> ``` There's some config options available to you, such as setting attributes on all/external images and links, setting table and table-cell alignment classes, adjusting footnote classes and IDs, adding <code> attributes to their parent <pre> elements, and changing the <code> class if your syntax highlighter does not use language-*.
      I was thinking about adding the ability to make links open in a new tab by appending a plus to the link syntax, but only external links should be opening in a new tab anyway. Further, this would add extra, unnecessary processing time.
      Please let me know if you bump into any problems. ☺️
    • By Mike Rockett
      TextformatterTypographer (0.4.0 Beta)
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      Learn more on my blog
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
      Please do test it out and let me know what you think.
      Also note that I have indicated support for PW 2.8, but I haven't tested there as yet. This was built on PW 3.0.42/62.
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.50
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy!