class LtiToolProviderReturnEvent in LTI Tool Provider 2.x

Hierarchy

• class \Drupal\lti_tool_provider\LtiToolProviderEvent extends \Symfony\Component\EventDispatcher\Event
  • class \Drupal\lti_tool_provider\Event\LtiToolProviderReturnEvent

1 file declares its use of LtiToolProviderReturnEvent

LTIToolProviderController.php in src/Controller/LTIToolProviderController.php

File

src/Event/LtiToolProviderReturnEvent.php, line 7

Namespace

Drupal\lti_tool_provider\Event

class LtiToolProviderReturnEvent extends LtiToolProviderEvent {
  const EVENT_NAME = 'LTI_TOOL_PROVIDER_RETURN_EVENT';

  /**
   * @var array
   */
  private $context;

  /**
   * @var string
   */
  private $destination;

  /**
   * LtiToolProviderReturnEvent constructor.
   *
   * @param array $context
   * @param string $destination
   */
  public function __construct(array $context, string $destination) {
    $this
      ->setContext($context);
    $this
      ->setDestination($destination);
  }

  /**
   * @return array
   */
  public function getContext() : array {
    return $this->context;
  }

  /**
   * @param array $context
   */
  public function setContext(array $context) {
    $this->context = $context;
  }

  /**
   * @return string
   */
  public function getDestination() : string {
    return $this->destination;
  }

  /**
   * @param string $destination
   */
  public function setDestination(string $destination) : void {
    $this->destination = $destination;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LtiToolProviderEvent::$cancelled	private	property
LtiToolProviderEvent::$message	private	property
LtiToolProviderEvent::cancel	public	function
LtiToolProviderEvent::dispatchEvent	static	function	Dispatch an LTI Tool Provider event.
LtiToolProviderEvent::getMessage	public	function
LtiToolProviderEvent::isCancelled	public	function
LtiToolProviderEvent::sendLtiError	public	function	Send an error back to the LMS.
LtiToolProviderReturnEvent::$context	private	property
LtiToolProviderReturnEvent::$destination	private	property
LtiToolProviderReturnEvent::EVENT_NAME		constant	Overrides LtiToolProviderEvent::EVENT_NAME
LtiToolProviderReturnEvent::getContext	public	function
LtiToolProviderReturnEvent::getDestination	public	function
LtiToolProviderReturnEvent::setContext	public	function
LtiToolProviderReturnEvent::setDestination	public	function
LtiToolProviderReturnEvent::__construct	public	function	LtiToolProviderReturnEvent constructor.