You are here

Home » API reference » CKEditor Entity Link 8 » CKEditorEntityLinkConfigForm.php

class CKEditorEntityLinkConfigForm in CKEditor Entity Link 8

Class CKEditorEntityLinkConfigForm.

@package Drupal\ckeditor_entity_link\Form

Hierarchy

Expanded class hierarchy of CKEditorEntityLinkConfigForm

1 string reference to 'CKEditorEntityLinkConfigForm'
ckeditor_entity_link.routing.yml in ./ckeditor_entity_link.routing.yml
ckeditor_entity_link.routing.yml

File

src/Form/CKEditorEntityLinkConfigForm.php, line 19

Namespace

Drupal\ckeditor_entity_link\Form
View source 
class CKEditorEntityLinkConfigForm extends ConfigFormBase {

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

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

  /**
   * Class constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity type manager service.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundle_info
   *   The entity bundle information service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $bundle_info) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entity_type_manager;
    $this->bundleInfo = $bundle_info;
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'ckeditor_entity_link.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'ckeditor_entity_link_config_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('ckeditor_entity_link.settings');
    $entity_types = $this->entityTypeManager
      ->getDefinitions();
    $options = [];
    foreach ($entity_types as $entity_type) {
      if ($entity_type
        ->getGroup() == 'content') {
        $options[$entity_type
          ->id()] = $entity_type
          ->getLabel();
      }
    }
    if (!$options) {
      return [
        '#markup' => 'No entity types',
      ];
    }
    $form['entity_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Entity types'),
      '#options' => $options,
      '#default_value' => $config
        ->get('entity_types'),
      '#required' => TRUE,
      '#ajax' => [
        'callback' => '::updateTypeSettings',
        'effect' => 'fade',
      ],
    ];
    $form['bundles'] = [
      '#type' => 'container',
      '#prefix' => '<div id="bundles-wrapper">',
      '#suffix' => '</div>',
    ];
    $selected_types = empty($form_state
      ->getValue('entity_types')) ? $config
      ->get('entity_types') : $form_state
      ->getValue('entity_types');
    foreach ($selected_types as $type) {
      if (!empty($type)) {
        $bundle_info = $this->bundleInfo
          ->getBundleInfo($type);
        $bundles = [];
        foreach ($bundle_info as $bundle => $info) {
          $bundles[$bundle] = $info['label'];
        }
        $form['bundles'][$type] = [
          '#type' => 'fieldset',
          '#title' => $this
            ->t('@bundles', [
            '@bundles' => $options[$type] . ' bundles',
          ]),
        ];
        $form['bundles'][$type][$type . '_bundles'] = [
          '#type' => 'checkboxes',
          '#options' => $bundles,
          '#default_value' => $config
            ->get($type . '_bundles'),
          '#description' => $this
            ->t('Select bundles to be available as autocomplete suggestions. If no selected, all will be available.'),
        ];
      }
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('ckeditor_entity_link.settings');
    $types = $form_state
      ->getValue('entity_types');
    $config
      ->set('entity_types', $types);
    foreach ($types as $type) {
      $config
        ->set($type . '_bundles', $form_state
        ->getValue($type . '_bundles'));
    }
    $config
      ->save();
  }

  /**
   * Ajax callback to update the form fields which depend on embed type.
   *
   * @param array $form
   *   The build form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   Ajax response with updated options for the embed type.
   */
  public function updateTypeSettings(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();

    // Update options for entity type bundles.
    $response
      ->addCommand(new ReplaceCommand('#bundles-wrapper', $form['bundles']));
    return $response;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CKEditorEntityLinkConfigForm::$bundleInfo protected property The bundle information service.
CKEditorEntityLinkConfigForm::$entityTypeManager protected property Entity type manager service.
CKEditorEntityLinkConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CKEditorEntityLinkConfigForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
CKEditorEntityLinkConfigForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CKEditorEntityLinkConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CKEditorEntityLinkConfigForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
CKEditorEntityLinkConfigForm::updateTypeSettings public function Ajax callback to update the form fields which depend on embed type.
CKEditorEntityLinkConfigForm::__construct public function Class constructor. 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.