trait BasicAuthTestTrait

Same name in other branches
  1. 9 core/modules/basic_auth/tests/src/Traits/BasicAuthTestTrait.php \Drupal\Tests\basic_auth\Traits\BasicAuthTestTrait
  2. 8.9.x core/modules/basic_auth/src/Tests/BasicAuthTestTrait.php \Drupal\basic_auth\Tests\BasicAuthTestTrait
  3. 8.9.x core/modules/basic_auth/tests/src/Traits/BasicAuthTestTrait.php \Drupal\Tests\basic_auth\Traits\BasicAuthTestTrait
  4. 11.x core/modules/basic_auth/tests/src/Traits/BasicAuthTestTrait.php \Drupal\Tests\basic_auth\Traits\BasicAuthTestTrait

Provides common functionality for Basic Authentication test classes.

Hierarchy

2 files declare their use of BasicAuthTestTrait
BasicAuthTest.php in core/modules/basic_auth/tests/src/Functional/BasicAuthTest.php
SessionAuthenticationTest.php in core/modules/system/tests/src/Functional/Session/SessionAuthenticationTest.php

File

core/modules/basic_auth/tests/src/Traits/BasicAuthTestTrait.php, line 10

Namespace

Drupal\Tests\basic_auth\Traits
View source 
trait BasicAuthTestTrait {
    
    /**
     * Retrieves a Drupal path or an absolute path using basic authentication.
     *
     * @param \Drupal\Core\Url|string $path
     *   Drupal path or URL to load into the internal browser.
     * @param string $username
     *   The username to use for basic authentication.
     * @param string $password
     *   The password to use for basic authentication.
     * @param array $options
     *   (optional) Options to be forwarded to the URL generator.
     *
     * @return string
     *   The retrieved HTML string, also available as $this->getRawContent().
     */
    protected function basicAuthGet($path, $username, $password, array $options = []) {
        return $this->drupalGet($path, $options, $this->getBasicAuthHeaders($username, $password));
    }
    
    /**
     * Returns HTTP headers that can be used for basic authentication in Curl.
     *
     * @param string $username
     *   The username to use for basic authentication.
     * @param string $password
     *   The password to use for basic authentication.
     *
     * @return array
     *   An array of raw request headers as used by curl_setopt().
     */
    protected function getBasicAuthHeaders($username, $password) {
        // Set up Curl to use basic authentication with the test user's credentials.
        return [
            'Authorization' => 'Basic ' . base64_encode("{$username}:{$password}"),
        ];
    }

}

Members

Title Modifiers Object type Summary
BasicAuthTestTrait::basicAuthGet protected function Retrieves a Drupal path or an absolute path using basic authentication.
BasicAuthTestTrait::getBasicAuthHeaders protected function Returns HTTP headers that can be used for basic authentication in Curl.

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