[META] Remove all usages of drupal_static() & drupal_static_reset()

Created on 14 May 2012, about 12 years ago

Updated 4 October 2023, 9 months ago

Problem/Motivation

In #2260187: [PP-1] Deprecate drupal_static() and drupal_static_reset() → we'll deprecate the drupal_static() & drupal_static_reset() procedural functions. However, in order to do so, we have to remove first all usages from Drupal core.

Proposed resolution

We cannot do all the removals in one step. Each usage it's an issue itself. So, this issues is a META to track the progress:

Child issues:

#3035288: Deprecate theme_get_setting() →
#3035340: Deprecate views_ui_add_ajax_trigger() →
#2875151: [META] Implement Batch API as a service → , #2875219: [PP-1] Batch not using new service → to cover the usage in _batch_needs_update().
#2324719: Node indexing - should use view mode for comments, not hook → to cover the usage in comment_node_update_index().
📌 Deprecate drupal_attach_tabledrag(). Move its logic in Table form element Needs review to cover the usage from drupal_attach_tabledrag().
#3037054: Deprecate drupal_static_reset() without @trigger_error() → usage from drupal_flush_all_caches(). This is tricky! Probably we want to deprecate drupal_static() only when writing to the cache but we still want to allow a non-deprecated drupal_static_reset() to clear the static cache.
📌 Fold drupal_get_updaters() into Updater class, deprecate drupal_get_updaters() Needs review usage from drupal_get_updaters()
📌 [PP-1] Deprecate file_get_file_references(). Move the logic to file.usage service Postponed
#2536594: Add a FilterFormatRepository providing methods to load filter formats → to cover usages from filter_formats() and filter_formats_reset().
#3037054: Deprecate drupal_static_reset() without @trigger_error() → usage from FunctionalTestSetupTrait. This is also tricky for the same reason as drupal_flush_all_caches().
#2081585: [META] Modernize the History module → to cover usages in history.module.
📌 Convert locale.compare.inc to a service Needs work
🐛 locale_get_plural call in PluralTranslatableString is wrong Needs work to cover removal from locale_get_plural()
#3037156: Locale import history service. Deprecate locale_translation_get_file_history(), locale_translation_update_file_history(), locale_translation_file_history_delete() → to cover removal from locale_translation_get_file_history() and locale_translation_update_file_history().
#3036982: Deprecate locale_translation_get_projects() and locale_translation_clear_cache_projects() →
#3037054: Deprecate drupal_static_reset() without @trigger_error() → usage from MigrateExecutable::attemptMemoryReclaim(). Same as drupal_flush_all_caches().
#3038908: Deprecate node_access_view_all_nodes(). Move its functionality in NodeAccessControlHandlerInterface →
#2171397: Move options_allowed_values() to a method somewhere ? → to cover usage from options_allowed_values().
📌 Shortcut cleanup: Remove duplicated code and deprecate legacy functions Needs work to cover usage from shortcut.module.
📌 Move system_get_module_admin_tasks() into a service and deprecate it Fixed
#2340341: Move template_preprocess, _template_preprocess_default_variables into services → to cover usage from template_preprocess().
#3039248: Deprecate views_ui_contextual_links_suppress(), views_ui_contextual_links_suppress_push(), views_ui_contextual_links_suppress_pop() → to cove usage from views_ui_contextual_links_suppress().

Done:

Remaining tasks

N/A

User interface changes

N/A

API changes

N/A

Data model changes

N/A

Release notes snippet

N/A

Original report

from comment #19 of #1567428: Active trail tests → , in order to handle static variables in Drupal 8 we should convert every use of statics to instead be protected properties of proper objects. The result of this effort will be that we properly register objects into the Dependency Injection Container and perhaps do away with drupal_static() and drupal_static_reset().

🌱 Plan

Status

Postponed

Version

11.0 🔥

Component

Base →

Last updated about 1 hour ago

Maintained by
🇺🇸United States @effulgentsia
🇬🇧United Kingdom @catch
🇬🇧United Kingdom @alexpott
🇦🇺Australia @larowlan
🇺🇸United States @bnjmnm
🇫🇷France @nod_
🇪🇸Spain @ckrina
🇬🇧United Kingdom @justafish

Created by

🇺🇸United States cosmicdreams Minneapolis/St. Paul

Live updates comments and jobs are added and updated live.

@deprecated

midcamp2019

Seattle2019

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment about 1 year ago →
🇬🇧United Kingdom catch
Comment about 1 year ago →
🇳🇿New Zealand jweowu
I agree with waiting until there is a standard replacement for drupal_static() which provides equivalent functionality and can be easily employed to replace the original API calls.

I'm really startled to observe that a lot of commits have been made replacing drupal_static() with plain PHP static! To my mind that is counter-productive and achieves nothing more than the removal of useful functionality.

I think those commits ought to be revisited once a new API is available so that they can be refitted with the new standard.
Status changed to Postponed 9 months ago1:01am 4 October 2023
Comment 9 months ago →
🇳🇿New Zealand jweowu
Per #86, setting this to Postponed pending 🌱 [policy] Standardize how we implement in-memory caches Needs work .

(And once that is resolved, the previous changes made for this issue ought to be reviewed.)

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024