class LingotekSettingsTabContentForm in Lingotek Translation 8

Configure Lingotek

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\lingotek\Form\LingotekConfigFormBase
      • class \Drupal\lingotek\Form\LingotekSettingsTabContentForm

1 string reference to 'LingotekSettingsTabContentForm'

LingotekSettingsController::content in src/Controller/LingotekSettingsController.php

File

src/Form/LingotekSettingsTabContentForm.php, line 16

Contains \Drupal\lingotek\Form\LingotekSettingsTabContentForm.

Namespace

Drupal\lingotek\Form

class LingotekSettingsTabContentForm extends LingotekConfigFormBase {
  protected $profile_options;
  protected $profiles;
  protected $bundles;
  protected $translatable_bundles;

  /**
   * {@inheritdoc}
   */
  public function getFormID() {
    return 'lingotek.settings_tab_content_form';
  }

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

    /** @var \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_config */
    $lingotek_config = \Drupal::service('lingotek.configuration');
    $entity_type_definitions = \Drupal::entityManager()
      ->getDefinitions();

    // Get the profiles
    $this
      ->retrieveProfileOptions();

    // Retrieve bundles
    $this
      ->retrieveBundles();

    // Retrieve translatable bundles
    $this
      ->retrieveTranslatableBundles();
    $form['parent_details'] = array(
      '#type' => 'details',
      '#title' => t('Translate Content Entities'),
    );
    $form['parent_details']['list']['#type'] = 'container';
    $form['parent_details']['list']['#attributes']['class'][] = 'entity-meta';

    // If user specifies no translatable entities, post this message
    if (empty($this->translatable_bundles)) {
      $form['parent_details']['empty_message'] = array(
        '#markup' => t('There are no translatable content entities specified. You can enable translation for the desired content entities on the <a href=":translation-entity">Content language</a> page.', [
          ':translation-entity' => \Drupal::url('language.content_settings_page'),
        ]),
      );
    }

    // I. Loop through all entities and create a details container for each
    foreach ($this->translatable_bundles as $entity_id => $bundles) {
      $entity_key = 'entity-' . $entity_id;
      $form['parent_details']['list'][$entity_key] = array(
        '#type' => 'details',
        '#title' => $entity_type_definitions[$entity_id]
          ->getLabel(),
        'content' => array(),
      );
      $bundle_label = $entity_type_definitions[$entity_id]
        ->getBundleLabel();
      $header = array(
        $this
          ->t('Enable'),
        $bundle_label,
        $this
          ->t('Translation Profile'),
        $this
          ->t('Fields'),
      );
      $table = array(
        '#type' => 'table',
        '#header' => $header,
        '#empty' => $this
          ->t('No Entries'),
      );

      // II. Loop through bundles per entity and make a table
      foreach ($bundles as $bundle_id => $bundle) {
        $row = array();
        $row['enabled'] = [
          '#type' => 'checkbox',
          '#label' => $this
            ->t('Enabled'),
          '#default_value' => $lingotek_config
            ->isEnabled($entity_id, $bundle_id),
        ];
        $row['content_type'] = array(
          '#markup' => $bundle['label'],
        );
        $row['profiles'] = $this
          ->retrieveProfiles($entity_id, $bundle_id);
        $row['fields'] = $this
          ->retrieveFields($entity_id, $bundle_id);
        $table[$bundle_id] = $row;
      }

      // III. Add table to respective details
      $form['parent_details']['list'][$entity_key]['content'][$entity_id] = $table;
    }
    if (!empty($this->translatable_bundles)) {
      $form['parent_details']['note'] = array(
        '#markup' => t('Note: changing the profile will update all settings for existing nodes except for the project, workflow, vault, and storage method (e.g. node/field)'),
      );
      $form['parent_details']['actions']['#type'] = 'actions';
      $form['parent_details']['actions']['submit'] = array(
        '#type' => 'submit',
        '#value' => $this
          ->t('Save'),
        '#button_type' => 'primary',
      );
    }
    $form['#attached']['library'][] = 'lingotek/lingotek.settings';
    return $form;
  }

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

    /** @var \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_config */
    $lingotek_config = \Drupal::service('lingotek.configuration');
    $form_values = $form_state
      ->getValues();
    $data = array();

    // For every content type, save the profile and fields in the Lingotek object
    foreach ($this->translatable_bundles as $entity_id => $bundles) {
      foreach ($form_values[$entity_id] as $bundle_id => $bundle) {

        // Only process if we have marked the checkbox.
        if ($bundle['enabled']) {
          if (!$lingotek_config
            ->isEnabled($entity_id, $bundle_id)) {
            $lingotek_config
              ->setEnabled($entity_id, $bundle_id);
          }
          foreach ($bundle['fields'] as $field_id => $field_choice) {
            if ($field_choice == 1) {
              $lingotek_config
                ->setFieldLingotekEnabled($entity_id, $bundle_id, $field_id);
              if (isset($form_values[$entity_id][$bundle_id]['fields'][$field_id . ':properties'])) {
                $lingotek_config
                  ->setFieldPropertiesLingotekEnabled($entity_id, $bundle_id, $field_id, $form_values[$entity_id][$bundle_id]['fields'][$field_id . ':properties']);
              }
            }
            else {
              if ($field_choice == 0) {
                $lingotek_config
                  ->setFieldLingotekEnabled($entity_id, $bundle_id, $field_id, FALSE);
                if (isset($form_values[$entity_id][$bundle_id]['fields'][$field_id . ':properties'])) {
                  $properties = array_keys($form_values[$entity_id][$bundle_id]['fields'][$field_id . ':properties']);
                  $properties = array_fill_keys($properties, 0);
                  $lingotek_config
                    ->setFieldPropertiesLingotekEnabled($entity_id, $bundle_id, $field_id, $properties);
                }
              }
            }
          }
          $lingotek_config
            ->setDefaultProfileId($entity_id, $bundle_id, $form_values[$entity_id][$bundle_id]['profiles']);
        }
        else {

          // If we removed it, unable it.
          $lingotek_config
            ->setEnabled($entity_id, $bundle_id, FALSE);
        }
      }
    }
    parent::submitForm($form, $form_state);
  }
  protected function retrieveProfileOptions() {
    $this->profiles = \Drupal::entityManager()
      ->getListBuilder('lingotek_profile')
      ->load();
    foreach ($this->profiles as $profile) {
      $this->profile_options[$profile
        ->id()] = $profile
        ->label();
    }
  }
  protected function retrieveBundles() {
    $entities = \Drupal::entityManager()
      ->getDefinitions();
    $this->bundles = array();
    foreach ($entities as $entity) {
      if ($entity instanceof ContentEntityType && $entity
        ->hasKey('langcode')) {
        $bundle = \Drupal::entityManager()
          ->getBundleInfo($entity
          ->id());
        $this->bundles[$entity
          ->id()] = $bundle;
      }
    }
  }
  protected function retrieveTranslatableBundles() {
    $this->translatable_bundles = array();
    foreach ($this->bundles as $bundle_group_id => $bundle_group) {
      foreach ($bundle_group as $bundle_id => $bundle) {
        if ($bundle['translatable']) {
          $this->translatable_bundles[$bundle_group_id][$bundle_id] = $bundle;
        }
      }
    }
  }
  protected function retrieveProfiles($entity_id, $bundle_id) {

    /** @var \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_config */
    $lingotek_config = \Drupal::service('lingotek.configuration');
    $select = array(
      '#type' => 'select',
      '#options' => $lingotek_config
        ->getProfileOptions(),
      '#default_value' => $lingotek_config
        ->getDefaultProfileId($entity_id, $bundle_id),
    );
    return $select;
  }
  protected function retrieveFields($entity_id, $bundle_id) {
    $entity_type = \Drupal::entityManager()
      ->getDefinition($entity_id);

    /** @var \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_config */
    $lingotek_config = \Drupal::service('lingotek.configuration');
    $content_translation_manager = \Drupal::service('content_translation.manager');
    $storage_definitions = \Drupal::entityManager()
      ->getFieldStorageDefinitions($entity_id);
    $field_checkboxes = array();
    if ($content_translation_manager
      ->isSupported($entity_id)) {
      $fields = \Drupal::entityManager()
        ->getFieldDefinitions($entity_id, $bundle_id);

      // Find which fields the user previously selected
      foreach ($fields as $field_id => $field_definition) {
        $checkbox_choice = 0;

        // We allow non-translatable entity_reference_revisions fields through.
        // See https://www.drupal.org/node/2788285
        if (!empty($storage_definitions[$field_id]) && $storage_definitions[$field_id]
          ->getProvider() != 'content_translation' && !in_array($storage_definitions[$field_id]
          ->getName(), [
          $entity_type
            ->getKey('langcode'),
          $entity_type
            ->getKey('default_langcode'),
          'revision_translation_affected',
        ]) && ($field_definition
          ->isTranslatable() || ($field_definition
          ->getType() == 'entity_reference_revisions' || $field_definition
          ->getType() == 'path')) && !$field_definition
          ->isComputed() && !$field_definition
          ->isReadOnly()) {
          if ($value = $lingotek_config
            ->isFieldLingotekEnabled($entity_id, $bundle_id, $field_id)) {
            $checkbox_choice = $value;
          }
          $field_checkbox = array(
            '#type' => 'checkbox',
            '#title' => $field_definition
              ->getLabel(),
            '#default_value' => $checkbox_choice,
          );
          $field_checkboxes[$field_id] = $field_checkbox;

          // Display the column translatability configuration widget.
          module_load_include('inc', 'content_translation', 'content_translation.admin');
          $column_element = content_translation_field_sync_widget($field_definition);
          if ($column_element) {
            $properties_checkbox_choice = $lingotek_config
              ->getFieldPropertiesLingotekEnabled($entity_id, $bundle_id, $field_id);
            $field_checkbox = array(
              '#type' => 'checkboxes',
              '#options' => $column_element['#options'],
              '#default_value' => $properties_checkbox_choice ?: [],
              '#attributes' => [
                'class' => array(
                  'field-property-checkbox',
                ),
              ],
            );
            $field_checkboxes[$field_id . ':properties'] = $field_checkbox;
          }
        }
        elseif ($field_definition
          ->getType() == 'path' && $field_definition
          ->isComputed()) {
          if ($value = $lingotek_config
            ->isFieldLingotekEnabled($entity_id, $bundle_id, $field_id)) {
            $checkbox_choice = $value;
          }
          $field_checkbox = array(
            '#type' => 'checkbox',
            '#title' => $field_definition
              ->getLabel(),
            '#default_value' => $checkbox_choice,
          );
          $field_checkboxes[$field_id] = $field_checkbox;
        }
      }
    }
    return $field_checkboxes;
  }

}

Members

Name	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
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
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
LingotekConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create	3
LingotekConfigFormBase::getEditableConfigNames	public	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LingotekConfigFormBase::__construct	public	function	Constructs a \Drupal\lingotek\Form\LingotekConfigFormBase object. Overrides ConfigFormBase::__construct	3
LingotekSettingsTabContentForm::$bundles	protected	property
LingotekSettingsTabContentForm::$profiles	protected	property
LingotekSettingsTabContentForm::$profile_options	protected	property
LingotekSettingsTabContentForm::$translatable_bundles	protected	property
LingotekSettingsTabContentForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
LingotekSettingsTabContentForm::getFormID	public	function
LingotekSettingsTabContentForm::retrieveBundles	protected	function
LingotekSettingsTabContentForm::retrieveFields	protected	function
LingotekSettingsTabContentForm::retrieveProfileOptions	protected	function
LingotekSettingsTabContentForm::retrieveProfiles	protected	function
LingotekSettingsTabContentForm::retrieveTranslatableBundles	protected	function
LingotekSettingsTabContentForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.