class SocialProfileFieldsSettingsForm in Open Social 8.9

Configure social profile settings.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\social_profile_fields\Form\SocialProfileFieldsSettingsForm implements ContainerInjectionInterface

1 string reference to 'SocialProfileFieldsSettingsForm'

social_profile_fields.routing.yml in modules/social_features/social_profile/modules/social_profile_fields/social_profile_fields.routing.yml

modules/social_features/social_profile/modules/social_profile_fields/social_profile_fields.routing.yml

File

modules/social_features/social_profile/modules/social_profile_fields/src/Form/SocialProfileFieldsSettingsForm.php, line 21

Namespace

Drupal\social_profile_fields\Form

class SocialProfileFieldsSettingsForm extends ConfigFormBase implements ContainerInjectionInterface {

  /**
   * Profile fields helper.
   *
   * @var \Drupal\social_profile_fields\SocialProfileFieldsHelper
   */
  protected $profileFieldsHelper;

  /**
   * The database.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * Cache tags invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidator
   */
  protected $cacheTagsInvalidator;

  /**
   * Module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandler
   */
  protected $moduleHandler;

  /**
   * Entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * SocialProfileSettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\social_profile_fields\SocialProfileFieldsHelper $profile_fields_helper
   *   Profile fields helper.
   * @param \Drupal\Core\Database\Connection $database
   *   Database connection for invalidating caches.
   * @param \Drupal\Core\Cache\CacheTagsInvalidator $cache_tags_invalidator
   *   Cache tags invalidator for clearing tags.
   * @param \Drupal\Core\Extension\ModuleHandler $module_handler
   *   Module handler for checking if modules exist.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity type manager for clearing cached definitions.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   Entity field manager for clearing cached field definitions.
   */
  public function __construct(ConfigFactoryInterface $config_factory, SocialProfileFieldsHelper $profile_fields_helper, Connection $database, CacheTagsInvalidator $cache_tags_invalidator, ModuleHandler $module_handler, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager) {
    parent::__construct($config_factory);
    $this->profileFieldsHelper = $profile_fields_helper;
    $this->database = $database;
    $this->cacheTagsInvalidator = $cache_tags_invalidator;
    $this->moduleHandler = $module_handler;
    $this->entityTypeManager = $entity_type_manager;
    $this->entityFieldManager = $entity_field_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('social_profile_fields.helper'), $container
      ->get('database'), $container
      ->get('cache_tags.invalidator'), $container
      ->get('module_handler'), $container
      ->get('entity_type.manager'), $container
      ->get('entity_field.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'social_profile_fields_admin_settings_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'social_profile_fields.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('social_profile_fields.settings');

    // Add an introduction text to explain what can be done here.
    $form['introduction']['description'] = [
      '#type' => 'html_tag',
      '#tag' => 'p',
      '#value' => $this
        ->t('Per profile type you can choose which fields you want to use. Users will not be able to edit or view fields that are deselected.'),
    ];
    $form['introduction']['warning'] = [
      '#type' => 'html_tag',
      '#tag' => 'p',
      '#value' => $this
        ->t('Be aware that data is <em>not removed</em>, and can possibly still be found through the search, until you flush the data.'),
    ];

    /** @var \Drupal\profile\Entity\ProfileType $profile_type */
    foreach (ProfileType::loadMultiple() as $profile_type) {
      $type = $profile_type
        ->id();
      $form[$type] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Settings for profiletype: @profile_type', [
          '@profile_type' => $type,
        ]),
        '#description' => $this
          ->t('Select the fields you want to use on this profile type.'),
        '#open' => TRUE,
      ];

