class SocialEmbedConfigOverride in Open Social 10.0.x

Class SocialEmbedConfigOverride.

@package Drupal\social_embed

Hierarchy

• class \Drupal\social_embed\SocialEmbedConfigOverride implements ConfigFactoryOverrideInterface

2 string references to 'SocialEmbedConfigOverride'

SocialEmbedConfigOverride::getCacheSuffix in modules/social_features/social_embed/src/SocialEmbedConfigOverride.php

The string to append to the configuration static cache name.

social_embed.services.yml in modules/social_features/social_embed/social_embed.services.yml

modules/social_features/social_embed/social_embed.services.yml

1 service uses SocialEmbedConfigOverride

social_embed.overrider in modules/social_features/social_embed/social_embed.services.yml

\Drupal\social_embed\SocialEmbedConfigOverride

File

modules/social_features/social_embed/src/SocialEmbedConfigOverride.php, line 16

Namespace

Drupal\social_embed

class SocialEmbedConfigOverride implements ConfigFactoryOverrideInterface {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs the configuration override.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   */
  public function __construct(ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory) {
    $this->moduleHandler = $module_handler;
    $this->configFactory = $config_factory;
  }

  /**
   * {@inheritdoc}
   */
  public function loadOverrides($names) {
    $overrides = [];
    $formats = [
      'basic_html' => TRUE,
      'full_html' => FALSE,
    ];
    $this->moduleHandler
      ->alter('social_embed_formats', $formats);
    foreach ($formats as $format => $convert_url) {
      if (in_array('filter.format.' . $format, $names)) {
        $this
          ->addFilterOverride($format, $convert_url, $overrides);
      }
      if (in_array('editor.editor.' . $format, $names)) {
        $this
          ->addEditorOverride($format, $overrides);
      }
    }
    return $overrides;
  }

  /**
   * Alters the filter settings for the text format.
   *
   * @param string $text_format
   *   A config name.
   * @param bool $convert_url
   *   TRUE if filter should be used.
   * @param array $overrides
   *   An override configuration.
   */
  protected function addFilterOverride($text_format, $convert_url, array &$overrides) {
    $config_name = 'filter.format.' . $text_format;

    /** @var \Drupal\Core\Config\Config $config */
    $config = $this->configFactory
      ->getEditable($config_name);
    $filters = $config
      ->get('filters');
    $dependencies = $config
      ->getOriginal('dependencies.module');
    $overrides[$config_name]['dependencies']['module'] = $dependencies;
    $overrides[$config_name]['dependencies']['module'][] = 'url_embed';
    $overrides[$config_name]['filters']['url_embed'] = [
      'id' => 'url_embed',
      'provider' => 'url_embed',
      'status' => TRUE,
      'weight' => 100,
      'settings' => [],
    ];
    if ($convert_url) {
      $overrides[$config_name]['filters']['social_embed_convert_url'] = [
        'id' => 'social_embed_convert_url',
        'provider' => 'social_embed',
        'status' => TRUE,
        'weight' => isset($filters['filter_url']['weight']) ? $filters['filter_url']['weight'] - 1 : 99,
        'settings' => [
          'url_prefix' => '',
        ],
      ];
      if (isset($filters['filter_html'])) {
        $overrides[$config_name]['filters']['filter_html']['settings']['allowed_html'] = $filters['filter_html']['settings']['allowed_html'] . ' <drupal-url data-*>';
      }
    }
  }

  /**
   * Alters the editor settings for the text format.
   *
   * @param string $text_format
   *   The text format to adjust.
   * @param array $overrides
   *   An override configuration.
   */
  protected function addEditorOverride($text_format, array &$overrides) {
    $config_name = 'editor.editor.' . $text_format;

    /** @var \Drupal\Core\Config\Config $config */
    $config = $this->configFactory
      ->getEditable($config_name);
    $settings = $config
      ->get('settings');

    // Ensure we have an existing row that the button can be added to.
    if (empty($settings) || !isset($settings['toolbar']['rows']) || !is_array($settings['toolbar']['rows'])) {
      return;
    }
    $overrides = [];
    $button_exists = FALSE;
    foreach ($settings['toolbar']['rows'] as $row) {
      foreach ($row as $group) {
        foreach ($group['items'] as $button) {
          if ($button === 'social_embed') {
            $button_exists = TRUE;
            break 3;
          }
        }
      }
    }

    // If the button already exists we change nothing.
    if (!$button_exists) {
      $row_array_keys = array_keys($settings['toolbar']['rows']);
      $last_row_key = end($row_array_keys);

      // Ensure we add our button at the end of the row.
      // We use count to avoid issues when keys are non-numeric (even though
      // that shouldn't happen). This will break if the keys are non-consecutive
      // (which should also never happen).
      $group_key = count($settings['toolbar']['rows'][$last_row_key]) + 1;

      // Add the button as a new group to the bottom row as the last item.
      $group = [
        'name' => 'Embed',
        'items' => [
          'social_embed',
        ],
      ];
      $overrides[$config_name]['settings']['toolbar']['rows'][$last_row_key][$group_key] = $group;
    }
  }

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

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
SocialEmbedConfigOverride::$configFactory	protected	property	The config factory.
SocialEmbedConfigOverride::$moduleHandler	protected	property	The module handler.
SocialEmbedConfigOverride::addEditorOverride	protected	function	Alters the editor settings for the text format.
SocialEmbedConfigOverride::addFilterOverride	protected	function	Alters the filter settings for the text format.
SocialEmbedConfigOverride::createConfigObject	public	function	Creates a configuration object for use during install and synchronization. Overrides ConfigFactoryOverrideInterface::createConfigObject
SocialEmbedConfigOverride::getCacheableMetadata	public	function	Gets the cacheability metadata associated with the config factory override. Overrides ConfigFactoryOverrideInterface::getCacheableMetadata
SocialEmbedConfigOverride::getCacheSuffix	public	function	The string to append to the configuration static cache name. Overrides ConfigFactoryOverrideInterface::getCacheSuffix
SocialEmbedConfigOverride::loadOverrides	public	function	Returns config overrides. Overrides ConfigFactoryOverrideInterface::loadOverrides
SocialEmbedConfigOverride::__construct	public	function	Constructs the configuration override.