FormObjectTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Functional\Form;

use Drupal\Tests\BrowserTestBase;

/**
 * Tests building a form from an object.
 *
 * @group Form
 */
class FormObjectTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'form_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests using an object as the form callback.
     *
     * @see \Drupal\form_test\EventSubscriber\FormTestEventSubscriber::onKernelRequest()
     */
    public function testObjectFormCallback() : void {
        $config_factory = $this->container
            ->get('config.factory');
        $this->drupalGet('form-test/object-builder');
        $this->assertSession()
            ->pageTextContains('The FormTestObject::buildForm() method was used for this form.');
        $this->assertSession()
            ->elementExists('xpath', '//form[@id="form-test-form-test-object"]');
        $this->submitForm([
            'bananas' => 'green',
        ], 'Save');
        $this->assertSession()
            ->pageTextContains('The FormTestObject::validateForm() method was used for this form.');
        $this->assertSession()
            ->pageTextContains('The FormTestObject::submitForm() method was used for this form.');
        $value = $config_factory->get('form_test.object')
            ->get('bananas');
        $this->assertSame('green', $value);
        $this->drupalGet('form-test/object-arguments-builder/yellow');
        $this->assertSession()
            ->pageTextContains('The FormTestArgumentsObject::buildForm() method was used for this form.');
        $this->assertSession()
            ->elementExists('xpath', '//form[@id="form-test-form-test-arguments-object"]');
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains('The FormTestArgumentsObject::validateForm() method was used for this form.');
        $this->assertSession()
            ->pageTextContains('The FormTestArgumentsObject::submitForm() method was used for this form.');
        $value = $config_factory->get('form_test.object')
            ->get('bananas');
        $this->assertSame('yellow', $value);
        $this->drupalGet('form-test/object-service-builder');
        $this->assertSession()
            ->pageTextContains('The FormTestServiceObject::buildForm() method was used for this form.');
        $this->assertSession()
            ->elementExists('xpath', '//form[@id="form-test-form-test-service-object"]');
        $this->submitForm([
            'bananas' => 'brown',
        ], 'Save');
        $this->assertSession()
            ->pageTextContains('The FormTestServiceObject::validateForm() method was used for this form.');
        $this->assertSession()
            ->pageTextContains('The FormTestServiceObject::submitForm() method was used for this form.');
        $value = $config_factory->get('form_test.object')
            ->get('bananas');
        $this->assertSame('brown', $value);
        $this->drupalGet('form-test/object-controller-builder');
        $this->assertSession()
            ->pageTextContains('The FormTestControllerObject::create() method was used for this form.');
        $this->assertSession()
            ->pageTextContains('The FormTestControllerObject::buildForm() method was used for this form.');
        $this->assertSession()
            ->elementExists('xpath', '//form[@id="form-test-form-test-controller-object"]');
        // Ensure parameters are injected from request attributes.
        $this->assertSession()
            ->pageTextContains('custom_value');
        // Ensure the request object is injected.
        $this->assertSession()
            ->pageTextContains('request_value');
        $this->submitForm([
            'bananas' => 'black',
        ], 'Save');
        $this->assertSession()
            ->pageTextContains('The FormTestControllerObject::validateForm() method was used for this form.');
        $this->assertSession()
            ->pageTextContains('The FormTestControllerObject::submitForm() method was used for this form.');
        $value = $config_factory->get('form_test.object')
            ->get('bananas');
        $this->assertSame('black', $value);
    }

}