class WebformBlock in Webform 8.5

Same name and namespace in other branches

6.x src/Plugin/Block/WebformBlock.php \Drupal\webform\Plugin\Block\WebformBlock

Provides a 'Webform' block.

Plugin annotation


@Block(
  id = "webform_block",
  admin_label = @Translation("Webform"),
  category = @Translation("Webform")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\webform\Plugin\Block\WebformBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of WebformBlock

1 file declares its use of WebformBlock

WebformBlockTest.php in tests/src/Unit/Plugin/Block/WebformBlockTest.php

File

src/Plugin/Block/WebformBlock.php, line 28

Namespace

Drupal\webform\Plugin\Block

View source

class WebformBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

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

  /**
   * The webform token manager.
   *
   * @var \Drupal\webform\WebformTokenManagerInterface
   */
  protected $tokenManager;

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Creates a WebformBlock instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\webform\WebformTokenManagerInterface $token_manager
   *   The webform token manager.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RequestStack $request_stack, EntityTypeManagerInterface $entity_type_manager, WebformTokenManagerInterface $token_manager, RouteMatchInterface $route_match = NULL) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->requestStack = $request_stack;
    $this->entityTypeManager = $entity_type_manager;
    $this->tokenManager = $token_manager;
    $this->routeMatch = $route_match ?: \Drupal::routeMatch();
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('request_stack'), $container
      ->get('entity_type.manager'), $container
      ->get('webform.token_manager'), $container
      ->get('current_route_match'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'webform_id' => '',
      'default_data' => '',
      'redirect' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $wrapper_format = $this->requestStack
      ->getCurrentRequest()
      ->get(MainContentViewSubscriber::WRAPPER_FORMAT);
    $is_off_canvas = in_array($wrapper_format, [
      'drupal_dialog.off_canvas',
    ]);

    // Get title, description, and code example.
    $title = $this
      ->t('Default webform submission data (YAML)');
    $description = [
      'content' => [
        '#markup' => $this
          ->t('Enter submission data as name and value pairs as <a href=":href">YAML</a> which will be used to prepopulate the selected webform.', [
          ':href' => 'https://en.wikipedia.org/wiki/YAML',
        ]),
        '#suffix' => ' ',
      ],
      'token' => $this->tokenManager
        ->buildTreeLink(),
    ];
    $example = [];
    $example[] = '# ' . $this
      ->t('This is an example of a comment.');
    $example[] = "element_key: 'some value'";
    $example[] = '';
    $example[] = '# ' . $this
      ->t("The below example uses a token to get the current node's title.");
    $example[] = "title: '[webform_submission:node:title:clear]'";
    $example[] = '';
    $example[] = '# ' . $this
      ->t("Add ':clear' to the end token to return an empty value when the token is missing.");
    $example[] = '# ' . $this
      ->t('The below example uses a token to get a field value from the current node.');
    $example[] = "full_name: '[webform_submission:node:field_full_name:clear]'";
    $example[] = '';
    $form['#attributes'] = [
      'class' => [
        'webform-block-settings-tray-form',
      ],
    ];
    $form['webform_id'] = [
      '#title' => $this
        ->t('Webform'),
      '#type' => 'entity_autocomplete',
      '#target_type' => 'webform',
      '#required' => TRUE,
      '#default_value' => $this
        ->getWebform(),
    ];
    if ($is_off_canvas) {
      $form['default_data'] = [
        '#title' => $title,
        '#type' => 'textarea',
        '#default_value' => $this->configuration['default_data'],
        '#webform_element' => TRUE,
        '#description' => $description,
        '#more_title' => $this
          ->t('Example'),
        '#wrapper_attributes' => [
          'class' => [
            'webform-default-data',
          ],
        ],
        '#more' => [
          '#markup' => implode(PHP_EOL, $example),
          '#prefix' => '<pre>',
          '#suffix' => '</pre>',
        ],
      ];
      $form['#attached']['library'][] = 'webform/webform.off_canvas';
    }
    else {
      $form['default_data'] = [
        '#title' => $title,
        '#type' => 'webform_codemirror',
        '#mode' => 'yaml',
        '#default_value' => $this->configuration['default_data'],
        '#webform_element' => TRUE,
        '#description' => $description,
        '#more_title' => $this
          ->t('Example'),
        '#more' => [
          '#theme' => 'webform_codemirror',
          '#type' => 'yaml',
          '#code' => implode(PHP_EOL, $example),
        ],
      ];
    }
    $form['redirect'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Redirect to the webform'),
      '#default_value' => $this->configuration['redirect'],
      '#return_value' => TRUE,
      '#description' => $this
        ->t('If your webform has multiple pages, this will change the behavior of the "Next" button. This will also affect where validation messages show up after an error.'),
    ];
    $form['token_tree_link'] = $this->tokenManager
      ->buildTreeElement();
    $this->tokenManager
      ->elementValidate($form);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['webform_id'] = $form_state
      ->getValue('webform_id');
    $this->configuration['default_data'] = $form_state
      ->getValue('default_data');
    $this->configuration['redirect'] = $form_state
      ->getValue('redirect');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $webform = $this
      ->getWebform();
    if (!$webform) {
      if (strpos($this->routeMatch
        ->getRouteName(), 'layout_builder.') === 0) {
        return [
          '#markup' => $this
            ->t('The webform (@webform) is broken or missing.', [
            '@webform' => $this->configuration['webform_id'],
          ]),
        ];
      }
      else {
        return [];
      }
    }
    $build = [
      '#type' => 'webform',
      '#webform' => $webform,
      '#default_data' => WebformYaml::decode($this->configuration['default_data']),
    ];

    // If redirect, set the #action property on the form.
    if ($this->configuration['redirect']) {
      $build['#action'] = $this
        ->getWebform()
        ->toUrl()
        ->setOption('query', $this->requestStack
        ->getCurrentRequest()->query
        ->all())
        ->toString();
    }
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    $webform = $this
      ->getWebform();
    if (!$webform) {
      return AccessResult::forbidden();
    }
    $access_result = $webform
      ->access('submission_create', $account, TRUE);
    if ($access_result
      ->isAllowed()) {
      return $access_result;
    }
    $has_access_denied_message = $webform
      ->getSetting('form_access_denied') !== WebformInterface::ACCESS_DENIED_DEFAULT;
    return AccessResult::allowedIf($has_access_denied_message)
      ->addCacheableDependency($access_result);
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();
    if ($webform = $this
      ->getWebform()) {
      $dependencies[$webform
        ->getConfigDependencyKey()][] = $webform
        ->getConfigDependencyName();
    }
    return $dependencies;
  }

  /**
   * Get this block instance webform.
   *
   * @return \Drupal\webform\WebformInterface
   *   A webform or NULL.
   */
  protected function getWebform() {
    return $this->entityTypeManager
      ->getStorage('webform')
      ->load($this->configuration['webform_id']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE		constant	Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration	protected	property	The transliteration service.
BlockPluginTrait::access	public	function
BlockPluginTrait::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::blockValidate	public	function		3
BlockPluginTrait::buildConfigurationForm	public	function	Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements.	2
BlockPluginTrait::getConfiguration	public	function		1
BlockPluginTrait::getMachineNameSuggestion	public	function		1
BlockPluginTrait::getPreviewFallbackString	public	function		3
BlockPluginTrait::label	public	function
BlockPluginTrait::setConfiguration	public	function
BlockPluginTrait::setConfigurationValue	public	function
BlockPluginTrait::setTransliteration	public	function	Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm	public	function	Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration	protected	function	Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm	public	function	Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().	1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass	public	function
PluginWithFormsTrait::hasFormClass	public	function
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2
WebformBlock::$entityTypeManager	protected	property	Entity type manager.
WebformBlock::$requestStack	protected	property	The request stack.
WebformBlock::$routeMatch	protected	property	The route match.
WebformBlock::$tokenManager	protected	property	The webform token manager.
WebformBlock::blockAccess	protected	function	Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
WebformBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
WebformBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
WebformBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
WebformBlock::calculateDependencies	public	function	Overrides BlockPluginTrait::calculateDependencies
WebformBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
WebformBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
WebformBlock::getWebform	protected	function	Get this block instance webform.
WebformBlock::__construct	public	function	Creates a WebformBlock instance. Overrides BlockPluginTrait::__construct

You are here

class WebformBlock in Webform 8.5

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation