public function WebformEntityTest::testWebformMethods in Webform 6.x

Same name and namespace in other branches

1. 8.5 tests/src/Kernel/Entity/WebformEntityTest.php \Drupal\Tests\webform\Kernel\Entity\WebformEntityTest::testWebformMethods()

Tests some of the methods.

File

tests/src/Kernel/Entity/WebformEntityTest.php, line 29

Class

WebformEntityTest

Tests the webform entity class.

Namespace

Drupal\Tests\webform\Kernel\Entity

Code

public function testWebformMethods() {
  $this
    ->installEntitySchema('path_alias');
  $this
    ->installSchema('webform', [
    'webform',
  ]);
  $this
    ->installConfig('webform');

  /**************************************************************************/

  // Create.

  /**************************************************************************/

  // Create webform.

  /** @var \Drupal\webform\WebformInterface $webform */
  $webform = Webform::create([
    'id' => 'webform_test',
  ]);
  $webform
    ->save();
  $this
    ->assertEquals('webform_test', $webform
    ->id());
  $this
    ->assertFalse($webform
    ->isTemplate());
  $this
    ->assertTrue($webform
    ->isOpen());

  /**************************************************************************/

  // Override.

  /**************************************************************************/
  try {
    $webform
      ->setOverride(TRUE);
    $webform
      ->save();
    $this
      ->fail('Not possible to save webform with override = TRUE.');
  } catch (WebformException $e) {
    $this
      ->pass('Not possible to save webform with override = TRUE.');
  }
  try {
    $webform
      ->setOverride(FALSE);
    $webform
      ->save();
    $this
      ->pass('Possible to save webform with override = FALSE.');
  } catch (WebformException $e) {
    $this
      ->fail('Possible to save webform with override = FALSE.');
  }

  /**************************************************************************/

  // Status.

  /**************************************************************************/

  // Check set status to FALSE.
  $webform
    ->setStatus(FALSE);
  $this
    ->assertFalse($webform
    ->isOpen());
  $this
    ->assertEquals($webform
    ->get('status'), WebformInterface::STATUS_CLOSED);
  $this
    ->assertFalse($webform
    ->isScheduled());

  // Check set status to TRUE.
  $webform
    ->setStatus(TRUE);
  $this
    ->assertTrue($webform
    ->isOpen());
  $this
    ->assertEquals($webform
    ->get('status'), WebformInterface::STATUS_OPEN);

  // Check set status to NULL.
  $webform
    ->setStatus(NULL);
  $this
    ->assertTrue($webform
    ->isOpen());
  $this
    ->assertEquals($webform
    ->get('status'), WebformInterface::STATUS_SCHEDULED);

  // Check set status to WebformInterface::STATUS_CLOSED.
  $webform
    ->setStatus(WebformInterface::STATUS_CLOSED);
  $this
    ->assertFalse($webform
    ->isOpen());

  // Check set status to WebformInterface::STATUS_OPEN.
  $webform
    ->setStatus(WebformInterface::STATUS_OPEN);
  $this
    ->assertTrue($webform
    ->isOpen());

  // Check set status to WebformInterface::STATUS_SCHEDULED.
  $webform
    ->setStatus(WebformInterface::STATUS_SCHEDULED);
  $this
    ->assertTrue($webform
    ->isOpen());
  $this
    ->assertTrue($webform
    ->isScheduled());

  /**************************************************************************/

  // Scheduled.

  /**************************************************************************/
  $webform
    ->setStatus(WebformInterface::STATUS_SCHEDULED);

  // Check set open date to yesterday.
  $webform
    ->set('open', date('Y-m-d\\TH:i:s', strtotime('today -1 days')));
  $webform
    ->set('close', NULL);
  $this
    ->assertTrue($webform
    ->isOpen());

  // Check set open date to tomorrow.
  $webform
    ->set('open', date('Y-m-d\\TH:i:s', strtotime('today +1 day')));
  $webform
    ->set('close', NULL);
  $this
    ->assertFalse($webform
    ->isOpen());

  // Check set close date to yesterday.
  $webform
    ->set('open', NULL);
  $webform
    ->set('close', date('Y-m-d\\TH:i:s', strtotime('today -1 day')));
  $this
    ->assertFalse($webform
    ->isOpen());

  // Check set close date to tomorrow.
  $webform
    ->set('open', NULL);
  $webform
    ->set('close', date('Y-m-d\\TH:i:s', strtotime('today +1 day')));
  $this
    ->assertTrue($webform
    ->isOpen());

  // Check set open date to tomorrow with close date in 10 days.
  $webform
    ->set('open', date('Y-m-d\\TH:i:s', strtotime('today +1 day')));
  $webform
    ->set('close', date('Y-m-d\\TH:i:s', strtotime('today +10 days')));
  $this
    ->assertFalse($webform
    ->isOpen());
  $this
    ->assertTrue($webform
    ->isOpening());

  // Check set open date to yesterday with close date in +10 days.
  $webform
    ->set('open', date('Y-m-d\\TH:i:s', strtotime('today -1 day')));
  $webform
    ->set('close', date('Y-m-d\\TH:i:s', strtotime('today +10 days')));
  $this
    ->assertTrue($webform
    ->isOpen());

  // Check set open date to yesterday with close date -10 days.
  $webform
    ->set('open', date('Y-m-d\\TH:i:s', strtotime('today -1 day')));
  $webform
    ->set('close', date('Y-m-d\\TH:i:s', strtotime('today -10 days')));
  $this
    ->assertFalse($webform
    ->isOpen());
  $this
    ->assertFalse($webform
    ->isOpening());

  // Check that open overrides scheduled.
  $webform
    ->setStatus(TRUE);
  $webform
    ->set('open', date('Y-m-d\\TH:i:s', strtotime('today -1 day')));
  $webform
    ->set('close', date('Y-m-d\\TH:i:s', strtotime('today -10 days')));
  $this
    ->assertTrue($webform
    ->isOpen());

  // Check that closed overrides scheduled.
  $webform
    ->setStatus(FALSE);
  $webform
    ->set('open', date('Y-m-d\\TH:i:s', strtotime('today +1 day')));
  $webform
    ->set('close', date('Y-m-d\\TH:i:s', strtotime('today -10 days')));
  $this
    ->assertFalse($webform
    ->isOpen());

  // Check that open and close date is set to NULL when status is set to open
  // or closed.
  $webform
    ->set('open', date('Y-m-d\\TH:i:s', strtotime('today +1 day')));
  $webform
    ->set('close', date('Y-m-d\\TH:i:s', strtotime('today -10 days')));
  $this
    ->assertNotNull($webform
    ->get('open'));
  $this
    ->assertNotNull($webform
    ->get('close'));
  $webform
    ->setStatus(TRUE);
  $this
    ->assertNull($webform
    ->get('open'));
  $this
    ->assertNull($webform
    ->get('close'));

  /**************************************************************************/

  // Templates.

  /**************************************************************************/

  // Check that templates are always closed.
  $webform
    ->set('template', TRUE)
    ->save();
  $this
    ->assertTrue($webform
    ->isTemplate());
  $this
    ->assertFalse($webform
    ->isOpen());

  /**************************************************************************/

  // Elements.

  /**************************************************************************/

  // Set elements.
  $elements = [
    'root' => [
      '#type' => 'textfield',
      '#title' => 'root',
    ],
    'container' => [
      '#type' => 'container',
      '#title' => 'container',
      'child' => [
        '#type' => 'textfield',
        '#title' => 'child',
        '#default_value' => '{default value}',
      ],
    ],
  ];
  $webform
    ->setElements($elements);

  // Check that elements are serialized to YAML.
  $this
    ->assertEquals($webform
    ->getElementsRaw(), WebformYaml::encode($elements));

  // Check elements decoded and flattened.
  $flattened_elements = [
    'root' => [
      '#type' => 'textfield',
      '#title' => 'root',
    ],
    'container' => [
      '#type' => 'container',
      '#title' => 'container',
    ],
    'child' => [
      '#type' => 'textfield',
      '#title' => 'child',
      '#default_value' => '{default value}',
    ],
  ];
  $this
    ->assertEquals($webform
    ->getElementsDecodedAndFlattened(), $flattened_elements);

  // Check elements initialized and flattened.
  $elements_initialized_and_flattened = [
    'root' => [
      '#type' => 'textfield',
      '#title' => 'root',
      '#webform' => 'webform_test',
      '#webform_id' => 'webform_test--root',
      '#webform_key' => 'root',
      '#webform_parent_key' => '',
      '#webform_parent_flexbox' => FALSE,
      '#webform_depth' => 0,
      '#webform_children' => [],
      '#webform_multiple' => FALSE,
      '#webform_composite' => FALSE,
      '#webform_parents' => [
        'root',
      ],
      '#webform_plugin_id' => 'textfield',
      '#admin_title' => 'root',
    ],
    'container' => [
      '#type' => 'container',
      '#title' => 'container',
      '#webform' => 'webform_test',
      '#webform_id' => 'webform_test--container',
      '#webform_key' => 'container',
      '#webform_parent_key' => '',
      '#webform_parent_flexbox' => FALSE,
      '#webform_depth' => 0,
      '#webform_children' => [
        'child' => 'child',
      ],
      '#webform_multiple' => FALSE,
      '#webform_composite' => FALSE,
      '#webform_parents' => [
        'container',
      ],
      '#webform_plugin_id' => 'container',
      '#admin_title' => 'container',
    ],
    'child' => [
      '#type' => 'textfield',
      '#title' => 'child',
      '#default_value' => '{default value}',
      '#webform' => 'webform_test',
      '#webform_id' => 'webform_test--child',
      '#webform_key' => 'child',
      '#webform_parent_key' => 'container',
      '#webform_parent_flexbox' => FALSE,
      '#webform_depth' => 1,
      '#webform_children' => [],
      '#webform_multiple' => FALSE,
      '#webform_composite' => FALSE,
      '#webform_parents' => [
        'container',
        'child',
      ],
      '#webform_plugin_id' => 'textfield',
      '#admin_title' => 'child',
    ],
  ];
  $this
    ->assertEquals($webform
    ->getElementsInitializedAndFlattened(), $elements_initialized_and_flattened);

  // Check elements flattened has value.
  $elements_initialized_flattened_and_has_value = $elements_initialized_and_flattened;
  unset($elements_initialized_flattened_and_has_value['container']);
  $this
    ->assertEquals($webform
    ->getElementsInitializedFlattenedAndHasValue(), $elements_initialized_flattened_and_has_value);

  // Check elements default data.
  $this
    ->assertEquals($webform
    ->getElementsDefaultData(), [
    'child' => '{default value}',
  ]);

  // Check invalid elements.
  $webform
    ->set('elements', 'invalid')
    ->save();
  $this
    ->assertEquals([], $webform
    ->getElementsInitialized());

  /**************************************************************************/

  // Wizard pages.

  /**************************************************************************/

  // Check get no wizard pages.
  $this
    ->assertEquals($webform
    ->getPages(), []);

  // Set wizard pages.
  $wizard_elements = [
    'page_1' => [
      '#type' => 'webform_wizard_page',
      '#title' => 'Page 1',
    ],
    'page_2' => [
      '#type' => 'webform_wizard_page',
      '#title' => 'Page 2',
    ],
    'page_3' => [
      '#type' => 'webform_wizard_page',
      '#title' => 'Page 3',
    ],
  ];
  $webform
    ->set('elements', $wizard_elements)
    ->save();

  // Check get wizard pages.
  $wizard_pages = [
    'page_1' => [
      '#title' => 'Page 1',
      '#type' => 'page',
      '#access' => TRUE,
    ],
    'page_2' => [
      '#title' => 'Page 2',
      '#type' => 'page',
      '#access' => TRUE,
    ],
    'page_3' => [
      '#title' => 'Page 3',
      '#type' => 'page',
      '#access' => TRUE,
    ],
    'webform_confirmation' => [
      '#title' => 'Complete',
      '#type' => 'page',
      '#access' => TRUE,
    ],
  ];
  $this
    ->assertEquals($webform
    ->getPages(), $wizard_pages);

  // Check get wizard pages with preview.
  $webform
    ->setSetting('preview', TRUE)
    ->save();
  $wizard_pages = [
    'page_1' => [
      '#title' => 'Page 1',
      '#type' => 'page',
      '#access' => TRUE,
    ],
    'page_2' => [
      '#title' => 'Page 2',
      '#type' => 'page',
      '#access' => TRUE,
    ],
    'page_3' => [
      '#title' => 'Page 3',
      '#type' => 'page',
      '#access' => TRUE,
    ],
    'webform_preview' => [
      '#title' => 'Preview',
      '#type' => 'page',
      '#access' => TRUE,
    ],
    'webform_confirmation' => [
      '#title' => 'Complete',
      '#type' => 'page',
      '#access' => TRUE,
    ],
  ];
  $this
    ->assertEquals($webform
    ->getPages(), $wizard_pages);

  // Check get wizard pages with preview with disable pages.
  $webform
    ->setSetting('preview', TRUE)
    ->save();
  $wizard_pages = [
    'webform_start' => [
      '#title' => 'Start',
      '#type' => 'page',
      '#access' => TRUE,
    ],
    'webform_preview' => [
      '#title' => 'Preview',
      '#type' => 'page',
      '#access' => TRUE,
    ],
    'webform_confirmation' => [
      '#title' => 'Complete',
      '#type' => 'page',
      '#access' => TRUE,
    ],
  ];
  $this
    ->assertEquals($webform
    ->getPages(TRUE), $wizard_pages);

  // @todo Add the below assertions.
  // Check access rules.
  // Check get submission form.
  // Check handlers CRUD operations.
}