DokuWiki

It's better when it's simple

User Tools

Site Tools


devel:event:parser_cache_use

This is an old revision of the document!


PARSER_CACHE_USE

Description:
manipulate the cache validity
DefaultAction:
determine whether or not cached data should be used
Preventable:
yes
Added:
2006-09-16

Signalled by cache versions of parser wrapper functions inc/parserutils.php. Syntax plugins can use this event to provide their own assistance to DokuWiki's cache validity logic when the syntax extension adds other dependencies to the rendered page.

Passed Data and Result in event handler

The passed Doku_Event has the fields $data and $result.

$data is a cache object (cache_parser or extended on that object) – refer inc/cache.php.

For handling the event, key properties of the cache object are:

  • page, if present the wiki page id, may not always be present, e.g. when called for locale XHTML files
  • file, source file
  • mode, renderer mode (e.g. 'xhtml') or 'i' for instructions
  • depends, array of dependencies used to determine cache validity

In the AFTER event handler the $result field is set with the result of the _useCache() method. The AFTER event handler can modify this.

Plugins handling this event

The following plugins are known to handle this event and their source code may be a good start for understanding and implementing a handler yourself.

See also

devel/event/parser_cache_use.1417121439.txt.gz · Last modified: 2014-11-27 21:50 by Klap-in

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki