class Message in Hook Update Deploy Tools 8

Hierarchy

• class \HookUpdateDeployTools\Message

File

src/Message.php, line 6

Namespace

HookUpdateDeployTools

class Message {

  /**
   * Logs a system message and outputs it to drush terminal if run from drush.
   *
   * @param string $message
   *   The message to store in the log. Keep $message translatable
   *   by not concatenating dynamic values into it! Variables in the
   *   message should be added by using placeholder strings alongside
   *   the variables argument to declare the value of the placeholders.
   *   See t() for documentation on how $message and $variables interact.
   * @param array $variables
   *   Array of variables to replace in the message on display or
   *   NULL if message is already translated or not possible to
   *   translate.
   * @param int $severity
   *   The severity of the message; one of the following values as defined by
   *   Psr\Log.  RfcLogLevel::ERROR and up throws a notice and fails the update.
   * debug, info, notice, warning, error, critical, alert, emergency.
   *   - RfcLogLevel::EMERGENCY: Emergency, system is unusable.
   *   - RfcLogLevel::ALERT: Alert, action must be taken immediately.
   *   - RfcLogLevel::CRITICAL: Critical conditions.
   *   - RfcLogLevel::ERROR: Error conditions.
   *   - RfcLogLevel::WARNING: Warning conditions.
   *   - RfcLogLevel::NOTICE: (default) Normal but significant conditions.
   *   - RfcLogLevel::INFO: Informational messages.
   *   -  RfcLogLevel::DEBUG: Debug-level messages.
   *   - FALSE: Outputs the message to drush without calling logging to dblog.
   * @param int $indent
   *   (optional). Sets indentation for drush output. Defaults to 1.
   * @param string $link
   *   (optional) A url to serve as the link in Watchdog. Unsuported?
   *
   * @return string
   *   - Returns an empty string to support legacy messaging style when run by
   *     drush.
   *   - Returns the full message if run by update.php so Drupal can handle the
   *     message.
   *
   * @throws DrupalUpdateException
   *   Exception thrown fails update if logger level is RfcLogLevel::ERROR,
   *   RfcLogLevel::CRITICAL, RfcLogLevel::ALERT, or RfcLogLevel::EMERGENCY
   */
  public static function make($message, $variables = array(), $severity = RfcLogLevel::NOTICE, $indent = 1, $link = NULL) {
    $variables = self::stringifyValues($variables);

    // Determine what instantiated this message's parent.
    $trace = debug_backtrace();
    $called_by = '';
    if (isset($trace[2])) {

      // $trace[2] is usually the hook update that instantiated this message.
      if (!empty($trace[2]['class'])) {
        $called_by = $trace[2]['class'];
      }
      elseif (!empty($trace[2]['function']) && stripos($trace[2]['function'], 'update_do_one') === FALSE) {
        $called_by = $trace[2]['function'];
      }
      elseif (!empty($trace[1]['function']) && stripos($trace[1]['function'], 'update_do_one') === FALSE) {
        $called_by = $trace[1]['function'];
      }
    }

    // Try to determine the module caller to pass to Logger.
    $wd_type = empty($called_by) ? 'hook_update_deploy_tools' : current(explode('_update_', $called_by));

    // Clean the watchdog of any types that are known nonsense from backtrace.
    $wd_type_giberish = array(
      // Bad type => Good type.
      'call_user_func_array' => 'hook_update_deploy_tools',
      'eval' => 'hook_update_deploy_tools',
      'site_deploy_install' => 'site_deploy',
      'HookUpdateDeployTools\\Menus' => $trace[3]['function'],
      'HookUpdateDeployTools\\Rules' => $trace[3]['function'],
    );
    $wd_type = !empty($wd_type_giberish[$wd_type]) ? $wd_type_giberish[$wd_type] : $wd_type;

    // t() might not be available at .install.
    $t = get_t();
    $fail_header = $severity <= RfcLogLevel::ERROR && $severity !== FALSE ? $t('UPDATE FAILED:') . ' ' : '';
    $formatted_message = format_string($message, $variables);
    if ($severity !== FALSE) {
      \Drupal::logger('HookUpdateDeployTools')
        ->log($severity, $fail_header . $message, $variables);
    }

    // Check to see if this is run by drush and no WD error was
    // already sent.  RfcLogLevel::ERROR and up get sent to terminal by WD.
    if (drupal_is_cli() && ($severity > RfcLogLevel::WARNING || $severity === FALSE)) {

      // Being run through drush, so output feedback to drush, and not already
      // output to terminal so output it.
      drush_print("{$fail_header}{$called_by}:{$formatted_message}", $indent);
    }
    else {

      // Being run by update.php so translate and return.
      $return_message = $t($message, $variables) . " \n";
    }

    // Error or more serious? Fail the hook_update_N.
    if ($severity <= RfcLogLevel::ERROR && $severity !== FALSE) {
      throw new \DrupalUpdateException("{$fail_header}{$called_by}: {$formatted_message}");
    }
    return !empty($return_message) ? "{$fail_header}{$wd_type}: {$return_message}" : '';
  }

  /**
   * Dumps a var to drush terminal if run by drush.
   *
   * @param mixed $var
   *   Any variable value to output.
   * @param string $var_id
   *   An optional string to identify what is being output.
   */
  public static function varDumpToDrush($var, $var_id = 'VAR DUMPs') {

    // Check to see if this is run by drush and output is desired.
    if (drupal_is_cli()) {
      drush_print("{$var_id}: \n", 0);
      if (!empty($var)) {
        drush_print_r($var);
      }
      else {
        drush_print("This variable was EMPTY. \n", 1);
      }
    }
  }

  /**
   * Loops through an array and pretty prints any values that are arrays or obj.
   *
   * @param array $variables
   *   A variables array ready for logger, but possibly containing arrays or
   *   objects as first level array values..
   *
   * @return array
   *   A single level array where all values are pretty printed.
   */
  public static function stringifyValues($variables) {
    if (is_array($variables) || is_object($variables)) {
      foreach ($variables as $key => $value) {
        $variables[$key] = is_array($value) || is_object($value) ? '<pre>' . print_r($value, TRUE) . '</pre>' : $value;
      }
    }
    return $variables;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Message::make	public static	function	Logs a system message and outputs it to drush terminal if run from drush.
Message::stringifyValues	public static	function	Loops through an array and pretty prints any values that are arrays or obj.
Message::varDumpToDrush	public static	function	Dumps a var to drush terminal if run by drush.