You are here

Home » API reference » Drupal 8 » JsonApiFunctionalMultilingualTest.php

class JsonApiFunctionalMultilingualTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalMultilingualTest.php \Drupal\Tests\jsonapi\Functional\JsonApiFunctionalMultilingualTest

Tests JSON:API multilingual support.

@group jsonapi

@internal

Hierarchy

Expanded class hierarchy of JsonApiFunctionalMultilingualTest

File

core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalMultilingualTest.php, line 21

Namespace

Drupal\Tests\jsonapi\Functional
View source 
class JsonApiFunctionalMultilingualTest extends JsonApiFunctionalTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'language',
    'content_translation',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $language = ConfigurableLanguage::createFromLangcode('ca');
    $language
      ->save();
    ConfigurableLanguage::createFromLangcode('ca-fr')
      ->save();

    // In order to reflect the changes for a multilingual site in the container
    // we have to rebuild it.
    $this
      ->rebuildContainer();
    \Drupal::configFactory()
      ->getEditable('language.negotiation')
      ->set('url.prefixes.ca', 'ca')
      ->set('url.prefixes.ca-fr', 'ca-fr')
      ->save();
    ContentLanguageSettings::create([
      'target_entity_type_id' => 'node',
      'target_bundle' => 'article',
    ])
      ->setThirdPartySetting('content_translation', 'enabled', TRUE)
      ->save();
    $this
      ->createDefaultContent(5, 5, TRUE, TRUE, static::IS_MULTILINGUAL, FALSE);
  }

  /**
   * Tests reading multilingual content.
   */
  public function testReadMultilingual() {

    // Different databases have different sort orders, so a sort is required so
    // test expectations do not need to vary per database.
    $default_sort = [
      'sort' => 'drupal_internal__nid',
    ];

    // Test reading an individual entity translation.
    $output = Json::decode($this
      ->drupalGet('/ca/jsonapi/node/article/' . $this->nodes[0]
      ->uuid(), [
      'query' => [
        'include' => 'field_tags,field_image',
      ] + $default_sort,
    ]));
    $this
      ->assertEquals($this->nodes[0]
      ->getTranslation('ca')
      ->getTitle(), $output['data']['attributes']['title']);
    $this
      ->assertSame('ca', $output['data']['attributes']['langcode']);
    $included_tags = array_filter($output['included'], function ($entry) {
      return $entry['type'] === 'taxonomy_term--tags';
    });
    $tag_name = $this->nodes[0]
      ->get('field_tags')->entity
      ->getTranslation('ca')
      ->getName();
    $this
      ->assertEquals($tag_name, reset($included_tags)['attributes']['name']);
    $alt = $this->nodes[0]
      ->getTranslation('ca')
      ->get('field_image')->alt;
    $this
      ->assertSame($alt, $output['data']['relationships']['field_image']['data']['meta']['alt']);

    // Test reading an individual entity fallback.
    $output = Json::decode($this
      ->drupalGet('/ca-fr/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()));
    $this
      ->assertEquals($this->nodes[0]
      ->getTranslation('ca')
      ->getTitle(), $output['data']['attributes']['title']);
    $output = Json::decode($this
      ->drupalGet('/ca/jsonapi/node/article/' . $this->nodes[0]
      ->uuid(), [
      'query' => $default_sort,
    ]));
    $this
      ->assertEquals($this->nodes[0]
      ->getTranslation('ca')
      ->getTitle(), $output['data']['attributes']['title']);

    // Test reading a collection of entities.
    $output = Json::decode($this
      ->drupalGet('/ca/jsonapi/node/article', [
      'query' => $default_sort,
    ]));
    $this
      ->assertEquals($this->nodes[0]
      ->getTranslation('ca')
      ->getTitle(), $output['data'][0]['attributes']['title']);
  }

  /**
   * Tests updating a translation.
   */
  public function testPatchTranslation() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $node = $this->nodes[0];
    $uuid = $node
      ->uuid();

    // Assert the precondition: the 'ca' translation has a different title.
    $document = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid));
    $document_ca = Json::decode($this
      ->drupalGet('/ca/jsonapi/node/article/' . $uuid));
    $this
      ->assertSame('en', $document['data']['attributes']['langcode']);
    $this
      ->assertSame('ca', $document_ca['data']['attributes']['langcode']);
    $this
      ->assertSame($node
      ->getTitle(), $document['data']['attributes']['title']);
    $this
      ->assertSame($node
      ->getTitle() . ' (ca)', $document_ca['data']['attributes']['title']);

    // PATCH the 'ca' translation.
    $this
      ->grantPermissions(Role::load(RoleInterface::ANONYMOUS_ID), [
      'bypass node access',
    ]);
    $request_options = [];
    $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
    $request_options[RequestOptions::BODY] = Json::encode([
      'data' => [
        'type' => 'node--article',
        'id' => $uuid,
        'attributes' => [
          'title' => $document_ca['data']['attributes']['title'] . ' UPDATED',
        ],
      ],
    ]);
    $response = $this
      ->request('PATCH', Url::fromUri('base:/ca/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());

    // Assert the postcondition: only the 'ca' translation has an updated title.
    $document_updated = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid));
    $document_ca_updated = Json::decode($this
      ->drupalGet('/ca/jsonapi/node/article/' . $uuid));
    $this
      ->assertSame('en', $document_updated['data']['attributes']['langcode']);
    $this
      ->assertSame('ca', $document_ca_updated['data']['attributes']['langcode']);
    $this
      ->assertSame($node
      ->getTitle(), $document_updated['data']['attributes']['title']);
    $this
      ->assertSame($node
      ->getTitle() . ' (ca) UPDATED', $document_ca_updated['data']['attributes']['title']);

    // Specifying a langcode is not allowed by default.
    $request_options[RequestOptions::BODY] = Json::encode([
      'data' => [
        'type' => 'node--article',
        'id' => $uuid,
        'attributes' => [
          'langcode' => 'ca-fr',
        ],
      ],
    ]);
    $response = $this
      ->request('PATCH', Url::fromUri('base:/ca/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), $request_options);
    $this
      ->assertSame(403, $response
      ->getStatusCode());

    // Specifying a langcode is allowed once configured to be alterable. But
    // modifying the language of a non-default translation is still not allowed.
    ContentLanguageSettings::loadByEntityTypeBundle('node', 'article')
      ->setLanguageAlterable(TRUE)
      ->save();
    $response = $this
      ->request('PATCH', Url::fromUri('base:/ca/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), $request_options);
    $this
      ->assertSame(500, $response
      ->getStatusCode());
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('The translation language cannot be changed (ca).', $document['errors'][0]['detail']);

    // Changing the langcode of the default ('en') translation is possible:
    // first verify that it currently is 'en', then change it to 'ca-fr', and
    // verify that the title is unchanged, but the langcode is updated.
    $response = $this
      ->request('GET', Url::fromUri('base:/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame($node
      ->getTitle(), $document['data']['attributes']['title']);
    $this
      ->assertSame('en', $document['data']['attributes']['langcode']);
    $response = $this
      ->request('PATCH', Url::fromUri('base:/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame($node
      ->getTitle(), $document['data']['attributes']['title']);
    $this
      ->assertSame('ca-fr', $document['data']['attributes']['langcode']);

    // Finally: assert the postcondition of all installed languages.
    // - When GETting the 'en' translation, we get 'ca-fr', since the 'en'
    //   translation doesn't exist anymore.
    $response = $this
      ->request('GET', Url::fromUri('base:/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), $request_options);
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('ca-fr', $document['data']['attributes']['langcode']);
    $this
      ->assertSame($node
      ->getTitle(), $document['data']['attributes']['title']);

    // - When GETting the 'ca' translation, we still get the 'ca' one.
    $response = $this
      ->request('GET', Url::fromUri('base:/ca/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), $request_options);
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('ca', $document['data']['attributes']['langcode']);
    $this
      ->assertSame($node
      ->getTitle() . ' (ca) UPDATED', $document['data']['attributes']['title']);

    // - When GETting the 'ca-fr' translation, we now get the default
    //   translation.
    $response = $this
      ->request('GET', Url::fromUri('base:/ca-fr/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), $request_options);
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('ca-fr', $document['data']['attributes']['langcode']);
    $this
      ->assertSame($node
      ->getTitle(), $document['data']['attributes']['title']);
  }

  /**
   * Tests updating a translation fallback.
   */
  public function testPatchTranslationFallback() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $node = $this->nodes[0];
    $uuid = $node
      ->uuid();

    // Assert the precondition: 'ca-fr' falls back to the 'ca' translation which
    // has a different title.
    $document = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid));
    $document_ca = Json::decode($this
      ->drupalGet('/ca/jsonapi/node/article/' . $uuid));
    $document_cafr = Json::decode($this
      ->drupalGet('/ca-fr/jsonapi/node/article/' . $uuid));
    $this
      ->assertSame('en', $document['data']['attributes']['langcode']);
    $this
      ->assertSame('ca', $document_ca['data']['attributes']['langcode']);
    $this
      ->assertSame('ca', $document_cafr['data']['attributes']['langcode']);
    $this
      ->assertSame($node
      ->getTitle(), $document['data']['attributes']['title']);
    $this
      ->assertSame($node
      ->getTitle() . ' (ca)', $document_ca['data']['attributes']['title']);
    $this
      ->assertSame($node
      ->getTitle() . ' (ca)', $document_cafr['data']['attributes']['title']);

    // PATCH the 'ca-fr' translation.
    $this
      ->grantPermissions(Role::load(RoleInterface::ANONYMOUS_ID), [
      'bypass node access',
    ]);
    $request_options = [];
    $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
    $request_options[RequestOptions::BODY] = Json::encode([
      'data' => [
        'type' => 'node--article',
        'id' => $uuid,
        'attributes' => [
          'title' => $document_cafr['data']['attributes']['title'] . ' UPDATED',
        ],
      ],
    ]);
    $response = $this
      ->request('PATCH', Url::fromUri('base:/ca-fr/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), $request_options);
    $this
      ->assertSame(405, $response
      ->getStatusCode());
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('The requested translation of the resource object does not exist, instead modify one of the translations that do exist: ca, en.', $document['errors'][0]['detail']);
  }

  /**
   * Tests creating a translation.
   */
  public function testPostTranslation() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $this
      ->grantPermissions(Role::load(RoleInterface::ANONYMOUS_ID), [
      'bypass node access',
    ]);
    $title = 'Llamas FTW (ca)';
    $request_document = [
      'data' => [
        'type' => 'node--article',
        'attributes' => [
          'title' => $title,
          'langcode' => 'ca',
        ],
      ],
    ];
    $request_options = [];
    $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';

    // Specifying a langcode is forbidden by language_entity_field_access().
    $request_options[RequestOptions::BODY] = Json::encode($request_document);
    $response = $this
      ->request('POST', Url::fromUri('base:/ca/jsonapi/node/article/'), $request_options);
    $this
      ->assertSame(403, $response
      ->getStatusCode());
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('The current user is not allowed to POST the selected field (langcode).', $document['errors'][0]['detail']);

    // Omitting a langcode results in an entity in 'en': the default language of
    // the site.
    unset($request_document['data']['attributes']['langcode']);
    $request_options[RequestOptions::BODY] = Json::encode($request_document);
    $response = $this
      ->request('POST', Url::fromUri('base:/ca/jsonapi/node/article/'), $request_options);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame($title, $document['data']['attributes']['title']);
    $this
      ->assertSame('en', $document['data']['attributes']['langcode']);
    $this
      ->assertSame([
      'en',
    ], array_keys(Node::load($document['data']['attributes']['drupal_internal__nid'])
      ->getTranslationLanguages()));

    // Specifying a langcode is allowed once configured to be alterable. Now an
    // entity can be created with the specified langcode.
    ContentLanguageSettings::loadByEntityTypeBundle('node', 'article')
      ->setLanguageAlterable(TRUE)
      ->save();
    $request_document['data']['attributes']['langcode'] = 'ca';
    $request_options[RequestOptions::BODY] = Json::encode($request_document);
    $response = $this
      ->request('POST', Url::fromUri('base:/ca/jsonapi/node/article/'), $request_options);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame($title, $document['data']['attributes']['title']);
    $this
      ->assertSame('ca', $document['data']['attributes']['langcode']);
    $this
      ->assertSame([
      'ca',
    ], array_keys(Node::load($document['data']['attributes']['drupal_internal__nid'])
      ->getTranslationLanguages()));

    // Same request, but sent to the URL without the language prefix.
    $response = $this
      ->request('POST', Url::fromUri('base:/jsonapi/node/article/'), $request_options);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame($title, $document['data']['attributes']['title']);
    $this
      ->assertSame('ca', $document['data']['attributes']['langcode']);
    $this
      ->assertSame([
      'ca',
    ], array_keys(Node::load($document['data']['attributes']['drupal_internal__nid'])
      ->getTranslationLanguages()));
  }

  /**
   * Tests deleting multilingual content.
   */
  public function testDeleteMultilingual() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $this
      ->grantPermissions(Role::load(RoleInterface::ANONYMOUS_ID), [
      'bypass node access',
    ]);
    $response = $this
      ->request('DELETE', Url::fromUri('base:/ca/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), []);
    $this
      ->assertSame(405, $response
      ->getStatusCode());
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('Deleting a resource object translation is not yet supported. See https://www.drupal.org/docs/8/modules/jsonapi/translations.', $document['errors'][0]['detail']);
    $response = $this
      ->request('DELETE', Url::fromUri('base:/ca-fr/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), []);
    $this
      ->assertSame(405, $response
      ->getStatusCode());
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('Deleting a resource object translation is not yet supported. See https://www.drupal.org/docs/8/modules/jsonapi/translations.', $document['errors'][0]['detail']);
    $response = $this
      ->request('DELETE', Url::fromUri('base:/jsonapi/node/article/' . $this->nodes[0]
      ->uuid()), []);
    $this
      ->assertSame(204, $response
      ->getStatusCode());
    $this
      ->assertNull(Node::load($this->nodes[0]
      ->id()));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
ImageFieldCreationTrait::createImageField protected function Create a new image field.
JsonApiFunctionalMultilingualTest::$defaultTheme protected property The theme to install as the default for testing. Overrides JsonApiFunctionalTestBase::$defaultTheme
JsonApiFunctionalMultilingualTest::$modules public static property Modules to enable. Overrides JsonApiFunctionalTestBase::$modules
JsonApiFunctionalMultilingualTest::setUp protected function Overrides JsonApiFunctionalTestBase::setUp
JsonApiFunctionalMultilingualTest::testDeleteMultilingual public function Tests deleting multilingual content.
JsonApiFunctionalMultilingualTest::testPatchTranslation public function Tests updating a translation.
JsonApiFunctionalMultilingualTest::testPatchTranslationFallback public function Tests updating a translation fallback.
JsonApiFunctionalMultilingualTest::testPostTranslation public function Tests creating a translation.
JsonApiFunctionalMultilingualTest::testReadMultilingual public function Tests reading multilingual content.
JsonApiFunctionalTestBase::$files protected property Test files.
JsonApiFunctionalTestBase::$httpClient protected property The HTTP client.
JsonApiFunctionalTestBase::$nodes protected property Test nodes.
JsonApiFunctionalTestBase::$tags protected property Test taxonomy terms.
JsonApiFunctionalTestBase::$user protected property Test user.
JsonApiFunctionalTestBase::$userCanViewProfiles protected property Test user with access to view profiles.
JsonApiFunctionalTestBase::createDefaultContent protected function Creates default content to test the API.
JsonApiFunctionalTestBase::IS_MULTILINGUAL constant
JsonApiFunctionalTestBase::IS_NOT_MULTILINGUAL constant
JsonApiFunctionalTestBase::request protected function Performs a HTTP request. Wraps the Guzzle HTTP client.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.