Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Modules should have the possibility to react on a cache reset.
Example use case is the title module which does a field synchronisation.
It caches on which entity the sync is done to prevent unnecessary processing.
Unfortunately the module has no way to detect if a resync is necessary due an entitycache reset.
Attached patch adds the same code as in EntityCacheControllerHelper::entityCacheAttachLoad() for EntityCacheControllerHelper::resetEntityCache
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | entitycache-provide-cache-reset-hook-1157430-5.patch | 1.97 KB | das-peter |
| #2 | entitycache-provide-cache-reset-hook-1157430-2.patch | 1.99 KB | das-peter |
| entitycache-provide-cache-reset-hook.patch | 932 bytes | das-peter | |
Comments
Comment #1
catchSince entitycache isn't just able to implement hook_entity_update() and hook_entity_delete() due to inconsistencies in the core entities, it probably makes sense to provide this hook to save other modules having to figure out the same thing.
However, please add documentation to entitycache.api.php for the new hooks (I realise there is no docs in there for hook_entitycache_load() yet, will add those soon or happily commit a patch).
Also while I'm not sold on Drupal 7 hook groupings yet, not all sites will have entitycache module enabled - so it might be worth adding a group here so that code can be loaded only when needed (especially since cache resets only happen on requests doing CUD operations).
Comment #2
das-peter CreditAttribution: das-peter commentedThe api doc is up to date now.
Comment #3
das-peter CreditAttribution: das-peter commentedComment #4
catchThanks for this, needs tweaks for coding style though.
- line break is missing between function summary and @param
- for some reason (I don't know why) we don't state argument types in the @param line.
Otherwise looks great.
Comment #5
das-peter CreditAttribution: das-peter commented*grml* I always forget the thing with the param types - I'm used to add these because the Eclipse PDT autcomplete function ;).
^^ Same no type rule applies to returns too, right?
Comment #6
catchThanks. No type rule applies to return as well yeah.
Committed!