xbbcode.inc in Extensible BBCode 8.2

General library of internal functions only called by this module.

File

xbbcode.inc

<?php

/**
 * @file
 * General library of internal functions only called by this module.
 */
use Drupal\xbbcode\XBBCodeFilter;

/**
 * Discover the handlers by module hook invokation.
 *
 * @return
 *   An array keyed by tag name. Each element is an array.
 *   - the 'modules' key contains a list of public module names (keyed by 
 *     internal name) that provide this tag.
 *   - the 'info' key contains the data returned by each module's hook.
 */
function _xbbcode_build_handlers() {
  $module_names = _xbbcode_module_names();
  $handlers = array();
  foreach ($module_names as $module => $name) {
    $tags = Drupal::moduleHandler()
      ->invoke($module, 'xbbcode_info');
    foreach ($tags as $tag_name => $info) {
      $handlers[$tag_name]['modules'][$module] = $name;
      $handlers[$tag_name]['info'][$module] = $info;
    }
  }
  ksort($handlers);
  return $handlers;
}

/**
 * Invoke all handlers to get the tags for a certain format.
 *
 * @param $format_id
 *   The name of the format for which tags should be built.
 *
 * @return
 *   An array of tag objects, keyed by name.
 */
function _xbbcode_build_tags($handlers) {

  // First, check if the tags are in cache.

  //if ($cache = Drupal::cache()->get("xbbcode_tags:$format_id")) {

  //  $tags = $cache->data;

  //}

  // Load the preferred handlers for this text format.
  $providers = array();
  foreach ($handlers as $name => $handler) {

    // Build a list of what modules are used, and what to get from each.
    if ($handler['enabled']) {
      $providers[$handler['module']][$name] = $name;
    }
  }
  $tags = [];
  $default = [
    'selfclosing' => FALSE,
  ];
  foreach ($providers as $module => $provides) {
    $info = Drupal::moduleHandler()
      ->invoke($module, 'xbbcode_info');
    foreach ($provides as $tag) {
      if (isset($info[$tag])) {
        if (!isset($info[$tag]['options'])) {
          $info[$tag]['options'] = [];
        }
        $tags[$tag] = (object) array(
          'name' => $tag,
          'description' => $info[$tag]['description'],
          'sample' => $info[$tag]['sample'],
          'options' => (object) ($info[$tag]['options'] + $default),
          'markup' => isset($info[$tag]['markup']) ? $info[$tag]['markup'] : NULL,
          'callback' => !isset($info[$tag]['markup']) ? $info[$tag]['callback'] : NULL,
        );
      }
    }
  }

  //Drupal::cache()->set("xbbcode_tags:$format_id", $tags, Cache::Permanent, ['xbbcode_tags']);
  return $tags;
}

/**
 * Concatenate a tag's descriptions, making all but one invisible.
 *
 * @param $tag
 *   The name of the tag.
 * @param $handlers
 *   The info from each module that provides the tag, keyed by module name.
 * @param $selected
 *   (optional for a single handler) The name of the active handler.
 *
 * @return
 *   The HTML code.
 */
function _xbbcode_build_descriptions($name, $handlers, $selected = NULL) {
  reset($handlers);
  if (!$selected) {
    $selected = key($handlers);
  }
  $descriptions = '';
  foreach ($handlers as $module => $info) {
    $class = $module == $selected ? 'visible' : 'invisible';
    if (isset($info['description'])) {
      $descriptions .= "<span class='tag-{$name} module-{$module} xbbcode-description-{$class}'>{$info['description']}</span>\n";
    }
  }
  return $descriptions;
}

/**
 * End-user names of all modules that implement hook_xbbcode_info().
 *
 * These names are displayed on the settings form when choosing a module that
 * should handle each tag. The xbbcode module itself is renamed "Custom" since
 * its tags are the ones entered through the admin interface.
 */
function _xbbcode_module_names() {
  $modules =& drupal_static(__FUNCTION__, array());
  if (!$modules) {
    $info = system_get_info('module');
    foreach (Drupal::moduleHandler()
      ->getImplementations('xbbcode_info') as $module) {
      $modules[$module] = $info[$module]['name'];
    }
    $modules['xbbcode'] = 'Custom';
  }
  return $modules;
}

Functions

Name	Description
_xbbcode_build_descriptions	Concatenate a tag's descriptions, making all but one invisible.
_xbbcode_build_handlers	Discover the handlers by module hook invokation.
_xbbcode_build_tags	Invoke all handlers to get the tags for a certain format.
_xbbcode_module_names	End-user names of all modules that implement hook_xbbcode_info().