Warning: Trying to access array offset on null in toastify_is_active

Created on 3 December 2024, 4 months ago

Problem/Motivation

I am developing a module and when I started building out my admin forms, it triggered the issue with Toastify.

Steps to reproduce

Build module. Forget to verify "enable_for". Profit!

Proposed resolution

I took a quick look at the .module file looked at where "toastify_is_active()" is being called.

/**
 * Determines whether the Toastify functionality is active.
 */
function toastify_is_active(): bool {
  $hasPermission = \Drupal::currentUser()->hasPermission('show toastify messages');
  if (!$hasPermission) {
    return FALSE;
  }

  $settings = \Drupal::config('toastify.settings')->get();
  $isAdminTheme = \Drupal::service('router.admin_context')->isAdminRoute();

  $enableForAdminTheme = $settings['enable_for']['admin_theme'];
  $enableForFrontendTheme = $settings['enable_for']['frontend_theme'];

  return ($isAdminTheme && $enableForAdminTheme) || (!$isAdminTheme && $enableForFrontendTheme);
}

Did a small change adding and added a few comments:

/**
 * Determines whether the Toastify functionality is active.
 */
function toastify_is_active(): bool {
  // Check for required permission.
  $hasPermission = \Drupal::currentUser()->hasPermission('show toastify messages');
  if (!$hasPermission) {
    return FALSE;
  }

  // Get settings and provide defaults if keys are missing.
  $settings = \Drupal::config('toastify.settings')->get();
  $enableForAdminTheme = $settings['enable_for']['admin_theme'] ?? FALSE;
  $enableForFrontendTheme = $settings['enable_for']['frontend_theme'] ?? FALSE;

  // Check if the current route is an admin route.
  $isAdminTheme = \Drupal::service('router.admin_context')->isAdminRoute();

  return ($isAdminTheme && $enableForAdminTheme) || (!$isAdminTheme && $enableForFrontendTheme);
}

Remaining tasks

It will require some testing but I think that solves the problem. Just a quick check.

User interface changes

None.

API changes

None.

Data model changes

None.

🐛 Bug report

Status

Active

Version

1.2

Component

Code

Created by

🇨🇦Canada Shane Birley

Live updates comments and jobs are added and updated live.

Comments & Activities

Issue created by @Shane Birley
Comment 4 months ago →
🇨🇦Canada Shane Birley
I applied my thinking to my dev environment and the issue appears to be fixed.
Comment 4 months ago →
🇧🇪Belgium dieterholvoet Brussels
Did you run database updates after updating the module? Default values for the new config values should be set there.
Comment 4 months ago →
🇨🇦Canada Shane Birley
I did a drush updb and, I think, 8002 and 8003 updated without issue.
Comment 4 months ago →
🇧🇪Belgium dieterholvoet Brussels
Those two new config options were set in toastify_update_8003. If you're still getting the issue you described, you probably imported your configuration after running database updates, overwriting the changes the update hook did.
Comment 4 months ago →
🇨🇦Canada Shane Birley
Nope, I did my little hacky fix prior to the update so I should be good. You rock!
Comment 4 months ago →
🇧🇪Belgium dieterholvoet Brussels
:)

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024