class FeedbackBlock in Feedback 3.x

Provides a 'FeedbackBlock' block.

Plugin annotation


@Block(
 id = "feedback_block",
 admin_label = @Translation("Feedback block"),
)

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\feedback\Plugin\Block\FeedbackBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of FeedbackBlock

File

src/Plugin/Block/FeedbackBlock.php, line 22

Namespace

Drupal\feedback\Plugin\Block

View source

class FeedbackBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Drupal\Core\Path\CurrentPathStack definition.
   *
   * @var \Drupal\Core\Path\CurrentPathStack
   */
  protected $path;

  /**
   * The bundle info service to know which feedback types exist.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $bundleInfo;

  /**
   * Construct.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param string $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CurrentPathStack $path_current, EntityTypeBundleInfoInterface $bundle_info) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->path = $path_current;
    $this->bundleInfo = $bundle_info;
  }

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

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $build['feedback'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('@title', [
        '@title' => $this->configuration['label'],
      ]),
    ];
    $build['feedback']['feedback_help'] = [
      '#markup' => $this->configuration['feedback_help'],
    ];
    $build['feedback']['feedback_form'] = [
      '#lazy_builder' => [
        'feedback.lazy_builders:renderForm',
        [
          $this->configuration['feedback_type'],
          'internal:' . $this->path
            ->getPath(),
          \Drupal::request()
            ->getQueryString(),
          $this->configuration['feedback_submit'],
        ],
      ],
      '#create_placeholder' => TRUE,
    ];
    $build['#attached'] = [
      'library' => [
        'feedback/feedback',
      ],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    return AccessResult::allowedIfHasPermission($account, 'add feedback message entities');
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $type = isset($this->configuration['feedback_type']) ? $this->configuration['feedback_type'] : '';
    $message = $this
      ->t('If you experience a bug or would like to see an addition on the current page, feel free to leave us a message.');
    $message = isset($this->configuration['feedback_help']) ? $this->configuration['feedback_help'] : $message;
    $submit = isset($this->configuration['feedback_submit']) ? $this->configuration['feedback_submit'] : $this
      ->t('Send');
    $feedback_types = array_map(function ($item) {
      return $item['label'];
    }, $this->bundleInfo
      ->getBundleInfo('feedback_message'));
    $form['feedback_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Feedback type'),
      '#options' => $feedback_types,
      '#default_option' => $type,
      '#description' => $this
        ->t('Select the feedback type which will be used.'),
    ];
    $form['feedback_help'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Help'),
      '#default_value' => $message,
      '#description' => $this
        ->t('Feedback submission guidelines.'),
    ];
    $form['feedback_submit'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Submit button'),
      '#default_value' => $submit,
      '#description' => $this
        ->t('Specify the label that will appear on the feedback submit button.'),
    ];
    return $form;
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
BlockBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	2
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. Aliased as: traitBuildConfigurationForm
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.
ContextAwarePluginTrait::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig	protected	property	Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts	public	function		9
ContextAwarePluginTrait::getCacheMaxAge	public	function		7
ContextAwarePluginTrait::getCacheTags	public	function		4
ContextAwarePluginTrait::getContext	public	function
ContextAwarePluginTrait::getContextDefinition	public	function
ContextAwarePluginTrait::getContextDefinitions	public	function
ContextAwarePluginTrait::getContextMapping	public	function
ContextAwarePluginTrait::getContexts	public	function
ContextAwarePluginTrait::getContextValue	public	function
ContextAwarePluginTrait::getContextValues	public	function
ContextAwarePluginTrait::getPluginDefinition	abstract protected	function		1
ContextAwarePluginTrait::setContext	public	function		1
ContextAwarePluginTrait::setContextMapping	public	function
ContextAwarePluginTrait::setContextValue	public	function
ContextAwarePluginTrait::validateContexts	public	function
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FeedbackBlock::$bundleInfo	protected	property	The bundle info service to know which feedback types exist.
FeedbackBlock::$path	protected	property	Drupal\Core\Path\CurrentPathStack definition.
FeedbackBlock::blockAccess	protected	function	Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
FeedbackBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
FeedbackBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
FeedbackBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
FeedbackBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FeedbackBlock::__construct	public	function	Construct. Overrides BlockPluginTrait::__construct
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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::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	Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass	public	function	Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.

You are here

class FeedbackBlock in Feedback 3.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation