You are here

Home » API reference » YAML Form 8 » YamlFormHandlerMessageInterface.php

interface YamlFormHandlerMessageInterface in YAML Form 8

Defines the interface for form handlers that send messages.

Hierarchy

Expanded class hierarchy of YamlFormHandlerMessageInterface

All classes that implement YamlFormHandlerMessageInterface

See also

\Drupal\yamlform\Plugin\YamlFormHandler\EmailYamlFormHandler

2 files declare their use of YamlFormHandlerMessageInterface
EmailYamlFormHandler.php in src/Plugin/YamlFormHandler/EmailYamlFormHandler.php
YamlFormAccess.php in src/Access/YamlFormAccess.php

File

src/YamlFormHandlerMessageInterface.php, line 10

Namespace

Drupal\yamlform
View source 
interface YamlFormHandlerMessageInterface extends YamlFormHandlerInterface {

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

  /**
   * Sends and logs a form submission message.
   *
   * @param array $message
   *   An array of message parameters.
   */
  public function sendMessage(array $message);

  /**
   * Build resend message form.
   *
   * @param array $message
   *   An array of message parameters.
   *
   * @return array
   *   A form 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
ConfigurablePluginInterface::defaultConfiguration public function Gets default configuration for this plugin. 1
ConfigurablePluginInterface::getConfiguration public function Gets this plugin's configuration. 1
ConfigurablePluginInterface::setConfiguration public function Sets the configuration for this plugin instance. 1
ContainerFactoryPluginInterface::create public static function Creates an instance of the plugin. 112
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 19
PluginFormInterface::buildConfigurationForm public function Form constructor. 36
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
YamlFormHandlerInterface::alterElements public function Alter form submission form elements. 1
YamlFormHandlerInterface::alterForm public function Alter form submission form . 1
YamlFormHandlerInterface::cardinality public function Returns the form handler cardinality settings. 1
YamlFormHandlerInterface::CARDINALITY_SINGLE constant Value indicating a single plugin instances are permitted.
YamlFormHandlerInterface::CARDINALITY_UNLIMITED constant Value indicating unlimited plugin instances are permitted.
YamlFormHandlerInterface::confirmForm public function Confirm form submission form. 1
YamlFormHandlerInterface::description public function Returns the form handler description. 1
YamlFormHandlerInterface::getHandlerId public function Returns the unique ID representing the form handler. 1
YamlFormHandlerInterface::getLabel public function Returns the label of the form handler. 1
YamlFormHandlerInterface::getStatus public function Returns the status of the form handler. 1
YamlFormHandlerInterface::getSummary public function Returns a render array summarizing the configuration of the form handler. 1
YamlFormHandlerInterface::getWeight public function Returns the weight of the form handler. 1
YamlFormHandlerInterface::isDisabled public function Returns the form handler disabled indicator. 1
YamlFormHandlerInterface::isEnabled public function Returns the form handler enabled indicator. 1
YamlFormHandlerInterface::label public function Returns the form handler label. 1
YamlFormHandlerInterface::postCreate public function Acts on a form submission after it is created. 1
YamlFormHandlerInterface::postDelete public function Acts on deleted a form submission before the delete hook is invoked. 1
YamlFormHandlerInterface::postLoad public function Acts on loaded form submission. 1
YamlFormHandlerInterface::postSave public function Acts on a saved form submission before the insert or update hook is invoked. 1
YamlFormHandlerInterface::preCreate public function Changes the values of an entity before it is created. 1
YamlFormHandlerInterface::preDelete public function Acts on a form submission before they are deleted and before hooks are invoked. 1
YamlFormHandlerInterface::preSave public function Acts on a form submission before the presave hook is invoked. 1
YamlFormHandlerInterface::RESULTS_IGNORED constant Value indicating form submissions are not processed (ie email or saved) by the handler.
YamlFormHandlerInterface::RESULTS_PROCESSED constant Value indicating form submissions are processed (ie email or saved) by the handler.
YamlFormHandlerInterface::setHandlerId public function Sets the id for this form handler. 1
YamlFormHandlerInterface::setLabel public function Sets the label for this form handler. 1
YamlFormHandlerInterface::setStatus public function Sets the status for this form handler. 1
YamlFormHandlerInterface::setWeight public function Sets the weight for this form handler. 1
YamlFormHandlerInterface::submitForm public function Submit form submission form. 1
YamlFormHandlerInterface::validateForm public function Validate form submission form . 1
YamlFormHandlerMessageInterface::getMessage public function Get a fully populated email for a form submission. 1
YamlFormHandlerMessageInterface::getMessageSummary public function Build message summary. 1
YamlFormHandlerMessageInterface::resendMessageForm public function Build resend message form. 1
YamlFormHandlerMessageInterface::sendMessage public function Sends and logs a form submission message. 1