class WebformTestAjaxBlock in Webform 8.5

Same name and namespace in other branches

6.x tests/modules/webform_test_ajax/src/Plugin/Block/WebformTestAjaxBlock.php \Drupal\webform_test_ajax\Plugin\Block\WebformTestAjaxBlock

Provides a 'webform_test_block_context' block.

Plugin annotation


@Block(
  id = "webform_test_ajax_block",
  admin_label = @Translation("Webform Ajax"),
  category = @Translation("Webform Test")
)

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_test_ajax\Plugin\Block\WebformTestAjaxBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of WebformTestAjaxBlock

File

tests/modules/webform_test_ajax/src/Plugin/Block/WebformTestAjaxBlock.php, line 23

Namespace

Drupal\webform_test_ajax\Plugin\Block

View source

class WebformTestAjaxBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The redirect destination service.
   *
   * @var \Drupal\Core\Routing\RedirectDestinationInterface
   */
  protected $redirectDestination;

  /**
   * Creates a WebformTestAjaxBlock 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 \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Drupal\Core\Routing\RedirectDestinationInterface $redirect_destination
   *   The redirect destination service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, RedirectDestinationInterface $redirect_destination) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configFactory = $config_factory;
    $this->redirectDestination = $redirect_destination;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('config.factory'), $container
      ->get('redirect.destination'));
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $webforms = Webform::loadMultiple();

    // Ajax links.
    $ajax_links = [];
    foreach ($webforms as $webform_id => $webform) {
      if (strpos($webform_id, 'test_ajax') !== 0 && $webform_id !== 'test_form_wizard_long_100') {
        continue;
      }
      if (!in_array($webform_id, [
        'test_ajax_confirmation_page',
        'test_ajax_confirmation_url',
        'test_ajax_confirmation_url_msg',
      ])) {

        // Add destination to Ajax webform that don't redirect to confirmation
        // page or URL.
        $route_options = [
          'query' => $this->redirectDestination
            ->getAsArray(),
        ];
      }
      else {
        $route_options = [];
      }
      $ajax_links[$webform_id] = [
        'title' => $this
          ->t('Open @webform_id', [
          '@webform_id' => $webform_id,
        ]),
        'url' => $webform
          ->toUrl('canonical', $route_options),
        'attributes' => [
          'data-dialog-type' => 'modal',
          'data-dialog-options' => Json::encode([
            'width' => 800,
          ]),
          'class' => [
            'use-ajax',
          ],
        ],
      ];
    }

    // Inline links.
    $webform = Webform::load('contact');
    $inline_links = [];
    $inline_links['webform'] = [
      'title' => $this
        ->t('Open Contact'),
      'url' => $webform
        ->toUrl('canonical'),
      'attributes' => [
        'class' => [
          'webform-dialog',
          'webform-dialog-normal',
        ],
      ],
    ];
    $inline_links['source_entity'] = [
      'title' => $this
        ->t('Open Contact with Source Entity'),
      'url' => $webform
        ->toUrl('canonical', [
        'query' => [
          'source_entity_type' => 'ENTITY_TYPE',
          'source_entity_id' => 'ENTITY_ID',
        ],
      ]),
      'attributes' => [
        'class' => [
          'webform-dialog',
          'webform-dialog-normal',
        ],
      ],
    ];
    $inline_links['javascript'] = [
      'title' => "Drupal.webformOpenDialog('" . $webform
        ->toUrl('canonical')
        ->toString() . "', 'webform-dialog-normal'); return false;",
      'url' => Url::fromRoute('<none>'),
      'attributes' => [
        'onclick' => "Drupal.webformOpenDialog('" . $webform
          ->toUrl('canonical')
          ->toString() . "', 'webform-dialog-normal'); return false;",
      ],
    ];

    // Dialog links.
    $dialog_links = [];
    $webform_style_guide = Webform::load('example_style_guide');
    if ($webform_style_guide) {
      $dialog_links['style_guide'] = [
        'title' => $this
          ->t('Open style guide'),
        'url' => $webform_style_guide
          ->toUrl('canonical'),
        'attributes' => [
          'data-dialog-type' => 'dialog',
          'data-dialog-renderer' => 'off_canvas',
          'data-dialog-options' => Json::encode([
            'width' => 600,
            'dialogClass' => 'ui-dialog-off-canvas webform-off-canvas',
          ]),
          'class' => [
            'use-ajax',
          ],
        ],
      ];
    }
    $build = [];
    if ($ajax_links) {
      $build['ajax'] = [
        '#prefix' => '<h3>' . $this
          ->t('Ajax links') . '</h3>',
        '#theme' => 'links',
        '#links' => $ajax_links,
      ];
    }
    if ($inline_links) {
      $build['inline'] = [
        '#prefix' => '<h3>' . $this
          ->t('Inline (Global) links') . '</h3>',
        '#theme' => 'links',
        '#links' => $inline_links,
      ];
    }
    if ($dialog_links) {
      $build['dialog'] = [
        '#prefix' => '<h3>' . $this
          ->t('Dialog/Offcanvas links') . '</h3>',
        '#theme' => 'links',
        '#links' => $dialog_links,
      ];
    }
    $build['#attached']['library'][] = 'webform/webform.dialog';
    $build['#attached']['drupalSettings']['webform']['dialog']['options'] = $this->configFactory
      ->get('webform.settings')
      ->get('settings.dialog_options');
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return 0;
  }

}

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::blockAccess	protected	function	Indicates whether the block should be shown.	16
BlockPluginTrait::blockForm	public	function		16
BlockPluginTrait::blockSubmit	public	function		13
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::calculateDependencies	public	function
BlockPluginTrait::defaultConfiguration	public	function		19
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::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
WebformTestAjaxBlock::$configFactory	protected	property	The configuration factory.
WebformTestAjaxBlock::$redirectDestination	protected	property	The redirect destination service.
WebformTestAjaxBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
WebformTestAjaxBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
WebformTestAjaxBlock::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides ContextAwarePluginBase::getCacheMaxAge
WebformTestAjaxBlock::__construct	public	function	Creates a WebformTestAjaxBlock instance. Overrides BlockPluginTrait::__construct

You are here

class WebformTestAjaxBlock in Webform 8.5

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation