class CommentAttributesTest

Same name in other branches
  1. 8.9.x core/modules/rdf/tests/src/Functional/CommentAttributesTest.php \Drupal\Tests\rdf\Functional\CommentAttributesTest

Tests the RDFa markup of comments.

@group rdf @group legacy

Hierarchy

Expanded class hierarchy of CommentAttributesTest

File

core/modules/rdf/tests/src/Functional/CommentAttributesTest.php, line 20

Namespace

Drupal\Tests\rdf\Functional
View source
class CommentAttributesTest extends CommentTestBase {
    use RdfParsingTrait;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'views',
        'node',
        'comment',
        'rdf',
        'user_hooks_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * URI of the front page of the Drupal site.
     *
     * @var string
     */
    protected $baseUri;
    
    /**
     * URI of the test node created by CommentTestBase::setUp().
     *
     * @var string
     */
    protected $nodeUri;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Enables anonymous user comments.
        user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
            'access comments' => TRUE,
            'post comments' => TRUE,
            'skip comment approval' => TRUE,
        ]);
        // Allows anonymous to leave their contact information.
        $this->setCommentAnonymous(CommentInterface::ANONYMOUS_MAY_CONTACT);
        $this->setCommentPreview(DRUPAL_OPTIONAL);
        $this->setCommentForm(TRUE);
        $this->setCommentSubject(TRUE);
        $this->setCommentSettings('comment_default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Comment paging changed.');
        // Prepares commonly used URIs.
        $this->baseUri = Url::fromRoute('<front>', [], [
            'absolute' => TRUE,
        ])->toString();
        $this->nodeUri = $this->node
            ->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        // Set relation between node and comment.
        $article_mapping = rdf_get_mapping('node', 'article');
        $comment_count_mapping = [
            'properties' => [
                'sioc:num_replies',
            ],
            'datatype' => 'xsd:integer',
            'datatype_callback' => [
                'callable' => 'Drupal\\rdf\\CommonDataConverter::rawValue',
            ],
        ];
        $article_mapping->setFieldMapping('comment_count', $comment_count_mapping)
            ->save();
        // Save user mapping.
        $user_mapping = rdf_get_mapping('user', 'user');
        $username_mapping = [
            'properties' => [
                'foaf:name',
            ],
        ];
        $user_mapping->setFieldMapping('name', $username_mapping)
            ->save();
        $user_mapping->setFieldMapping('homepage', [
            'properties' => [
                'foaf:page',
            ],
            'mapping_type' => 'rel',
        ])
            ->save();
        // Save comment mapping.
        $mapping = rdf_get_mapping('comment', 'comment');
        $mapping->setBundleMapping([
            'types' => [
                'sioc:Post',
                'sioct:Comment',
            ],
        ])
            ->save();
        $field_mappings = [
            'subject' => [
                'properties' => [
                    'dc:title',
                ],
            ],
            'created' => [
                'properties' => [
                    'dc:date',
                    'dc:created',
                ],
                'datatype' => 'xsd:dateTime',
                'datatype_callback' => [
                    'callable' => 'Drupal\\rdf\\CommonDataConverter::dateIso8601Value',
                ],
            ],
            'changed' => [
                'properties' => [
                    'dc:modified',
                ],
                'datatype' => 'xsd:dateTime',
                'datatype_callback' => [
                    'callable' => 'Drupal\\rdf\\CommonDataConverter::dateIso8601Value',
                ],
            ],
            'comment_body' => [
                'properties' => [
                    'content:encoded',
                ],
            ],
            'pid' => [
                'properties' => [
                    'sioc:reply_of',
                ],
                'mapping_type' => 'rel',
            ],
            'uid' => [
                'properties' => [
                    'sioc:has_creator',
                ],
                'mapping_type' => 'rel',
            ],
            'name' => [
                'properties' => [
                    'foaf:name',
                ],
            ],
        ];
        // Iterate over shared field mappings and save.
        foreach ($field_mappings as $field_name => $field_mapping) {
            $mapping->setFieldMapping($field_name, $field_mapping)
                ->save();
        }
    }
    
    /**
     * Tests the presence of the RDFa markup for the number of comments.
     */
    public function testNumberOfCommentsRdfaMarkup() {
        // Posts 2 comments on behalf of registered user.
        $this->saveComment($this->node
            ->id(), $this->webUser
            ->id());
        $this->saveComment($this->node
            ->id(), $this->webUser
            ->id());
        // Tests number of comments in teaser view.
        $this->drupalLogin($this->webUser);
        $this->drupalGet('node');
        // Number of comments.
        $expected_value = [
            'type' => 'literal',
            'value' => 2,
            'datatype' => 'http://www.w3.org/2001/XMLSchema#integer',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->nodeUri, 'http://rdfs.org/sioc/ns#num_replies', $expected_value), 'Number of comments found in RDF output of teaser view (sioc:num_replies).');
        $this->drupalGet($this->node
            ->toUrl());
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $this->nodeUri, 'http://rdfs.org/sioc/ns#num_replies', $expected_value), 'Number of comments found in RDF output of full node view mode (sioc:num_replies).');
    }
    
    /**
     * Tests comment author link markup has not been broken by RDF.
     */
    public function testCommentRdfAuthorMarkup() {
        // Set to test the altered display name.
        \Drupal::state()->set('user_hooks_test_user_format_name_alter', TRUE);
        // Post a comment as a registered user.
        $this->saveComment($this->node
            ->id(), $this->webUser
            ->id());
        // Give the user access to view user profiles so the profile link shows up.
        user_role_grant_permissions(RoleInterface::AUTHENTICATED_ID, [
            'access user profiles',
        ]);
        $this->drupalLogin($this->webUser);
        // Ensure that the author link still works properly after the author output
        // is modified by the RDF module.
        $this->drupalGet('node/' . $this->node
            ->id());
        $this->assertSession()
            ->linkExistsExact($this->webUser
            ->getDisplayName());
        $this->assertSession()
            ->linkByHrefExists('user/' . $this->webUser
            ->id());
    }
    
    /**
     * Tests if RDFa markup for meta information is present in comments.
     *
     * Tests presence of RDFa markup for the title, date and author and homepage
     * on comments from registered and anonymous users.
     */
    public function testCommentRdfaMarkup() {
        // Set to test the altered display name.
        \Drupal::state()->set('user_hooks_test_user_format_name_alter', TRUE);
        // Posts comment #1 on behalf of registered user.
        $comment1 = $this->saveComment($this->node
            ->id(), $this->webUser
            ->id());
        // Tests comment #1 with access to the user profile.
        $this->drupalLogin($this->webUser);
        $this->_testBasicCommentRdfaMarkup($comment1);
        // Tests comment #1 with no access to the user profile (as anonymous user).
        $this->drupalLogout();
        $this->_testBasicCommentRdfaMarkup($comment1);
        // Posts comment #2 as anonymous user.
        $anonymous_user = [];
        $anonymous_user['name'] = $this->randomMachineName();
        $anonymous_user['mail'] = 'tester@simpletest.org';
        $anonymous_user['homepage'] = 'http://example.org/';
        $comment2 = $this->saveComment($this->node
            ->id(), 0, $anonymous_user);
        $anonymous = User::load(0);
        // Tests comment #2 as anonymous user.
        $this->_testBasicCommentRdfaMarkup($comment2, $anonymous);
        // Tests comment #2 as logged in user.
        $this->drupalLogin($this->webUser);
        $this->_testBasicCommentRdfaMarkup($comment2, $anonymous);
    }
    
    /**
     * Tests RDF comment replies.
     */
    public function testCommentReplyOfRdfaMarkup() {
        // Posts comment #1 on behalf of registered user.
        $this->drupalLogin($this->webUser);
        $comment_1 = $this->saveComment($this->node
            ->id(), $this->webUser
            ->id());
        $comment_1_uri = $comment_1->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        // Posts a reply to the first comment.
        $comment_2 = $this->saveComment($this->node
            ->id(), $this->webUser
            ->id(), NULL, $comment_1->id());
        $comment_2_uri = $comment_2->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        // Tests the reply_of relationship of a first level comment.
        $this->drupalGet($this->node
            ->toUrl());
        $expected_value = [
            'type' => 'uri',
            'value' => $this->nodeUri,
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $comment_1_uri, 'http://rdfs.org/sioc/ns#reply_of', $expected_value), 'Comment relation to its node found in RDF output (sioc:reply_of).');
        // Tests the reply_of relationship of a second level comment.
        $expected_value = [
            'type' => 'uri',
            'value' => $this->nodeUri,
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $comment_2_uri, 'http://rdfs.org/sioc/ns#reply_of', $expected_value), 'Comment relation to its node found in RDF output (sioc:reply_of).');
        $expected_value = [
            'type' => 'uri',
            'value' => $comment_1_uri,
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $comment_2_uri, 'http://rdfs.org/sioc/ns#reply_of', $expected_value), 'Comment relation to its parent comment found in RDF output (sioc:reply_of).');
    }
    
    /**
     * Helper function for testCommentRdfaMarkup().
     *
     * Tests the current page for basic comment RDFa markup.
     *
     * @param \Drupal\comment\CommentInterface $comment
     *   Comment object.
     * @param array|null $account
     *   (optional) An array containing information about an anonymous user.
     *   Defaults to NULL.
     */
    public function _testBasicCommentRdfaMarkup(CommentInterface $comment, $account = NULL) {
        $this->drupalGet($this->node
            ->toUrl());
        $comment_uri = $comment->toUrl('canonical', [
            'absolute' => TRUE,
        ])
            ->toString();
        // Comment type.
        $expected_value = [
            'type' => 'uri',
            'value' => 'http://rdfs.org/sioc/types#Comment',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $comment_uri, 'http://www.w3.org/1999/02/22-rdf-syntax-ns#type', $expected_value), 'Comment type found in RDF output (sioct:Comment).');
        // Comment type.
        $expected_value = [
            'type' => 'uri',
            'value' => 'http://rdfs.org/sioc/ns#Post',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $comment_uri, 'http://www.w3.org/1999/02/22-rdf-syntax-ns#type', $expected_value), 'Comment type found in RDF output (sioc:Post).');
        // Comment title.
        $expected_value = [
            'type' => 'literal',
            'value' => $comment->getSubject(),
            'lang' => 'en',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $comment_uri, 'http://purl.org/dc/terms/title', $expected_value), 'Comment subject found in RDF output (dc:title).');
        // Comment date.
        $expected_value = [
            'type' => 'literal',
            'value' => $this->container
                ->get('date.formatter')
                ->format($comment->getCreatedTime(), 'custom', 'c', 'UTC'),
            'datatype' => 'http://www.w3.org/2001/XMLSchema#dateTime',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $comment_uri, 'http://purl.org/dc/terms/date', $expected_value), 'Comment date found in RDF output (dc:date).');
        // Comment date.
        $expected_value = [
            'type' => 'literal',
            'value' => $this->container
                ->get('date.formatter')
                ->format($comment->getCreatedTime(), 'custom', 'c', 'UTC'),
            'datatype' => 'http://www.w3.org/2001/XMLSchema#dateTime',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $comment_uri, 'http://purl.org/dc/terms/created', $expected_value), 'Comment date found in RDF output (dc:created).');
        // Comment body.
        $expected_value = [
            'type' => 'literal',
            'value' => $comment->comment_body->value . "\n",
            'lang' => 'en',
        ];
        $this->assertTrue($this->hasRdfProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $comment_uri, 'http://purl.org/rss/1.0/modules/content/encoded', $expected_value), 'Comment body found in RDF output (content:encoded).');
        // The comment author can be a registered user or an anonymous user.
        if ($comment->getOwnerId() > 0) {
            // Comment relation to author.
            $expected_value = [
                'type' => 'uri',
                'value' => Url::fromRoute('entity.user.canonical', [
                    'user' => $comment->getOwnerId(),
                ], [
                    'absolute' => TRUE,
                ])
                    ->toString(),
            ];
            $this->assertTrue($this->hasRdfProperty($this->getSession()
                ->getPage()
                ->getContent(), $this->baseUri, $comment_uri, 'http://rdfs.org/sioc/ns#has_creator', $expected_value), 'Comment relation to author found in RDF output (sioc:has_creator).');
        }
        else {
            // The author is expected to be a blank node.
            $this->assertTrue($this->rdfElementIsBlankNode($this->getSession()
                ->getPage()
                ->getContent(), $this->baseUri, $comment_uri, '<http://rdfs.org/sioc/ns#has_creator>'));
        }
        // Author name.
        $name = $account ? $account->getDisplayName() . " (not verified)" : $this->webUser
            ->getDisplayName();
        $expected_value = [
            'type' => 'literal',
            'value' => $name,
        ];
        $this->assertTrue($this->hasRdfChildProperty($this->getSession()
            ->getPage()
            ->getContent(), $this->baseUri, $comment_uri, '<http://rdfs.org/sioc/ns#has_creator>', 'http://xmlns.com/foaf/0.1/name', $expected_value), 'Comment author name found in RDF output (foaf:name).');
        // Comment author homepage (only for anonymous authors).
        if ($comment->getOwnerId() == 0) {
            $expected_value = [
                'type' => 'uri',
                'value' => 'http://example.org/',
            ];
            $this->assertTrue($this->hasRdfChildProperty($this->getSession()
                ->getPage()
                ->getContent(), $this->baseUri, $comment_uri, '<http://rdfs.org/sioc/ns#has_creator>', 'http://xmlns.com/foaf/0.1/page', $expected_value), 'Comment author link found in RDF output (foaf:page).');
        }
    }
    
    /**
     * Creates a comment entity.
     *
     * @param $nid
     *   Node id which will hold the comment.
     * @param $uid
     *   User id of the author of the comment. Can be NULL if $contact provided.
     * @param $contact
     *   Set to NULL for no contact info, TRUE to ignore success checking, and
     *   array of values to set contact info.
     * @param $pid
     *   Comment id of the parent comment in a thread.
     *
     * @return \Drupal\comment\Entity\Comment
     *   The saved comment.
     */
    public function saveComment($nid, $uid, $contact = NULL, $pid = 0) {
        $values = [
            'entity_id' => $nid,
            'entity_type' => 'node',
            'field_name' => 'comment',
            'uid' => $uid,
            'pid' => $pid,
            'subject' => $this->randomMachineName(),
            'comment_body' => $this->randomMachineName(),
            'status' => 1,
        ];
        if ($contact) {
            $values += $contact;
        }
        $comment = Comment::create($values);
        $comment->save();
        return $comment;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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 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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
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::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 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. 37
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::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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 Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
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::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentAttributesTest::$baseUri protected property URI of the front page of the Drupal site.
CommentAttributesTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentAttributesTest::$modules protected static property Modules to enable. Overrides CommentTestBase::$modules
CommentAttributesTest::$nodeUri protected property URI of the test node created by CommentTestBase::setUp().
CommentAttributesTest::saveComment public function Creates a comment entity.
CommentAttributesTest::setUp protected function Overrides CommentTestBase::setUp
CommentAttributesTest::testCommentRdfaMarkup public function Tests if RDFa markup for meta information is present in comments.
CommentAttributesTest::testCommentRdfAuthorMarkup public function Tests comment author link markup has not been broken by RDF.
CommentAttributesTest::testCommentReplyOfRdfaMarkup public function Tests RDF comment replies.
CommentAttributesTest::testNumberOfCommentsRdfaMarkup public function Tests the presence of the RDFa markup for the number of comments.
CommentAttributesTest::_testBasicCommentRdfaMarkup public function Helper function for testCommentRdfaMarkup().
CommentTestBase::$adminUser protected property An administrative user with permission to configure comment settings. 1
CommentTestBase::$node protected property A test node to which comments will be posted.
CommentTestBase::$webUser protected property A normal user with permission to post comments.
CommentTestBase::commentContactInfoAvailable public function Checks whether the commenter&#039;s contact information is displayed.
CommentTestBase::commentExists public function Checks current page for specified comment.
CommentTestBase::createCommentType protected function Creates a comment type (bundle).
CommentTestBase::deleteComment public function Deletes a comment.
CommentTestBase::getUnapprovedComment public function Gets the comment ID for an unapproved comment.
CommentTestBase::performCommentOperation public function Performs the specified operation on the specified comment.
CommentTestBase::postComment public function Posts a comment.
CommentTestBase::setCommentAnonymous public function Sets the value governing restrictions on anonymous comments.
CommentTestBase::setCommentForm public function Sets the value governing whether the comment form is on its own page.
CommentTestBase::setCommentPreview public function Sets the value governing the previewing mode for the comment form.
CommentTestBase::setCommentSettings public function Sets a comment settings variable for the article content type.
CommentTestBase::setCommentsPerPage public function Sets the value specifying the default number of comments per page.
CommentTestBase::setCommentSubject public function Sets the value governing whether the subject field should be enabled.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
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
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; 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. 1
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. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
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. 3
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. 1
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
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
RdfParsingTrait::getElementByRdfTypeCount protected function Counts the number of resources of the provided type.
RdfParsingTrait::getElementRdfType protected function Gets type of RDF Element.
RdfParsingTrait::getInstanceGraph private function Gets a new instance of EasyRdf\Graph or EasyRdf_Graph.
RdfParsingTrait::getInstanceParser private function Gets a new instance of EasyRdf\Parser\Rdfa or EasyRdf_Parser_Rdfa.
RdfParsingTrait::hasRdfChildProperty protected function Checks if a html document contains a resource with a given property value.
RdfParsingTrait::hasRdfProperty protected function Checks if a html document contains a resource with a given property value.
RdfParsingTrait::rdfElementIsBlankNode protected function Checks if RDF Node property is blank.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
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.
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. 1
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
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::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
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. 1
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 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
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 Deprecated 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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
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.

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