abstract class BaseFieldConfigFromBase in Apigee Edge 8

Base form for configuring base fields on Apigee Edge entities.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\apigee_edge\Form\BaseFieldConfigFromBase

Expanded class hierarchy of BaseFieldConfigFromBase

1 file declares its use of BaseFieldConfigFromBase

TeamAppBaseFieldConfigForm.php in modules/apigee_edge_teams/src/Form/TeamAppBaseFieldConfigForm.php

File

src/Form/BaseFieldConfigFromBase.php, line 32

Namespace

Drupal\apigee_edge\Form

View source

abstract class BaseFieldConfigFromBase extends FormBase {

  /**
   * The entity field manager service.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

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

  /**
   * BaseFieldConfigFromBase constructor.
   *
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   */
  public function __construct(EntityFieldManagerInterface $entity_field_manager, EntityTypeManagerInterface $entity_type_manager) {
    $this->entityFieldManager = $entity_field_manager;
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $base_fields = $this->entityFieldManager
      ->getBaseFieldDefinitions($this
      ->entityType());
    $form['#attached']['library'][] = 'apigee_edge/apigee_edge.admin';
    $form['table'] = [
      '#type' => 'table',
      '#caption' => $this
        ->t('Base field settings'),
      '#header' => [
        $this
          ->t('Field name'),
        $this
          ->t('Required'),
      ],
    ];
    foreach ($base_fields as $name => $base_field) {
      if ($base_field
        ->isDisplayConfigurable('form')) {
        $form['table'][$name] = [
          'name' => [
            '#type' => 'item',
            '#markup' => $base_field
              ->getLabel(),
          ],
          'required' => [
            '#type' => 'checkbox',
            '#title' => $this
              ->t('Required'),
            '#title_display' => 'invisible',
            '#default_value' => $base_field
              ->isRequired(),
          ],
        ];
      }
    }
    foreach ($this
      ->getLockedBaseFields() as $locked) {
      $form['table'][$locked]['required']['#disabled'] = TRUE;
    }
    $form['save'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);

    /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $display */
    $display = $this->entityTypeManager
      ->getStorage('entity_form_display')
      ->load("{$this->entityType()}.{$this->entityType()}.default");
    if ($display) {
      foreach ($form_state
        ->getValue('table') as $name => $data) {
        $component = $display
          ->getComponent($name);
        if ($data['required'] && !($component && $component['region'] !== 'hidden')) {
          $form_state
            ->setError($form['table'][$name]['required'], $this
            ->t('%field-name is hidden on the default form display.', [
            '%field-name' => $form['table'][$name]['name']['#markup'],
          ]));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $required_base_fields = [];
    foreach ($form_state
      ->getValue('table') as $name => $data) {
      if ($data['required']) {
        $required_base_fields[] = $name;
      }
    }
    $this
      ->saveRequiredBaseFields($required_base_fields);

    // Let's clear every cache not just base field definitions for safety.
    drupal_flush_all_caches();
    $this
      ->messenger()
      ->addStatus($this
      ->t('Field settings have been saved successfully.'));
  }

  /**
   * The name of the entity type in Drupal.
   *
   * @return string
   *   The entity type id.
   */
  protected abstract function entityType() : string;

  /**
   * Returns the array of locked base field on the entity type.
   *
   * @return array
   *   Array of base field names.
   */
  protected abstract function getLockedBaseFields() : array;

  /**
   * Saves required base fields.
   *
   * @param array $required_base_fields
   *   Array of base field names.
   */
  protected abstract function saveRequiredBaseFields(array $required_base_fields) : void;

}

Members

Name	Modifiers	Type	Description	Overrides
BaseFieldConfigFromBase::$entityFieldManager	protected	property	The entity field manager service.
BaseFieldConfigFromBase::$entityTypeManager	protected	property	The entity type manager service.
BaseFieldConfigFromBase::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
BaseFieldConfigFromBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
BaseFieldConfigFromBase::entityType	abstract protected	function	The name of the entity type in Drupal.	2
BaseFieldConfigFromBase::getLockedBaseFields	abstract protected	function	Returns the array of locked base field on the entity type.	2
BaseFieldConfigFromBase::saveRequiredBaseFields	abstract protected	function	Saves required base fields.	2
BaseFieldConfigFromBase::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
BaseFieldConfigFromBase::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
BaseFieldConfigFromBase::__construct	public	function	BaseFieldConfigFromBase constructor.
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::config	protected	function	Retrieves a configuration object.
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.
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
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.

You are here

abstract class BaseFieldConfigFromBase in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation