You are here

Home » API reference » Entity Reference with Layout 8 » EntityReferenceLayoutSettingsForm.php

class EntityReferenceLayoutSettingsForm in Entity Reference with Layout 8

Class EntityReferenceLayoutSettingsForm.

Hierarchy

Expanded class hierarchy of EntityReferenceLayoutSettingsForm

1 string reference to 'EntityReferenceLayoutSettingsForm'
entity_reference_layout.routing.yml in ./entity_reference_layout.routing.yml
entity_reference_layout.routing.yml

File

src/Form/EntityReferenceLayoutSettingsForm.php, line 14

Namespace

Drupal\entity_reference_layout\Form
View source 
class EntityReferenceLayoutSettingsForm extends ConfigFormBase {

  /**
   * The typed config service.
   *
   * @var \Drupal\Core\Config\TypedConfigManagerInterface
   */
  protected $typedConfigManager;

  /**
   * SettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Config\TypedConfigManagerInterface $typedConfigManager
   *   The typed config service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, TypedConfigManagerInterface $typedConfigManager) {
    parent::__construct($config_factory);
    $this->typedConfigManager = $typedConfigManager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->getEditable('entity_reference_layout.settings');
    $erl_config_schema = $this->typedConfigManager
      ->getDefinition('entity_reference_layout.settings') + [
      'mapping' => [],
    ];
    $erl_config_schema = $erl_config_schema['mapping'];
    $form['show_paragraph_labels'] = [
      '#type' => 'checkbox',
      '#title' => $erl_config_schema['show_paragraph_labels']['label'],
      '#description' => $erl_config_schema['show_paragraph_labels']['description'],
      '#default_value' => $config
        ->get('show_paragraph_labels'),
    ];
    $form['show_layout_labels'] = [
      '#type' => 'checkbox',
      '#title' => $erl_config_schema['show_layout_labels']['label'],
      '#description' => $erl_config_schema['show_layout_labels']['description'],
      '#default_value' => $config
        ->get('show_layout_labels'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->getEditable('entity_reference_layout.settings');
    $config
      ->set('show_paragraph_labels', $form_state
      ->getValue('show_paragraph_labels'));
    $config
      ->set('show_layout_labels', $form_state
      ->getValue('show_layout_labels'));
    $config
      ->save();

    // Confirmation on form submission.
    $this
      ->messenger()
      ->addMessage($this
      ->t('The Entoty Reference Layout settings have been saved.'));
  }

}

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
EntityReferenceLayoutSettingsForm::$typedConfigManager protected property The typed config service.
EntityReferenceLayoutSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
EntityReferenceLayoutSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
EntityReferenceLayoutSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
EntityReferenceLayoutSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EntityReferenceLayoutSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
EntityReferenceLayoutSettingsForm::__construct public function SettingsForm constructor. Overrides ConfigFormBase::__construct
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.
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.