class WebhookController in Webhooks 8

Class Webhook.

@package Drupal\webhooks\Controller

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\webhooks\Controller\WebhookController

Expanded class hierarchy of WebhookController

File

src/Controller/WebhookController.php, line 24

Namespace

Drupal\webhooks\Controller

View source

class WebhookController extends ControllerBase {

  /**
   * The webhooks service.
   *
   * @var \Drupal\webhooks\WebhooksService
   */
  protected $webhooksService;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The Logger.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * The messenger.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * WebhookController constructor.
   *
   * @param \Drupal\webhooks\WebhooksService $webhooks_service
   *   The webhooks service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   The logger channel factory.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   */
  public function __construct(WebhooksService $webhooks_service, EntityTypeManagerInterface $entity_type_manager, LoggerChannelFactoryInterface $logger_factory, MessengerInterface $messenger) {
    $this->webhooksService = $webhooks_service;
    $this->entityTypeManager = $entity_type_manager;
    $this->logger = $logger_factory
      ->get('webhooks');
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('webhooks.service'), $container
      ->get('entity_type.manager'), $container
      ->get('logger.factory'), $container
      ->get('messenger'));
  }

  /**
   * Webhooks receiver.
   *
   * @param string $incoming_webhook_name
   *   The machine name of a webhook.
   *
   * @return \GuzzleHttp\Psr7\Response
   *   Return a response with code 200 for OK or code 500 in case of error.
   */
  public function receive($incoming_webhook_name) {
    try {
      $this->webhooksService
        ->receive($incoming_webhook_name);
    } catch (WebhookIncomingEndpointNotFoundException $e) {
      $this->logger
        ->error($e
        ->getMessage());
      return new Response(404, [], $e
        ->getMessage());
    } catch (WebhookMismatchSignatureException $e) {
      $this->logger
        ->error('Unauthorized. Signature mismatch for Webhook Subscriber %name: @message', [
        '%name' => $incoming_webhook_name,
        '@message' => $e
          ->getMessage(),
        'link' => Link::createFromRoute($this
          ->t('Edit Webhook'), 'entity.webhook_config.edit_form', [
          'webhook_config' => $incoming_webhook_name,
        ])
          ->toString(),
      ]);
      return new Response(401, [], $e
        ->getMessage());
    }
    $this->logger
      ->info('Received a Webhook: %name', [
      '%name' => $incoming_webhook_name,
      'link' => Link::createFromRoute($this
        ->t('Edit Webhook'), 'entity.webhook_config.edit_form', [
        'webhook_config' => $incoming_webhook_name,
      ])
        ->toString(),
    ]);
    return new Response(200, [], 'OK');
  }

  /**
   * Access check callback.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The current account.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   A successful access result.
   */
  public function access(AccountInterface $account) {
    return AccessResult::allowed();
  }

  /**
   * Toggle the active state.
   *
   * @param mixed $id
   *   The id of the entity given by route url.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect response object that may be returned by the controller.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function toggleActive($id) {
    $webhooks_storage = $this->entityTypeManager
      ->getStorage('webhook_config');

    /** @var \Drupal\webhooks\Entity\WebhookConfig $webhook_config */
    $webhook_config = $webhooks_storage
      ->load($id);
    $webhook_config
      ->setStatus(!$webhook_config
      ->status());
    $webhook_config
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('Webhook <a href=":url">@webhook</a> has been %status.', [
      ':url' => Url::fromRoute('entity.webhook_config.edit_form', [
        'webhook_config' => $webhook_config
          ->getId(),
      ])
        ->toString(),
      '@webhook' => $webhook_config
        ->getLabel(),
      '%status' => $webhook_config
        ->status() ? 'enabled' : 'disabled',
    ]));
    return $this
      ->redirect("entity.webhook_config.collection");
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.
WebhookController::$entityTypeManager	protected	property	The entity type manager. Overrides ControllerBase::$entityTypeManager
WebhookController::$logger	protected	property	The Logger.
WebhookController::$messenger	protected	property	The messenger. Overrides MessengerTrait::$messenger
WebhookController::$webhooksService	protected	property	The webhooks service.
WebhookController::access	public	function	Access check callback.
WebhookController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
WebhookController::receive	public	function	Webhooks receiver.
WebhookController::toggleActive	public	function	Toggle the active state.
WebhookController::__construct	public	function	WebhookController constructor.

You are here

class WebhookController in Webhooks 8

Hierarchy

File

Namespace

Members

API Navigation