diff --git a/profile.module b/profile.module index 089d178..2d481a3 100644 --- a/profile.module +++ b/profile.module @@ -133,12 +133,12 @@ function profile_entity_extra_field_info() { // automatically to other view modes. /** @var \Drupal\profile\Entity\ProfileType $bundle */ foreach (ProfileType::loadMultiple() as $bundle) { - $extra['user']['user']['display']['profile_' . $bundle->id()] = array( + $extra['user']['user']['display']['profile_' . $bundle->id()] = [ 'label' => $bundle->label(), 'description' => t('Display @type profiles', ['@type' => $bundle->label()]), 'weight' => 10, 'visible' => FALSE, - ); + ]; } return $extra; } @@ -180,7 +180,7 @@ function profile_form_field_config_edit_form_alter(&$form, FormStateInterface $f * * @param array $form * The form array. - * @param FormStateInterface $form_state + * @param \Drupal\Core\Form\FormStateInterface $form_state * The form state. */ function profile_form_field_config_edit_form_submit(array $form, FormStateInterface $form_state) { @@ -207,7 +207,7 @@ function profile_form_user_register_form_alter(&$form, FormStateInterface $form_ $attached_profile_form = FALSE; $weight = 90; - /** @var ProfileType[] $profile_types */ + /** @var \Drupal\profile\Entity\ProfileType[] $profile_types */ $profile_types = ProfileType::loadMultiple(); foreach ($profile_types as $profile_type) { $instances = array_filter(\Drupal::service('entity_field.manager')->getFieldDefinitions('profile', $profile_type->id()), function ($field_definition) { @@ -221,7 +221,7 @@ function profile_form_user_register_form_alter(&$form, FormStateInterface $form_ $profile = Profile::create([ 'type' => $profile_type->id(), 'langcode' => $profile_type->language() ? - $profile_type->language() : \Drupal::languageManager()->getDefaultLanguage()->getId(), + $profile_type->language() : \Drupal::languageManager()->getDefaultLanguage()->getId(), ]); // Attach profile entity form. @@ -288,11 +288,14 @@ function profile_form_user_register_form_submit(array &$form, FormStateInterface /** * Pre render callback for profile embedded views to ensure a title is set. - * @param $element * - * @return mixed + * @param array $element + * The element. + * + * @return array + * The element. */ -function profile_views_add_title_pre_render($element) { +function profile_views_add_title_pre_render(array $element) { /** @var \Drupal\views\ViewExecutable $view */ if (isset($element['#title'])) { $view = $element['view_build']['#view']; diff --git a/src/Controller/ProfileController.php b/src/Controller/ProfileController.php index ed50c80..d9b5661 100644 --- a/src/Controller/ProfileController.php +++ b/src/Controller/ProfileController.php @@ -100,14 +100,14 @@ class ProfileController extends ControllerBase implements ContainerInjectionInte * The profile type entity for the profile. * * @return array - * Returns form array. + * Returns form array. */ public function userProfileForm(RouteMatchInterface $route_match, UserInterface $user, ProfileTypeInterface $profile_type) { /** @var \Drupal\profile\Entity\ProfileType $profile_type */ /** @var \Drupal\profile\Entity\ProfileInterface|bool $active_profile */ $active_profile = $this->entityTypeManager()->getStorage('profile') - ->loadByUser($user, $profile_type->id()); + ->loadByUser($user, $profile_type->id()); // If the profile type does not support multiple, only display an add form // if there are no entities, or an edit for the current. diff --git a/src/Entity/Profile.php b/src/Entity/Profile.php index 01193b4..bc8e097 100644 --- a/src/Entity/Profile.php +++ b/src/Entity/Profile.php @@ -13,7 +13,6 @@ use Drupal\profile\Event\ProfileEvents; use Drupal\profile\Event\ProfileLabelEvent; use Drupal\user\UserInterface; - /** * Defines the profile entity class. * diff --git a/src/Entity/ProfileType.php b/src/Entity/ProfileType.php index b8da364..4e1b1ff 100644 --- a/src/Entity/ProfileType.php +++ b/src/Entity/ProfileType.php @@ -3,7 +3,6 @@ namespace Drupal\profile\Entity; use Drupal\Core\Config\Entity\ConfigEntityBundleBase; -use Drupal\Core\Entity\EntityStorageInterface; /** * Defines the profile type entity class. @@ -54,7 +53,7 @@ class ProfileType extends ConfigEntityBundleBase implements ProfileTypeInterface /** * The primary identifier of the profile type. * - * @var integer + * @var int */ protected $id; @@ -75,14 +74,14 @@ class ProfileType extends ConfigEntityBundleBase implements ProfileTypeInterface /** * Whether the profile type is shown during registration. * - * @var boolean + * @var bool */ protected $registration = FALSE; /** * Whether the profile type allows multiple profiles. * - * @var boolean + * @var bool */ protected $multiple = FALSE; @@ -96,7 +95,7 @@ class ProfileType extends ConfigEntityBundleBase implements ProfileTypeInterface /** * The weight of the profile type compared to others. * - * @var integer + * @var int */ protected $weight = 0; @@ -160,16 +159,4 @@ class ProfileType extends ConfigEntityBundleBase implements ProfileTypeInterface return $this; } - /** - * {@inheritdoc} - */ - public function postSave(EntityStorageInterface $storage, $update = TRUE) { - parent::postSave($storage, $update); - - // Rebuild module data to generate bundle permissions and link tasks. - if (!$update) { - system_rebuild_module_data(); - } - } - } diff --git a/src/Entity/ProfileTypeInterface.php b/src/Entity/ProfileTypeInterface.php index d831ddc..310e8ac 100644 --- a/src/Entity/ProfileTypeInterface.php +++ b/src/Entity/ProfileTypeInterface.php @@ -50,7 +50,7 @@ interface ProfileTypeInterface extends ConfigEntityInterface { * * @return $this */ - public function setRoles($roles); + public function setRoles(array $roles); /** * Returns the profile type's weight. diff --git a/src/Form/ProfileDeleteForm.php b/src/Form/ProfileDeleteForm.php index 79d4ec5..9d4dc27 100644 --- a/src/Form/ProfileDeleteForm.php +++ b/src/Form/ProfileDeleteForm.php @@ -3,7 +3,6 @@ namespace Drupal\profile\Form; use Drupal\Core\Entity\ContentEntityDeleteForm; -use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Url; /** diff --git a/src/Form/ProfileForm.php b/src/Form/ProfileForm.php index fe867cd..3047278 100644 --- a/src/Form/ProfileForm.php +++ b/src/Form/ProfileForm.php @@ -21,7 +21,7 @@ class ProfileForm extends ContentEntityForm { // Display a "make default" button if: // - this is an active profile and // - this is not the default profile. - if ($profile->isActive() && !$profile->isDefault()){ + if ($profile->isActive() && !$profile->isDefault()) { // Add a "make default" button. $element['set_default'] = $element['submit']; $element['set_default']['#value'] = $this->t('Save and make default'); diff --git a/src/Form/ProfileTypeDeleteForm.php b/src/Form/ProfileTypeDeleteForm.php index 5d1def1..83055ae 100644 --- a/src/Form/ProfileTypeDeleteForm.php +++ b/src/Form/ProfileTypeDeleteForm.php @@ -23,7 +23,7 @@ class ProfileTypeDeleteForm extends EntityDeleteForm { * Constructs a new ProductTypeDeleteForm object. * * @param \Drupal\Core\Entity\Query\QueryFactory $query_factory - * The entity query object. + * The entity query object. */ public function __construct(QueryFactory $query_factory) { $this->queryFactory = $query_factory; @@ -48,7 +48,7 @@ class ProfileTypeDeleteForm extends EntityDeleteForm { ->execute(); if ($num_profiles) { $caption = '

' . \Drupal::translation() - ->formatPlural($num_profiles, '%type is used by 1 profile on your site. You can not remove this profile type until you have removed all of the %type profiles.', '%type is used by @count profiles on your site. You may not remove %type until you have removed all of the %type profiles.', ['%type' => $this->entity->label()]) . '

'; + ->formatPlural($num_profiles, '%type is used by 1 profile on your site. You can not remove this profile type until you have removed all of the %type profiles.', '%type is used by @count profiles on your site. You may not remove %type until you have removed all of the %type profiles.', ['%type' => $this->entity->label()]) . '

'; $form['#title'] = $this->entity->label(); $form['description'] = ['#markup' => $caption]; return $form; diff --git a/src/Form/ProfileTypeForm.php b/src/Form/ProfileTypeForm.php index 89696fe..f6ad660 100644 --- a/src/Form/ProfileTypeForm.php +++ b/src/Form/ProfileTypeForm.php @@ -8,7 +8,6 @@ use Drupal\Core\Form\FormStateInterface; use Drupal\field_ui\FieldUI; use Drupal\user\Entity\Role; - /** * Form controller for profile type forms. */ @@ -108,7 +107,7 @@ class ProfileTypeForm extends BundleEntityFormBase { /** * Form submission handler to redirect to Manage fields page of Field UI. */ - public function redirectToFieldUI(array $form, FormStateInterface $form_state) { + public function redirectToFieldUi(array $form, FormStateInterface $form_state) { if ($form_state->getTriggeringElement()['#parents'][0] === 'save_continue' && $route_info = FieldUI::getOverviewRouteInfo('profile', $this->entity->id())) { $form_state->setRedirectUrl($route_info); } diff --git a/src/Plugin/EntityReferenceSelection/ProfileSelection.php b/src/Plugin/EntityReferenceSelection/ProfileSelection.php index 55c5b64..a3e4bca 100644 --- a/src/Plugin/EntityReferenceSelection/ProfileSelection.php +++ b/src/Plugin/EntityReferenceSelection/ProfileSelection.php @@ -26,4 +26,5 @@ class ProfileSelection extends DefaultSelection { $form['target_bundles']['#title'] = $this->t('Profile types'); return $form; } + } diff --git a/src/ProfileAccessControlHandler.php b/src/ProfileAccessControlHandler.php index b26d3e2..8c4eac4 100644 --- a/src/ProfileAccessControlHandler.php +++ b/src/ProfileAccessControlHandler.php @@ -3,7 +3,6 @@ namespace Drupal\profile; use Drupal\Core\Access\AccessResult; -use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Session\AccountInterface; use Drupal\entity\EntityAccessControlHandler as EntityApiAccessControlHandler; use Drupal\profile\Entity\ProfileType; diff --git a/src/ProfilePermissions.php b/src/ProfilePermissions.php index 22d8725..e979fde 100644 --- a/src/ProfilePermissions.php +++ b/src/ProfilePermissions.php @@ -16,7 +16,7 @@ class ProfilePermissions { * Returns an array of profile type permissions. * * @return array - * Returns an array of permissions. + * Returns an array of permissions. */ public function profileTypePermissions() { $perms = []; diff --git a/src/ProfileStorage.php b/src/ProfileStorage.php index fadef58..4ae10cf 100644 --- a/src/ProfileStorage.php +++ b/src/ProfileStorage.php @@ -28,10 +28,10 @@ class ProfileStorage extends SqlContentEntityStorage implements ProfileStorageIn */ public function loadMultipleByUser(AccountInterface $account, $profile_type, $active = TRUE) { return $this->loadByProperties([ - 'uid' => $account->id(), - 'type' => $profile_type, - 'status' => $active, - ]); + 'uid' => $account->id(), + 'type' => $profile_type, + 'status' => $active, + ]); } /** diff --git a/src/ProfileStorageInterface.php b/src/ProfileStorageInterface.php index 18bea72..47f72b0 100644 --- a/src/ProfileStorageInterface.php +++ b/src/ProfileStorageInterface.php @@ -14,14 +14,14 @@ interface ProfileStorageInterface extends EntityStorageInterface { * Loads the given user's profile. * * @param \Drupal\Core\Session\AccountInterface $account - * The user entity. + * The user entity. * @param string $profile_type - * The profile type. + * The profile type. * @param bool $active - * Boolean representing if profile active or not. + * Boolean representing if profile active or not. * * @return \Drupal\profile\Entity\ProfileInterface - * The loaded profile entity. + * The loaded profile entity. */ public function loadByUser(AccountInterface $account, $profile_type, $active); @@ -29,14 +29,14 @@ interface ProfileStorageInterface extends EntityStorageInterface { * Loads the given user's profiles. * * @param \Drupal\Core\Session\AccountInterface $account - * The user entity. + * The user entity. * @param string $profile_type - * The profile type. + * The profile type. * @param bool $active - * Boolean representing if profile active or not. + * Boolean representing if profile active or not. * * @return \Drupal\profile\Entity\ProfileInterface[] - * An array of loaded profile entities. + * An array of loaded profile entities. */ public function loadMultipleByUser(AccountInterface $account, $profile_type, $active); @@ -44,12 +44,12 @@ interface ProfileStorageInterface extends EntityStorageInterface { * Loads the default user profile. * * @param \Drupal\Core\Session\AccountInterface $account - * The user entity. + * The user entity. * @param string $profile_type - * The profile type. + * The profile type. * * @return \Drupal\profile\Entity\ProfileInterface - * An array of loaded profile entities. + * An array of loaded profile entities. */ public function loadDefaultByUser(AccountInterface $account, $profile_type); diff --git a/src/ProfileTestTrait.php b/src/ProfileTestTrait.php index ff87c0c..af39329 100644 --- a/src/ProfileTestTrait.php +++ b/src/ProfileTestTrait.php @@ -29,7 +29,7 @@ trait ProfileTestTrait { * @return \Drupal\profile\Entity\ProfileTypeInterface * Returns a profile type entity. */ - protected function createProfileType($id = NULL, $label = NULL, $registration = FALSE, $roles = []) { + protected function createProfileType($id = NULL, $label = NULL, $registration = FALSE, array $roles = []) { $id = !empty($id) ? $id : $this->randomMachineName(); $label = !empty($label) ? $label : $this->randomMachineName(); diff --git a/tests/src/Functional/ProfileDefaultTest.php b/tests/src/Functional/ProfileDefaultTest.php index 169e471..f4e095b 100644 --- a/tests/src/Functional/ProfileDefaultTest.php +++ b/tests/src/Functional/ProfileDefaultTest.php @@ -22,7 +22,7 @@ class ProfileDefaultTest extends ProfileTestBase { /** * Testing demo user 2. * - * @var \Drupal\user\UserInterface; + * @var \Drupal\user\UserInterface */ public $user2; diff --git a/tests/src/Functional/ProfileFieldAccessTest.php b/tests/src/Functional/ProfileFieldAccessTest.php index ca9053f..a354aed 100644 --- a/tests/src/Functional/ProfileFieldAccessTest.php +++ b/tests/src/Functional/ProfileFieldAccessTest.php @@ -1,6 +1,7 @@ ['label' => $this->randomMachineName()], ]; - /** @var ProfileType[] $types */ + /** @var \Drupal\profile\Entity\ProfileType[] $types */ $types = []; foreach ($types_data as $id => $values) { $types[$id] = ProfileType::create(['id' => $id] + $values); diff --git a/tests/src/Functional/ProfileTestBase.php b/tests/src/Functional/ProfileTestBase.php index ef22f76..bda6b4d 100644 --- a/tests/src/Functional/ProfileTestBase.php +++ b/tests/src/Functional/ProfileTestBase.php @@ -8,7 +8,6 @@ use Drupal\Core\Session\AccountInterface; use Drupal\field\Entity\FieldConfig; use Drupal\field\Entity\FieldStorageConfig; use Drupal\profile\ProfileTestTrait; -use Drupal\simpletest\WebTestBase; use Drupal\Tests\BrowserTestBase; /** @@ -30,14 +29,14 @@ abstract class ProfileTestBase extends BrowserTestBase { /** * Testing profile type entity view display. * - * @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display + * @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface */ protected $display; /** * Testing profile type entity form display. * - * @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $form + * @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface */ protected $form; diff --git a/tests/src/Functional/ProfileTypeCRUDTest.php b/tests/src/Functional/ProfileTypeTest.php similarity index 96% rename from tests/src/Functional/ProfileTypeCRUDTest.php rename to tests/src/Functional/ProfileTypeTest.php index 149032e..4b9625f 100644 --- a/tests/src/Functional/ProfileTypeCRUDTest.php +++ b/tests/src/Functional/ProfileTypeTest.php @@ -10,7 +10,7 @@ use Drupal\Component\Utility\Unicode; * * @group profile */ -class ProfileTypeCRUDTest extends ProfileTestBase { +class ProfileTypeTest extends ProfileTestBase { /** * {@inheritdoc} @@ -40,7 +40,7 @@ class ProfileTypeCRUDTest extends ProfileTestBase { /** * Tests CRUD operations for profile types through the UI. */ - public function testCRUDUI() { + public function testUi() { $this->drupalLogin($this->adminUser); // Create a new profile type. diff --git a/tests/src/Kernel/ProfileAccessTest.php b/tests/src/Kernel/ProfileAccessTest.php index 5fb48c9..961f7d0 100644 --- a/tests/src/Kernel/ProfileAccessTest.php +++ b/tests/src/Kernel/ProfileAccessTest.php @@ -2,7 +2,6 @@ namespace Drupal\Tests\profile\Kernel; -use Drupal\Component\Utility\SafeMarkup; use Drupal\Core\Session\AccountInterface; use Drupal\KernelTests\Core\Entity\EntityKernelTestBase; use Drupal\profile\Entity\Profile; @@ -84,7 +83,6 @@ class ProfileAccessTest extends EntityKernelTestBase { $web_user1 )); - // Test user with permission to only add a profile. $web_user2 = $this->createUser([], ["create {$this->type->id()} profile"]); $web_user1->addRole($web_user2->get('roles')->first()->target_id); @@ -172,7 +170,7 @@ class ProfileAccessTest extends EntityKernelTestBase { $this->assertFalse($profile2->access('view', User::getAnonymousUser())); // @todo Fix in https://www.drupal.org/node/2820209 - // user_role_grant_permissions(AccountInterface::ANONYMOUS_ROLE, ["view any {$this->type->id()} profile"]); + user_role_grant_permissions(AccountInterface::ANONYMOUS_ROLE, ["view any {$this->type->id()} profile"]); // $this->assertTrue($profile1->access('view', User::getAnonymousUser())); // $this->assertTrue($profile2->access('view', User::getAnonymousUser())); } diff --git a/tests/src/Kernel/ProfileRoleAccessTest.php b/tests/src/Kernel/ProfileRoleAccessTest.php index f9c6b7c..6cc6b3f 100644 --- a/tests/src/Kernel/ProfileRoleAccessTest.php +++ b/tests/src/Kernel/ProfileRoleAccessTest.php @@ -69,6 +69,8 @@ class ProfileRoleAccessTest extends EntityKernelTestBase { protected $role2; /** + * The profile access handler. + * * @var \Drupal\profile\ProfileAccessControlHandler */ protected $accessHandler; @@ -93,7 +95,7 @@ class ProfileRoleAccessTest extends EntityKernelTestBase { $this->type2 = $this->createProfileType(NULL, NULL, FALSE, [$this->role2->id()]); $this->type3 = $this->createProfileType(NULL, NULL, FALSE, [ $this->role1->id(), - $this->role2->id() + $this->role2->id(), ]); $this->accessHandler = $this->container->get('entity_type.manager') @@ -104,8 +106,7 @@ class ProfileRoleAccessTest extends EntityKernelTestBase { } /** - * Tests add profile form access for a profile type that does not require - * users to have a role. + * Tests add profile form access for type that does not limit roles. */ public function testProfileWithNoRoles() { // Create user with add profile permissions. @@ -113,6 +114,9 @@ class ProfileRoleAccessTest extends EntityKernelTestBase { $this->assertTrue($this->accessHandler->createAccess($this->type1->id(), $web_user1)); } + /** + * Test add profile form access for type with locked roles. + */ public function testLockedRoles() { $locked_role_type = $this->createProfileType(NULL, NULL, FALSE, [AccountInterface::AUTHENTICATED_ROLE]); // Create user with add profile permissions. @@ -121,8 +125,7 @@ class ProfileRoleAccessTest extends EntityKernelTestBase { } /** - * Tests add profile form access for a profile type that requires users to - * have a single role. + * Tests add profile form access for type that has single custom role. */ public function testProfileWithSingleRole() { // Create user with add own profile permissions. @@ -153,8 +156,7 @@ class ProfileRoleAccessTest extends EntityKernelTestBase { } /** - * Tests add profile form access for a profile type that requires users to - * have one of multiple roles. + * Tests add profile form access for type that requires multiple roles. */ public function testProfileWithAllRoles() { // Create user with add own profile permissions. diff --git a/tests/src/Kernel/ProfileTest.php b/tests/src/Kernel/ProfileTest.php index 0fc2237..0c60edf 100644 --- a/tests/src/Kernel/ProfileTest.php +++ b/tests/src/Kernel/ProfileTest.php @@ -6,7 +6,6 @@ use Drupal\Core\StringTranslation\TranslatableMarkup; use Drupal\KernelTests\Core\Entity\EntityKernelTestBase; use Drupal\profile\Entity\Profile; use Drupal\profile\Entity\ProfileType; -use Drupal\profile\ProfileTestTrait; /** * Tests basic functionality of profiles. @@ -36,7 +35,7 @@ class ProfileTest extends EntityKernelTestBase { /** * Testing demo user 2. * - * @var \Drupal\user\UserInterface; + * @var \Drupal\user\UserInterface */ public $user2; diff --git a/tests/src/Kernel/ProfileViewTest.php b/tests/src/Kernel/ProfileViewTest.php index e820b08..6324242 100644 --- a/tests/src/Kernel/ProfileViewTest.php +++ b/tests/src/Kernel/ProfileViewTest.php @@ -29,6 +29,9 @@ class ProfileViewTest extends ViewsKernelTestBase { 'users', ]; + /** + * {@inheritdoc} + */ protected function setUp($import_test_views = TRUE) { parent::setUp($import_test_views);