class Messages in Acquia Search 3.x

Class Messages.

Contains methods related to the UI messages.

Hierarchy

• class \Drupal\acquia_search\Helper\Messages

3 files declare their use of Messages

acquia_search.install in ./acquia_search.install

Install, update, and uninstall functions for the Acquia Search Solr module.

acquia_search.module in ./acquia_search.module

Integration between Drupal and Acquia's hosted Solr search service.

SearchApiSolrAcquiaConnector.php in src/Plugin/SolrConnector/SearchApiSolrAcquiaConnector.php

File

src/Helper/Messages.php, line 15

Namespace

Drupal\acquia_search\Helper

class Messages {

  /**
   * Generates DSM with read-only message warning.
   */
  public static function showReadOnlyModeWarning() {
    $message = Messages::getReadOnlyModeWarning();
    \Drupal::messenger()
      ->addWarning($message);
  }

  /**
   * Generates DSM with "could not find preferred core" message warning.
   */
  public static function showNoPreferredCoreError() {
    $message = Messages::getNoPreferredCoreError();
    \Drupal::messenger()
      ->addWarning(Markup::create($message));
  }

  /**
   * Returns formatted message if preferred search core is unavailable.
   *
   * @return string
   *   Formatted message.
   */
  public static function getNoPreferredCoreError() : string {
    $possible_cores = Runtime::getPreferredSearchCoreService()
      ->getListOfPossibleCores();
    $messages[] = t('Could not find a Solr core corresponding to your website and environment.');
    if (!empty($possible_cores)) {
      $messages[] = t('These cores were expected but not found in your subscription: @list.', [
        '@list' => implode(', ', $possible_cores),
      ]);
    }
    $available_cores = Runtime::getPreferredSearchCoreService()
      ->getListOfAvailableCores();
    if (!empty($available_cores)) {
      $messages[] = t('Your subscription contains these cores: @list.', [
        '@list' => implode(', ', $available_cores),
      ]);
    }
    else {
      $messages[] = t('Your subscription contains no cores.');
    }
    $messages[] = t('To fix this problem, please read <a href="@url">our documentation</a>.', [
      '@url' => 'https://docs.acquia.com/acquia-search/multiple-cores/',
    ]);
    return implode(' ', $messages);
  }

  /**
   * Returns formatted message about read-only mode.
   *
   * @return string
   *   Formatted message about read-only mode.
   */
  public static function getReadOnlyModeWarning() : string {
    return (string) t('The read-only mode is set in the configuration of the Acquia Search Solr module.');
  }

