You are here

Home » API reference » Display Suite 8.4 » BlockFieldForm.php

class BlockFieldForm in Display Suite 8.4

Same name and namespace in other branches
  1. 8.2 src/Form/BlockFieldForm.php \Drupal\ds\Form\BlockFieldForm
  2. 8.3 src/Form/BlockFieldForm.php \Drupal\ds\Form\BlockFieldForm

Configure block fields.

Hierarchy

Expanded class hierarchy of BlockFieldForm

1 file declares its use of BlockFieldForm
DynamicBlockField.php in src/Plugin/Derivative/DynamicBlockField.php
1 string reference to 'BlockFieldForm'
ds.routing.yml in ./ds.routing.yml
ds.routing.yml

File

src/Form/BlockFieldForm.php, line 14

Namespace

Drupal\ds\Form
View source 
class BlockFieldForm extends FieldFormBase implements ContainerInjectionInterface {

  /**
   * The type of the dynamic ds field.
   */
  const TYPE = 'block';

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $field_key = '') {
    $form = parent::buildForm($form, $form_state, $field_key);
    $field = $this->field;
    $manager = \Drupal::service('plugin.manager.block');
    $blocks = [];
    foreach ($manager
      ->getDefinitions() as $plugin_id => $plugin_definition) {
      $blocks[$plugin_id] = $plugin_definition['admin_label'];
    }
    asort($blocks);
    $form['block_identity']['block'] = [
      '#type' => 'select',
      '#options' => $blocks,
      '#title' => $this
        ->t('Block'),
      '#required' => TRUE,
      '#default_value' => isset($field['properties']['block']) ? $field['properties']['block'] : '',
    ];
    $form['use_block_title'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use block title as the field label'),
      '#default_value' => isset($field['properties']['use_block_title']) ? $field['properties']['use_block_title'] : FALSE,
      '#weight' => 90,
    ];
    $form['add_block_wrappers'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add block wrappers and classes'),
      '#default_value' => isset($field['properties']['add_block_wrappers']) ? $field['properties']['add_block_wrappers'] : FALSE,
      '#description' => $this
        ->t('Render using the block theme hook to add the block wrappers and clases.'),
      '#weight' => 91,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getProperties(FormStateInterface $form_state) {
    $properties['block'] = $form_state
      ->getValue('block');

    // Preserve existing block config.
    $field_key = $form_state
      ->getValue('id');
    $field = $this
      ->config('ds.field.' . $field_key)
      ->get();
    if (isset($field['properties']) && $field['properties']['block'] == $properties['block']) {
      $properties = $field['properties'];
    }

    // Save configuration.
    $properties['use_block_title'] = $form_state
      ->getValue('use_block_title');
    $properties['add_block_wrappers'] = $form_state
      ->getValue('add_block_wrappers');
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function getType() {
    return BlockFieldForm::TYPE;
  }

  /**
   * {@inheritdoc}
   */
  public function getTypeLabel() {
    return 'Block field';
  }

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

    // Create an instance of the block to find out if it has a config form.
    // Redirect to the block config form if there is one.

    /* @var $block \Drupal\Core\Block\BlockPluginInterface */
    $manager = \Drupal::service('plugin.manager.block');
    $block_id = $this->field['properties']['block'];
    $block = $manager
      ->createInstance($block_id);

    // Inject default theme in form state (Site branding needs it for instance).
    $form_state = new FormState();
    $default_theme = $this
      ->config('system.theme')
      ->get('default');
    $form_state
      ->set('block_theme', $default_theme);
    $block_config_form = $block
      ->blockForm([], $form_state);
    if ($block_config_form) {
      $url = new Url('ds.manage_block_field_config', [
        'field_key' => $this->field['id'],
      ]);
      $form_state
        ->setRedirectUrl($url);
    }

    // Invalidate all blocks.
    Cache::invalidateTags([
      'config:ds.block_base',
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockFieldForm::buildForm public function Form constructor. Overrides FieldFormBase::buildForm
BlockFieldForm::getFormId public function Returns a unique string identifying the form. Overrides FieldFormBase::getFormId
BlockFieldForm::getProperties public function Returns the properties for the custom field. Overrides FieldFormBase::getProperties
BlockFieldForm::getType public function Returns the type of the field. Overrides FieldFormBase::getType
BlockFieldForm::getTypeLabel public function Returns the admin label for the field on the field overview page. Overrides FieldFormBase::getTypeLabel
BlockFieldForm::submitForm public function Form submission handler. Overrides FieldFormBase::submitForm
BlockFieldForm::TYPE constant The type of the dynamic ds field.
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
FieldFormBase::$cacheInvalidator protected property Holds the cache invalidator.
FieldFormBase::$entityTypeManager protected property Holds the entity type manager.
FieldFormBase::$field protected property The field properties.
FieldFormBase::$moduleHandler protected property Drupal module handler.
FieldFormBase::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create 1
FieldFormBase::finishSubmitForm public function Finishes the submit.
FieldFormBase::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
FieldFormBase::uniqueFieldName public function Returns whether a field machine name is unique.
FieldFormBase::__construct public function Constructs a \Drupal\system\CustomFieldFormBase object. Overrides ConfigFormBase::__construct 1
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.