ConfigPagesForm.php in Config Pages 8.2

Namespace

Drupal\config_pages

File

src/ConfigPagesForm.php

<?php

namespace Drupal\config_pages;

use Drupal\Component\Utility\Html;
use Drupal\config_pages\Entity\ConfigPagesType;
use Drupal\Core\Entity\ContentEntityForm;
use Drupal\Core\Entity\EntityRepositoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\Core\Render\Markup;
use Drupal\Core\Session\AccountProxyInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Field\FieldConfigInterface;
use Drupal\Core\Url;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Messenger\MessengerInterface;

/**
 * Form controller for the custom config page edit forms.
 */
class ConfigPagesForm extends ContentEntityForm {

  /**
   * The custom config page storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $configPagesStorage;

  /**
   * The custom config page type storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $configPagesTypeStorage;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The config page content entity.
   *
   * @var \Drupal\config_pages\ConfigPagesInterface
   */
  protected $entity;

  /**
   * User proxy, for checking permissions.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $user;

  /**
   * The Messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs a ConfigPagesForm object.
   *
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
   *   Entity repository.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity manager.
   * @param \Drupal\Core\Entity\EntityStorageInterface $config_pages_storage
   *   The custom config page storage.
   * @param \Drupal\Core\Entity\EntityStorageInterface $config_pages_type_storage
   *   The custom config page type storage.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param MessengerInterface $messenger
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle service.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   * @param \Drupal\Core\Session\AccountProxyInterface $user
   *   User proxy, for checking permissions.
   */
  public function __construct(EntityRepositoryInterface $entity_repository, EntityTypeManagerInterface $entity_type_manager, EntityStorageInterface $config_pages_storage, EntityStorageInterface $config_pages_type_storage, LanguageManagerInterface $language_manager, MessengerInterface $messenger, EntityTypeBundleInfoInterface $entity_type_bundle_info = NULL, TimeInterface $time = NULL, AccountProxyInterface $user = NULL) {
    parent::__construct($entity_repository, $entity_type_bundle_info, $time);
    $this->configPagesStorage = $config_pages_storage;
    $this->configPagesTypeStorage = $config_pages_type_storage;
    $this->languageManager = $language_manager;
    $this->entityTypeManager = $entity_type_manager;
    $this->user = $user;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $entity_type_manager = $container
      ->get('entity_type.manager');
    return new static($container
      ->get('entity.repository'), $entity_type_manager, $entity_type_manager
      ->getStorage('config_pages'), $entity_type_manager
      ->getStorage('config_pages_type'), $container
      ->get('language_manager'), $container
      ->get('messenger'), $container
      ->get('entity_type.bundle.info'), $container
      ->get('datetime.time'), $container
      ->get('current_user'));
  }

  /**
   * Overrides \Drupal\Core\Entity\EntityForm::prepareEntity().
   *
   * Prepares the custom config page object.
   *
   * Fills in a few default values, and then invokes
   * hook_config_pages_prepare() on all modules.
   */
  protected function prepareEntity() {
    $config_pages = $this->entity;

    // Set up default values, if required.
    $this->configPagesTypeStorage
      ->load($config_pages
      ->bundle());
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $config_pages = $this->entity;
    $config_pages_type = $this->configPagesTypeStorage
      ->load($config_pages
      ->bundle());
    $form = parent::form($form, $form_state, $config_pages);
    $conditions['type'] = $config_pages
      ->bundle();
    $list = $this->entityTypeManager
      ->getStorage('config_pages')
      ->loadByProperties($conditions);

    // Show context message.
    $show_warning = $config_pages_type->context['show_warning'];
    $label = $config_pages_type
      ->getContextLabel();
    if (!empty($label) && $show_warning) {
      $this->messenger
        ->addWarning($this
        ->t('Please note that this Page is context sensitive, current context is %label', [
        '%label' => $label,
      ]));
    }
    if ($this->operation == 'edit') {
      $form['#title'] = $this
        ->t('Edit custom config page %label', [
        '%label' => $config_pages
          ->label(),
      ]);
    }

    // Override the default CSS class name, since the user-defined custom
    // config page type name in 'TYPE-config-page-form' potentially clashes
    // with third-party class names.
    $form['#attributes']['class'][0] = 'config-page-' . Html::getClass($config_pages
      ->bundle()) . '-form';

    // Create form elements to select another context.
    $links = $config_pages_type
      ->getContextLinks();
    foreach ($links as $group_id => $context_links) {

      // If no contextual links provided then just don't show fieldset.
      if (!count($context_links)) {
        continue;
      }

      // Fieldset to handle Context links.
      $form['context_selection_' . $group_id] = [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('Choose @name context', [
          '@name' => $group_id,
        ]),
        '#weight' => -100,
      ];

      // Links to switch between available contexts.
      foreach ($context_links as $pos => $link) {
        if ($link['selected']) {
          $link['title'] = Markup::create('<strong>' . $link['title'] . '</strong>');
        }
        $form['context_selection_' . $group_id][$link['value']] = [
          '#type' => 'link',
          '#url' => $link['href'],
          '#title' => $link['title'],
          '#prefix' => $pos > 0 ? ' | ' : '',
        ];
      }
    }

    // Add context import fieldset if any CP exists at this moment.
    if (!$this->entity
      ->get('context')
      ->isEmpty()) {
      $options = [];
      foreach ($list as $id => $item) {

        // Build options list.
        if ($config_pages
          ->id() != $id) {
          $value = $item
            ->get('context')
            ->first()
            ->getValue();
          $params = unserialize($value['value']);
          $string = '';
          if (is_array($params)) {
            foreach ($params as $param) {
              foreach ($param as $name => $val) {
                $string .= $name . ' - ' . $val . ';';
              }
            }
            $options[$id] = $string;
          }
        }
      }

      // Show form if any data available.
      if (!empty($options)) {
        $form['other_context'] = [
          '#type' => 'details',
          '#tree' => TRUE,
          '#title' => t('Import'),
          '#weight' => 1000,
        ];
        $form['other_context']['list'] = [
          '#type' => 'select',
          '#options' => $options,
        ];
        $form['other_context']['submit'] = [
          '#type' => 'submit',
          '#value' => t('Import'),
          '#prefix' => '<div class="import-form-actions">',
          '#suffix' => '</div>',
          '#submit' => [
            '::configPagesImportValues',
          ],
        ];
      }
    }
    return $form;
  }

