class WebformBlock in Webform 6.x
Same name and namespace in other branches
- 8.5 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\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, ContextAwarePluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait, ContextAwarePluginTrait
- class \Drupal\webform\Plugin\Block\WebformBlock implements ContainerFactoryPluginInterface
- class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, ContextAwarePluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait, ContextAwarePluginTrait
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
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 24
Namespace
Drupal\webform\Plugin\BlockView source
class WebformBlock extends BlockBase implements ContainerFactoryPluginInterface {
/**
* The request stack.
*
* @var \Symfony\Component\HttpFoundation\RequestStack
*/
protected $requestStack;
/**
* The route match.
*
* @var \Drupal\Core\Routing\RouteMatchInterface
*/
protected $routeMatch;
/**
* Entity type manager.
*
* @var \Drupal\core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The webform token manager.
*
* @var \Drupal\webform\WebformTokenManagerInterface
*/
protected $tokenManager;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
$instance = new static($configuration, $plugin_id, $plugin_definition);
$instance->requestStack = $container
->get('request_stack');
$instance->routeMatch = $container
->get('current_route_match');
$instance->entityTypeManager = $container
->get('entity_type.manager');
$instance->tokenManager = $container
->get('webform.token_manager');
return $instance;
}
/**
* {@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.
// @see \Drupal\webform\Plugin\Field\FieldWidget\WebformEntityReferenceWidgetTrait::formElement
$title = $this
->t('Default submission data (YAML)');
$placeholder = $this
->t("Enter 'name': 'value' pairs…");
$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(),
];
$default_data_example = [];
$default_data_example[] = '# ' . $this
->t('This is an example of a comment.');
$default_data_example[] = "element_key: 'some value'";
$default_data_example[] = '';
$default_data_example[] = '# ' . $this
->t("The below example uses a token to get the current node's title.");
$default_data_example[] = "title: '[webform_submission:node:title:clear]'";
$default_data_example[] = '';
$default_data_example[] = '# ' . $this
->t("Add ':clear' to the end token to return an empty value when the token is missing.");
$default_data_example[] = '# ' . $this
->t('The below example uses a token to get a field value from the current node.');
$default_data_example[] = "full_name: '[webform_submission:node:field_full_name:clear]'";
$form['#attributes'] = [
'class' => [
'webform-block-settings-tray-form',
],
];
$form['webform_id'] = [
'#type' => 'entity_autocomplete',
'#title' => $this
->t('Webform'),
'#description' => $this
->t('Select the webform that you would like to display in this block.'),
'#target_type' => 'webform',
'#required' => TRUE,
'#default_value' => $this
->getWebform(),
];
$form['settings'] = [
'#type' => 'details',
'#title' => $this
->t('Webform settings'),
];
if ($is_off_canvas) {
// Using <textarea> and <pre> tags to support off-canvas CSS reset.
$form['settings']['default_data'] = [
'#type' => 'textarea',
'#title' => $title,
'#description' => $description,
'#placeholder' => $placeholder,
'#default_value' => $this->configuration['default_data'],
'#webform_element' => TRUE,
'#more_title' => $this
->t('Example'),
'#more' => [
'#markup' => implode(PHP_EOL, $default_data_example),
'#prefix' => '<pre>',
'#suffix' => '</pre>',
],
'#wrapper_attributes' => [
'class' => [
'webform-default-data',
],
],
];
$form['#attached']['library'][] = 'webform/webform.off_canvas';
}
else {
$form['settings']['default_data'] = [
'#type' => 'webform_codemirror',
'#mode' => 'yaml',
'#title' => $title,
'#description' => $description,
'#placeholder' => $placeholder,
'#default_value' => $this->configuration['default_data'],
'#webform_element' => TRUE,
'#more_title' => $this
->t('Example'),
'#more' => [
'#theme' => 'webform_codemirror',
'#type' => 'yaml',
'#code' => implode(PHP_EOL, $default_data_example),
],
];
}
$form['settings']['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.'),
];
$this->tokenManager
->elementValidate($form);
return $form;
}
/**
* {@inheritdoc}
*/
public function blockSubmit($form, FormStateInterface $form_state) {
$values = $form_state
->getValues();
$this->configuration['webform_id'] = $values['webform_id'];
$this->configuration['default_data'] = $values['settings']['default_data'];
$this->configuration['redirect'] = $values['settings']['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 |
---|---|---|---|---|
BlockBase:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
2 |
BlockPluginInterface:: |
constant | Indicates the block label (title) should be displayed to end users. | ||
BlockPluginTrait:: |
protected | property | The transliteration service. | |
BlockPluginTrait:: |
public | function | ||
BlockPluginTrait:: |
protected | function | Returns generic default configuration for block plugins. | |
BlockPluginTrait:: |
public | function | 3 | |
BlockPluginTrait:: |
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. Aliased as: traitBuildConfigurationForm | |
BlockPluginTrait:: |
public | function | 1 | |
BlockPluginTrait:: |
public | function | 1 | |
BlockPluginTrait:: |
public | function | 3 | |
BlockPluginTrait:: |
public | function | ||
BlockPluginTrait:: |
public | function | ||
BlockPluginTrait:: |
public | function | ||
BlockPluginTrait:: |
public | function | Sets the transliteration service. | |
BlockPluginTrait:: |
public | function | Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). | |
BlockPluginTrait:: |
protected | function | Wraps the transliteration service. | |
BlockPluginTrait:: |
public | function | Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). | 1 |
BlockPluginTrait:: |
public | function | 24 | |
ContextAwarePluginAssignmentTrait:: |
protected | function | Builds a form element for assigning a context to a given slot. | |
ContextAwarePluginAssignmentTrait:: |
protected | function | Wraps the context handler. | |
ContextAwarePluginTrait:: |
protected | property | The data objects representing the context of this plugin. | |
ContextAwarePluginTrait:: |
protected | property | Tracks whether the context has been initialized from configuration. | |
ContextAwarePluginTrait:: |
public | function | 9 | |
ContextAwarePluginTrait:: |
public | function | 7 | |
ContextAwarePluginTrait:: |
public | function | 4 | |
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
abstract protected | function | 1 | |
ContextAwarePluginTrait:: |
public | function | 1 | |
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginWithFormsTrait:: |
public | function | Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass(). | |
PluginWithFormsTrait:: |
public | function | Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass(). | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
WebformBlock:: |
protected | property | Entity type manager. | |
WebformBlock:: |
protected | property | The request stack. | |
WebformBlock:: |
protected | property | The route match. | |
WebformBlock:: |
protected | property | The webform token manager. | |
WebformBlock:: |
protected | function |
Indicates whether the block should be shown. Overrides BlockPluginTrait:: |
|
WebformBlock:: |
public | function |
Overrides BlockPluginTrait:: |
|
WebformBlock:: |
public | function |
Overrides BlockPluginTrait:: |
|
WebformBlock:: |
public | function |
Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface:: |
|
WebformBlock:: |
public | function |
Overrides BlockPluginTrait:: |
|
WebformBlock:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
WebformBlock:: |
public | function |
Overrides BlockPluginTrait:: |
|
WebformBlock:: |
protected | function | Get this block instance webform. |