DokuWiki

It's better when it's simple

User Tools

Site Tools

Trace:
devel:event:parser_cache_use

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
devel:event:parser_cache_use [2022-02-08 23:16] – Klap-indevel:event:parser_cache_use [2023-09-02 13:57] (current) – [Passed Data and Result in event handler] Klap-in
Line 11: Line 11:
  
 ===== Passed Data and Result in event handler ===== ===== Passed Data and Result in event handler =====
-The passed [[xref>dokuwiki\extension\Event]] has the fields ''$data'' and ''$result''.+The passed [[xref>dokuwiki\Extension\Event]] has the fields ''$data'' and ''$result''.
  
-''$data'' is a cache object ([[xref>CacheParser]] or extended on that object) -- refer [[xref> inc/Cache/CacheParser.php]].+''$data'' is a cache object ([[xref>dokuwiki\Cache\CacheParser]] or extended on that object) -- refer [[xref> inc/Cache/CacheParser.php]].
  
-For handling the event, key properties of the cache object are:+For handling the event, key properties of the CacheParser object are:
  
   * ''$page'', if present the wiki page id, may not always be present, e.g. when called for locale XHTML files   * ''$page'', if present the wiki page id, may not always be present, e.g. when called for locale XHTML files
Line 25: Line 25:
   * ''[[xref>$depends]]'', array of dependencies used to determine cache validity   * ''[[xref>$depends]]'', array of dependencies used to determine cache validity
  
-In the BEFORE event handler the cache object can be modified. Some examples are: extending the ''$depends'' field, using more cachefiles for variants of the same source file (see also [[plugin:struct]] plugin)  or preventing and replacing the default ''makeDefaultCacheDecision'' cache check.+In the BEFORE event handler the cache object can be modified. Some examples are: extending the ''$depends'' field, using more cachefiles for variants of the same source file (see also [[plugin:struct]] plugin)  or preventing and replacing the default ''makeDefaultCacheDecision()'' cache check.
  
 In the AFTER event handler the ''$result'' field is set with the result of the [[xref> makeDefaultCacheDecision()]] method. The AFTER event handler can modify this field. In the AFTER event handler the ''$result'' field is set with the result of the [[xref> makeDefaultCacheDecision()]] method. The AFTER event handler can modify this field.
Line 33: Line 33:
  
   * [[codesearch>PARSER_CACHE_USE|Code related to this event]] used in any DokuWiki's files, plugins and templates   * [[codesearch>PARSER_CACHE_USE|Code related to this event]] used in any DokuWiki's files, plugins and templates
 +  * [[devel:caching#plugins|Influencing of cache by plugins]]
   * [[devel:Action Plugins]]   * [[devel:Action Plugins]]
   * [[devel:Events]]   * [[devel:Events]]
  
  
devel/event/parser_cache_use.1644358600.txt.gz · Last modified: 2022-02-08 23:16 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

Global DokuWiki Links