      /** @var \Drupal\field\Entity\FieldConfig $field_config */
      foreach ($this->profileFieldsHelper
        ->getProfileFields($type) as $field) {

        // Loop through the fields.
        $id = $field['id'];

        // Hiding this field on the Open Social profile will make no difference,
        // let's skip it for now.
        if ($type === 'profile' && $id === 'profile_profile_field_profile_show_email') {
          continue;
        }

        // No setting is TRUE.
        $default_value = is_null($config
          ->get($id)) ? TRUE : $config
          ->get($id);
        $form[$type][$id] = [
          '#type' => 'checkbox',
          '#title' => $field['label'],
          '#description' => $field['name'],
          '#default_value' => $default_value,
        ];
        if ($type === 'profile' && $id === 'profile_profile_field_profile_address') {
          $form[$type]['profile_profile_field_profile_address_wrapper'][$id] = $form[$type][$id];
          unset($form[$type][$id]);
          $form[$type]['profile_profile_field_profile_address_wrapper']['address_settings'] = [
            '#type' => 'details',
            '#title' => $this
              ->t('Individual address field settings'),
            '#open' => TRUE,
            '#states' => [
              'visible' => [
                ':input[name="' . $id . '"]' => [
                  'checked' => TRUE,
                ],
              ],
            ],
          ];
          $form[$type]['profile_profile_field_profile_address_wrapper']['address_settings']['profile_address_field_country'] = [
            '#type' => 'html_tag',
            '#tag' => 'p',
            '#value' => $this
              ->t('You can hide individual address fields, with the exception of the country field. <br/>
            Disable the country field by disabling the whole address, using the checkbox <em>field_profile_address</em>.'),
          ];
          $form[$type]['profile_profile_field_profile_address_wrapper']['address_settings']['profile_address_field_city'] = [
            '#type' => 'checkbox',
            '#title' => $this
              ->t('City'),
            '#default_value' => is_null($config
              ->get('profile_address_field_city')) ? TRUE : $config
              ->get('profile_address_field_city'),
          ];
          $form[$type]['profile_profile_field_profile_address_wrapper']['address_settings']['profile_address_field_address'] = [
            '#type' => 'checkbox',
            '#title' => $this
              ->t('Address'),
            '#default_value' => is_null($config
              ->get('profile_address_field_address')) ? TRUE : $config
              ->get('profile_address_field_address'),
          ];
          $form[$type]['profile_profile_field_profile_address_wrapper']['address_settings']['profile_address_field_postalcode'] = [
            '#type' => 'checkbox',
            '#title' => $this
              ->t('Postal code'),
            '#default_value' => is_null($config
              ->get('profile_address_field_postalcode')) ? TRUE : $config
              ->get('profile_address_field_postalcode'),
          ];
        }
      }
    }
    $form['nickname_unique_validation'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Unique nicknames'),
      '#description' => $this
        ->t('If you check this, validation is applied that verifies the users nickname is unique whenever they save their profile.'),
      '#default_value' => $config
        ->get('nickname_unique_validation'),
    ];
    $form['actions']['social_profile_fields_confirm_flush'] = [
      '#type' => 'submit',
      '#submit' => [
        '::submitFlush',
      ],
      '#value' => $this
        ->t('Flush profile data'),
      '#weight' => 5,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Save config.
    $config = $this
      ->config('social_profile_fields.settings');

    /** @var \Drupal\profile\Entity\ProfileType $profile_type */
    foreach (ProfileType::loadMultiple() as $profile_type) {
      $type = $profile_type
        ->id();

      /** @var \Drupal\field\Entity\FieldConfig $field_config */
      foreach ($this->profileFieldsHelper
        ->getProfileFields($type) as $field) {
        $config
          ->set($field['id'], $form_state
          ->getValue($field['id']));
      }
    }
    $main_address_value = $form_state
      ->getValue('profile_profile_field_profile_address');
    $config
      ->set('profile_address_field_city', $main_address_value ? $form_state
      ->getValue('profile_address_field_city') : FALSE);
    $config
      ->set('profile_address_field_address', $main_address_value ? $form_state
      ->getValue('profile_address_field_address') : FALSE);
    $config
      ->set('profile_address_field_postalcode', $main_address_value ? $form_state
      ->getValue('profile_address_field_postalcode') : FALSE);
    $config
      ->set('nickname_unique_validation', $form_state
      ->getValue('nickname_unique_validation'));
    $config
      ->save();
    parent::submitForm($form, $form_state);

    // Invalidate profile cache tags.
    $query = $this->database
      ->select('profile', 'p');
    $query
      ->addField('p', 'profile_id');
    $query
      ->condition('p.type', 'profile');
    $query
      ->condition('p.status', 1);
    $ids = $query
      ->execute()
      ->fetchCol();
    $cache_tags = [
      'profile',
      'profile_list',
      'profile_view',
    ];
    if (!empty($ids)) {
      foreach ($ids as $id) {
        $cache_tags[] = 'profile:' . $id;
      }
    }
    $this->cacheTagsInvalidator
      ->invalidateTags($cache_tags);

    // Clear the entity type manager cached definitions as the nick name unique
    // validation might now need to be applied.
    // @see social_profile_fields_entity_bundle_field_info_alter().
    $this->entityTypeManager
      ->clearCachedDefinitions();

    // Clear the entity field manager cached field definitions as the address
    // field overrides settings need to be applied.
    // @see social_profile_fields_entity_bundle_field_info_alter().
    $this->entityFieldManager
      ->clearCachedFieldDefinitions();

    // If the user export module is on, clear the cached definitions.
    if ($this->moduleHandler
      ->moduleExists('social_user_export')) {
      $user_export_manager = \Drupal::service('plugin.manager.user_export_plugin');
      $user_export_manager
        ->clearCachedDefinitions();
    }
  }

  /**
   * Redirects to confirmation form for the flush action.
   */
  public function submitFlush(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('social_profile_fields.flush');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
SocialProfileFieldsSettingsForm::$cacheTagsInvalidator	protected	property	Cache tags invalidator.
SocialProfileFieldsSettingsForm::$database	protected	property	The database.
SocialProfileFieldsSettingsForm::$entityFieldManager	protected	property	Entity field manager.
SocialProfileFieldsSettingsForm::$entityTypeManager	protected	property	Entity type manager.
SocialProfileFieldsSettingsForm::$moduleHandler	protected	property	Module handler.
SocialProfileFieldsSettingsForm::$profileFieldsHelper	protected	property	Profile fields helper.
SocialProfileFieldsSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SocialProfileFieldsSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SocialProfileFieldsSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SocialProfileFieldsSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SocialProfileFieldsSettingsForm::submitFlush	public	function	Redirects to confirmation form for the flush action.
SocialProfileFieldsSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
SocialProfileFieldsSettingsForm::__construct	public	function	SocialProfileSettingsForm constructor. Overrides ConfigFormBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.