class OembedProvidersSettingsForm in oEmbed Providers 1.1.x

Configure oEmbed settings form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\oembed_providers\Form\OembedProvidersSettingsForm

1 string reference to 'OembedProvidersSettingsForm'

oembed_providers.routing.yml in ./oembed_providers.routing.yml

oembed_providers.routing.yml

File

src/Form/OembedProvidersSettingsForm.php, line 14

Namespace

Drupal\oembed_providers\Form

class OembedProvidersSettingsForm extends ConfigFormBase {

  /**
   * Config settings.
   *
   * @var string
   */
  const SETTINGS = 'oembed_providers.settings';

  /**
   * Cache backend for default cache.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $defaultCache;

  /**
   * Constructs an OembedProvidersSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Cache\CacheBackendInterface $default_cache
   *   Cache backend for default cache.
   */
  public function __construct(ConfigFactoryInterface $config_factory, CacheBackendInterface $default_cache) {
    $this
      ->setConfigFactory($config_factory);
    $this->defaultCache = $default_cache;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('cache.default'));
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      static::SETTINGS,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config(static::SETTINGS);
    $form['external_fetch'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable external fetch of providers'),
      '#description' => $this
        ->t('If enabled, oEmbed providers will be fetched from the <em>oEmbed Providers URL</em>. If disabled, any oEmbed providers must be defined locally.'),
      '#default_value' => $config
        ->get('external_fetch'),
    ];
    $form['oembed_providers_url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('oEmbed Providers URL'),
      '#description' => $this
        ->t('The URL where Media fetches the list of oEmbed providers'),
      '#default_value' => $this
        ->config('media.settings')
        ->get('oembed_providers_url'),
      '#states' => [
        'visible' => [
          ':input[name="external_fetch"]' => [
            'checked' => TRUE,
          ],
        ],
        'required' => [
          ':input[name="external_fetch"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if ($form_state
      ->getValue('oembed_providers_url') === '' && $form_state
      ->getValue('external_fetch') === 1) {
      $form_state
        ->setErrorByName('oembed_providers_url', $this
        ->t('The <em>oEmbed Providers URL</em> field is required.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->configFactory
      ->getEditable('media.settings')
      ->set('oembed_providers_url', $form_state
      ->getValue('oembed_providers_url'))
      ->save();
    $this->configFactory
      ->getEditable(static::SETTINGS)
      ->set('external_fetch', (bool) $form_state
      ->getValue('external_fetch'))
      ->save();
    parent::submitForm($form, $form_state);
    $this->defaultCache
      ->delete('oembed_providers:oembed_providers');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.	3
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.
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.
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
OembedProvidersSettingsForm::$defaultCache	protected	property	Cache backend for default cache.
OembedProvidersSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
OembedProvidersSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
OembedProvidersSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
OembedProvidersSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
OembedProvidersSettingsForm::SETTINGS		constant	Config settings.
OembedProvidersSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
OembedProvidersSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
OembedProvidersSettingsForm::__construct	public	function	Constructs an OembedProvidersSettingsForm object. Overrides ConfigFormBase::__construct
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.