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 thuijzer
      https://github.com/thuijzer/processwire-FieldtypeBusinessHours
      Fieldtype Business Hours
      ProcessWire Fieldtype for entering business hours (opening hours)
       
      Input format
      Leave a day empty when closed on that day
      Times are in 24 hour format.
      9:00-12:00 9:00-12:00, 13:00-17:30 16:00-2:00  
      Usage in templates
      Days are from 1 to 7 where 1 is Monday and 7 is Sunday (ISO-8601)
      echo $page->field_name->isNowOpen() ? 'Now open' : 'Now closed'; if($page->field_name[1] == null) { echo 'Closed on Monday'; } if($page->field_name[2]->inRange('11:00')) { echo 'Tuesday at 11:00 open'; } echo $page->field_name[1]; echo $page->field_name[1]->entries[0]->getFrom()->format('H:i');  
    • By adrian
           Tracy Debugger for ProcessWire
      The ultimate “swiss army knife” debugging and development tool for the ProcessWire CMF/CMS
       

       
      Integrates and extends Nette's Tracy debugging tool and adds 30+ custom tools designed for effective ProcessWire debugging and lightning fast development
      The most comprehensive set of instructions and examples is available at: https://adrianbj.github.io/TracyDebugger
      Modules Directory: http://modules.processwire.com/modules/tracy-debugger/
      Github: https://github.com/adrianbj/TracyDebugger
      A big thanks to @tpr for introducing me to Tracy and for the idea for this module and for significant feedback, testing, and feature suggestions.
    • By Harmen
      Hello all,
      Was wondering if any of you tried to include the Exact PHP client by Picqer in Processwire (URL)? I am trying to at the moment but I am stuck at the Authorization process. Building it inside a module file to execute a certain function every 6 hours to update something on the website. For the authorization process the file has to execute the following piece of code:
      header('Location:'. $urlThatRedirectsMeToTheLoginOfExact); But each time I am trying  to do so, I get the following error: Cannot modify header information - headers already sent by (output started at /processwire/index.php:55). I am out of options so that's why I am trying to find someone who used this library and could get it to work or someone who knows how I can fix it.
      Tips are highly appreciated (if they work ;))
      Cheers, Harmen
    • By BitPoet
      So I stumbled over the request to allow limiting templates to be used only once under every parent page in this thread
      and found that this would actually come in handy (also in a site I've built).
      The code can be found on github and soon also in the module repo.
      After installation, you'll find a new checkbox "Only once per parent" in the family tab when editing a template.