Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #3480442 by mstrelan, alexpott, smustgrave: Add return types to UserCreationTrait

merge-requests/10240/head
catch 2024-11-15 09:56:01 +00:00
parent 69df78a3e7
commit aaff5b55ca
3 changed files with 10 additions and 1373 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1350
core/.phpstan-baseline.php
View File

File diff suppressed because it is too large Load Diff

16
core/modules/system/tests/src/Functional/Entity/EntityOperationsTest.php
View File

@ -4,7 +4,6 @@ declare(strict_types=1);
namespace Drupal\Tests\system\Functional\Entity;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Tests\BrowserTestBase;
use Drupal\user\Entity\Role;
@ -46,21 +45,8 @@ class EntityOperationsTest extends BrowserTestBase {
$roles = Role::loadMultiple();
foreach ($roles as $role) {
$this->assertSession()->linkByHrefExists($role->toUrl()->toString() . '/test_operation');
$this->assertSession()->linkExists(new FormattableMarkup('Test Operation: @label', ['@label' => $role->label()]));
$this->assertSession()->linkExists('Test Operation: ' . $role->label());
}
}
/**
* {@inheritdoc}
*/
protected function createRole(array $permissions, $rid = NULL, $name = NULL, $weight = NULL) {
// The parent method uses random strings by default, which may include HTML
// entities for the entity label. Since in this test the entity label is
// used to generate a link, and AssertContentTrait::assertLink() is not
// designed to deal with links potentially containing HTML entities this
// causes random failures. Use a random HTML safe string instead.
$name = $name ?: $this->randomMachineName();
return parent::createRole($permissions, $rid, $name, $weight);
}
}

17
core/modules/user/tests/src/Traits/UserCreationTrait.php
View File

@ -11,6 +11,7 @@ use Drupal\KernelTests\KernelTestBase;
use Drupal\user\Entity\Role;
use Drupal\user\Entity\User;
use Drupal\user\RoleInterface;
use Drupal\user\UserInterface;
/**
* Provides test methods for user creation and authentication.
@ -45,7 +46,7 @@ trait UserCreationTrait {
* @throws \Drupal\Core\Entity\EntityStorageException
* If the user could not be saved.
*/
protected function setUpCurrentUser(array $values = [], array $permissions = [], $admin = FALSE) {
protected function setUpCurrentUser(array $values = [], array $permissions = [], $admin = FALSE): UserInterface {
$values += [
'name' => $this->randomMachineName(),
];
@ -124,7 +125,7 @@ trait UserCreationTrait {
* @param \Drupal\Core\Session\AccountInterface $account
* The user account object.
*/
protected function setCurrentUser(AccountInterface $account) {
protected function setCurrentUser(AccountInterface $account): void {
\Drupal::currentUser()->setAccount($account);
}
@ -149,7 +150,7 @@ trait UserCreationTrait {
* @throws \Drupal\Core\Entity\EntityStorageException
* If the user creation fails.
*/
protected function createUser(array $permissions = [], $name = NULL, $admin = FALSE, array $values = []) {
protected function createUser(array $permissions = [], $name = NULL, $admin = FALSE, array $values = []): UserInterface|false {
// Create a role with the given permission set, if any.
$rid = FALSE;
if ($permissions) {
@ -207,10 +208,10 @@ trait UserCreationTrait {
* (optional) The weight for the role. Defaults to NULL which sets the
* weight to maximum + 1.
*
* @return string
* @return string|false
* Role ID of newly created role, or FALSE if role creation failed.
*/
protected function createAdminRole($rid = NULL, $name = NULL, $weight = NULL) {
protected function createAdminRole($rid = NULL, $name = NULL, $weight = NULL): string|false {
$rid = $this->createRole([], $rid, $name, $weight);
if ($rid) {
/** @var \Drupal\user\RoleInterface $role */
@ -234,10 +235,10 @@ trait UserCreationTrait {
* (optional) The weight for the role. Defaults to NULL which sets the
* weight to maximum + 1.
*
* @return string
* @return string|false
* Role ID of newly created role, or FALSE if role creation failed.
*/
protected function createRole(array $permissions, $rid = NULL, $name = NULL, $weight = NULL) {
protected function createRole(array $permissions, $rid = NULL, $name = NULL, $weight = NULL): string|false {
// Generate a random, lowercase machine name if none was passed.
if (!isset($rid)) {
$rid = $this->randomMachineName(8);
@ -310,7 +311,7 @@ trait UserCreationTrait {
* @param array $permissions
* (optional) A list of permission names to grant.
*/
protected function grantPermissions(RoleInterface $role, array $permissions) {
protected function grantPermissions(RoleInterface $role, array $permissions): void {
foreach ($permissions as $permission) {
$role->grantPermission($permission);
}