You are here

Home » API reference » Webform 6.x » WebformHandlerMessageInterface.php

interface WebformHandlerMessageInterface in Webform 6.x

Same name and namespace in other branches
  1. 8.5 src/Plugin/WebformHandlerMessageInterface.php \Drupal\webform\Plugin\WebformHandlerMessageInterface

Defines the interface for webform handlers that send messages.

Hierarchy

Expanded class hierarchy of WebformHandlerMessageInterface

All classes that implement WebformHandlerMessageInterface

See also

\Drupal\webform\Plugin\WebformHandler\EmailWebformHandler

3 files declare their use of WebformHandlerMessageInterface
EmailWebformHandler.php in src/Plugin/WebformHandler/EmailWebformHandler.php
Webform.php in src/Entity/Webform.php
WebformSubmissionResendForm.php in src/Form/WebformSubmissionResendForm.php

File

src/Plugin/WebformHandlerMessageInterface.php, line 12

Namespace

Drupal\webform\Plugin
View source 
interface WebformHandlerMessageInterface extends WebformHandlerInterface {

  /**
   * Get a fully populated email for a webform submission.
   *
   * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
   *   A webform submission.
   *
   * @return array
   *   An array containing message parameters.
   */
  public function getMessage(WebformSubmissionInterface $webform_submission);

  /**
   * Sends and logs a webform submission message.
   *
   * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
   *   A webform submission.
   * @param array $message
   *   An array of message parameters.
   */
  public function sendMessage(WebformSubmissionInterface $webform_submission, array $message);

  /**
   * Confirm that a message has a recipient.
   *
   * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
   *   A webform submission.
   * @param array $message
   *   An array of message parameters.
   *
   * @return bool
   *   TRUE if the message has a recipient.
   */
  public function hasRecipient(WebformSubmissionInterface $webform_submission, array $message);

  /**
   * Build resend message webform.
   *
   * @param array $message
   *   An array of message parameters.
   *
   * @return array
   *   A webform to edit a message.
   */
  public function resendMessageForm(array $message);

