ryan

Module
New MarkupCache module

27 posts in this topic

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.

9 people like this

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

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

1 person likes this

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..

1 person likes this

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?

1 person likes this

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);
1 person likes this

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.
        }
}
2 people like this

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 ...

1 person likes this

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.

1 person likes this

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 kixe
      Today I have been running in mysql errors using @renobird s Module MarkupActivityLog which still uses mysqli Driver.
      @all developers
      Although mysqli is still supported PDO driver is the default database driver in PW since https://processwire.com/about/news/introducing-processwire-2.4/
      and its strongly recommend to all module authors to use/change-to PDO driver instead of mysqli.

      @renobird I have sent a pull request.
       
    • By Nurguly Ashyrov
      NOTE: This thread originally started in the Pub section of the forum. Since we moved it into the Plugin/Modules section I edited this post to meet the guidelines but also left the original content so that the replies can make sense.  
      ProcessGraphQL
      ProcessGraphQL seamlessly integrates to your ProcessWire web app and allows you to serve the GraphQL api of your existing content. You don't need to apply changes to your content or it's structure. Just choose what you want to serve via GraphQL and your API is ready.
      Warning: The module supports PHP version >= 5.5 and ProcessWire version >= 3.
      Links:
      Zip Download Github Repo ScreenCast  
      At this moment the module is not available from the modules section. Please refer to the Readme to learn more about how to use the module.
       
      Original post starts here...
      Hi Everyone! I became very interested in this GraphQL thing lately and decided to learn a bit about it. And what is the better way of learning a new thing than making a ProcessWire module out of it! 
      For those who are wondering what GraphQL is, in short, it is an alternative to REST. I couldn't find the thread but I remember that Ryan was not very happy with the REST and did not see much value in it. He offered his own AJAX API instead, but it doesn't seem to be supported much by him, and was never published to official modules directory. While ProcessWire's API is already amazing and allows you to quickly serve your content in any format with less than ten lines of code, I think it might be convenient to install a module and have JSON access to all of your content instantly. Especially this could be useful for developers that use ProcessWire as a framework instead of CMS.
      GraphQL is much more flexible than REST. In fact you can build queries in GraphQL with the same patterns you do with ProcessWire API.
      Ok, Ok. Enough talk. Here is what the module does after just installing it into skyscrapers profile.

      It supports filtering via ProcessWire selectors and complex fields like FieldtypeImage or FieldtypePage. See more demo here
      The module is ready to be used, but there are lots of things could be added to it. Like supporting any type of fields via third party modules, authentication, permissions on field level, optimization and so on. I would love to continue to develop it further if I would only know that there is an interest in it. It would be great to hear some feedback from you. I did not open a thread in modules section of the forum because I wanted to be sure there is interest  in it first.
      You can install and learn about it more from it's repository. It should work with PHP >=5.5 and ProcessWire 3.x.x. The support for 2.x.x version is not planned yet.
      Please open an issue if you find bugs or you want some features added in issue tracker. Or you can share your experience with the module here in this thread.
    • By Macrura
      Released:
      http://modules.processwire.com/modules/jquery-ion-range-slider/
      The built in rangeslider is good, but it is somewhat limited if you need really specific slider interfaces, like with pips and showing the value on the handles.
      There are many Jquery rangesliders, but one of the best and easiest to implement is the ion.rangeSlider.
      http://ionden.com/a/plugins/ion.rangeSlider/en.html
      This is a preview of the very simple module that basically allows you to enable the ion.Rangeslider on any text input, and then you type in your params into the textarea field (careful, you can break the page's javascrpt if you are not careful!) There are way too many options to really make this configurable, so the easiest way it to have a free text field where you enter any params. The params are just passed to the instance of the slider.
      Features of ion.Rangeslider:
      Skin support. (5 skins included and PSD for skin creation) Any number of sliders at one page without conflicts and big performance problems Two slider types single (1 slider) and double (2 sliders) Support of negative and fractional values Ability to set custom step and snap grid to step Support of custom values diapason Customisable grid of values Ability to disable UI elements (min and max, current value, grid) Postfixes and prefixes for your numbers ($20, 20 € etc.) Additional postfix for maximum value (eg. $0 — $100+) Ability to prettify large numbers (eg. 10000000 -> 10 000 000 or 10.000.000) Slider writes its value right into input value field. This makes it easy to use in any html form Any slider value can be set through input data-attribute (eg. data-min="10") Slider supports disable param. You can set it true to make slider inactive Slider supports external methods (update, reset and remove) to control it after creation For advanced users slider has callbacks (onStart, onChange, onFinish, onUpdate). Slider pastes all its params to callback first argument as object Slider supports date and time  
      Screenshots comparing Inputfield Rangeslider (Soma) vs. JqueryIonRangeSlider...
      1) basic range using currency
      '
      Same with different skin

      Range of years

      Same with narrower column and different skin..

       
      the module is functional and being used on 1 site, but some additional testing is needed...
    • By FIA2008
      I'm using PHPdocumentor to generate documentation of my modules, but it fails to scan the .module files. Is there another way of making processwire see a module other than giving it a .module extension?
      I'd like to rename my module file to .php but then processwire no longer sees my module.
    • By fbg13
      Is it possible to update a module without it being in the module directory?
      The same way that one in the module directory is.