  /**
   * Returns formatted message about Acquia Search connection details.
   *
   * @param \Drupal\search_api\Entity\Server $server
   *   Search server configuration entity.
   *
   * @return \Drupal\Component\Render\MarkupInterface|string
   *   Formatted message about Acquia Search connection details.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Drupal\search_api\SearchApiException
   */
  public static function getSearchStatusMessage(Server $server) {

    /** @var \Drupal\search_api_solr\Plugin\search_api\backend\SearchApiSolrBackend $backend */
    $backend = $server
      ->getBackend();
    $configuration = $backend
      ->getSolrConnector()
      ->getConfiguration();
    $items[] = Messages::getServerIdMessage($server
      ->id());
    if (Runtime::getPreferredSearchCoreService()
      ->isPreferredCoreAvailable()) {
      $items[] = Messages::getServerUrlMessage($configuration);

      // Report on the behavior chosen.
      if (isset($configuration['overridden_by_acquia_search'])) {
        $items[] = Messages::getOverriddenModeMessage($configuration['overridden_by_acquia_search']);
      }
      $items[] = Messages::getServerAvailabilityMessage($server);
      $items[] = Messages::getServerAuthCheckMessage($server);
    }
    else {
      $items[] = [
        '#markup' => '<span class="color-error">' . Messages::getNoPreferredCoreError() . '</span>',
      ];
    }
    $list = [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
    $list = \Drupal::service('renderer')
      ->renderRoot($list);
    $msg = t('Connection managed by Acquia Search Solr module.') . $list;
    return Markup::create((string) $msg);
  }

  /**
   * Get text describing the current override mode.
   *
   * @param int $override
   *   Override mode. Read-only or core auto selected.
   *
   * @return array|\Drupal\Core\StringTranslation\TranslatableMarkup
   *   Text describing the current override mode.
   */
  public static function getOverriddenModeMessage(int $override) {
    switch ($override) {
      case SearchApiSolrAcquiaConnector::READ_ONLY:
        return [
          '#markup' => '<span class="color-warning">' . t('Acquia Search Solr module automatically enforced read-only mode on this connection.') . '</span>',
        ];
      case SearchApiSolrAcquiaConnector::OVERRIDE_AUTO_SET:
        return t('Acquia Search Solr module automatically selected the proper Solr connection based on the detected environment and configuration.');
    }
  }

  /**
   * Get text showing the current URL based on configuration.
   *
   * @param array $configuration
   *   A configuration array containing scheme, host, port and path.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   Translatable markup showing the current URL based on configuration.
   */
  public static function getServerUrlMessage(array $configuration) : TranslatableMarkup {
    if (empty($configuration['host'])) {
      $url = t('N/A');
    }
    else {
      $url = $configuration['scheme'] . '://' . $configuration['host'] . ':' . $configuration['port'] . $configuration['path'];
    }
    return t('URL: @url', [
      '@url' => $url,
    ]);
  }

  /**
   * Get text describing current server ID.
   *
   * @param string|int|null $server_id
   *   Server ID.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   Translatable markup describing current server.
   */
  public static function getServerIdMessage($server_id) : TranslatableMarkup {
    return t('search_api_solr.module server ID: @id', [
      '@id' => $server_id,
    ]);
  }

  /**
   * Get text describing availability for the given server.
   *
   * @param \Drupal\search_api\Entity\Server $server
   *   Search server configuration entity.
   *
   * @return array|\Drupal\Core\StringTranslation\TranslatableMarkup
   *   Solr server availability message.
   *
   * @throws \Drupal\search_api\SearchApiException
   */
  public static function getServerAvailabilityMessage(Server $server) {
    if ($server
      ->getBackend()
      ->getSolrConnector()
      ->pingCore()) {
      return t('Solr core is currently reachable and up.');
    }
    return [
      '#markup' => '<span class="color-error">' . t('Solr core is currently unreachable.') . '</span>',
    ];
  }

  /**
   * Get message describing authentication status for the given server.
   *
   * @param \Drupal\search_api\Entity\Server $server
   *   Search server configuration entity.
   *
   * @return array|\Drupal\Core\StringTranslation\TranslatableMarkup
   *   Solr server authentication status message.
   *
   * @throws \Drupal\search_api\SearchApiException
   */
  public static function getServerAuthCheckMessage(Server $server) {
    if ($server
      ->getBackend()
      ->getSolrConnector()
      ->pingServer()) {
      return t('Requests to Solr core are passing authentication checks.');
    }
    return [
      '#markup' => '<span class="color-error">' . t('Solr core authentication check fails.') . '</span>',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Messages::getNoPreferredCoreError	public static	function	Returns formatted message if preferred search core is unavailable.
Messages::getOverriddenModeMessage	public static	function	Get text describing the current override mode.
Messages::getReadOnlyModeWarning	public static	function	Returns formatted message about read-only mode.
Messages::getSearchStatusMessage	public static	function	Returns formatted message about Acquia Search connection details.
Messages::getServerAuthCheckMessage	public static	function	Get message describing authentication status for the given server.
Messages::getServerAvailabilityMessage	public static	function	Get text describing availability for the given server.
Messages::getServerIdMessage	public static	function	Get text describing current server ID.
Messages::getServerUrlMessage	public static	function	Get text showing the current URL based on configuration.
Messages::showNoPreferredCoreError	public static	function	Generates DSM with "could not find preferred core" message warning.
Messages::showReadOnlyModeWarning	public static	function	Generates DSM with read-only message warning.