  /**
   * Build message summary.
   *
   * @param array $message
   *   An array of message parameters.
   *
   * @return array
   *   A renderable array representing a message summary.
   */
  public function getMessageSummary(array $message);

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 14
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 15
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 15
ContainerFactoryPluginInterface::create public static function Creates an instance of the plugin. 120
PluginFormInterface::buildConfigurationForm public function Form constructor. 37
PluginFormInterface::submitConfigurationForm public function Form submission handler. 32
PluginFormInterface::validateConfigurationForm public function Form validation handler. 18
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
WebformEntityInjectionInterface::getWebform public function Get the webform that this handler is attached to.
WebformEntityInjectionInterface::getWebformSubmission public function Get the webform submission that this handler is handling.
WebformEntityInjectionInterface::resetEntities public function Reset webform and webform submission entity.
WebformEntityInjectionInterface::setEntities public function Set webform and webform submission entity.
WebformEntityInjectionInterface::setWebform public function Set the webform that this is handler is attached to.
WebformEntityInjectionInterface::setWebformSubmission public function Set the webform submission that this handler is handling.
WebformHandlerInterface::access public function Controls entity operation access to webform submission. 1
WebformHandlerInterface::accessElement public function Controls entity operation access to webform submission element. 1
WebformHandlerInterface::alterElement public function Alter webform element. 1
WebformHandlerInterface::alterElements public function Alter webform submission webform elements. 1
WebformHandlerInterface::alterForm public function Alter webform submission form. 1
WebformHandlerInterface::cardinality public function Returns the webform handler cardinality settings. 1
WebformHandlerInterface::CARDINALITY_SINGLE constant Value indicating a single plugin instances are permitted.
WebformHandlerInterface::CARDINALITY_UNLIMITED constant Value indicating unlimited plugin instances are permitted.
WebformHandlerInterface::checkConditions public function Check handler conditions against a webform submission. 1
WebformHandlerInterface::confirmForm public function Confirm webform submission form. 1
WebformHandlerInterface::createElement public function Acts on a element after it has been created. 1
WebformHandlerInterface::createHandler public function Acts on handler after it has been created and added to webform. 1
WebformHandlerInterface::deleteElement public function Acts on a element after it has been deleted. 1
WebformHandlerInterface::deleteHandler public function Acts on handler after it has been removed. 1
WebformHandlerInterface::description public function Returns the webform handler description. 1
WebformHandlerInterface::disable public function Disables the webform handler. 1
WebformHandlerInterface::enable public function Enables the webform handler. 1
WebformHandlerInterface::getConditions public function Returns the conditions the webform handler. 1
WebformHandlerInterface::getHandlerId public function Returns the unique ID representing the webform handler. 1
WebformHandlerInterface::getLabel public function Returns the label of the webform handler. 1
WebformHandlerInterface::getNotes public function Returns notes of the webform variant. 1
WebformHandlerInterface::getOffCanvasWidth public function Get configuration form's off-canvas width. 1
WebformHandlerInterface::getStatus public function Returns the status of the webform handler. 1
WebformHandlerInterface::getSummary public function Returns a render array summarizing the configuration of the webform handler. 1
WebformHandlerInterface::getWeight public function Returns the weight of the webform handler. 1
WebformHandlerInterface::hasAnonymousSubmissionTracking public function Determine if the webform handler requires anonymous submission tracking. 1
WebformHandlerInterface::isApplicable public function Determine if this handle is applicable to the webform. 1
WebformHandlerInterface::isDisabled public function Returns the webform handler disabled indicator. 1
WebformHandlerInterface::isEnabled public function Returns the webform handler enabled indicator. 1
WebformHandlerInterface::isExcluded public function Checks if the handler is excluded via webform.settings. 1
WebformHandlerInterface::isSubmissionOptional public function Returns the webform submission is optional indicator. 1
WebformHandlerInterface::isSubmissionRequired public function Returns the webform submission is required indicator. 1
WebformHandlerInterface::label public function Returns the webform handler label. 1
WebformHandlerInterface::overrideSettings public function Alter/override a webform submission webform settings. 1
WebformHandlerInterface::postCreate public function Acts on a webform submission after it is created. 1
WebformHandlerInterface::postDelete public function Acts on deleted a webform submission before the delete hook is invoked. 1
WebformHandlerInterface::postLoad public function Acts on loaded webform submission. 1
WebformHandlerInterface::postPurge public function Acts on webform submissions after they are purged. 1
WebformHandlerInterface::postSave public function Acts on a saved webform submission before the insert or update hook is invoked. 1
WebformHandlerInterface::preCreate public function Changes the values of an entity before it is created. 1
WebformHandlerInterface::preDelete public function Acts on a webform submission before they are deleted and before hooks are invoked. 1
WebformHandlerInterface::prepareForm public function Acts on an webform submission about to be shown on a webform submission form. 1
WebformHandlerInterface::preprocessConfirmation public function Prepares variables for webform confirmation templates. 1
WebformHandlerInterface::prePurge public function Acts on webform submissions before they are purged. 1
WebformHandlerInterface::preSave public function Acts on a webform submission before the presave hook is invoked. 1
WebformHandlerInterface::RESULTS_IGNORED constant Value indicating webform submissions are not processed (i.e. email or saved) by the handler.
WebformHandlerInterface::RESULTS_PROCESSED constant Value indicating webform submissions are processed (i.e. email or saved) by the handler.
WebformHandlerInterface::setConditions public function Sets the conditions for this webform handler. 1
WebformHandlerInterface::setHandlerId public function Sets the id for this webform handler. 1
WebformHandlerInterface::setLabel public function Sets the label for this webform handler. 1
WebformHandlerInterface::setNotes public function Set notes for this webform variant. 1
WebformHandlerInterface::setStatus public function Sets the status for this webform handler. 1
WebformHandlerInterface::setWeight public function Sets the weight for this webform handler. 1
WebformHandlerInterface::SUBMISSION_OPTIONAL constant Value indicating webform submissions do not have to be stored in the database.
WebformHandlerInterface::SUBMISSION_REQUIRED constant Value indicating webform submissions must be stored in the database.
WebformHandlerInterface::submitForm public function Submit webform submission form. 1
WebformHandlerInterface::supportsConditions public function Determine if webform handler supports conditions. 1
WebformHandlerInterface::supportsTokens public function Determine if webform handler supports tokens. 1
WebformHandlerInterface::updateElement public function Acts on a element after it has been updated. 1
WebformHandlerInterface::updateHandler public function Acts on handler after it has been updated. 1
WebformHandlerInterface::validateForm public function Validate webform submission form. 1
WebformHandlerMessageInterface::getMessage public function Get a fully populated email for a webform submission. 1
WebformHandlerMessageInterface::getMessageSummary public function Build message summary. 1
WebformHandlerMessageInterface::hasRecipient public function Confirm that a message has a recipient. 1
WebformHandlerMessageInterface::resendMessageForm public function Build resend message webform. 1
WebformHandlerMessageInterface::sendMessage public function Sends and logs a webform submission message. 1
WebformPluginSettingsInterface::getSetting public function Returns the plugin setting for given key
WebformPluginSettingsInterface::getSettings public function Returns the plugin's settings.
WebformPluginSettingsInterface::setSetting public function Sets a plugin setting for a given key.
WebformPluginSettingsInterface::setSettings public function Update a plugin's settings.