class SocialFilePrivateTextEditorConfigOverride in Open Social 10.2.x

Class SocialFilePrivateTextEditorConfigOverride.

Override the text editor configuration and set private scheme for files.

@package Drupal\social_file_private

Hierarchy

• class \Drupal\social_file_private\SocialFilePrivateTextEditorConfigOverride implements ConfigFactoryOverrideInterface

2 string references to 'SocialFilePrivateTextEditorConfigOverride'

SocialFilePrivateTextEditorConfigOverride::getCacheSuffix in modules/custom/social_file_private/src/SocialFilePrivateTextEditorConfigOverride.php

The string to append to the configuration static cache name.

social_file_private.services.yml in modules/custom/social_file_private/social_file_private.services.yml

modules/custom/social_file_private/social_file_private.services.yml

1 service uses SocialFilePrivateTextEditorConfigOverride

social_file_private_text_editor.overrider in modules/custom/social_file_private/social_file_private.services.yml

\Drupal\social_file_private\SocialFilePrivateTextEditorConfigOverride

File

modules/custom/social_file_private/src/SocialFilePrivateTextEditorConfigOverride.php, line 18

Namespace

Drupal\social_file_private

class SocialFilePrivateTextEditorConfigOverride implements ConfigFactoryOverrideInterface {

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

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

  /**
   * Get all the editors/input formats we need to protect.
   *
   * @todo Retrieve the input formats programmatically.
   *
   * Note: this list is now fixed, but an error will be shown in the status
   * report when there are text editors using public scheme.
   *
   * @return array
   *   Returns an array containing config_names.
   */
  public function getTextEditorsToProtect() {
    $config_names = [
      'editor.editor.basic_html',
      'editor.editor.full_html',
    ];
    return $config_names;
  }

  /**
   * {@inheritdoc}
   */
  public function loadOverrides($names) {
    $overrides = [];
    if (PrivateStream::basePath()) {
      $config_names = $this
        ->getTextEditorsToProtect();
      foreach ($config_names as $config_name) {
        if (in_array($config_name, $names)) {
          $scheme = $this->configFactory
            ->getEditable($config_name)
            ->get('image_upload.scheme');
          if ($scheme == 'public') {
            $overrides[$config_name]['image_upload']['scheme'] = 'private';
          }
        }
      }
    }
    return $overrides;
  }

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

  /**
   * {@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
SocialFilePrivateTextEditorConfigOverride::$configFactory	protected	property	The config factory.
SocialFilePrivateTextEditorConfigOverride::createConfigObject	public	function	Creates a configuration object for use during install and synchronization. Overrides ConfigFactoryOverrideInterface::createConfigObject
SocialFilePrivateTextEditorConfigOverride::getCacheableMetadata	public	function	Gets the cacheability metadata associated with the config factory override. Overrides ConfigFactoryOverrideInterface::getCacheableMetadata
SocialFilePrivateTextEditorConfigOverride::getCacheSuffix	public	function	The string to append to the configuration static cache name. Overrides ConfigFactoryOverrideInterface::getCacheSuffix
SocialFilePrivateTextEditorConfigOverride::getTextEditorsToProtect	public	function	Get all the editors/input formats we need to protect.
SocialFilePrivateTextEditorConfigOverride::loadOverrides	public	function	Returns config overrides. Overrides ConfigFactoryOverrideInterface::loadOverrides
SocialFilePrivateTextEditorConfigOverride::__construct	public	function	Constructs the configuration override.