class AllowedProvidersForm in oEmbed Providers 1.0.x

Configure allowed providers 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\AllowedProvidersForm

1 string reference to 'AllowedProvidersForm'

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

oembed_providers.routing.yml

File

src/Form/AllowedProvidersForm.php, line 15

Namespace

Drupal\oembed_providers\Form

class AllowedProvidersForm extends ConfigFormBase {

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

  /**
   * The decorated oEmbed ProviderRepository.
   *
   * @var \Drupal\oembed_providers\OEmbed\ProviderRepositoryDecorator
   */
  protected $providerRepository;

  /**
   * Constructs an AllowedProvidersForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\oembed_providers\OEmbed\ProviderRepositoryDecorator $provider_repository
   *   The decorated oEmbed ProviderRepository.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ProviderRepositoryDecorator $provider_repository) {
    $this
      ->setConfigFactory($config_factory);
    $this->providerRepository = $provider_repository;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config(static::SETTINGS);
    $form['security_warning'] = [
      '#markup' => HelperTrait::disabledProviderSecurityWarning(),
      // Simulate warning message.
      '#prefix' => '<div role="contentinfo" aria-label="Warning message" class="messages messages--warning">',
      '#suffix' => '</div>',
    ];
    if (empty($config
      ->get('allowed_providers'))) {
      $form['install_markup'] = [
        '#markup' => $this
          ->t('The <em>oEmbed Providers</em> module now manages oEmbed providers. Allowed oEmbed providers must be configured below.'),
        // Simulate warning message.
        '#prefix' => '<div role="contentinfo" aria-label="Warning message" class="messages messages--warning">',
        '#suffix' => '</div>',
      ];
    }
    $form['markup'] = [
      '#markup' => $this
        ->t('<p>Providers enabled below will be made available as media sources.</p>'),
    ];
    $providers = $this->providerRepository
      ->getAll();
    $provider_keys = [];
    foreach ($providers as $provider) {
      $provider_keys[$provider
        ->getName()] = $provider
        ->getName();
    }
    $form['allowed_providers'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Allowed Providers'),
      '#default_value' => $config
        ->get('allowed_providers') ? $config
        ->get('allowed_providers') : [],
      '#options' => $provider_keys,
    ];
    $form['#attached']['library'][] = 'oembed_providers/settings_form';
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $allowed_providers = [];
    foreach ($form_state
      ->getValue('allowed_providers') as $provider) {
      if ($provider) {
        $allowed_providers[] = $provider;
      }
    }
    $this->configFactory
      ->getEditable(static::SETTINGS)
      ->set('allowed_providers', $allowed_providers)
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AllowedProvidersForm::$providerRepository	protected	property	The decorated oEmbed ProviderRepository.
AllowedProvidersForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AllowedProvidersForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
AllowedProvidersForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AllowedProvidersForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AllowedProvidersForm::SETTINGS		constant	Config settings.
AllowedProvidersForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
AllowedProvidersForm::__construct	public	function	Constructs an AllowedProvidersForm object. Overrides ConfigFormBase::__construct
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
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.
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.