You are here

Home » API reference » Viewfield 8.3 » ViewfieldFormatterDefault.php

class ViewfieldFormatterDefault in Viewfield 8.3

Viewfield Default Formatter plugin definition.

Plugin annotation


@FieldFormatter(
  id = "viewfield_default",
  label = @Translation("Viewfield"),
  field_types = {"viewfield"}
)

Hierarchy

Expanded class hierarchy of ViewfieldFormatterDefault

File

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

Namespace

Drupal\viewfield\Plugin\Field\FieldFormatter
View source 
class ViewfieldFormatterDefault extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'view_title' => 'hidden',
      'always_build_output' => 0,
      'empty_view_title' => 'hidden',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['view_title'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('View title'),
      '#options' => $this
        ->getFieldLabelOptions(),
      '#default_value' => $this
        ->getSetting('view_title'),
      '#description' => $this
        ->t('Option to render the view display title.'),
    ];
    $form['always_build_output'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Always build output'),
      '#default_value' => $this
        ->getSetting('always_build_output'),
      '#description' => $this
        ->t('Produce renderable output even if the view produces no results.<br>This option may be useful for some specialized cases, e.g., to force rendering of an attachment display even if there are no view results.'),
    ];
    $always_build_output_name = 'fields[' . $this->fieldDefinition
      ->getName() . '][settings_edit_form][settings][always_build_output]';
    $form['empty_view_title'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Empty view title'),
      '#options' => $this
        ->getFieldLabelOptions(),
      '#default_value' => $this
        ->getSetting('empty_view_title'),
      '#description' => $this
        ->t('Option to output the view display title even when the view produces no results.<br>This option has an effect only when <em>Always build output</em> is also selected.'),
      '#states' => [
        'visible' => [
          ':input[name="' . $always_build_output_name . '"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $settings = $this
      ->getSettings();
    $label_options = $this
      ->getFieldLabelOptions();
    $summary = [];
    $summary[] = $this
      ->t('Show view title: @view_title', [
      '@view_title' => $label_options[$settings['view_title']],
    ]);
    $summary[] = $this
      ->t('Always build output: @always_build_output', [
      '@always_build_output' => $this
        ->getCheckboxLabel($settings['always_build_output']),
    ]);
    if ($settings['always_build_output']) {
      $summary[] = $this
        ->t('Show empty view title: @show_empty_view_title', [
        '@show_empty_view_title' => $label_options[$settings['empty_view_title']],
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function view(FieldItemListInterface $items, $langcode = NULL) {
    $elements = parent::view($items, $langcode);
    if (isset($elements['#items'])) {
      $elements['#theme'] = 'viewfield';
      $elements['#entity'] = $items
        ->getEntity();
      $elements['#entity_type'] = $items
        ->getEntity()
        ->getEntityTypeId();
      $elements['#bundle'] = $items
        ->getEntity()
        ->bundle();
      $elements['#field_name'] = $this->fieldDefinition
        ->getName();
      $elements['#field_type'] = $this->fieldDefinition
        ->getType();
      $elements['#view_mode'] = $this->viewMode;
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $entity = $items
      ->getEntity();
    if ($this
      ->getFieldSetting('force_default')) {
      $values = $this->fieldDefinition
        ->getDefaultValue($entity);
    }
    else {
      $values = [];
      foreach ($items as $delta => $item) {
        $values[$delta] = $item
          ->getValue();
      }
    }
    $elements = [];
    $cacheability = new CacheableMetadata();
    $always_build_output = $this
      ->getSetting('always_build_output');
    $view_title = $this
      ->getSetting('view_title');
    $empty_view_title = $this
      ->getSetting('empty_view_title');
    foreach ($values as $delta => $value) {
      if (!empty($value['target_id']) && !empty($value['display_id'])) {
        $target_id = $value['target_id'];
        $display_id = $value['display_id'];
        $items_to_display = $value['items_to_display'];
        if (!empty($value['arguments'])) {
          $arguments = $this
            ->processArguments($value['arguments'], $entity);
        }
        else {
          $arguments = [];
        }

        // @see views_embed_view()
        // @see views_get_view_result()
        $view = Views::getView($target_id);
        if (!$view || !$view
          ->access($display_id)) {
          continue;
        }

        // Set arguments if they exist
        if (!empty($arguments)) {
          $view
            ->setArguments($arguments);
        }
        $view
          ->setDisplay($display_id);

        // Override items to display if set.
        if (!empty($items_to_display)) {
          $view
            ->setItemsPerPage($items_to_display);
        }
        $view
          ->preExecute();
        $view
          ->execute();

        // Disable pager, if items_to_display was set.
        if (!empty($items_to_display)) {
          $view->pager = new \Drupal\views\Plugin\views\pager\None([], '', []);
          $view->pager
            ->init($view, $view->display_handler);
          $view->pager
            ->setItemsPerPage($items_to_display);
        }
        $rendered_view = $view
          ->buildRenderable($display_id, $arguments);

        // Get cache metadata from view and merge.
        $view_cacheability = CacheableMetadata::createFromRenderArray($view->element);
        $cacheability = $cacheability
          ->merge($view_cacheability);
        if (!empty($view->result) || $always_build_output) {
          $elements[$delta] = [
            '#theme' => 'viewfield_item',
            '#content' => $rendered_view,
            '#title' => $view
              ->getTitle(),
            '#label_display' => empty($view->result) ? $empty_view_title : $view_title,
            '#delta' => $delta,
            '#field_name' => $this->fieldDefinition
              ->getName(),
            '#view_id' => $target_id,
            '#display_id' => $display_id,
          ];

          // Add arguments to view cache keys to allow multiple viewfields with
          // same view but different arguments per page.
          $cache_keys = array_merge($rendered_view['#cache']['keys'], $arguments);
          $elements[$delta]['#content']['#cache']['keys'] = $cache_keys;
        }
      }
    }

    // Apply merged cache metadata to $elements.
    $cacheability
      ->applyTo($elements);
    return $elements;
  }

  /**
   * Perform argument parsing and token replacement.
   *
   * @param string $argument_string
   *   The raw argument string.
   * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
   *   The entity containing this field.
   *
   * @return array
   *   The array of processed arguments.
   */
  protected function processArguments($argument_string, FieldableEntityInterface $entity) {
    $arguments = [];
    if (!empty($argument_string)) {
      $pos = 0;
      while ($pos < strlen($argument_string)) {
        $found = FALSE;

        // If string starts with a quote, start after quote and get everything
        // before next quote.
        if (strpos($argument_string, '"', $pos) === $pos) {
          if (($quote = strpos($argument_string, '"', ++$pos)) !== FALSE) {

            // Skip pairs of quotes.
            while (!(($ql = strspn($argument_string, '"', $quote)) & 1)) {
              $quote = strpos($argument_string, '"', $quote + $ql);
            }
            $arguments[] = str_replace('""', '"', substr($argument_string, $pos, $quote + $ql - $pos - 1));
            $pos = $quote + $ql + 1;
            $found = TRUE;
          }
        }
        else {
          $arguments = explode('/', $argument_string);
          $pos = strlen($argument_string) + 1;
          $found = TRUE;
        }
        if (!$found) {
          $arguments[] = substr($argument_string, $pos);
          $pos = strlen($argument_string);
        }
      }
      $token_service = \Drupal::token();
      $token_data = [
        $entity
          ->getEntityTypeId() => $entity,
      ];
      foreach ($arguments as $key => $value) {
        $arguments[$key] = $token_service
          ->replace($value, $token_data);
      }
    }
    return $arguments;
  }

  /**
   * Get a printable label for a checkbox value.
   *
   * @param string $value
   *   The checkbox value.
   *
   * @return string
   *   The label for the checkbox value.
   */
  protected function getCheckboxLabel($value) {
    return !empty($value) ? $this
      ->t('Yes') : $this
      ->t('No');
  }

  /**
   * Returns an array of visibility options for field labels.
   *
   * @return array
   *   An array of visibility options.
   *
   * @see EntityViewDisplayEditForm::getFieldLabelOptions()
   */
  protected function getFieldLabelOptions() {
    return [
      'above' => $this
        ->t('Above'),
      'inline' => $this
        ->t('Inline'),
      'hidden' => '- ' . $this
        ->t('Hidden') . ' -',
      'visually_hidden' => '- ' . $this
        ->t('Visually Hidden') . ' -',
    ];
  }

}

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
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
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::__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.
ViewfieldFormatterDefault::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ViewfieldFormatterDefault::getCheckboxLabel protected function Get a printable label for a checkbox value.
ViewfieldFormatterDefault::getFieldLabelOptions protected function Returns an array of visibility options for field labels.
ViewfieldFormatterDefault::processArguments protected function Perform argument parsing and token replacement.
ViewfieldFormatterDefault::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ViewfieldFormatterDefault::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ViewfieldFormatterDefault::view public function Builds a renderable array for a fully themed field. Overrides FormatterBase::view
ViewfieldFormatterDefault::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements