You are here

class MentionsSettingsForm in Open Social 8

Same name and namespace in other branches
  1. 8.9 modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  2. 8.2 modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  3. 8.3 modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  4. 8.4 modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  5. 8.5 modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  6. 8.6 modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  7. 8.7 modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  8. 8.8 modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  9. 10.3.x modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  10. 10.0.x modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  11. 10.1.x modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm
  12. 10.2.x modules/custom/mentions/src/Form/MentionsSettingsForm.php \Drupal\mentions\Form\MentionsSettingsForm

Configure mentions settings.

Hierarchy

Expanded class hierarchy of MentionsSettingsForm

1 string reference to 'MentionsSettingsForm'
mentions.routing.yml in modules/custom/mentions/mentions.routing.yml
modules/custom/mentions/mentions.routing.yml

File

modules/custom/mentions/src/Form/MentionsSettingsForm.php, line 16

Namespace

Drupal\mentions\Form
View source
class MentionsSettingsForm extends ConfigFormBase {
  use StringTranslationTrait;

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Class constructor.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entity_type_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'mentions.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('mentions.settings');
    $form['general'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('General configuration'),
      '#open' => TRUE,
    ];
    $form['general']['supported_entity_types'] = [
      '#title' => $this
        ->t('Supported entity types'),
      '#type' => 'select',
      '#multiple' => TRUE,
      '#options' => $this
        ->getContentEntityTypes(),
      '#default_value' => $config
        ->get('supported_entity_types'),
      '#description' => $this
        ->t('Mentions entity will be created only for selected entity types.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Save config.
    $config = $this
      ->config('mentions.settings');
    $config
      ->set('supported_entity_types', $form_state
      ->getValue('supported_entity_types'));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Get content entity types keyed by id.
   *
   * @return array
   *   Returns array of content entity types.
   */
  protected function getContentEntityTypes() {
    $options = [];
    foreach ($this->entityTypeManager
      ->getDefinitions() as $entity_type) {
      if ($entity_type instanceof ContentEntityTypeInterface) {
        $options[$entity_type
          ->id()] = $entity_type
          ->getLabel();
      }
    }
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
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. 1
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. Overrides UrlGeneratorTrait::redirect
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 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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.
MentionsSettingsForm::$entityTypeManager protected property The entity type manager service.
MentionsSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
MentionsSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
MentionsSettingsForm::getContentEntityTypes protected function Get content entity types keyed by id.
MentionsSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MentionsSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MentionsSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
MentionsSettingsForm::__construct public function Class constructor. Overrides ConfigFormBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.