You are here

Home » API reference » Webform Views Integration 8.5 » WebformSubmissionViewsData.php

class WebformSubmissionViewsData in Webform Views Integration 8.5

Views data for 'webform_submission' entity type.

Hierarchy

Expanded class hierarchy of WebformSubmissionViewsData

1 file declares its use of WebformSubmissionViewsData
webform_views.module in ./webform_views.module
Webform integration with views.

File

src/WebformSubmissionViewsData.php, line 22

Namespace

Drupal\webform_views
View source 
class WebformSubmissionViewsData extends WebformSubmissionViewsDataBase {

  /**
   * @var WebformElementManagerInterface
   */
  protected $webformElementManager;

  /**
   * @var EntityStorageInterface
   */
  protected $webformStorage;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('entity_type.manager'), $container
      ->get('module_handler'), $container
      ->get('string_translation'), $container
      ->get('entity_field.manager'), $container
      ->get('plugin.manager.webform.element'), $container
      ->get('entity_type.manager')
      ->getStorage('webform'));
  }

  /**
   * WebformSubmissionViewsData constructor.
   */
  public function __construct(EntityTypeInterface $entity_type, SqlEntityStorageInterface $storage_controller, EntityTypeManagerInterface $entity_manager, ModuleHandlerInterface $module_handler, TranslationInterface $translation_manager, EntityFieldManagerInterface $entity_field_manager, WebformElementManagerInterface $webform_element_manager, EntityStorageInterface $webform_storage) {
    parent::__construct($entity_type, $storage_controller, $entity_manager, $module_handler, $translation_manager, $entity_field_manager);
    $this->webformElementManager = $webform_element_manager;
    $this->webformStorage = $webform_storage;
  }

  /**
   * {@inheritdoc}
   */
  public function getViewsData() {
    $data = parent::getViewsData();
    $base_table = $this->entityType
      ->getBaseTable() ?: $this->entityType
      ->id();
    $data[$base_table]['source_entity_label'] = [
      'title' => $this
        ->t('Submitted to: Entity label'),
      'help' => $this
        ->t('The label of entity to which this submission was submitted.'),
      'field' => [
        'id' => 'webform_submission_submitted_to_label',
      ],
    ];
    $data[$base_table]['source_entity_rendered_entity'] = [
      'title' => $this
        ->t('Submitted to: Rendered entity'),
      'help' => $this
        ->t('Rendered entity to which this submission was submitted.'),
      'field' => [
        'id' => 'webform_submission_submitted_to_rendered_entity',
      ],
    ];

    // Reverse relationship on the "entity_type" and "entity_id" columns, i.e.
    // from an arbitrary entity to webform submissions that have been submitted
    // to it.
    foreach ($this->entityTypeManager
      ->getDefinitions() as $definition) {
      if ($definition instanceof ContentEntityTypeInterface) {
        $relationship = [
          'base' => $base_table,
          'field' => $definition
            ->getKey('id'),
          'base field' => 'entity_id',
          'id' => 'standard',
          'extra' => [
            [
              'field' => 'entity_type',
              'value' => $definition
                ->id(),
            ],
          ],
        ];

        // Depending on whether the foreign entity has data table we join on its
        // data table or on its base table. Additionally, if we join on the data
        // table, then we also must join on langcode column.
        if ($definition
          ->getDataTable()) {
          $foreign_table = $definition
            ->getDataTable();
          $relationship['extra'][] = [
            'field' => 'langcode',
            'left_field' => 'langcode',
          ];
        }
        else {
          $foreign_table = $definition
            ->getBaseTable();
        }
        $data[$foreign_table]['webform_submission'] = [
          'title' => $this
            ->t('Webform submissions'),
          'help' => $this
            ->t('Webform submissions submitted to an entity.'),
        ];
        $data[$foreign_table]['webform_submission']['relationship'] = $relationship;
      }
    }

    // Add non-admin "view", "duplicate" and "edit" links.
    $data[$base_table]['webform_submission_user_submission_view'] = [
      'title' => $this
        ->t('Non-admin view link'),
      'help' => $this
        ->t('Link to view a webform submission for non-admin users.'),
      'field' => [
        'id' => 'webform_submission_user_submission_view_field',
        'real field' => $this->entityType
          ->getKey('id'),
        'click sortable' => FALSE,
      ],
    ];
    $data[$base_table]['webform_submission_user_submission_duplicate'] = [
      'title' => $this
        ->t('Non-admin duplicate link'),
      'help' => $this
        ->t('Link to duplicate a webform submission for non-admin users.'),
      'field' => [
        'id' => 'webform_submission_user_submission_duplicate_field',
        'real field' => $this->entityType
          ->getKey('id'),
        'click sortable' => FALSE,
      ],
    ];
    $data[$base_table]['webform_submission_user_submission_edit'] = [
      'title' => $this
        ->t('Non-admin edit link'),
      'help' => $this
        ->t('Link to edit a webform submission for non-admin users.'),
      'field' => [
        'id' => 'webform_submission_user_submission_edit_field',
        'real field' => $this->entityType
          ->getKey('id'),
        'click sortable' => FALSE,
      ],
    ];
    $data[$base_table]['webform_submission_notes_edit'] = [
      'title' => $this
        ->t('Edit notes'),
      'help' => $this
        ->t('In-line text area to edit webform submission notes.'),
      'field' => [
        'id' => 'webform_submission_notes_edit',
        'real field' => 'notes',
        'click sortable' => FALSE,
      ],
    ];
    $data[$base_table]['webform_category'] = [
      'title' => $this
        ->t('Webform category'),
      'help' => $this
        ->t('Webform category of webform submission.'),
      'filter' => [
        'id' => 'webform_views_webform_category',
        'real field' => $this->entityType
          ->getKey('bundle'),
      ],
    ];
    $data[$base_table]['webform_status'] = [
      'title' => $this
        ->t('Webform status'),
      'help' => $this
        ->t('Status of a webform to which submission is submitted to.'),
      'filter' => [
        'id' => 'webform_views_webform_status',
        'real field' => $this->entityType
          ->getKey('bundle'),
      ],
    ];

    // There is no general way to add a relationship to an entity where webform
    // submission has been submitted to, so we just cover the most common case
    // here - the case when the source is a node.
    if ($this->entityTypeManager
      ->hasDefinition('node')) {
      $node_definition = $this->entityTypeManager
        ->getDefinition('node');
      $data[$base_table]['entity_id'] += [
        'relationship' => [
          'base' => $node_definition
            ->getDataTable(),
          'base field' => $node_definition
            ->getKey('id'),
          'id' => 'standard',
          'label' => $this
            ->t('Submitted to: Content'),
          'title' => $this
            ->t('Submitted to: Content'),
          'extra' => [
            [
              'left_field' => 'entity_type',
              'value' => 'node',
            ],
          ],
        ],
      ];
    }

    // Add relationship from user to webform submissions he has submitted.
    $user_definition = $this->entityTypeManager
      ->hasDefinition('user') ? $this->entityTypeManager
      ->getDefinition('user') : FALSE;
    if ($user_definition && $user_definition
      ->getDataTable()) {
      $data[$user_definition
        ->getDataTable()]['webform_submission'] = [
        'title' => $this
          ->t('Webform submission'),
        'help' => $this
          ->t('Webform submission(-s) the user has submitted.'),
        'relationship' => [
          'relationship field' => $user_definition
            ->getKey('id'),
          'base' => $base_table,
          'base field' => 'uid',
          'id' => 'standard',
          'label' => $this
            ->t('Webform submission'),
        ],
      ];
    }
    foreach ($this->webformStorage
      ->loadMultiple() as $webform) {
      foreach ($webform
        ->getElementsInitializedAndFlattened() as $element) {
        $data = array_replace_recursive($data, $this
          ->getWebformElementViewsData($element, $webform));
      }
    }
    return $data;
  }

  /**
   * Collect webform element views data.
   *
   * @param array $element
   *   Element whose views data is to be collected
   * @param \Drupal\webform\WebformInterface $webform
   *   Webform where $element belongs to
   *
   * @return array
   *   Views data that corresponds to the provided $element
   */
  protected function getWebformElementViewsData($element, WebformInterface $webform) {
    $data = [];
    $element_plugin = $this->webformElementManager
      ->getElementInstance($element);
    if (isset($element_plugin
      ->getPluginDefinition()['webform_views_handler'])) {
      $views_handler_class = $element_plugin
        ->getPluginDefinition()['webform_views_handler'];
      $this->moduleHandler
        ->alter('webform_views_element_views_handler', $views_handler_class, $element, $webform);
      if (is_subclass_of($views_handler_class, ContainerInjectionInterface::class)) {
        $views_handler = $views_handler_class::create(\Drupal::getContainer());
      }
      else {
        $views_handler = new $views_handler_class();
      }
      $data = $views_handler
        ->getViewsData($element, $webform);
    }
    return $data;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityViewsData::$deprecatedProperties protected property
EntityViewsData::$entityFieldManager protected property The entity field manager.
EntityViewsData::$entityType protected property Entity type for this views data handler instance.
EntityViewsData::$entityTypeManager protected property The entity type manager.
EntityViewsData::$fieldStorageDefinitions protected property The field storage definitions for all base fields of the entity type.
EntityViewsData::$moduleHandler protected property The module handler.
EntityViewsData::$storage protected property The storage used for this entity type.
EntityViewsData::$translationManager protected property The translation manager.
EntityViewsData::addEntityLinks protected function Sets the entity links in case corresponding link templates exist.
EntityViewsData::getFieldStorageDefinitions protected function Gets the field storage definitions.
EntityViewsData::getViewsTableForEntityType public function Gets the table of an entity type to be used as base table in views. Overrides EntityViewsDataInterface::getViewsTableForEntityType
EntityViewsData::mapFieldDefinition protected function Puts the views data for a single field onto the views data.
EntityViewsData::mapSingleFieldViewsData protected function Provides the views data for a given data type and schema field.
EntityViewsData::processViewsDataForEntityReference protected function Processes the views data for an entity reference field.
EntityViewsData::processViewsDataForLanguage protected function Processes the views data for a language field.
EntityViewsData::processViewsDataForTextLong protected function Processes the views data for a text field with formatting.
EntityViewsData::processViewsDataForUuid protected function Processes the views data for a UUID field.
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.
WebformSubmissionViewsData::$webformElementManager protected property
WebformSubmissionViewsData::$webformStorage protected property
WebformSubmissionViewsData::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityViewsData::createInstance
WebformSubmissionViewsData::getViewsData public function Returns views data for the entity type. Overrides WebformSubmissionViewsData::getViewsData
WebformSubmissionViewsData::getWebformElementViewsData protected function Collect webform element views data.
WebformSubmissionViewsData::__construct public function WebformSubmissionViewsData constructor. Overrides EntityViewsData::__construct