class D7Webform in Webform: Migrate 8

Same name and namespace in other branches

8.2 src/Plugin/migrate/source/d7/D7Webform.php \Drupal\webform_migrate\Plugin\migrate\source\d7\D7Webform

Drupal 7 webform source from database.

Plugin annotation


@MigrateSource(
  id = "d7_webform",
  core = {7},
  source_module = "webform",
  destination_module = "webform"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements RollbackAwareInterface, MigrateSourceInterface
    class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface, RequirementsInterface
    class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface, ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait, DependencyTrait
    class \Drupal\webform_migrate\Plugin\migrate\source\d7\D7Webform implements ImportAwareInterface, RollbackAwareInterface

Expanded class hierarchy of D7Webform

File

src/Plugin/migrate/source/d7/D7Webform.php, line 28

Namespace

Drupal\webform_migrate\Plugin\migrate\source\d7

View source

class D7Webform extends DrupalSqlBase implements ImportAwareInterface, RollbackAwareInterface {

  /**
   * {@inheritdoc}
   */
  public function query() {
    $query = $this
      ->select('webform', 'wf');
    $query
      ->innerJoin('node', 'n', 'wf.nid=n.nid');
    $query
      ->innerJoin('node_revision', 'nr', 'n.vid=nr.vid');
    $query
      ->fields('wf', [
      'nid',
      'confirmation',
      'confirmation_format',
      'redirect_url',
      'status',
      'block',
      'allow_draft',
      'auto_save',
      'submit_notice',
      'submit_text',
      'submit_limit',
      'submit_interval',
      'total_submit_limit',
      'total_submit_interval',
      'progressbar_bar',
      'progressbar_page_number',
      'progressbar_percent',
      'progressbar_pagebreak_labels',
      'progressbar_include_confirmation',
      'progressbar_label_first',
      'progressbar_label_confirmation',
      'preview',
      'preview_next_button_label',
      'preview_prev_button_label',
      'preview_title',
      'preview_message',
      'preview_message_format',
      'preview_excluded_components',
      'next_serial',
      'confidential',
    ])
      ->fields('nr', [
      'title',
    ]);
    $query
      ->addField('n', 'uid', 'node_uid');
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {
    $this->filterDefaultFormat = $this
      ->variableGet('filter_default_format', '1');
    return parent::initializeIterator();
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = [
      'nid' => $this
        ->t('Node ID'),
      'title' => $this
        ->t('Webform title'),
      'node_uid' => $this
        ->t('Webform author'),
      'confirmation' => $this
        ->t('Confirmation message'),
      'confirmation_type' => $this
        ->t('Confirmation type'),
      'status' => $this
        ->t('Status'),
      'submit_text' => $this
        ->t('Submission text'),
      'submit_limit' => $this
        ->t('Submission limit'),
      'submit_interval' => $this
        ->t('Submission interval'),
      'submit_notice' => $this
        ->t('Submission notice'),
      'allow_draft' => $this
        ->t('Draft submission allowed'),
      'redirect_url' => $this
        ->t('Redirect url'),
      'block' => $this
        ->t('Block'),
      'auto_save' => $this
        ->t('Automatic save'),
      'total_submit_limit' => $this
        ->t('Total submission limit'),
      'total_submit_interval' => $this
        ->t('Total submission interval'),
      'webform_id' => $this
        ->t('Id to be used for  Webform'),
      'elements' => $this
        ->t('Elements for the Webform'),
      'confirmation_format' => $this
        ->t('The filter_format.format of the confirmation message.'),
      'auto_save' => $this
        ->t('Boolean value for whether submissions to this form should be auto-saved between pages.'),
      'progressbar_bar' => $this
        ->t('Boolean value indicating if the bar should be shown as part of the progress bar.'),
      'progressbar_page_number' => $this
        ->t('Boolean value indicating if the page number should be shown as part of the progress bar.'),
      'progressbar_percent' => $this
        ->t('Boolean value indicating if the percentage complete should be shown as part of the progress bar.'),
      'progressbar_pagebreak_labels' => $this
        ->t('Boolean value indicating if the pagebreak labels should be included as part of the progress bar.'),
      'progressbar_include_confirmation' => $this
        ->t('Boolean value indicating if the confirmation page should count as a page in the progress bar.'),
      'progressbar_label_first' => $this
        ->t('Label for the first page of the progress bar.'),
      'progressbar_label_confirmation' => $this
        ->t('Label for the last page of the progress bar.'),
      'preview' => $this
        ->t('Boolean value indicating if this form includes a page for previewing the submission.'),
      'preview_next_button_label' => $this
        ->t('The text for the button that will proceed to the preview page.'),
      'preview_prev_button_label' => $this
        ->t('The text for the button to go backwards from the preview page.'),
      'preview_title' => $this
        ->t('The title of the preview page, as used by the progress bar.'),
      'preview_message' => $this
        ->t('Text shown on the preview page of the form.'),
      'preview_message_format' => $this
        ->t('The filter_format.format of the preview page message.'),
      'preview_excluded_components' => $this
        ->t('Comma-separated list of component IDs that should not be included in this form’s confirmation page.'),
      'next_serial' => $this
        ->t('The serial number to give to the next submission to this webform.'),
      'confidential' => $this
        ->t('Boolean value for whether to anonymize submissions.'),
    ];
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    $elements = '';
    $nid = $row
      ->getSourceProperty('nid');
    $webform = $this
      ->buildFormElements($nid);
    $elements .= $webform['elements'];
    $handlers = $this
      ->buildEmailHandlers($nid, $webform['xref']);
    $access = $this
      ->buildAccessTable($nid);
    $confirm = $row
      ->getSourceProperty('redirect_url');
    if ($confirm == '<confirmation>') {
      $confirm_type = 'page';
      $row
        ->setSourceProperty('redirect_url', '');
    }
    elseif ($confirm == '<none>') {
      $confirm_type = 'inline';
      $row
        ->setSourceProperty('redirect_url', '');
    }
    else {
      $confirm_type = 'url';
    }
    if ($row
      ->getSourceProperty('submit_limit') < 0) {
      $row
        ->setSourceProperty('submit_limit', '');
    }
    if ($row
      ->getSourceProperty('total_submit_limit') < 0) {
      $row
        ->setSourceProperty('total_submit_limit', '');
    }
    $row
      ->setSourceProperty('confirmation_type', $confirm_type);
    $row
      ->setSourceProperty('elements', $elements);
    $row
      ->setSourceProperty('handlers', $handlers);
    $row
      ->setSourceProperty('access', $access);
    $row
      ->setSourceProperty('webform_id', 'webform_' . $nid);
    $row
      ->setSourceProperty('status', $row
      ->getSourceProperty('status') ? 'open' : 'closed');
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['nid']['type'] = 'integer';
    $ids['nid']['alias'] = 'wf';
    return $ids;
  }

  /**
   * Build form elements from webform component table.
   */
  protected function buildFormElements($nid) {

    // TODO : Use yaml_emit http://php.net/manual/en/function.yaml-emit.php
    $output = '';
    $query = $this
      ->select('webform_component', 'wc');
    $query
      ->fields('wc', [
      'nid',
      'cid',
      'pid',
      'form_key',
      'name',
      'type',
      'value',
      'extra',
      'required',
      'weight',
    ]);
    $components = $query
      ->condition('nid', $nid)
      ->orderBy('pid')
      ->orderBy('weight')
      ->execute();
    $children = [];
    $parents = [];
    $elements = [];
    $xref = [];

    // Build an array of elements in the correct order for rendering based on
    // pid and weight and a cross reference array to match cid with form_key
    // used by email handler.
    $multiPage = FALSE;
    foreach ($components as $component) {
      $xref[$component['cid']] = $component['form_key'];
      if ($component['type'] == 'pagebreak') {

        // Pagebreak found so we have a multi-page form.
        $multiPage = TRUE;
      }
      $children[$component['pid']][] = $component['cid'];
      $parents[$component['cid']][] = $component['pid'];
      $elements[$component['cid']] = $component;
    }

    // Keeps track of the parents we have to process, the last entry is used
    // for the next processing step.
    $process_parents = [];
    $process_parents[] = 0;
    $elements_tree = [];

    // Loops over the parent components and adds its children to the tree array.
    // Uses a loop instead of a recursion, because it's more efficient.
    while (count($process_parents)) {
      $parent = array_pop($process_parents);

      // The number of parents determines the current depth.
      $depth = count($process_parents);
      if (!empty($children[$parent])) {
        $has_children = FALSE;
        $child = current($children[$parent]);
        do {
          if (empty($child)) {
            break;
          }
          $element =& $elements[$child];
          $element['depth'] = $depth;

          // We might get element with same form_key
          // d8 doesn't like that so rename it.
          if ($depth > 0) {
            $element['form_key'] = $element['form_key'] . '_' . $element['pid'];
          }
          unset($element['pid']);
          $elements_tree[] = $element;
          if (!empty($children[$element['cid']])) {
            $has_children = TRUE;

            // We have to continue with this parent later.
            $process_parents[] = $parent;

            // Use the current component as parent for the next iteration.
            $process_parents[] = $element['cid'];

            // Reset pointers for child lists because we step in there more often
            // with multi parents.
            reset($children[$element['cid']]);

            // Move pointer so that we get the correct term the next time.
            next($children[$parent]);
            break;
          }
        } while ($child = next($children[$parent]));
        if (!$has_children) {

          // We processed all components in this hierarchy-level.
          reset($children[$parent]);
        }
      }
    }

    // If form has multiple pages then start first page automatically.
    if ($multiPage) {
      $pageCnt = 1;
      $current_page = 'wizard_page_1';
      $output .= "first_page:\n  '#type': webform_wizard_page\n  '#title': {" . $current_page . "_title}\n";
      $current_page_title = 'Start';
    }
    foreach ($elements_tree as $element) {

      // Rename fieldsets to it's own unique key.
      if ($element['type'] == 'fieldset' && strpos($element['form_key'], 'fieldset') === FALSE) {
        $element['form_key'] = 'fieldset_' . $element['form_key'];
      }

      // If this is a multi-page form then indent all elements one level
      // to allow for page elements.
      if ($multiPage && $element['type'] != 'pagebreak') {
        $element['depth'] += 1;
      }
      $indent = str_repeat(' ', $element['depth'] * 2);
      $extra = unserialize($element['extra']);

      // The description key can be missing (since description is optional and
      // it isn't saved by Drupal 7 webform when it is left empty).
      $description = !empty($extra['description']) ? $this
        ->cleanString($extra['description']) : NULL;

      // Create an option list if there are items for this element.
      $options = '';
      $valid_options = [];
      if (!empty($extra['items'])) {
        $items = explode("\n", trim($extra['items']));
        $ingroup = '';
        foreach ($items as $item) {
          $item = trim($item);
          if (!empty($item)) {

            // Handle option groups.
            if (preg_match('/^<(.*)>$/', $item, $matches)) {
              if (empty(trim($matches[1]))) {
                $ingroup = '';
                continue;
              }
              $options .= "{$indent}    '" . $matches[1] . "':\n";
              $ingroup = str_repeat(' ', 2);
            }
            else {
              $option = explode('|', $item);
              $valid_options[] = $option[0];
              if (count($option) == 2) {
                $options .= "{$indent}{$ingroup}    " . $option[0] . ": '" . str_replace('\'', '"', $option[1]) . "'\n";
              }
              else {
                $options .= "{$indent}{$ingroup}    " . $option[0] . ": '" . str_replace('\'', '"', $option[0]) . "'\n";
              }
            }
          }
        }
      }

      // Replace any tokens in the value.
      if (!empty($element['value'])) {
        $element['value'] = $this
          ->replaceTokens($element['value']);
      }
      $markup = $indent . strtolower($element['form_key']) . ":\n";
      switch ($element['type']) {
        case 'fieldset':
          if ($multiPage && empty($current_page_title)) {
            $current_page_title = $element['name'];
          }
          $markup .= "{$indent}  '#type': fieldset\n{$indent}  '#open': true\n";
          break;
        case 'textfield':
          $markup .= "{$indent}  '#type': textfield\n";
          if (!empty($extra['width'])) {
            $markup .= "{$indent}  '#size': " . (int) $extra['width'] . "\n";
          }
          break;
        case 'textarea':
          $markup .= "{$indent}  '#type': textarea\n";
          break;
        case 'select':
          if (!empty($extra['aslist'])) {
            $select_type = 'select';
          }
          elseif (!empty($extra['multiple']) && count($valid_options) > 1) {
            $select_type = 'checkboxes';
          }
          elseif (!empty($extra['multiple']) && count($valid_options) == 1) {
            $select_type = 'checkbox';
            list($key, $desc) = explode('|', $extra['items']);
            $markup .= "{$indent}  '#description': \"" . $this
              ->cleanString($desc) . "\"\n";
          }
          else {
            $select_type = 'radios';
          }
          $markup .= "{$indent}  '#type': {$select_type}\n";
          $markup .= "{$indent}  '#options':\n" . $options;
          if (!empty($extra['multiple'])) {
            $markup .= "{$indent}  '#multiple': true\n";
          }
          break;
        case 'email':
          $markup .= "{$indent}  '#type': email\n{$indent}  '#size': 20\n";
          break;
        case 'number':
          if ($extra['type'] == 'textfield') {
            $markup .= "{$indent}  '#type': textfield\n{$indent}  '#size': 20\n";
          }
          elseif ($extra['type'] == 'select') {
            $markup .= "{$indent}  '#type': select\n";
            $markup .= "{$indent}  '#options':\n" . $options;
            $min = $extra['min'];
            $max = $extra['max'];
            $step = !empty($extra['step']) ? $extra['step'] : 1;
            for ($value = $min; $value <= $max; $value += $step) {
              $markup .= "{$indent}    " . $value . ": " . $value . "\n";
            }
          }
          if (!empty($extra['min'])) {
            $markup .= "{$indent}  '#min': " . $extra['min'] . "\n";
          }
          if (!empty($extra['max'])) {
            $markup .= "{$indent}  '#max': " . $extra['max'] . "\n";
          }
          if (!empty($extra['step'])) {
            $markup .= "{$indent}  '#step': " . $extra['step'] . "\n";
          }
          if (isset($extra['unique'])) {
            $unique = $extra['unique'] ? 'true' : 'false';
            $markup .= "{$indent}  '#unique': " . $unique . "\n";
          }
          break;
        case 'markup':
          $markup .= "{$indent}  '#type': processed_text\n{$indent}  '#format': full_html\n{$indent}  '#text': \"" . $this
            ->cleanString($element['value']) . "\"\n";
          $element['value'] = '';
          break;
        case 'file':
        case 'multiple_file':
          $exts = '';
          if (!empty($extra['filtering']['types'])) {
            $types = $extra['filtering']['types'];
            if (!empty($extra['filtering']['addextensions'])) {
              $add_types = explode(',', $extra['filtering']['addextensions']);
              $types = array_unique(array_merge($types, array_map('trim', $add_types)));
            }
            $exts = implode(' ', $types);
          }
          $file_size = '';
          if (!empty($extra['filtering']['size'])) {

            // Get the string for the size. Will be something like "2 MB".
            $size = $extra['filtering']['size'];

            // Convert the string into an integer in bytes.
            $file_size_bytes = Bytes::toInt($size);

            // Convert that to MB.
            $file_size = floor($file_size_bytes / 1024 / 1024);

            // Failsafe as Webform doesn't let you go less than 1MB.
            $file_size = $file_size < 1 ? 1 : $file_size;
          }
          $markup .= "{$indent}  '#type': managed_file\n";
          $markup .= "{$indent}  '#max_filesize': '{$file_size}'\n";
          $markup .= "{$indent}  '#file_extensions': '{$exts}'\n";
          if (!empty($extra['width'])) {
            $markup .= "{$indent}  '#size': " . $extra['width'] . "\n";
          }
          if ($element['type'] == 'multiple_file') {
            $markup .= "{$indent}  '#multiple': true\n";
          }
          break;
        case 'date':
          $markup .= "{$indent}  '#type': date\n";

          /*if (!empty($element['value'])) {
            $element['value'] = date('Y-m-d', strtotime($element['value']));
            }*/
          break;
        case 'time':
          $markup .= "{$indent}  '#type': webform_time\n";
          if (!empty($extra['hourformat'])) {
            if ($extra['hourformat'] == '12-hour') {
              $markup .= "{$indent}  '#time_format': 'g:i A'\n";
            }
            elseif ($extra['hourformat'] == '24-hour') {
              $markup .= "{$indent}  '#time_format': 'H:i'\n";
            }
          }
          if (!empty($extra['minuteincrements'])) {

            // Setting expects seconds not minutes.
            $step = (int) $extra['minuteincrements'] * 60;
            $markup .= "{$indent}  '#step': {$step}\n";
          }

          /*if (!empty($element['value'])) {
            $element['value'] = date('c', strtotime($element['value']));
            }*/
          break;
        case 'hidden':
          $markup .= "{$indent}  '#type': hidden\n";
          break;
        case 'pagebreak':
          $output = str_replace('{' . $current_page . '_title}', $current_page_title, $output);
          $current_page = $element['form_key'];
          $markup .= "{$indent}  '#type': webform_wizard_page\n  '#title': {" . $current_page . "_title}\n";
          $current_page_title = $element['name'];
          $pageCnt++;
          break;
        case 'addressfield':
          $markup .= "{$indent}  '#type': webform_address\n";
          $markup .= "{$indent}  '#state_province__type': textfield\n";
          break;
        case 'grid':
          $questionsArray = $this
            ->getItemsArray($extra['questions']);
          $questions = $this
            ->buildItemsString($questionsArray, $indent . '  ');
          $answersArray = $this
            ->getItemsArray($extra['options']);
          $answers = $this
            ->buildItemsString($answersArray, $indent . '  ');
          $markup .= "{$indent}  '#type': webform_likert\n";
          $markup .= "{$indent}  '#questions':\n" . $questions . "\n";
          $markup .= "{$indent}  '#answers':\n" . $answers . "\n";
          break;
        default:
          echo '';
      }
      if (!empty($element['type']) && is_string($element['type'])) {
        $this
          ->getModuleHandler()
          ->alter('webform_migrate_d7_webform_element_' . $element['type'], $markup, $indent, $element);
      }

      // Add common fields.
      if (!empty(trim($element['value'])) && (empty($valid_options) || in_array($element['value'], $valid_options))) {
        $markup .= "{$indent}  '#default_value': '" . str_replace(array(
          '\'',
          "\n",
          "\r",
        ), array(
          '"',
          '\\n',
          '',
        ), trim($element['value'])) . "'\n";
      }
      if (!empty($extra['field_prefix'])) {
        $markup .= "{$indent}  '#field_prefix': " . $extra['field_prefix'] . "\n";
      }
      if (!empty($extra['field_suffix'])) {
        $markup .= "{$indent}  '#field_suffix': " . $extra['field_suffix'] . "\n";
      }
      if (!empty($extra['title_display']) && $extra['title_display'] != 'before') {
        $title_display = $extra['title_display'];
        if ($title_display == 'none') {
          $title_display = 'invisible';
        }
        $markup .= "{$indent}  '#title_display': " . $title_display . "\n";
      }
      if ($element['type'] != 'pagebreak') {
        $markup .= "{$indent}  '#title': '" . str_replace('\'', '"', $element['name']) . "'\n";
        $markup .= "{$indent}  '#description': \"" . $description . "\"\n";
      }
      if (!empty($element['required'])) {
        $markup .= "{$indent}  '#required': true\n";
      }

      // Build contionals.
      if ($states = $this
        ->buildConditionals($element, $elements)) {
        $markup .= "{$indent}  '#states':\n";
        foreach ($states as $key => $values) {
          $markup .= "{$indent}    {$key}:\n";
          foreach ($values as $value) {
            foreach ($value as $name => $item) {
              $markup .= "{$indent}      " . Yaml::dump($name, 2, 2) . ":\n";
              foreach (explode("\n", Yaml::dump($item, 2, 2)) as $line) {
                if (!empty($line)) {
                  $markup .= "{$indent}        " . $line . "\n";
                }
              }
            }
          }
        }
      }
      $output .= $markup;
    }
    if ($multiPage) {

      // Replace the final page title.
      $output = str_replace('{' . $current_page . '_title}', $current_page_title, $output);
    }
    return [
      'elements' => $output,
      'xref' => $xref,
    ];
  }

  /**
   * Build conditionals and translate them to states api in D8.
   */
  protected function buildConditionals($element, $elements) {
    $nid = $element['nid'];
    $cid = $element['cid'];
    $extra = unserialize($element['extra']);

    // Checkboxes : ':input[name="add_more_locations_24[yes]"]':
    $query = $this
      ->select('webform_conditional', 'wc');
    $query
      ->innerJoin('webform_conditional_actions', 'wca', 'wca.nid=wc.nid AND wca.rgid=wc.rgid');
    $query
      ->innerJoin('webform_conditional_rules', 'wcr', 'wcr.nid=wca.nid AND wcr.rgid=wca.rgid');
    $query
      ->fields('wc', [
      'nid',
      'rgid',
      'andor',
      'weight',
    ])
      ->fields('wca', [
      'aid',
      'target_type',
      'target',
      'invert',
      'action',
      'argument',
    ])
      ->fields('wcr', [
      'rid',
      'source_type',
      'source',
      'operator',
      'value',
    ]);
    $conditions = $query
      ->condition('wc.nid', $nid)
      ->condition('wca.target', $cid)
      ->execute();
    $states = [];
    if (!empty($conditions)) {
      foreach ($conditions as $condition) {
        $unsupported_condition = FALSE;

        // Element states.
        switch ($condition['action']) {
          case 'show':
            $element_state = $condition['invert'] ? 'invisible' : 'visible';
            break;
          case 'require':
            $element_state = $condition['invert'] ? 'optional' : 'required';
            break;
          case 'set':

            // Nothing found in D8 :(.
            $unsupported_condition = TRUE;
            break;
        }

        // Condition states.
        $operator_value = $condition['value'];
        $depedent = $elements[$condition['source']];
        $depedent_extra = unserialize($depedent['extra']);
        $depedent_extra['items'] = !empty($depedent_extra['items']) ? explode("\n", $depedent_extra['items']) : [];
        $depedent_extra += [
          'aslist' => NULL,
          'multiple' => NULL,
        ];

        // Element condition must be an array in Drupal 8|9 Webform.
        $element_condition = [];
        switch ($condition['operator']) {
          case 'contains':
            $element_trigger = $condition['invert'] ? '!pattern' : 'pattern';
            $element_condition = [
              'value' => [
                $element_trigger => $operator_value,
              ],
            ];

            // Specially handle the checkboxes.
            if ($depedent['type'] == 'select' && !$depedent_extra['aslist'] && $depedent_extra['multiple']) {
              $element_condition = [
                'checked' => !empty($condition['invert']),
              ];
            }
            break;
          case 'equal':
            $element_condition = [
              'value' => $operator_value,
            ];
            if ($depedent['type'] == 'select' && !$depedent_extra['aslist'] && $depedent_extra['multiple']) {
              $element_condition = [
                'checked' => TRUE,
              ];
            }
            break;
          case 'not_equal':

            // There is no handler for this in D8 so we do the reverse.
            $element_state = $condition['invert'] ? 'visible' : 'invisible';
            $element_condition = [
              'value' => $operator_value,
            ];

            // Specially handle the checkboxes.
            if ($depedent['type'] == 'select' && !$depedent_extra['aslist'] && $depedent_extra['multiple']) {
              $element_condition = [
                'checked' => TRUE,
              ];
            }
            break;
          case 'less_than':
            $element_condition = [
              'value' => [
                'less' => $operator_value,
              ],
            ];
            break;
          case 'less_than_equal':
            $element_condition = [
              'value' => [
                'less_equal' => $operator_value,
              ],
            ];
            break;
          case 'greater_than':
            $element_condition = [
              'value' => [
                'greater' => $operator_value,
              ],
            ];
            break;
          case 'greater_than_equal':
            $element_condition = [
              'value' => [
                'greater_equal' => $operator_value,
              ],
            ];
            break;
          case 'empty':
            if ($operator_value == 'checked') {
              $element_condition = [
                'unchecked' => TRUE,
              ];
            }
            else {
              $element_condition = [
                'empty' => TRUE,
              ];
            }
            break;
          case 'not_empty':
            if ($operator_value == 'checked') {
              $element_condition = [
                'checked' => TRUE,
              ];
            }
            else {
              $element_condition = [
                'filled' => FALSE,
              ];
            }
            break;
        }
        if (!$depedent_extra['aslist'] && $depedent_extra['multiple'] && is_array($depedent_extra['items']) && count($depedent_extra['items']) > 1) {
          $depedent['form_key'] = $depedent['form_key'] . "[{$operator_value}]";
        }
        elseif (!$depedent_extra['aslist'] && !$depedent_extra['multiple'] && is_array($depedent_extra['items']) && count($depedent_extra['items']) == 1) {
          $depedent['form_key'] = $depedent['form_key'] . "[{$operator_value}]";
        }
        if (!$unsupported_condition) {
          $states[$element_state][] = [
            ':input[name="' . strtolower($depedent['form_key']) . '"]' => $element_condition,
          ];
        }
      }
      if (empty($states)) {
        return FALSE;
      }
      return $states;
    }
    else {
      return FALSE;
    }
  }

  /**
   * Build email handlers from webform emails table.
   */
  protected function buildEmailHandlers($nid, $xref) {
    $query = $this
      ->select('webform_emails', 'we');
    $query
      ->fields('we', [
      'nid',
      'eid',
      'email',
      'subject',
      'from_name',
      'from_address',
      'template',
      'excluded_components',
      'html',
      'attachments',
    ]);
    $emails = $query
      ->condition('nid', $nid)
      ->execute();
    $handlers = [];
    foreach ($emails as $email) {
      $id = 'email_' . $email['eid'];
      foreach ([
        'email',
        'subject',
        'from_name',
        'from_address',
      ] as $field) {
        if (!empty($email[$field]) && is_numeric($email[$field]) && !empty($xref[$email[$field]])) {
          $email[$field] = "[webform_submission:values:{$xref[$email[$field]]}:raw]";
        }
      }
      $excluded = [];
      if (!empty($email['excluded_components'])) {
        $excludes = explode(',', $email['excluded_components']);
        foreach ($excludes as $exclude) {
          if (!empty($xref[$exclude])) {
            $excluded[$xref[$exclude]] = $xref[$exclude];
          }
        }
      }
      $handlers[$id] = [
        'id' => 'email',
        'label' => 'Email ' . $email['eid'],
        'handler_id' => $id,
        'status' => 1,
        'weight' => $email['eid'],
        'settings' => [
          'to_mail' => $email['email'],
          'from_mail' => $email['from_address'],
          'from_name' => $email['from_name'],
          'subject' => $email['subject'],
          'body' => str_replace('[submission:', '[webform_submission:', $email['template']),
          'html' => $email['html'],
          'attachments' => $email['attachments'],
          'excluded_elements' => $excluded,
        ],
      ];
    }
    return $handlers;
  }

  /**
   * Build access table from webform roles table.
   */
  protected function buildAccessTable($nid) {
    $query = $this
      ->select('webform_roles', 'wr');
    $query
      ->innerJoin('role', 'r', 'wr.rid=r.rid');
    $query
      ->fields('wr', [
      'nid',
      'rid',
    ])
      ->fields('r', [
      'name',
    ]);
    $wf_roles = $query
      ->condition('nid', $nid)
      ->execute();
    $roles = [];

    // Handle rids 1 and 2 as per user_update_8002.
    $map = [
      1 => 'anonymous',
      2 => 'authenticated',
    ];
    foreach ($wf_roles as $role) {
      if (isset($map[$role['rid']])) {
        $roles[] = $map[$role['rid']];
      }
      else {
        $roles[] = str_replace(' ', '_', strtolower($role['name']));
      }
    }
    $access = [
      'create' => [
        'roles' => $roles,
        'users' => [],
      ],
    ];
    return $access;
  }

  /**
   * Translate webform tokens into regular tokens.
   *
   * %uid - The user id (unsafe)
   * %username - The name of the user if logged in.
   *                       Blank for anonymous users. (unsafe)
   * %useremail - The e-mail address of the user if logged in.
   *                       Blank for anonymous users. (unsafe)
   * %ip_address - The IP address of the user. (unsafe)
   * %site - The name of the site
   *             (i.e. Northland Pioneer College, Arizona) (safe)
   * %date - The current date, formatted according
   *              to the site settings.(safe)
   * %nid - The node ID. (safe)
   * %title - The node title. (safe)
   * %sid - The Submission id (unsafe)
   * %submission_url - The Submission url (unsafe)
   * %profile[key] - Any user profile field or value, such as %profile[name]
   *                         or %profile[profile_first_name] (unsafe)
   * %get[key] - Tokens may be populated from the URL by creating URLs of
   *                    the form http://example.com/my-form?foo=bar.
   *                    Using the token %get[foo] would print "bar". (safe)
   * %post[key] - Tokens may also be populated from POST values
   *                      that are submitted by forms. (safe)
   * %email[key] (unsafe)
   * %value[key] (unsafe)
   * %email_values (unsafe)
   * %cookie[key] (unsafe)
   * %session[key] (unsafe)
   * %request[key] (unsafe)
   * %server[key] (unsafe)
   *
   * Safe values are available to all users and unsafe values
   * should only be shown to authenticated users.
   */
  protected function replaceTokens($str) {
    return $str;
  }

  /**
   * {@inheritdoc}
   */
  protected function cleanString($str) {
    return str_replace([
      '"',
      "\n",
      "\r",
    ], [
      "'",
      '\\n',
      '',
    ], $str);
  }

  /**
   * {@inheritdoc}
   */
  public function preImport(MigrateImportEvent $event) {
  }

  /**
   * {@inheritdoc}
   */
  public function postImport(MigrateImportEvent $event) {

    // Add the Webform field to the webform content type
    // if it doesn't already exist.
    $field_storage = FieldStorageConfig::loadByName('node', 'webform');
    $field = FieldConfig::loadByName('node', 'webform', 'webform');
    if (empty($field)) {
      $field = \Drupal::service('entity_type.manager')
        ->getStorage('field_config')
        ->create([
        'field_storage' => $field_storage,
        'bundle' => 'webform',
        'label' => 'Webform',
        'settings' => [],
      ]);
      $field
        ->save();

      // Assign widget settings for the 'default' form mode.
      $display = \Drupal::service('entity_display.repository')
        ->getFormDisplay('node', 'webform', 'default')
        ->getComponent('webform');
      \Drupal::service('entity_display.repository')
        ->getFormDisplay('node', 'webform', 'default')
        ->setComponent('webform', [
        'type' => $display['type'],
      ])
        ->save();

      // Assign display settings for the 'default' and 'teaser' view modes.
      $display = \Drupal::service('entity_display.repository')
        ->getViewDisplay('node', 'webform', 'default')
        ->getComponent('webform');
      \Drupal::service('entity_display.repository')
        ->getViewDisplay('node', 'webform', 'default')
        ->setComponent('webform', [
        'label' => $display['label'],
        'type' => $display['type'],
      ])
        ->save();

      // The teaser view mode is created by the Standard profile and therefore
      // might not exist.
      $view_modes = \Drupal::service('entity_display.repository')
        ->getViewModes('node');
      if (isset($view_modes['teaser'])) {
        $display = \Drupal::service('entity_display.repository')
          ->getViewDisplay('node', 'webform', 'teaser')
          ->getComponent('webform');
        \Drupal::service('entity_display.repository')
          ->getViewDisplay('node', 'webform', 'teaser')
          ->setComponent('webform', [
          'label' => $display['label'],
          'type' => $display['type'],
        ])
          ->save();
      }
    }

    // Attach any Webform created to the relevant webforms if
    // Webform exists and Webform exists and Webform field is empty.
    $webforms = $this
      ->query()
      ->execute();
    foreach ($webforms as $webformInfo) {
      $webform_nid = $webformInfo['nid'];
      $webform_id = 'webform_' . $webform_nid;
      $webform = Webform::load($webform_id);
      if (!empty($webform)) {

        /** @var \Drupal\node\NodeInterface $node */
        $node = Node::load($webform_nid);
        if (!empty($node) && $node
          ->getType() == 'webform') {
          if (empty($node->webform->target_id)) {
            $node->webform->target_id = $webform_id;
            $node->webform->status = $webformInfo['status'] ? 'open' : 'closed';
            $node
              ->save();
          }
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function preRollback(MigrateRollbackEvent $event) {
  }

  /**
   * {@inheritdoc}
   */
  public function postRollback(MigrateRollbackEvent $event) {

    // Remove any Webform from webform if webform no longer exists.
    $webforms = $this
      ->query()
      ->execute();
    foreach ($webforms as $webform) {
      $webform_nid = $webform['nid'];
      $webform_id = 'webform_' . $webform_nid;
      $webform = Webform::load($webform_id);
      if (empty($webform)) {

        /** @var \Drupal\node\NodeInterface $node */
        $node = Node::load($webform_nid);
        if (!empty($node) && $node
          ->getType() == 'webform') {
          if (!empty($node->webform->target_id) && $node->webform->target_id == $webform_id) {
            $node->webform->target_id = NULL;
            $node
              ->save();
          }
        }
      }
    }
  }
  protected function getItemsArray($rawString) {
    $items = explode("\n", $rawString);
    $items = array_map('trim', $items);
    return array_map(function ($item) {
      return explode('|', $item);
    }, $items);
  }
  protected function buildItemsString($itemsArray, $baseIndent = '') {
    $preparedItems = array_map(function ($item) use ($baseIndent) {
      return $baseIndent . '  ' . $this
        ->encapsulateString($item[0]) . ': ' . $this
        ->encapsulateString($item[1]);
    }, $itemsArray);
    return implode("\n", $preparedItems);
  }
  protected function encapsulateString($string) {
    return sprintf("'%s'", addslashes($string));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
D7Webform::buildAccessTable	protected	function	Build access table from webform roles table.
D7Webform::buildConditionals	protected	function	Build conditionals and translate them to states api in D8.
D7Webform::buildEmailHandlers	protected	function	Build email handlers from webform emails table.
D7Webform::buildFormElements	protected	function	Build form elements from webform component table.
D7Webform::buildItemsString	protected	function
D7Webform::cleanString	protected	function
D7Webform::encapsulateString	protected	function
D7Webform::fields	public	function	Returns available fields on the source. Overrides MigrateSourceInterface::fields
D7Webform::getIds	public	function	Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
D7Webform::getItemsArray	protected	function
D7Webform::initializeIterator	protected	function	Initializes the iterator with the source data. Overrides SqlBase::initializeIterator
D7Webform::postImport	public	function	Performs post-import tasks. Overrides ImportAwareInterface::postImport
D7Webform::postRollback	public	function	Performs post-rollback tasks. Overrides SourcePluginBase::postRollback
D7Webform::preImport	public	function	Performs pre-import tasks. Overrides ImportAwareInterface::preImport
D7Webform::prepareRow	public	function	Adds additional data to the row. Overrides SourcePluginBase::prepareRow
D7Webform::preRollback	public	function	Performs pre-rollback tasks. Overrides SourcePluginBase::preRollback
D7Webform::query	public	function	Overrides SqlBase::query
D7Webform::replaceTokens	protected	function	Translate webform tokens into regular tokens.
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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
DrupalSqlBase::$deprecatedProperties	protected	property		1
DrupalSqlBase::$entityTypeManager	protected	property	The entity type manager.
DrupalSqlBase::$requirements	protected	property	If the source provider is missing.
DrupalSqlBase::$systemData	protected	property	The contents of the system table.
DrupalSqlBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
DrupalSqlBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements	2
DrupalSqlBase::create	public static	function	Creates an instance of the plugin. Overrides SqlBase::create	3
DrupalSqlBase::getModuleSchemaVersion	protected	function	Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::getSystemData	public	function	Retrieves all system data information from the source Drupal database.
DrupalSqlBase::moduleExists	protected	function	Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::variableGet	protected	function	Reads a variable from a source Drupal database.
DrupalSqlBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct	6
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.
SourcePluginBase::$cache	protected	property	The backend cache.
SourcePluginBase::$cacheCounts	protected	property	Whether this instance should cache the source count.	1
SourcePluginBase::$cacheKey	protected	property	Key to use for caching counts.
SourcePluginBase::$currentRow	protected	property	The current row from the query.
SourcePluginBase::$currentSourceIds	protected	property	The primary key of the current row.
SourcePluginBase::$highWaterProperty	protected	property	Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage	protected	property	The key-value storage for the high-water value.
SourcePluginBase::$idMap	protected	property	The migration ID map.
SourcePluginBase::$iterator	protected	property	The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded	protected	property	Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration	protected	property	The entity migration object.
SourcePluginBase::$moduleHandler	protected	property	The module handler service.	2
SourcePluginBase::$originalHighWater	protected	property	The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount	protected	property	Whether this instance should not attempt to count the source.	1
SourcePluginBase::$trackChanges	protected	property	Flags whether to track changes to incoming data.	1
SourcePluginBase::aboveHighwater	protected	function	Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::current	public	function
SourcePluginBase::doCount	protected	function	Gets the source count checking if the source is countable or using the iterator_count function.	1
SourcePluginBase::getCache	protected	function	Gets the cache object.
SourcePluginBase::getCurrentIds	public	function	Gets the currentSourceIds data member.
SourcePluginBase::getHighWater	protected	function	The current value of the high water mark.
SourcePluginBase::getHighWaterField	protected	function	Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty	protected	function	Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage	protected	function	Get the high water storage object.	1
SourcePluginBase::getIterator	protected	function	Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler	protected	function	Gets the module handler.
SourcePluginBase::getSourceModule	public	function	Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key	public	function	Gets the iterator key.
SourcePluginBase::next	public	function	The migration iterates over rows returned by the source plugin. This method determines the next row which will be processed and imported into the system.
SourcePluginBase::rewind	public	function	Rewinds the iterator.
SourcePluginBase::rowChanged	protected	function	Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater	protected	function	Save the new high water mark.
SourcePluginBase::valid	public	function	Checks whether the iterator is currently valid.
SqlBase::$batch	protected	property	The count of the number of batches run.
SqlBase::$batchSize	protected	property	Number of records to fetch from the database during each batch.
SqlBase::$database	protected	property	The database object.	1
SqlBase::$query	protected	property	The query string.
SqlBase::$state	protected	property	State service for retrieving database info.
SqlBase::count	public	function	Gets the source count. Overrides SourcePluginBase::count	6
SqlBase::fetchNextBatch	protected	function	Prepares query for the next set of data from the source database.
SqlBase::fetchNextRow	protected	function	Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::getDatabase	public	function	Gets the database connection object.	2
SqlBase::mapJoinable	protected	function	Checks if we can join against the map table.	1
SqlBase::prepareQuery	protected	function	Adds tags and metadata to the query.
SqlBase::select	protected	function	Wrapper for database select.
SqlBase::setUpDatabase	protected	function	Gets a connection to the referenced database.
SqlBase::__toString	public	function	Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
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.

You are here

class D7Webform in Webform: Migrate 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation