class WebformAnalysisBlock in Webform Analysis 8

Provides a 'Webform' block.

Plugin annotation


@Block(
  id = "webform_analysis_block",
  admin_label = @Translation("Webform Analysis"),
  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_analysis\Plugin\Block\WebformAnalysisBlock

Expanded class hierarchy of WebformAnalysisBlock

1 file declares its use of WebformAnalysisBlock

WebformNodeAnalysisBlock.php in modules/webform_node_analysis/src/Plugin/Block/WebformNodeAnalysisBlock.php

File

src/Plugin/Block/WebformAnalysisBlock.php, line 26

Namespace

Drupal\webform_analysis\Plugin\Block

View source

class WebformAnalysisBlock extends BlockBase {
  protected $entityTypeManager;
  protected $formBuilder;

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

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entityTypeManager = NULL, FormBuilderInterface $formBuilder = NULL) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entityTypeManager ? $entityTypeManager : \Drupal::entityTypeManager();
    $this->formBuilder = $formBuilder ? $formBuilder : \Drupal::formBuilder();
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'entity_id' => '',
      'component' => '',
      'chart_type' => '',
    ];
  }

  /**
   * Get Element Entity Type.
   *
   * @return string
   *   Entity Type Id.
   */
  public static function elementEntityTypeId() {
    return 'webform';
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $weight = 2;
    $form['entity_id'] = [
      '#title' => $this->entityTypeManager
        ->getDefinition(static::elementEntityTypeId())
        ->getLabel(),
      '#type' => 'select',
      '#options' => $this
        ->getEntities(),
      '#ajax' => [
        'callback' => [
          $this,
          'updateEntity',
        ],
        'wrapper' => 'edit-component-wrapper',
      ],
      '#weight' => $weight++,
    ];
    $entity_id = $this->configuration['entity_id'];
    if (!$entity_id && count($form['entity_id']['#options'] > 0)) {
      $entity_id = array_keys($form['entity_id']['#options'])[0];
    }
    $webform = $entity_id ? $this->entityTypeManager
      ->getStorage(static::elementEntityTypeId())
      ->load($entity_id) : NULL;
    $form['entity_id']['#default_value'] = $entity_id;
    $form['component'] = [
      '#title' => $this
        ->t('Component'),
      '#type' => 'select',
      '#default_value' => $this->configuration['component'],
      '#prefix' => '<div id="edit-component-wrapper">',
      '#suffix' => '</div>',
      '#weight' => $weight++,
    ];
    $form['chart_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Chart type'),
      '#default_value' => $this->configuration['chart_type'],
      '#options' => WebformAnalysis::getChartTypeOptions(),
      '#weight' => $weight++,
    ];
    if ($webform) {
      $analysis = new WebformAnalysis($webform);
      if (!$analysis
        ->getWebform()) {
        return $form;
      }
      $form['component']['#options'] = static::getElements($analysis);
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    parent::blockSubmit($form, $form_state);
    $settings = [
      'entity_id',
      'component',
      'chart_type',
    ];
    if (!$form_state
      ->getErrors()) {
      foreach ($settings as $setting) {
        $this->configuration[$setting] = $form_state
          ->getValue($setting);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $entity_id = $this->configuration['entity_id'];
    $entity = $this->entityTypeManager
      ->getStorage(static::elementEntityTypeId())
      ->load($entity_id);
    if (!$entity) {
      return $build;
    }
    $chart = new WebformAnalysisChart($entity, [
      $this->configuration['component'],
    ], $this->configuration['chart_type']);
    $chart
      ->build($build);
    return $build;
  }

  /**
   * Get Webforms.
   *
   * @return array
   *   Names.
   */
  public function getEntities() {
    $entity_storage = $this->entityTypeManager
      ->getStorage(static::elementEntityTypeId());
    foreach ($entity_storage
      ->loadMultiple() as $entity) {
      $entity_id = $entity
        ->id();
      $label = $entity
        ->label();
      if ($label) {
        $names[$entity_id] = new TranslatableMarkup('@label (@id)', [
          '@label' => $label,
          '@id' => $entity_id,
        ]);
      }
      else {
        $names[$entity_id] = $entity_id;
      }
    }
    return $names;
  }

  /**
   * Get Elements.
   *
   * @param \Drupal\webform_analysis\WebformAnalysisInterface $analysis
   *   Analaysis.
   *
   * @return array
   *   Options.
   */
  public static function getElements(WebformAnalysisInterface $analysis) {
    $options = [];
    foreach ($analysis
      ->getElements() as $element_name => $element) {
      $options[$element_name] = isset($element['#title']) ? $element['#title'] : $element_name;
    }
    return $options;
  }

  /**
   * Handles switching the configuration type selector.
   */
  public static function updateEntity($form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $form['component'] = [
      '#title' => t('Component'),
      '#type' => 'select',
      '#prefix' => '<div id="edit-component-wrapper">',
      '#suffix' => '</div>',
    ];
    $entity_id = $form_state
      ->getValue([
      'settings',
      'entity_id',
    ]);
    $entity = \Drupal::entityTypeManager()
      ->getStorage(static::elementEntityTypeId())
      ->load($entity_id);
    if ($entity) {
      $analysis = new WebformAnalysis($entity);
      $form['component']['#options'] = static::getElements($analysis);
    }
    $response
      ->addCommand(new ReplaceCommand('#edit-component-wrapper', $form['component']));
    return $response;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    return [];
  }

  /**
   * {@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::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::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::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
WebformAnalysisBlock::$entityTypeManager	protected	property
WebformAnalysisBlock::$formBuilder	protected	property
WebformAnalysisBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
WebformAnalysisBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
WebformAnalysisBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
WebformAnalysisBlock::create	public static	function
WebformAnalysisBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
WebformAnalysisBlock::elementEntityTypeId	public static	function	Get Element Entity Type.	1
WebformAnalysisBlock::getCacheContexts	public	function	The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
WebformAnalysisBlock::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides ContextAwarePluginBase::getCacheMaxAge
WebformAnalysisBlock::getCacheTags	public	function	The cache tags associated with this object. Overrides ContextAwarePluginBase::getCacheTags
WebformAnalysisBlock::getElements	public static	function	Get Elements.
WebformAnalysisBlock::getEntities	public	function	Get Webforms.
WebformAnalysisBlock::updateEntity	public static	function	Handles switching the configuration type selector.
WebformAnalysisBlock::__construct	public	function	Overrides BlockPluginTrait::__construct

You are here

class WebformAnalysisBlock in Webform Analysis 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation