class OembedProviderBucketForm in oEmbed Providers 2.x
Form controller for the oEmbed provider bucket edit/add forms.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\oembed_providers\OembedProviderBucketForm
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of OembedProviderBucketForm
File
- src/
OembedProviderBucketForm.php, line 17
Namespace
Drupal\oembed_providersView source
class OembedProviderBucketForm extends EntityForm {
/**
* The decorated oEmbed ProviderRepository.
*
* @var \Drupal\oembed_providers\OEmbed\ProviderRepositoryDecorator
*/
protected $providerRepository;
/**
* The entityTypeManager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The messenger service.
*
* @var \Drupal\Core\Messenger\Messenger
*/
protected $messenger;
/**
* Constructs an oEmbedProviderBucketForm object.
*
* @param \Drupal\oembed_providers\OEmbed\ProviderRepositoryDecorator $provider_repository
* The decorated oEmbed ProviderRepository.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
* The entityTypeManager.
* @param \Drupal\Core\Messenger\MessengerInterface $messenger
* The messenger service.
*/
public function __construct(ProviderRepositoryDecorator $provider_repository, EntityTypeManagerInterface $entityTypeManager, MessengerInterface $messenger) {
$this->providerRepository = $provider_repository;
$this->entityTypeManager = $entityTypeManager;
$this->messenger = $messenger;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('media.oembed.provider_repository'), $container
->get('entity_type.manager'), $container
->get('messenger'));
}
/**
* Overrides Drupal\Core\Entity\EntityForm::form().
*
* @param array $form
* A nested array form elements comprising the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* @return array
* The array containing the complete form.
*/
public function form(array $form, FormStateInterface $form_state) {
if ($this->operation == 'edit') {
$form['#title'] = $this
->t('<em>Edit oEmbed provider bucket</em> @label', [
'@label' => $this->entity
->label(),
]);
}
$entity = $this->entity;
$form['security_warning'] = [
'#markup' => HelperTrait::disabledProviderSecurityWarning(),
// Simulate warning message.
'#prefix' => '<div role="contentinfo" aria-label="Warning message" class="messages messages--warning">',
'#suffix' => '</div>',
];
$form['label'] = [
'#type' => 'textfield',
'#title' => $this
->t('Bucket name'),
'#default_value' => $entity
->label(),
'#required' => TRUE,
];
$form['id'] = [
'#type' => 'machine_name',
'#default_value' => $entity
->id(),
'#machine_name' => [
'exists' => [
$this,
'exist',
],
],
'#disabled' => !$entity
->isNew(),
];
$form['description'] = [
'#type' => 'textfield',
'#title' => $this
->t('Description'),
'#default_value' => $entity
->get('description'),
];
$providers = $this->providerRepository
->getAll();
$provider_keys = [];
foreach ($providers as $provider) {
$provider_keys[$provider
->getName()] = $provider
->getName();
}
$form['markup'] = [
'#markup' => $this
->t('<p>Providers enabled below will be made available to this media source.</p>'),
];
$form['providers'] = [
'#type' => 'checkboxes',
'#title' => $this
->t('Allowed Providers'),
'#default_value' => $entity
->get('providers') ? $entity
->get('providers') : [],
'#options' => $provider_keys,
];
$form['#attached']['library'][] = 'oembed_providers/provider_bucket_form';
return parent::form($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$entity = $this->entity;
$providers = Checkboxes::getCheckedCheckboxes($entity
->get('providers'));
$entity
->set('providers', $providers);
$status = $entity
->save();
if ($status === SAVED_NEW) {
$this
->messenger()
->addMessage($this
->t('The %label oEmbed provider bucket was created.', [
'%label' => $entity
->label(),
]));
}
else {
$this
->messenger()
->addMessage($this
->t('The %label oEmbed provider bucket was updated.', [
'%label' => $entity
->label(),
]));
}
$form_state
->setRedirect('entity.oembed_provider_bucket.collection');
}
/**
* Helper function to check if oEmbed provider bucket config entity exists.
*
* @param string $id
* A machine name.
*
* @return bool
* Whether or not the machine name already exists.
*/
public function exist($id) {
// The 'add' namespace is reserved.
if ($id == 'add') {
return TRUE;
}
$entity = $this->entityTypeManager
->getStorage('oembed_provider_bucket')
->getQuery()
->condition('id', $id)
->execute();
return (bool) $entity;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityForm:: |
protected | property | The entity being used by this form. | 11 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
protected | function | Returns an array of supported actions for the current entity form. | 35 |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface:: |
3 |
EntityForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
13 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties. | 9 |
EntityForm:: |
public | function |
Returns a string identifying the base form. Overrides BaseFormIdInterface:: |
6 |
EntityForm:: |
public | function |
Gets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
3 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
12 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Initialize the form state and the entity before the first form build. | 3 |
EntityForm:: |
protected | function | Prepares the entity object before the form is built first. | 3 |
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state… Overrides FormInterface:: |
20 |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
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:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
OembedProviderBucketForm:: |
protected | property |
The entityTypeManager. Overrides EntityForm:: |
|
OembedProviderBucketForm:: |
protected | property |
The messenger service. Overrides MessengerTrait:: |
|
OembedProviderBucketForm:: |
protected | property | The decorated oEmbed ProviderRepository. | |
OembedProviderBucketForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
OembedProviderBucketForm:: |
public | function | Helper function to check if oEmbed provider bucket config entity exists. | |
OembedProviderBucketForm:: |
public | function |
Overrides Drupal\Core\Entity\EntityForm::form(). Overrides EntityForm:: |
|
OembedProviderBucketForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityForm:: |
|
OembedProviderBucketForm:: |
public | function | Constructs an oEmbedProviderBucketForm object. | |
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. |