  /**
   * Clear field values submit callback.
   *
   * @param array $form
   *   Form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   */
  public function configPagesClearValues(array $form, FormStateInterface $form_state) {
    $entity = $this->entity;
    $form_state
      ->setRedirectUrl(Url::fromRoute('entity.config_pages.clear_confirmation', [
      'config_pages' => $entity
        ->id(),
    ]));
  }

  /**
   * Form submit.
   *
   * Import other context submit callback.
   */
  public function configPagesImportValues(array $form, FormStateInterface $form_state) {
    $entity = $this->entity;
    if ($imported_entity_id = $form_state
      ->getValue('other_context')['list']) {
      $entityStorage = $this->entityTypeManager
        ->getStorage('config_pages');
      $imported_entity = $entityStorage
        ->load($imported_entity_id);
      foreach ($entity as $name => &$value) {

        // Process only fields added from BO.
        if ($value
          ->getFieldDefinition() instanceof FieldConfigInterface) {
          $entity
            ->set($name, $imported_entity
            ->get($name)
            ->getValue());
        }
      }
      $entity
        ->save();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $config_pages = $this->entity;
    $type = ConfigPagesType::load($config_pages
      ->bundle());
    if (!$config_pages
      ->label()) {
      $config_pages
        ->setLabel($type
        ->label());
    }
    $config_pages->context = $type
      ->getContextData();

    // Save as a new revision if requested to do so.
    if (!$form_state
      ->isValueEmpty('revision')) {
      $config_pages
        ->setNewRevision();
    }
    $insert = $config_pages
      ->isNew();
    $config_pages
      ->save();
    $context = [
      '@type' => $config_pages
        ->bundle(),
      '%info' => $config_pages
        ->label(),
    ];
    $logger = $this
      ->logger('config_pages');
    $config_pages_type = $this->configPagesTypeStorage
      ->load($config_pages
      ->bundle());
    $t_args = [
      '@type' => $config_pages_type
        ->label(),
      '%info' => $config_pages
        ->label(),
    ];
    if ($insert) {
      $logger
        ->notice('@type: added %info.', $context);
      $this->messenger
        ->addStatus($this
        ->t('@type %info has been created.', $t_args));
    }
    else {
      $logger
        ->notice('@type: updated %info.', $context);
      $this->messenger
        ->addStatus($this
        ->t('@type %info has been updated.', $t_args));
    }
    if ($config_pages
      ->id()) {
      $form_state
        ->setValue('id', $config_pages
        ->id());
      $form_state
        ->set('id', $config_pages
        ->id());
    }
    else {

      // In the unlikely case something went wrong on save, the config page
      // will be rebuilt and config page form redisplayed.
      $this->messenger
        ->addError($this
        ->t('The config page could not be saved.'));
      $form_state
        ->setRebuild();
    }
  }

  /**
   * Returns an array of supported actions for the current entity form.
   *
   * @todo Consider introducing a 'preview' action here, since it is used by
   *   many entity types.
   *
   * @param array $form
   *   Form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   *
   * @return array
   *   Array of actions.
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $entity = $this->entity;

    // Save ConfigPage entity.
    $actions['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#submit' => [
        '::submitForm',
        '::save',
      ],
    ];
    if (!$entity
      ->isNew()) {

      // Add button to reset values.
      $actions['reset'] = [
        '#type' => 'submit',
        '#value' => t('Clear values'),
        '#submit' => [
          '::configPagesClearValues',
        ],
        '#button_type' => "submit",
        '#access' => $this->user
          ->hasPermission('administer config_pages entity'),
      ];
    }
    return $actions;
  }

}

Classes

Name	Description
ConfigPagesForm	Form controller for the custom config page edit forms.