You are here

interface SocialProfilePrivacyHelperInterface in Open Social 10.3.x

Same name and namespace in other branches
  1. 10.0.x modules/social_features/social_profile/modules/social_profile_privacy/src/Service/SocialProfilePrivacyHelperInterface.php \Drupal\social_profile_privacy\Service\SocialProfilePrivacyHelperInterface
  2. 10.1.x modules/social_features/social_profile/modules/social_profile_privacy/src/Service/SocialProfilePrivacyHelperInterface.php \Drupal\social_profile_privacy\Service\SocialProfilePrivacyHelperInterface
  3. 10.2.x modules/social_features/social_profile/modules/social_profile_privacy/src/Service/SocialProfilePrivacyHelperInterface.php \Drupal\social_profile_privacy\Service\SocialProfilePrivacyHelperInterface

Defines the helper service interface.

@package Drupal\social_profile_privacy\Service

Hierarchy

Expanded class hierarchy of SocialProfilePrivacyHelperInterface

All classes that implement SocialProfilePrivacyHelperInterface

2 files declare their use of SocialProfilePrivacyHelperInterface
social_profile_privacy.install in modules/social_features/social_profile/modules/social_profile_privacy/social_profile_privacy.install
The social profile privacy install file.
social_profile_privacy.module in modules/social_features/social_profile/modules/social_profile_privacy/social_profile_privacy.module
The Social profile privacy module file.

File

modules/social_features/social_profile/modules/social_profile_privacy/src/Service/SocialProfilePrivacyHelperInterface.php, line 12

Namespace

Drupal\social_profile_privacy\Service
View source
interface SocialProfilePrivacyHelperInterface {

  /**
   * Always show profile field for everyone.
   */
  const SHOW = 0;

  /**
   * Show profile field, but it can be hidden by a user.
   */
  const CONFIGURABLE = 1;

  /**
   * Hide profile field for everyone.
   */
  const HIDE = 2;

  /**
   * Returns field settings of a user profile.
   *
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   (optional) The user session for which to check access, or NULL to check
   *   access for the current user. Defaults to NULL.
   *
   * @return array
   *   The array of field labels and accesses, keyed by field name.
   */
  public function getFieldOptions(AccountInterface $account = NULL);

}

Members

Namesort descending Modifiers Type Description Overrides
SocialProfilePrivacyHelperInterface::CONFIGURABLE constant Show profile field, but it can be hidden by a user.
SocialProfilePrivacyHelperInterface::getFieldOptions public function Returns field settings of a user profile. 1
SocialProfilePrivacyHelperInterface::HIDE constant Hide profile field for everyone.
SocialProfilePrivacyHelperInterface::SHOW constant Always show profile field for everyone.