You are here

interface SalesforceExceptionEventInterface in Salesforce Suite 5.0.x

Same name and namespace in other branches
  1. 8.4 src/Event/SalesforceExceptionEventInterface.php \Drupal\salesforce\Event\SalesforceExceptionEventInterface
  2. 8.3 src/Event/SalesforceExceptionEventInterface.php \Drupal\salesforce\Event\SalesforceExceptionEventInterface

Interface for Salesforce Exception events, primarily for logging.

Hierarchy

Expanded class hierarchy of SalesforceExceptionEventInterface

All classes that implement SalesforceExceptionEventInterface

1 file declares its use of SalesforceExceptionEventInterface
SalesforceLoggerSubscriber.php in modules/salesforce_logger/src/EventSubscriber/SalesforceLoggerSubscriber.php

File

src/Event/SalesforceExceptionEventInterface.php, line 8

Namespace

Drupal\salesforce\Event
View source
interface SalesforceExceptionEventInterface {

  /**
   * Getter for exception.
   *
   * @return \Throwable|null
   *   The exception or NULL if no exception was given.
   */
  public function getException();

  /**
   * Getter for log level.
   *
   * @return string
   *   Severity level for the event. Probably a Drupal\Core\Logger\RfcLogLevel
   *   or Psr\Log\LogLevel value.
   */
  public function getLevel();

  /**
   * Getter for message string.
   *
   * @return string
   *   The message for this event, or a default message.
   */
  public function getMessage();

  /**
   * Getter for message context.
   *
   * @return array
   *   The context aka args for this message, suitable for passing to ::log
   */
  public function getContext();

}

Members

Namesort descending Modifiers Type Description Overrides
SalesforceExceptionEventInterface::getContext public function Getter for message context. 1
SalesforceExceptionEventInterface::getException public function Getter for exception. 1
SalesforceExceptionEventInterface::getLevel public function Getter for log level. 1
SalesforceExceptionEventInterface::getMessage public function Getter for message string. 1