You are here

Home » API reference » Field Redirection 8.2 » FieldRedirectionFormatter.php

class FieldRedirectionFormatter in Field Redirection 8.2

Plugin implementation of the 'field_redirection_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "field_redirection_formatter",
  label = @Translation("Redirect"),
  field_types = {
    "link"
  }
)

Hierarchy

Expanded class hierarchy of FieldRedirectionFormatter

File

src/Plugin/Field/FieldFormatter/FieldRedirectionFormatter.php, line 21

Namespace

Drupal\field_redirection\Plugin\Field\FieldFormatter
View source 
class FieldRedirectionFormatter extends FormatterBase {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The redirect result builder.
   *
   * @var \Drupal\field_redirection\FieldRedirectionResultBuilder
   */
  protected $redirectResultBuilder;

  /**
   * The current Request object.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * The standard HTTP redirection codes that are supported.
   *
   * @var array
   */
  protected $httpCodes = [
    '300' => '300: Multiple Choices (rarely used)',
    '301' => '301: Moved Permanently (default)',
    '302' => '302: Found (rarely used)',
    '303' => '303: See Other (rarely used)',
    '304' => '304: Not Modified (rarely used)',
    '305' => '305: Use Proxy (rarely used)',
    '307' => '307: Temporary Redirect (temporarily moved)',
  ];

  /**
   * Restrictions that may be applied to this redirection.
   *
   * @var array
   */
  protected $pageRestrictionOptions = [
    '0' => 'Redirect on all pages.',
    '1' => 'Redirect only on the following pages.',
    '2' => 'Redirect on all pages except the following pages.',
  ];

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance->currentUser = $container
      ->get('current_user');
    $instance->redirectResultBuilder = $container
      ->get('field_redirection.result_builder');
    $instance->request = $container
      ->get('request_stack')
      ->getCurrentRequest();
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'code' => '301',
      '404_if_empty' => FALSE,
      'page_restrictions' => 0,
      'pages' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);

    // Load the current selection, default to "301".
    $code = 301;
    if (!empty($this
      ->getSetting('code')) && isset($this->httpCodes[$this
      ->getSetting('code')])) {
      $code = $this
        ->getSetting('code');
    }

    // Choose the redirector.
    $elements['code'] = [
      '#title' => 'HTTP status code',
      '#type' => 'select',
      '#options' => [],
      '#default_value' => $code,
    ];
    foreach ($this->httpCodes as $code => $label) {
      $elements['code']['#options'][$code] = $this
        ->t('@label', [
        '@label' => $label,
      ]);
    }

    // 404 if the field value is empty.
    $elements['404_if_empty'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('404 if URL empty'),
      '#default_value' => !empty($this
        ->getSetting('404_if_empty')),
      '#description' => $this
        ->t('Optionally display a 404 error page if the associated URL field is empty.'),
    ];
    $elements['note'] = [
      '#markup' => $this
        ->t('Note: If the destination path is the same as the current path it will behave as if it is empty.'),
      '#prefix' => '<p>',
      '#suffix' => '</p>',
    ];

    // Provide targeted URL rules to trigger this action.
    $elements['page_restrictions'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Redirect page restrictions'),
      '#default_value' => empty($this
        ->getSetting('page_restrictions')) ? 0 : $this
        ->getSetting('page_restrictions'),
      '#options' => [],
    ];
    foreach ($this->pageRestrictionOptions as $code => $label) {
      $elements['page_restrictions']['#options'][$code] = $this
        ->t('@label', [
        '@label' => $label,
      ]);
    }
    $elements['pages'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Paths'),
      '#default_value' => empty($this
        ->getSetting('pages')) ? '' : $this
        ->getSetting('pages'),
      '#description' => $this
        ->t("Enter one page per line as Drupal paths. The '@wildcard' character is a wildcard. Example paths are '@example_blog' for the blog page and '@example_all_personal_blogs' for every personal blog. '@frontpage' is the front page. You can also use tokens in this field, for example '@example_current_node' can be used to define the current node path.", [
        '@wildcard' => '*',
        '@example_blog' => 'blog',
        '@example_all_personal_blogs' => 'blog/*',
        '@frontpage' => '<front>',
        '@example_current_node' => 'node/[node:nid]',
      ]),
      '#states' => [
        'invisible' => [
          ':input[name*="[page_restrictions]"]' => [
            'value' => '0',
          ],
        ],
      ],
    ];
    $elements['token_tree'] = [
      '#theme' => 'token_tree_link',
      '#token_types' => 'all',
      '#weight' => 100,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $settings = $this
      ->getSettings();

    // Display a "hair on fire" warning message for any view mode other than
    // "full".
    if ($this->viewMode != 'full') {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Danger! The Redirect formatter should not be used with any view mode other than "Full content".'));
    }
    if (!empty($settings['code'])) {
      $summary[] = $this
        ->t('HTTP status code: @code', [
        '@code' => $this->httpCodes[$settings['code']],
      ]);
    }
    if ($settings['404_if_empty']) {
      $summary[] = $this
        ->t('Will return 404 (page not found) if field is empty.');
    }
    if (!empty($settings['page_restrictions'])) {
      $page_restrictions = $this->pageRestrictionOptions;
      $summary[] = $this
        ->t('Page restriction options: @pagerestriction', [
        '@pagerestriction' => $page_restrictions[$settings['page_restrictions']],
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];

    // Don't do anything if running via the CLI, e.g. Drush.
    // Do this here instead of in the builder so tests don't exit early.
    if (php_sapi_name() == 'cli') {
      return $elements;
    }
    $settings = $this
      ->getSettings();

    // Set response code.
    $response_code = 301;
    if (!empty($settings['code']) && isset($this->httpCodes[$settings['code']])) {
      $response_code = $settings['code'];
    }

    /** @var \Drupal\field_redirection\FieldRedirectionResult $result */
    $result = $this->redirectResultBuilder
      ->buildResult($items, $this->request, $this->currentUser, $settings);
    if ($result
      ->shouldRedirect()) {
      $result
        ->asRedirectResponse($response_code)
        ->send();
      exit;
    }

    // If the user has permission to bypass the page redirection, return a
    // message explaining where they would have been redirected to.
    if ($this->currentUser
      ->hasPermission('bypass redirection') && !$items
      ->isEmpty()) {
      $message = $this
        ->t('This page is set to redirect to <a href="@href">another URL</a>, but you have permission to see this page and will not be automatically redirected.', [
        '@href' => $items
          ->first()
          ->getUrl()
          ->toString(),
      ]);
      $this
        ->messenger()
        ->addWarning($message);
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FieldRedirectionFormatter::$currentUser protected property The current user.
FieldRedirectionFormatter::$httpCodes protected property The standard HTTP redirection codes that are supported.
FieldRedirectionFormatter::$pageRestrictionOptions protected property Restrictions that may be applied to this redirection.
FieldRedirectionFormatter::$redirectResultBuilder protected property The redirect result builder.
FieldRedirectionFormatter::$request protected property The current Request object.
FieldRedirectionFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
FieldRedirectionFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FieldRedirectionFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
FieldRedirectionFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
FieldRedirectionFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.