Document Mautic 8 CacheStorageHelper removal migration for Plugin developers - #617
Open
promptless-for-oss wants to merge 1 commit into
Open
Conversation
Mautic 8 (mautic/mautic#17033) removes the deprecated CacheStorageHelper and its mautic.helper.cache_storage service in favor of CacheBundle. Add a 'Migrating to CacheBundle in Mautic 8' section to plugins/cache.rst covering the CacheProviderInterface/PSR-16 replacement (incl. null-vs-false miss and cache-clear behavior), the AbstractIntegration::getCache() signature change, and the WidgetDetailEvent API changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Open in Promptless
Mautic 8 removes the deprecated
CacheStorageHelperand itsmautic.helper.cache_storageservice in favor of CacheBundle. This adds a 'Migrating to CacheBundle in Mautic 8' section to the Plugins > Cache developer page so Plugin and Integration developers can update their code.The new section documents the three developer-facing changes: replacing
CacheStorageHelperby injectingCacheProviderInterfaceand callinggetSimpleCache()for the PSR-16 API (including the two behavior changes — a cache miss now returnsnullinstead offalse, and cached data now lives in the configuredcache_adapterrather than thecache_itemstable); the changedAbstractIntegration::getCache()return type and constructor argument; and theWidgetDetailEventAPI changes (setCacheDir()removed,$cacheProvidernow required,setTemplateData()no longer takes$skipCache). Each change includes a before/after code example.Files touched: docs/plugins/cache.rst
Trigger Events