You are here

Home » API reference » Domain Access 8 » DomainServerBlock.php

class DomainServerBlock in Domain Access 8

Provides a server information block for a domain request.

Plugin annotation


@Block(
  id = "domain_server_block",
  admin_label = @Translation("Domain server information")
)

Hierarchy

Expanded class hierarchy of DomainServerBlock

File

domain/src/Plugin/Block/DomainServerBlock.php, line 17

Namespace

Drupal\domain\Plugin\Block
View source 
class DomainServerBlock extends DomainBlockBase {

  /**
   * Overrides \Drupal\block\BlockBase::access().
   */
  public function access(AccountInterface $account, $return_as_object = FALSE) {
    $access = AccessResult::allowedIfHasPermissions($account, [
      'administer domains',
      'view domain information',
    ], 'OR');
    return $return_as_object ? $access : $access
      ->isAllowed();
  }

  /**
   * Build the output.
   */
  public function build() {

    /** @var \Drupal\domain\DomainInterface $domain */
    $domain = \Drupal::service('domain.negotiator')
      ->getActiveDomain();
    if (!$domain) {
      return [
        '#markup' => $this
          ->t('No domain record could be loaded.'),
      ];
    }
    $header = [
      $this
        ->t('Server'),
      $this
        ->t('Value'),
    ];
    $rows[] = [
      $this
        ->t('HTTP_HOST request'),
      Html::escape($_SERVER['HTTP_HOST']),
    ];

    // Check the response test.
    $domain
      ->getResponse();
    $check = \Drupal::entityTypeManager()
      ->getStorage('domain')
      ->loadByHostname($_SERVER['HTTP_HOST']);
    $match = $this
      ->t('Exact match');

    // This value is not translatable.
    $environment = 'default';
    if (!$check) {

      // Specific check for Domain Alias.
      if (isset($domain->alias)) {
        $match = $this
          ->t('ALIAS: Using alias %id', [
          '%id' => $domain->alias
            ->getPattern(),
        ]);

        // Get the environment.
        $environment = $domain->alias
          ->getEnvironment();
      }
      else {
        $match = $this
          ->t('FALSE: Using default domain.');
      }
    }
    $rows[] = [
      $this
        ->t('Domain match'),
      $match,
    ];
    $rows[] = [
      $this
        ->t('Environment'),
      $environment,
    ];
    $rows[] = [
      $this
        ->t('Canonical hostname'),
      $domain
        ->getCanonical(),
    ];
    $rows[] = [
      $this
        ->t('Base path'),
      $domain
        ->getPath(),
    ];
    $rows[] = [
      $this
        ->t('Current URL'),
      $domain
        ->getUrl(),
    ];
    $www = \Drupal::config('domain.settings')
      ->get('www_prefix');
    $rows[] = [
      $this
        ->t('Strip www prefix'),
      !empty($www) ? $this
        ->t('On') : $this
        ->t('Off'),
    ];
    $list = $domain
      ->toArray();
    ksort($list);
    foreach ($list as $key => $value) {
      if (is_null($value)) {
        $value = $this
          ->t('NULL');
      }
      elseif ($value === TRUE) {
        $value = $this
          ->t('TRUE');
      }
      elseif ($value === FALSE) {
        $value = $this
          ->t('FALSE');
      }
      elseif ($key == 'status' || $key == 'is_default') {
        $value = empty($value) ? $this
          ->t('FALSE') : $this
          ->t('TRUE');
      }
      $rows[] = [
        Html::escape($key),
        !is_array($value) ? Html::escape($value) : $this
          ->printArray($value),
      ];
    }
    return [
      '#theme' => 'table',
      '#rows' => $rows,
      '#header' => $header,
    ];
  }

  /**
   * Prints array data for the server block.
   *
   * @param array $array
   *   An array of data. Note that we support two levels of nesting.
   *
   * @return string
   *   A suitable output string.
   */
  public function printArray(array $array) {
    $items = [];
    foreach ($array as $key => $val) {
      if (!is_array($val)) {
        $value = Html::escape($val);
      }
      else {
        $list = [];
        foreach ($val as $k => $v) {
          $list[] = $this
            ->t('@key : @value', [
            '@key' => $k,
            '@value' => $v,
          ]);
        }
        $value = implode('<br />', $list);
      }
      $items[] = $this
        ->t('@key : @value', [
        '@key' => $key,
        '@value' => $value,
      ]);
    }
    $variables['domain_server'] = [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
    return render($variables);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::blockForm public function 16
BlockPluginTrait::blockSubmit public function 13
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::defaultConfiguration public function 19
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
BlockPluginTrait::__construct public function 22
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DomainBlockBase::getCacheContexts public function The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts 1
DomainServerBlock::access public function Overrides \Drupal\block\BlockBase::access(). Overrides BlockPluginTrait::access
DomainServerBlock::build public function Build the output. Overrides BlockPluginInterface::build
DomainServerBlock::printArray public function Prints array data for the server block.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2