utility.inc in Chaos Tool Suite (ctools) 7

Contains general utility functions for CTools that do not need to be in the module file.

In particular, things that are only needed during hook_menu() and hook_theme() are placed here.

File

includes/utility.inc

<?php

/**
 * @file
 * Contains general utility functions for CTools that do not need to be
 * in the module file.
 *
 * In particular, things that are only needed during hook_menu() and
 * hook_theme() are placed here.
 */

/**
 * Provide a hook passthrough to included files.
 *
 * To organize things neatly, each CTools tool gets its own toolname.$type.inc
 * file. If it exists, it's loaded and ctools_$tool_$type() is executed.
 * To save time we pass the $items array in so we don't need to do array
 * addition. It modifies the array by reference and doesn't need to return it.
 */
function ctools_passthrough($module, $type, &$items) {
  $files = file_scan_directory(drupal_get_path('module', $module) . '/includes', '/\\.' . $type . '\\.inc$/', array(
    'key' => 'name',
  ));
  foreach ($files as $file) {
    require_once DRUPAL_ROOT . '/' . $file->uri;
    list($tool) = explode('.', $file->name, 2);
    $function = $module . '_' . str_replace('-', '_', $tool) . '_' . str_replace('-', '_', $type);
    if (function_exists($function)) {
      $function($items);
    }
  }
}

Functions

Name	Description
ctools_passthrough	Provide a hook passthrough to included files.