UserCacheTagsTest.php

Same filename and directory in other branches
  1. 8.9.x core/modules/user/tests/src/Functional/UserCacheTagsTest.php
  2. 10 core/modules/user/tests/src/Functional/UserCacheTagsTest.php
  3. 11.x core/modules/user/tests/src/Functional/UserCacheTagsTest.php

Namespace

Drupal\Tests\user\Functional

File

core/modules/user/tests/src/Functional/UserCacheTagsTest.php

View source
<?php

namespace Drupal\Tests\user\Functional;

use Drupal\Tests\system\Functional\Entity\EntityWithUriCacheTagsTestBase;
use Drupal\user\Entity\Role;
use Drupal\user\Entity\User;
use Drupal\user\RoleInterface;

/**
 * Tests the User entity's cache tags.
 *
 * @group user
 */
class UserCacheTagsTest extends EntityWithUriCacheTagsTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'user',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Give anonymous users permission to view user profiles, so that we can
        // verify the cache tags of cached versions of user profile pages.
        $user_role = Role::load(RoleInterface::ANONYMOUS_ID);
        $user_role->grantPermission('access user profiles');
        $user_role->save();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function createEntity() {
        // Create a "Llama" user.
        $user = User::create([
            'name' => 'Llama',
            'status' => TRUE,
        ]);
        $user->save();
        return $user;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getAdditionalCacheTagsForEntityListing() {
        return [
            'user:0',
            'user:1',
        ];
    }

}

Classes

Title Deprecated Summary
UserCacheTagsTest Tests the User entity's cache tags.

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