Czy lepiej jest używać module_invoke_all (), czy module_invoke () i module_implements ()?

10

Korzystanie module_invoke_all('some_hook')jest łatwe, ale czy jest to lepsze dla wydajności?

foreach (module_implements('some_hook') as $module) {
  $data = module_invoke($module, 'some_hook');
}
użytkownik1750
źródło

Odpowiedzi:

11

Różnica jest niewielka; module_invoke_all()uruchamia następujący kod:

function module_invoke_all() {
  $args = func_get_args();
  $hook = $args[0];
  unset($args[0]);
  $return = array();
  foreach (module_implements($hook) as $module) {
    $function = $module . '_' . $hook;
    if (function_exists($function)) {
      $result = call_user_func_array($function, $args);
      if (isset($result) && is_array($result)) {
        $return = array_merge_recursive($return, $result);
      }
      elseif (isset($result)) {
        $return[] = $result;
      }
    }
  }

  return $return;
}

Jedyna różnica polega na tym module_invoke_all(), że na przykład func_get_args()przywoływany jest tylko raz, podczas gdy przy użyciu module_invoke() func_get_args()wywoływany jest za każdym razem module_invoke(); jest to jednak marginalna różnica.
Jest kilka przypadków, w których module_implementing()i module_invoke()są używane, zwykle gdy moduł musi wiedzieć, który moduł jest wywoływany, na przykład w przypadku search_get_info()budowania tablicy informacji o modułach implementujących funkcje wyszukiwania.

function search_get_info($all = FALSE) {
  $search_hooks = &drupal_static(__FUNCTION__);

  if (!isset($search_hooks)) {
    foreach (module_implements('search_info') as $module) {
      $search_hooks[$module] = call_user_func($module . '_search_info');
      // Use module name as the default value.
      $search_hooks[$module] += array(
        'title' => $module,
        'path' => $module,
      );
      // Include the module name itself in the array.
      $search_hooks[$module]['module'] = $module;
    }
  }

  if ($all) {
    return $search_hooks;
  }

  $active = variable_get('search_active_modules', array('node', 'user'));
  return array_intersect_key($search_hooks, array_flip($active));
}

Innym przykładem jest image_styles () , który pobiera listę wszystkich stylów obrazu zaimplementowanych przez moduły i używa następującego kodu:

  foreach (module_implements('image_default_styles') as $module) {
    $module_styles = module_invoke($module, 'image_default_styles');
    foreach ($module_styles as $style_name => $style) {
      $style['name'] = $style_name;
      $style['module'] = $module;
      $style['storage'] = IMAGE_STORAGE_DEFAULT;
      foreach ($style['effects'] as $key => $effect) {
        $definition = image_effect_definition_load($effect['name']);
        $effect = array_merge($definition, $effect);
        $style['effects'][$key] = $effect;
      }
      $styles[$style_name] = $style;
    }
  }

W obu przypadkach pobrane informacje są umieszczane w tablicy, w której indeks jest krótką nazwą modułu.

kiamlaluno
źródło
5

Gdy spojrzysz na kod, moduł właśnie to robi, plus kilka testów poprawności . I to jest łatwe. :-)

Jan Tomka
źródło
1
Link jest zepsuty, prawdopodobnie z powodu nadania priorytetu Drupalowi
user1359
-1

Prawdopodobnie lepiej nie używać żadnego z nich, a zamiast tego użyj drupal_alter () .

Jak podano w dokumentacji module_invoke_all () ,

Wszystkie argumenty są przekazywane przez wartość. Użyj drupal_alter (), jeśli potrzebujesz przekazać argumenty przez referencję.

colan
źródło