You are here

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

class BetterFieldDescriptionsSettingsForm in Better Field Descriptions 8

Displays the better_field_descriptions settings form.

Hierarchy

Expanded class hierarchy of BetterFieldDescriptionsSettingsForm

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

File

src/Form/BetterFieldDescriptionsSettingsForm.php, line 16

Namespace

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

  /**
   * EntityFieldManager services object.
   *
   * @var \Drupal\Core\Entity\EntityFieldManager
   */
  private $entityFieldManager;

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

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('entity_field.manager'), $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_settings_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 editable config.
    $config = $this
      ->config('better_field_descriptions.settings');

    // Get list of entity types selected for better desctiptions.
    $bfde = $config
      ->get('better_field_descriptions_entities');

    // Get list of fields selected for better descriptions.
    $bfds = $config
      ->get('better_field_descriptions_settings');
    $form['descriptions'] = [
      '#type' => 'markup',
      '#markup' => $this
        ->t('Select fields that should have better descriptions.'),
    ];
    $form['bundles'] = [
      '#type' => 'item',
      '#prefix' => '<div id="better-descriptions-form-id-wrapper">',
      '#suffix' => '</div>',
      '#tree' => TRUE,
    ];
    foreach ($all_bundles as $entity_type => $bundles) {
      if (in_array($entity_type, $bfde)) {
        foreach ($bundles as $bundle => $label) {

          // Array to hold fields in the node.
          $fields_instances = [];

          // Get info on pseudo fields, like title.
          $extra_fields = $this->entityFieldManager
            ->getExtraFields($entity_type, $bundle, 'form');
          if (isset($extra_fields['title'])) {
            $fields_instances['title'] = $extra_fields['title']['label'];
          }

          // Get info on regular fields to the bundle.
          $fields = $this->entityFieldManager
            ->getFieldDefinitions($entity_type, $bundle);
          foreach ($fields as $field_machine_name => $field) {
            if ($field
              ->getFieldStorageDefinition()
              ->isBaseField() == FALSE) {
              $fields_instances[$field_machine_name] = $field
                ->getLabel() . ' (' . $field_machine_name . ')';
            }
          }
          foreach ($fields_instances as $field => $label) {
            $enabled = isset($bfds[$entity_type][$bundle][$field]);
            $form['bundles'][$entity_type][$bundle][$field] = [
              '#type' => 'checkbox',
              '#title' => $label,
              '#default_value' => $enabled,
            ];
            $form['bundles'][$entity_type][$bundle][$field]['#parents'] = [
              'bundles',
              $entity_type,
              $bundle,
              $field,
            ];
          }
        }
      }
    }
    foreach (Element::children($form['bundles']) as $entity_type) {
      $form['bundles'][$entity_type] += [
        '#type' => 'details',
        '#title' => $entity_type,
      ];
      foreach (Element::children($form['bundles'][$entity_type]) as $bundle) {
        $form['bundles'][$entity_type][$bundle] += [
          '#type' => 'details',
          '#title' => $bundle,
        ];
      }
      uasort($form['bundles'][$entity_type], [
        '\\Drupal\\Component\\Utility\\SortArray',
        'sortByTitleProperty',
      ]);
    }

    // Lastly, sort all packages by title.
    uasort($form['bundles'], [
      '\\Drupal\\Component\\Utility\\SortArray',
      'sortByTitleProperty',
    ]);
    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');

    // Get list of fields selected for better descriptions.
    $bfdescriptions = $config
      ->get('better_field_descriptions');

    // We don't want our settings to contain 0-values, only selected values.
    $bfds = [];

    // Default fields values.
    $bfd = [];
    foreach ($form_state
      ->getValue('bundles') as $entity_type => $bundles) {
      foreach ($bundles as $bundle_machine_name => $bundle) {
        foreach ($bundle as $field_machine_name => $value) {

          // $value is (int) 0 if the field was not selected in the form.
          if (is_string($value)) {
            $bfds[$entity_type][$bundle_machine_name][$field_machine_name] = $field_machine_name;

            // Get any existing description and/or label.
            $description = $bfdescriptions[$entity_type][$bundle_machine_name][$field_machine_name]['description'] ?? 'Sample Description';
            $label = $bfdescriptions[$entity_type][$bundle_machine_name][$field_machine_name]['label'] ?? 'Label';
            $position = $bfdescriptions[$entity_type][$bundle_machine_name][$field_machine_name]['position'] ?? 1;

            // Store the existing description/label or default values.
            $bfd[$entity_type][$bundle_machine_name][$field_machine_name]['description'] = $description;
            $bfd[$entity_type][$bundle_machine_name][$field_machine_name]['label'] = $label;
            $bfd[$entity_type][$bundle_machine_name][$field_machine_name]['position'] = $position;
          }
        }
      }
    }
    $config
      ->set('better_field_descriptions_settings', $bfds);
    $config
      ->set('better_field_descriptions', $bfd);
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

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