class SettingsForm in Synonyms 2.0.x

Same name in this branch

2.0.x src/Form/SettingsForm.php \Drupal\synonyms\Form\SettingsForm
2.0.x modules/synonyms_list_field/src/Form/SettingsForm.php \Drupal\synonyms_list_field\Form\SettingsForm

Defines a form that configures forms module settings.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\synonyms\Form\SettingsForm uses StringTranslationTrait

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'

synonyms.routing.yml in ./synonyms.routing.yml: synonyms.routing.yml

File

src/Form/SettingsForm.php, line 17

Namespace

Drupal\synonyms\Form

View source

class SettingsForm extends ConfigFormBase {
  use StringTranslationTrait, FormatWordingTrait;

  /**
   * The behavior service.
   *
   * @var \Drupal\synonyms\SynonymsService\BehaviorService
   */
  protected $behaviorService;

  /**
   * The renderer.
   *
   * @var Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * All available synonyms widgets.
   *
   * @var array
   */
  protected $widgets;

  /**
   * SettingsForm constructor.
   *
   * @param \Drupal\synonyms\SynonymsService\BehaviorService $behavior_service
   *   The behavior service.
   * @param Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   */
  public function __construct(BehaviorService $behavior_service, RendererInterface $renderer) {
    $this->behaviorService = $behavior_service;
    $this->renderer = $renderer;
    $this->widgets = $this->behaviorService
      ->getWidgetServices();
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('synonyms.behavior_service'), $container
      ->get('renderer'));
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    $config_names = [
      'synonyms.settings',
    ];
    if ($this->widgets) {
      foreach ($this->widgets as $service_id => $service) {
        $config_names[] = 'synonyms_' . $service_id . '.settings';
      }
    }
    return $config_names;
  }

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

    // The 'Wording type' select item.
    $form['wording_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Wording type'),
      '#options' => $this
        ->wordingTypeOptions(),
      '#default_value' => $this
        ->config('synonyms.settings')
        ->get('wording_type'),
      '#description' => $this
        ->t('<strong>No wording:</strong> All synonyms suggestions inside all synonyms friendly widgets will be presented to the user with synonym labels only.<br><strong>Default wording:</strong> Provides one default (and customisable) wording per widget. Good enough for sites with simple synonyms usage.<br><strong>Per entity type:</strong> Enables per entity type specific wording for each widget at "Manage behaviors" form.<br><strong>Per entity type and field:</strong> Enables per field (provider) specific wording at "Manage providers" form. One wording is used by all widgets here.') . '<br><br>',
    ];

    // Bring in the wording format from FormatWordingTrait.
    $replacements = [
      '#theme' => 'item_list',
      '#list_type' => 'ul',
      '#items' => [],
    ];
    foreach ($this
      ->formatWordingAvailableTokens() as $token => $token_info) {
      $replacements['#items'][] = Html::escape($token) . ': ' . $token_info;
    }
    $replacements = $this->renderer
      ->renderRoot($replacements);

    // Default wordings.
    if ($this->widgets) {
      foreach ($this->widgets as $service_id => $service) {
        $description = $this
          ->t('Specify the wording with which @widget widget suggestions should be presented. Available replacement tokens are: @replacements This will also serve as a fallback wording if more specific wordings are left empty.', [
          '@widget' => $service
            ->getWidgetTitle(),
          '@replacements' => $replacements,
        ]);
        $form[$service_id] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('@widget widget default wording', [
            '@widget' => $service
              ->getWidgetTitle(),
          ]),
          '#default_value' => $this
            ->config('synonyms_' . $service_id . '.settings')
            ->get('default_wording'),
          '#description' => $description . '<br><br>',
          '#states' => [
            'invisible' => [
              ':input[name="wording_type"]' => [
                'value' => 'none',
              ],
            ],
          ],
        ];
      }
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('synonyms.settings')
      ->set('wording_type', $form_state
      ->getValue('wording_type'))
      ->set('wording_type_label', $this
      ->wordingTypeOptions()[$form_state
      ->getValue('wording_type')])
      ->save();
    parent::submitForm($form, $form_state);
    if ($this->widgets) {
      foreach ($this->widgets as $service_id => $service) {
        $this
          ->config('synonyms_' . $service_id . '.settings')
          ->set('default_wording', $form_state
          ->getValue($service_id))
          ->save();
        parent::submitForm($form, $form_state);
      }
    }
  }

  /**
   * Helper function defining wording type options.
   */
  protected function wordingTypeOptions() {
    $options = [
      'none' => $this
        ->t('No wording'),
      'default' => $this
        ->t('Default'),
      'entity' => $this
        ->t('Per entity type'),
      'provider' => $this
        ->t('Per entity type and field'),
    ];
    return $options;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
SettingsForm::$behaviorService	protected	property	The behavior service.
SettingsForm::$renderer	protected	property	The renderer.
SettingsForm::$widgets	protected	property	All available synonyms widgets.
SettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::wordingTypeOptions	protected	function	Helper function defining wording type options.
SettingsForm::__construct	public	function	SettingsForm constructor. Overrides ConfigFormBase::__construct
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.

You are here

class SettingsForm in Synonyms 2.0.x

Hierarchy

File

Namespace

Members

API Navigation