You are here

Home » API reference » JS Callback Handler 8.3 » Email.php

class Email in JS Callback Handler 8.3

Plugin annotation


@JsCallback(
  id = "js_callback_examples.email",
  parameters = {
    "user" = {
      "type" = "entity:user"
    },
  },
)

Hierarchy

Expanded class hierarchy of Email

File

js_callback_examples/src/Plugin/Js/Email.php, line 18

Namespace

Drupal\js_callback_examples\Plugin\Js
View source 
class Email extends JsCallbackBase {

  /**
   * {@inheritdoc}
   */
  public function validate(UserInterface $user = NULL) {
    if (!$user || !$user
      ->isActive()) {
      drupal_set_message(t('You must enter a valid user.'), 'error');
      return FALSE;
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function execute(UserInterface $user = NULL) {
    return [
      '#markup' => $user
        ->getEmail(),
      '#attached' => [
        'drupalSettings' => [
          'testing' => 'test',
        ],
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
Email::execute public function Executes the callback. Overrides JsCallbackInterface::execute
Email::validate public function Validates the callback. Overrides JsCallbackBase::validate
JsCallbackBase::$classResolver protected property
JsCallbackBase::$js protected property
JsCallbackBase::$paramConversion protected property
JsCallbackBase::$parameters protected property
JsCallbackBase::$response protected property
JsCallbackBase::$title protected property
JsCallbackBase::access public function Access callback. Overrides JsCallbackInterface::access 1
JsCallbackBase::accessDeniedMessage public function Message to show when access to the callback has been denied. Overrides JsCallbackInterface::accessDeniedMessage
JsCallbackBase::anonymousUserMessage public function Message to show when user is anonymous and callback requires CSRF token. Overrides JsCallbackInterface::anonymousUserMessage
JsCallbackBase::call public function Calls a method on the callback, providing necessary converted parameters. Overrides JsCallbackInterface::call
JsCallbackBase::captureOutput public function Flag indicating whether or not the callback should capture printed output. Overrides JsCallbackInterface::captureOutput
JsCallbackBase::convertParameters protected function Convert callback parameters into fully loaded objects.
JsCallbackBase::csrfToken public function Flag indicating whether callback should validate a CSRF token. Overrides JsCallbackInterface::csrfToken
JsCallbackBase::getAllowedMethods public function An indexed array of allowed HTTP methods. Overrides JsCallbackInterface::getAllowedMethods
JsCallbackBase::getParameters public function An associative array of parameters. Overrides JsCallbackInterface::getParameters
JsCallbackBase::getResponse public function Retrieves the callback's response handler. Overrides JsCallbackInterface::getResponse
JsCallbackBase::getTitle public function The human readable title of the callback, if set. Overrides JsCallbackInterface::getTitle
JsCallbackBase::invalidTokenMessage public function Message to show when an invalid CSRF token was provided. Overrides JsCallbackInterface::invalidTokenMessage
JsCallbackBase::mapMethodParameters public function
JsCallbackBase::methodNotAllowedMessage public function Message to show when a callback was requested with an invalid HTTP method. Overrides JsCallbackInterface::methodNotAllowedMessage
JsCallbackBase::setTitle public function Sets the title for the callback. Overrides JsCallbackInterface::setTitle
JsCallbackBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 1
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.
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.