You are here

Home » API reference » Synonyms 2.0.x » SynonymForm.php

class SynonymForm in Synonyms 2.0.x

Same name and namespace in other branches
  1. 8 src/Form/SynonymForm.php \Drupal\synonyms\Form\SynonymForm

Entity form for 'synonym' config entity type.

Hierarchy

Expanded class hierarchy of SynonymForm

File

src/Form/SynonymForm.php, line 17

Namespace

Drupal\synonyms\Form
View source 
class SynonymForm extends EntityForm {

  /**
   * The synonym entity.
   *
   * @var \Drupal\synonyms\SynonymInterface
   */
  protected $entity;

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

  /**
   * The entity type bundle info.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * The synonyms provider plugin manager.
   *
   * @var \Drupal\synonyms\ProviderPluginManager
   */
  protected $synonymsProviderPluginManager;

  /**
   * Entity type that is being edited/added.
   *
   * @var \Drupal\Core\Entity\EntityTypeInterface
   */
  protected $controlledEntityType;

  /**
   * Bundle that is being edited/added.
   *
   * @var string
   */
  protected $controlledBundle;

  /**
   * The container.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerInterface
   */
  protected $container;

  /**
   * SynonymForm constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle info.
   * @param \Drupal\synonyms\ProviderPluginManager $synonyms_provider_plugin_manager
   *   The synonyms provider plugin_manager.
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The container.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, ProviderPluginManager $synonyms_provider_plugin_manager, ContainerInterface $container) {
    $this->entityTypeManager = $entity_type_manager;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
    $this->synonymsProviderPluginManager = $synonyms_provider_plugin_manager;
    $this->container = $container;
  }

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

  /**
   * {@inheritdoc}
   */
  protected function init(FormStateInterface $form_state) {
    parent::init($form_state);
    if ($this->entity
      ->isNew()) {
      $this->controlledEntityType = $this
        ->getRequest()
        ->get('synonyms_entity_type')
        ->id();
      $this->controlledBundle = $this
        ->getRequest()
        ->get('bundle');
    }
    else {
      $plugin_definition = $this->entity
        ->getProviderPluginInstance()
        ->getPluginDefinition();
      $this->controlledEntityType = $plugin_definition['controlled_entity_type'];
      $this->controlledBundle = $plugin_definition['controlled_bundle'];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    $class = get_class($this);
    $provider_plugin = $this->entity
      ->getProviderPlugin();
    if ($form_state
      ->getValue('provider_plugin')) {
      $provider_plugin = $form_state
        ->getValue('provider_plugin');
    }
    $form['id'] = [
      '#type' => 'value',
      '#value' => str_replace(':', '.', $provider_plugin),
    ];
    $options = [];
    foreach ($this->synonymsProviderPluginManager
      ->getDefinitions() as $plugin_id => $plugin) {
      if ($plugin['controlled_entity_type'] == $this->controlledEntityType && $plugin['controlled_bundle'] == $this->controlledBundle) {
        $options[$plugin_id] = $plugin['label'];
      }
    }
    $form['provider_plugin'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Synonyms provider'),
      '#description' => $this
        ->t('Select what synonyms provider it should represent.'),
      '#required' => TRUE,
      '#options' => $options,
      '#default_value' => $this->entity
        ->getProviderPlugin(),
      '#ajax' => [
        'wrapper' => 'synonyms-entity-configuration-ajax-wrapper',
        'event' => 'change',
        'callback' => [
          $class,
          'ajaxForm',
        ],
      ],
    ];
    $form['ajax_wrapper'] = [
      '#prefix' => '<div id="synonyms-entity-configuration-ajax-wrapper">',
      '#suffix' => '</div>',
    ];
    $form['ajax_wrapper']['provider_configuration'] = [
      '#tree' => TRUE,
      '#title' => $this
        ->t('Provider settings'),
      '#open' => TRUE,
    ];
    if ($provider_plugin) {
      if ($this
        ->showWordingForm()) {
        $form['ajax_wrapper']['provider_configuration']['#type'] = 'details';
        $form['ajax_wrapper']['provider_configuration'] += $this->entity
          ->getProviderPluginInstance()
          ->buildConfigurationForm($form['ajax_wrapper']['provider_configuration'], $form_state, $this->entity
          ->getProviderConfiguration(), $this->entity);
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if ($this
      ->showWordingForm()) {
      $this->entity
        ->getProviderPluginInstance()
        ->validateConfigurationForm($form['ajax_wrapper']['provider_configuration'], $this
        ->getSubFormState('provider_configuration', $form, $form_state), $this->entity);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    if ($this
      ->showWordingForm()) {
      $provider_configuration = $this->entity
        ->getProviderPluginInstance()
        ->submitConfigurationForm($form['ajax_wrapper']['provider_configuration'], $this
        ->getSubFormState('provider_configuration', $form, $form_state), $this->entity);
      $this->entity
        ->setProviderConfiguration($provider_configuration);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $status = $this->entity
      ->save();
    if ($status) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('Saved the %label synonym configuration.', [
        '%label' => $this->entity
          ->label(),
      ]));
    }
    else {
      $this
        ->messenger()
        ->addError($this
        ->t('The %label synonym configuration was not saved.', [
        '%label' => $this->entity
          ->label(),
      ]));
    }
    $form_state
      ->setRedirect('synonym.entity_type.bundle', [
      'synonyms_entity_type' => $this->controlledEntityType,
      'bundle' => $this->controlledBundle,
    ]);
  }

  /**
   * Check whether entity with such ID already exists.
   *
   * @param string $id
   *   Entity ID to check.
   *
   * @return bool
   *   Whether entity with such ID already exists.
   */
  public function exist($id) {
    $entity = $this->entityTypeManager
      ->getStorage('synonym')
      ->getQuery()
      ->condition('id', $id)
      ->execute();
    return (bool) $entity;
  }

  /**
   * Ajax callback.
   */
  public static function ajaxForm(array &$form, FormStateInterface $form_state, Request $request) {
    return $form['ajax_wrapper'];
  }

  /**
   * Supportive method to create sub-form-states.
   *
   * @param string $element_name
   *   Name of the nested form element for which to create a sub form state.
   * @param array $form
   *   Full form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Full form state out of which to create sub form state.
   *
   * @return \Drupal\Core\Form\SubformState
   *   Sub form state object generated based on the input arguments
   */
  protected function getSubFormState($element_name, array $form, FormStateInterface $form_state) {
    return SubformState::createForSubform($form['ajax_wrapper'][$element_name], $form, $form_state);
  }

  /**
   * Helper function which return depends on wording type.
   *
   * @return bool
   *   Whether wording forms should be visible or hidden.
   */
  public function showWordingForm() {
    return \Drupal::config('synonyms.settings')
      ->get('wording_type') == 'provider';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 35
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 3
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 13
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 9
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 6
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 12
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
FormBase::$configFactory protected property The config factory. 3
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. 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.
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.
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.
SynonymForm::$container protected property The container.
SynonymForm::$controlledBundle protected property Bundle that is being edited/added.
SynonymForm::$controlledEntityType protected property Entity type that is being edited/added.
SynonymForm::$entity protected property The synonym entity. Overrides EntityForm::$entity
SynonymForm::$entityTypeBundleInfo protected property The entity type bundle info.
SynonymForm::$entityTypeManager protected property The entity type manager. Overrides EntityForm::$entityTypeManager
SynonymForm::$synonymsProviderPluginManager protected property The synonyms provider plugin manager.
SynonymForm::ajaxForm public static function Ajax callback.
SynonymForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
SynonymForm::exist public function Check whether entity with such ID already exists.
SynonymForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
SynonymForm::getSubFormState protected function Supportive method to create sub-form-states.
SynonymForm::init protected function Initialize the form state and the entity before the first form build. Overrides EntityForm::init
SynonymForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
SynonymForm::showWordingForm public function Helper function which return depends on wording type.
SynonymForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides EntityForm::submitForm
SynonymForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
SynonymForm::__construct public function SynonymForm constructor.