You are here

Home » API reference » Better Field Descriptions 8 » BetterFieldDescriptionsEntitiesForm.php

class BetterFieldDescriptionsEntitiesForm in Better Field Descriptions 8

Displays the better_field_descriptions_entities settings form.

Hierarchy

Expanded class hierarchy of BetterFieldDescriptionsEntitiesForm

1 string reference to 'BetterFieldDescriptionsEntitiesForm'
better_field_descriptions.routing.yml in ./better_field_descriptions.routing.yml
better_field_descriptions.routing.yml

File

src/Form/BetterFieldDescriptionsEntitiesForm.php, line 14

Namespace

Drupal\better_field_descriptions\Form
View source 
class BetterFieldDescriptionsEntitiesForm extends ConfigFormBase {

  /**
   * The bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $bundleInfoService;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeBundleInfoInterface $bundle_info_service) {
    parent::__construct($config_factory);
    $this->bundleInfoService = $bundle_info_service;
  }

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

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

  /**
   * Implements \Drupal\Core\Form\FormInterface::getFormID().
   */
  public function getFormId() {
    return 'better_field_descriptions_entities_form';
  }

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

    // Get info on bundles.
    $all_bundles = $this->bundleInfoService
      ->getAllBundleInfo();

    // Sort into order on entity ids.
    ksort($all_bundles);

    // Get the editiable config.
    $config = $this
      ->config('better_field_descriptions.settings');

    // Get list of entities selected for better descriptions.
    $bfde = $config
      ->get('better_field_descriptions_entities');
    $form['descriptions'] = [
      '#type' => 'markup',
      '#markup' => $this
        ->t('Select entity types that should have better descriptions.'),
    ];
    $form['entities'] = [
      '#type' => 'item',
      '#prefix' => '<div id="better-descriptions-form-id-wrapper">',
      '#suffix' => '</div>',
      '#tree' => TRUE,
    ];
    foreach ($all_bundles as $entity_type => $bundles) {
      $form['entities'][$entity_type] = [
        '#type' => 'checkbox',
        '#title' => $entity_type,
        '#default_value' => isset($bfde[$entity_type]),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

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

    // Get the config settings.
    $config = $this
      ->config('better_field_descriptions.settings');

    // We don't want our settings to contain 0-values, only selected values.
    $selected = array_filter($form_state
      ->getValue('entities'));
    $bfde = [];
    foreach ($selected as $entity_type => $checked) {
      $bfde[$entity_type] = $entity_type;
    }
    $config
      ->set('better_field_descriptions_entities', $bfde);
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BetterFieldDescriptionsEntitiesForm::$bundleInfoService protected property The bundle info service.
BetterFieldDescriptionsEntitiesForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
BetterFieldDescriptionsEntitiesForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
BetterFieldDescriptionsEntitiesForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BetterFieldDescriptionsEntitiesForm::getFormId public function Implements \Drupal\Core\Form\FormInterface::getFormID(). Overrides FormInterface::getFormId
BetterFieldDescriptionsEntitiesForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
BetterFieldDescriptionsEntitiesForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.
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.