class PathElementFormTest

Same name and namespace in other branches
  1. 11.x core/tests/Drupal/KernelTests/Core/Element/PathElementFormTest.php \Drupal\KernelTests\Core\Element\PathElementFormTest
  2. 10 core/tests/Drupal/KernelTests/Core/Element/PathElementFormTest.php \Drupal\KernelTests\Core\Element\PathElementFormTest

Tests PathElement validation and conversion functionality.

@group Form

Hierarchy

Expanded class hierarchy of PathElementFormTest

File

core/tests/Drupal/KernelTests/Core/Element/PathElementFormTest.php, line 19

Namespace

Drupal\KernelTests\Core\Element
View source
class PathElementFormTest extends KernelTestBase implements FormInterface {
  
  /**
   * User for testing.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $testUser;
  
  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    'user',
  ];
  
  /**
   * Sets up the test.
   */
  protected function setUp() : void {
    parent::setUp();
    $this->installSchema('system', [
      'sequences',
    ]);
    $this->installEntitySchema('user');
    /** @var \Drupal\user\RoleInterface $role */
    $role = Role::create([
      'id' => 'admin',
      'label' => 'admin',
    ]);
    $role->grantPermission('link to any page');
    $role->save();
    $this->testUser = User::create([
      'name' => 'foobar',
      'mail' => 'foobar@example.com',
    ]);
    $this->testUser
      ->addRole($role->id());
    $this->testUser
      ->save();
    \Drupal::service('current_user')->setAccount($this->testUser);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'test_path_element';
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    // A required validated path.
    $form['required_validate'] = [
      '#type' => 'path',
      '#required' => TRUE,
      '#title' => 'required_validate',
      '#convert_path' => PathElement::CONVERT_NONE,
    ];
    // A non validated required path.
    $form['required_non_validate'] = [
      '#type' => 'path',
      '#required' => TRUE,
      '#title' => 'required_non_validate',
      '#convert_path' => PathElement::CONVERT_NONE,
      '#validate_path' => FALSE,
    ];
    // A non required validated path.
    $form['optional_validate'] = [
      '#type' => 'path',
      '#required' => FALSE,
      '#title' => 'optional_validate',
      '#convert_path' => PathElement::CONVERT_NONE,
    ];
    // A non required converted path.
    $form['optional_validate'] = [
      '#type' => 'path',
      '#required' => FALSE,
      '#title' => 'optional_validate',
      '#convert_path' => PathElement::CONVERT_ROUTE,
    ];
    // A converted required validated path.
    $form['required_validate_route'] = [
      '#type' => 'path',
      '#required' => TRUE,
      '#title' => 'required_validate_route',
    ];
    // A converted required validated path.
    $form['required_validate_url'] = [
      '#type' => 'path',
      '#required' => TRUE,
      '#title' => 'required_validate_url',
      '#convert_path' => PathElement::CONVERT_URL,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => t('Submit'),
    ];
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
  }
  
  /**
   * Form validation handler.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
  }
  
  /**
   * Tests that default handlers are added even if custom are specified.
   */
  public function testPathElement() {
    $form_state = (new FormState())->setValues([
      'required_validate' => 'user/' . $this->testUser
        ->id(),
      'required_non_validate' => 'magic-ponies',
      'required_validate_route' => 'user/' . $this->testUser
        ->id(),
      'required_validate_url' => 'user/' . $this->testUser
        ->id(),
    ]);
    $form_builder = $this->container
      ->get('form_builder');
    $form_builder->submitForm($this, $form_state);
    // Valid form state.
    $this->assertCount(0, $form_state->getErrors());
    $this->assertEquals([
      'route_name' => 'entity.user.canonical',
      'route_parameters' => [
        'user' => $this->testUser
          ->id(),
      ],
    ], $form_state->getValue('required_validate_route'));
    /** @var \Drupal\Core\Url $url */
    $url = $form_state->getValue('required_validate_url');
    $this->assertInstanceOf(Url::class, $url);
    $this->assertEquals('entity.user.canonical', $url->getRouteName());
    $this->assertEquals([
      'user' => $this->testUser
        ->id(),
    ], $url->getRouteParameters());
    // Test #required.
    $form_state = (new FormState())->setValues([
      'required_non_validate' => 'magic-ponies',
      'required_validate_route' => 'user/' . $this->testUser
        ->id(),
      'required_validate_url' => 'user/' . $this->testUser
        ->id(),
    ]);
    $form_builder->submitForm($this, $form_state);
    $errors = $form_state->getErrors();
    // Should be missing 'required_validate' field.
    $this->assertCount(1, $errors);
    $this->assertEquals([
      'required_validate' => t('@name field is required.', [
        '@name' => 'required_validate',
      ]),
    ], $errors);
    // Test invalid parameters.
    $form_state = (new FormState())->setValues([
      'required_validate' => 'user/74',
      'required_non_validate' => 'magic-ponies',
      'required_validate_route' => 'user/74',
      'required_validate_url' => 'user/74',
    ]);
    $form_builder = $this->container
      ->get('form_builder');
    $form_builder->submitForm($this, $form_state);
    // Valid form state.
    $errors = $form_state->getErrors();
    $this->assertCount(3, $errors);
    $this->assertEquals([
      'required_validate' => t('This path does not exist or you do not have permission to link to %path.', [
        '%path' => 'user/74',
      ]),
      'required_validate_route' => t('This path does not exist or you do not have permission to link to %path.', [
        '%path' => 'user/74',
      ]),
      'required_validate_url' => t('This path does not exist or you do not have permission to link to %path.', [
        '%path' => 'user/74',
      ]),
    ], $errors);
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.