class AllowedProvidersForm in oEmbed Providers 1.1.x
Same name and namespace in other branches
- 1.0.x src/Form/AllowedProvidersForm.php \Drupal\oembed_providers\Form\AllowedProvidersForm
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
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
Expanded class hierarchy of AllowedProvidersForm
1 string reference to 'AllowedProvidersForm'
File
- src/
Form/ AllowedProvidersForm.php, line 15
Namespace
Drupal\oembed_providers\FormView source
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:: |
protected | property | The decorated oEmbed ProviderRepository. | |
AllowedProvidersForm:: |
public | function |
Form constructor. Overrides ConfigFormBase:: |
|
AllowedProvidersForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ConfigFormBase:: |
|
AllowedProvidersForm:: |
protected | function |
Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait:: |
|
AllowedProvidersForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
AllowedProvidersForm:: |
constant | Config settings. | ||
AllowedProvidersForm:: |
public | function |
Form submission handler. Overrides ConfigFormBase:: |
|
AllowedProvidersForm:: |
public | function |
Constructs an AllowedProvidersForm object. Overrides ConfigFormBase:: |
|
ConfigFormBaseTrait:: |
protected | function | Retrieves a configuration object. | |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
72 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |