class BlockFieldConfigForm in Display Suite 8.4

Same name and namespace in other branches

8.2 src/Form/BlockFieldConfigForm.php \Drupal\ds\Form\BlockFieldConfigForm
8.3 src/Form/BlockFieldConfigForm.php \Drupal\ds\Form\BlockFieldConfigForm

Configure block fields.

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\ds\Form\FieldFormBase implements ContainerInjectionInterface
    class \Drupal\ds\Form\BlockFieldConfigForm implements ContainerInjectionInterface uses ContextAwarePluginAssignmentTrait

Expanded class hierarchy of BlockFieldConfigForm

1 string reference to 'BlockFieldConfigForm'

ds.routing.yml in ./ds.routing.yml: ds.routing.yml

File

src/Form/BlockFieldConfigForm.php, line 19

Namespace

Drupal\ds\Form

View source

class BlockFieldConfigForm extends FieldFormBase implements ContainerInjectionInterface {
  use ContextAwarePluginAssignmentTrait;

  /**
   * The context repository.
   *
   * @var \Drupal\Core\Plugin\Context\ContextRepositoryInterface
   */
  protected $contextRepository;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactory $config_factory, EntityTypeManagerInterface $entity_type_manager, CacheTagsInvalidatorInterface $cache_invalidator, ModuleHandler $module_handler, ContextRepositoryInterface $context_repository) {
    parent::__construct($config_factory, $entity_type_manager, $cache_invalidator, $module_handler);
    $this->contextRepository = $context_repository;
  }

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

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

    // Fetch field.
    $field = $this
      ->config('ds.field.' . $field_key)
      ->get();

    // Inject default theme in form state (Site branding needs it for instance).
    $default_theme = $this
      ->config('system.theme')
      ->get('default');
    $form_state
      ->set('block_theme', $default_theme);

    // Save the field for future reuse.
    $this->field = $field;

    // Create an instance of the block.

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

    // Set block config form default values.
    if (isset($field['properties']['config'])) {
      $block
        ->setConfiguration($field['properties']['config']);
    }

    // Get block config form.
    $form = $block
      ->blockForm($form, $form_state);

    // If the block is context aware, attach the mapping widget.
    if ($block instanceof ContextAwarePluginInterface) {
      $form['context_mapping'] = $this
        ->addContextAssignmentElement($block, $this->contextRepository
        ->getAvailableContexts());
    }
    if (!$form) {
      return [
        '#markup' => $this
          ->t("This block has no configuration options."),
      ];
    }

    // Some form items require this (core block manager also sets this).
    $form['#tree'] = TRUE;
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#weight' => 100,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $field = $this->field;

    // Create an instance of the block.

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

    // Validate block config data using the block's validation handler.
    $block
      ->validateConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $field = $this->field;

    // Create an instance of the block.

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

    // Process block config data using the block's submit handler.
    $block
      ->blockSubmit($form, $form_state);

    // If the block is context aware, store the context mapping.
    if ($block instanceof ContextAwarePluginInterface && $block
      ->getContextDefinitions()) {
      $context_mapping = $form_state
        ->getValue('context_mapping', []);
      $block
        ->setContextMapping($context_mapping);
    }
    $block_config = $block
      ->getConfiguration();

    // Clear cache tags.
    $this->cacheInvalidator
      ->invalidateTags($block
      ->getCacheTags());

    // Save block config.
    $this
      ->config('ds.field.' . $field['id'])
      ->set('properties.config', $block_config)
      ->save();

    // Clear caches and redirect.
    $this
      ->finishSubmitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockFieldConfigForm::$contextRepository	protected	property	The context repository.
BlockFieldConfigForm::buildForm	public	function	Form constructor. Overrides FieldFormBase::buildForm
BlockFieldConfigForm::create	public static	function	Instantiates a new instance of this class. Overrides FieldFormBase::create
BlockFieldConfigForm::submitForm	public	function	Form submission handler. Overrides FieldFormBase::submitForm
BlockFieldConfigForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
BlockFieldConfigForm::__construct	public	function	Constructs a \Drupal\system\CustomFieldFormBase object. Overrides FieldFormBase::__construct
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginAssignmentTrait::t	abstract protected	function	Ensures the t() method is available.
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::finishSubmitForm	public	function	Finishes the submit.
FieldFormBase::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
FieldFormBase::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId	4
FieldFormBase::getProperties	public	function	Returns the properties for the custom field.	4
FieldFormBase::getType	public	function	Returns the type of the field.	4
FieldFormBase::getTypeLabel	public	function	Returns the admin label for the field on the field overview page.	4
FieldFormBase::uniqueFieldName	public	function	Returns whether a field machine name is unique.
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.
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
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.

You are here

class BlockFieldConfigForm in Display Suite 8.4

Hierarchy

File

Namespace

Members

API Navigation