class OembedProvidersSettingsForm in oEmbed Providers 2.x
Same name and namespace in other branches
- 1.0.x src/Form/OembedProvidersSettingsForm.php \Drupal\oembed_providers\Form\OembedProvidersSettingsForm
- 1.1.x src/Form/OembedProvidersSettingsForm.php \Drupal\oembed_providers\Form\OembedProvidersSettingsForm
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
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
Expanded class hierarchy of OembedProvidersSettingsForm
1 string reference to 'OembedProvidersSettingsForm'
File
- src/
Form/ OembedProvidersSettingsForm.php, line 14
Namespace
Drupal\oembed_providers\FormView source
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:: |
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. | |
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. | |
OembedProvidersSettingsForm:: |
protected | property | Cache backend for default cache. | |
OembedProvidersSettingsForm:: |
public | function |
Form constructor. Overrides ConfigFormBase:: |
|
OembedProvidersSettingsForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ConfigFormBase:: |
|
OembedProvidersSettingsForm:: |
protected | function |
Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait:: |
|
OembedProvidersSettingsForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
OembedProvidersSettingsForm:: |
constant | Config settings. | ||
OembedProvidersSettingsForm:: |
public | function |
Form submission handler. Overrides ConfigFormBase:: |
|
OembedProvidersSettingsForm:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
OembedProvidersSettingsForm:: |
public | function |
Constructs an OembedProvidersSettingsForm object. Overrides ConfigFormBase:: |
|
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. |