Analyzer.php 3.72 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\views\Analyzer.
6 7 8 9
 */

namespace Drupal\views;

10
use Drupal\Core\Extension\ModuleHandlerInterface;
11
use Drupal\views\ViewExecutable;
12 13 14 15 16 17 18 19 20 21 22 23

/**
 * This tool is a small plugin manager to perform analysis on a view and
 * report results to the user. This tool is meant to let modules that
 * provide data to Views also help users properly use that data by
 * detecting invalid configurations. Views itself comes with only a
 * small amount of analysis tools, but more could easily be added either
 * by modules or as patches to Views itself.
 */
class Analyzer {

  /**
24
   * A module handler that invokes the 'views_analyze' hook.
25
   *
26
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
27
   */
28
  protected $moduleHandler;
29 30

  /**
31
   * Constructs an Analyzer object.
32
   *
33 34
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler that invokes the 'views_analyze' hook.
35
   */
36 37
  public function __construct(ModuleHandlerInterface $module_handler) {
    $this->moduleHandler = $module_handler;
38 39 40 41 42 43
  }


  /**
   * Analyzes a review and return the results.
   *
44 45 46
   * @param \Drupal\views\ViewExecutable $view
   *   The view to analyze.
   *
47 48 49 50
   * @return array
   *   An array of analyze results organized into arrays keyed by 'ok',
   *   'warning' and 'error'.
   */
51 52 53
  public function getMessages(ViewExecutable $view) {
    $view->initDisplay();
    $messages = $this->moduleHandler->invokeAll('views_analyze', array($view));
54 55 56 57 58 59 60 61 62 63 64 65

    return $messages;
  }

  /**
   * Formats the analyze result into a message string.
   *
   * This is based upon the format of drupal_set_message which uses separate
   * boxes for "ok", "warning" and "error".
   */
  public function formatMessages(array $messages) {
    if (empty($messages)) {
66
      $messages = array(static::formatMessage(t('View analysis can find nothing to report.'), 'ok'));
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
    }

    $types = array('ok' => array(), 'warning' => array(), 'error' => array());
    foreach ($messages as $message) {
      if (empty($types[$message['type']])) {
        $types[$message['type']] = array();
      }
      $types[$message['type']][] = $message['message'];
    }

    $output = '';
    foreach ($types as $type => $messages) {
      $type .= ' messages';
      $message = '';
      if (count($messages) > 1) {
82 83 84 85 86
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $messages,
        );
        $message = drupal_render($item_list);
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
      }
      elseif ($messages) {
        $message = array_shift($messages);
      }

      if ($message) {
        $output .= "<div class=\"$type\">$message</div>";
      }
    }

    return $output;
  }

  /**
   * Formats an analysis message.
   *
   * This tool should be called by any module responding to the analyze hook
   * to properly format the message. It is usually used in the form:
   * @code
   *   $ret[] = Analyzer::formatMessage(t('This is the message'), 'ok');
   * @endcode
   *
   * The 'ok' status should be used to provide information about things
   * that are acceptable. In general analysis isn't interested in 'ok'
   * messages, but instead the 'warning', which is a category for items
   * that may be broken unless the user knows what he or she is doing,
   * and 'error' for items that are definitely broken are much more useful.
   *
   * @param string $message
   * @param string $type
   *   The type of message. This should be "ok", "warning" or "error". Other
   *   values can be used but how they are treated by the output routine
   *   is undefined.
   *
   * @return array
   *   A single formatted message, consisting of a key message and a key type.
   */
  static function formatMessage($message, $type = 'error') {
    return array('message' => $message, 'type' => $type);
  }
127

128
}