class SocialProfileFieldsOverride in Open Social 8.5

Class SocialProfileFieldsConfigOverride.

Override profile form.

@package Drupal\social_profile_fields

Hierarchy

• class \Drupal\social_profile_fields\SocialProfileFieldsOverride implements ConfigFactoryOverrideInterface

2 string references to 'SocialProfileFieldsOverride'

SocialProfileFieldsOverride::getCacheSuffix in modules/social_features/social_profile/modules/social_profile_fields/src/SocialProfileFieldsOverride.php

The string to append to the configuration static cache name.

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

modules/social_features/social_profile/modules/social_profile_fields/social_profile_fields.services.yml

1 service uses SocialProfileFieldsOverride

social_profile_fields.overrider in modules/social_features/social_profile/modules/social_profile_fields/social_profile_fields.services.yml

\Drupal\social_profile_fields\SocialProfileFieldsOverride

File

modules/social_features/social_profile/modules/social_profile_fields/src/SocialProfileFieldsOverride.php, line 16

Namespace

Drupal\social_profile_fields

class SocialProfileFieldsOverride implements ConfigFactoryOverrideInterface {

  /**
   * Returns config overrides.
   */
  public function loadOverrides($names) {
    $overrides = [];
    $config_factory = \Drupal::service('config.factory');

    // Add field_group and field_comment_files.
    $config_name = 'core.entity_form_display.profile.profile.default';
    if (in_array($config_name, $names)) {
      $config = $config_factory
        ->getEditable($config_name);

      // Add the nick name field to the profile.
      $overrides[$config_name]['content']['field_profile_nick_name'] = [
        'weight' => 0,
        'settings' => [
          'size' => '60',
          'placeholder' => '',
        ],
        'third_party_settings' => [],
        'type' => 'string_textfield',
        'region' => 'content',
      ];

      // If there is a profile names and image field_group we move the field.
      $third_party = $config
        ->get('third_party_settings');
      if (isset($third_party['field_group']['group_profile_names_image'])) {

        // Append to the numeric array by using an index not in the range of
        // 0..(size-1). This limits our override to what's absolutely necessary.
        $next_index = count($third_party['field_group']['group_profile_names_image']['children']);
        $overrides[$config_name]['third_party_settings']['field_group']['group_profile_names_image']['children'][$next_index] = 'field_profile_nick_name';
      }
    }

    // Add field_group and field_comment_files.
    $config_names = [
      'search_api.index.social_all',
      'search_api.index.social_users',
    ];
    foreach ($config_names as $config_name) {
      if (in_array($config_name, $names)) {
        $config = $config_factory
          ->getEditable($config_name);

        // Add our field as config dependency.
        $config_dependencies = $config
          ->get('dependencies.config');
        $config_dependencies_next_index = count($config_dependencies);
        $overrides[$config_name]['dependencies']['config'][$config_dependencies_next_index] = 'field.storage.profile.field_profile_nick_name';

        // Add our field itself to the index.
        $overrides[$config_name] = [
          'field_settings' => [
            'field_profile_nick_name' => [
              'label' => 'Nickname',
              'datasource_id' => 'entity:profile',
              'property_path' => 'field_profile_nick_name',
              'type' => 'text',
              'dependencies' => [
                'config' => [
                  'field.storage.profile.field_profile_nick_name',
                ],
              ],
            ],
          ],
        ];

        // Configure the relevant processors for our field.
        $processor_settings = $config
          ->get('processor_settings');
        $enabled_processors = array_intersect([
          'ignorecase',
          'tokenizer',
          'transliteration',
        ], array_keys($processor_settings));
        foreach ($enabled_processors as $processor) {

          // Check if the fields are in this particular array.
          if (!isset($processor_settings[$processor]['fields'])) {
            continue;
          }
          $next_index = count($processor_settings[$processor]['fields']);
          $overrides[$config_name]['processor_settings'][$processor]['fields'][$next_index] = 'field_profile_nick_name';
        }
      }
    }
    return $overrides;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheSuffix() {
    return 'SocialProfileFieldsOverride';
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata($name) {
    return new CacheableMetadata();
  }

  /**
   * {@inheritdoc}
   */
  public function createConfigObject($name, $collection = StorageInterface::DEFAULT_COLLECTION) {
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SocialProfileFieldsOverride::createConfigObject	public	function	Creates a configuration object for use during install and synchronization. Overrides ConfigFactoryOverrideInterface::createConfigObject
SocialProfileFieldsOverride::getCacheableMetadata	public	function	Gets the cacheability metadata associated with the config factory override. Overrides ConfigFactoryOverrideInterface::getCacheableMetadata
SocialProfileFieldsOverride::getCacheSuffix	public	function	The string to append to the configuration static cache name. Overrides ConfigFactoryOverrideInterface::getCacheSuffix
SocialProfileFieldsOverride::loadOverrides	public	function	Returns config overrides. Overrides ConfigFactoryOverrideInterface::loadOverrides