You are here

Home » API reference » Tawk.to - Live chat application (Drupal 8) 8.2 » TawkToWidgetController.php

class TawkToWidgetController in Tawk.to - Live chat application (Drupal 8) 8.2

Same name and namespace in other branches
  1. 8 src/Controller/TawkToWidgetController.php \Drupal\tawk_to\Controller\TawkToWidgetController

Controller routine that manages tawk.to widget settings.

Hierarchy

Expanded class hierarchy of TawkToWidgetController

File

src/Controller/TawkToWidgetController.php, line 17

Namespace

Drupal\tawk_to\Controller
View source 
class TawkToWidgetController extends ControllerBase {

  /**
   * The tawk.to plugins URL.
   */
  const TAWK_TO_PLUGINS_URL = 'https://plugins.tawk.to';

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $request;

  /**
   * The settings config.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * Constructs a TawkToWidgetController object.
   *
   * @param \Symfony\Component\HttpFoundation\RequestStack $request
   *   The request stack.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config
   *   The configuration factory service.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   */
  public function __construct(RequestStack $request, ConfigFactoryInterface $config, LanguageManagerInterface $language_manager) {
    $this->request = $request;
    $this->languageManager = $language_manager;
    $currentLanguage = $this->languageManager
      ->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
      ->getId();
    $this->config = $config
      ->getEditable('tawk_to.settings');

    // Allows saving of the widget settings form multiple languages.
    if ($this->languageManager instanceof ConfigurableLanguageManagerInterface) {
      $configOverride = $this->languageManager
        ->getLanguageConfigOverride($currentLanguage, 'tawk_to.settings');
      if (!$configOverride
        ->isNew()) {
        $this->config = $configOverride;
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('request_stack'), $container
      ->get('config.factory'), $container
      ->get('language_manager'));
  }

  /**
   * Constructs url for configuration iframe.
   *
   * @return string
   *   Base iframe URL.
   */
  private function tawkToGetIframeUrl() {
    $pageId = $this->config
      ->get('tawk_to_widget_page_id');
    $widgetId = $this->config
      ->get('tawk_to_widget_id');
    return self::TAWK_TO_PLUGINS_URL . '/generic/widgets?currentWidgetId=' . $widgetId . '&currentPageId=' . $pageId;
  }

  /**
   * Constructs a widgets content.
   *
   * @return array
   *   Renderable array.
   */
  public function widgetsContent() {
    $items = [];
    $items['baseUrl'] = self::TAWK_TO_PLUGINS_URL;
    $items['iframeUrl'] = $this
      ->tawkToGetIframeUrl();
    return [
      '#theme' => 'tawk_to_iframe',
      '#items' => $items,
    ];
  }

  /**
   * Callback for settting widget with ajax in tawk.to iframe.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   JSON object for JS code.
   */
  public function setWidget() {
    $pageId = $this->request
      ->getCurrentRequest()
      ->get('pageId');
    $widgetId = $this->request
      ->getCurrentRequest()
      ->get('widgetId');
    if (!$pageId || !$widgetId) {
      return new JsonResponse([
        'success' => FALSE,
      ]);
    }
    if (preg_match('/^[0-9A-Fa-f]{24}$/', $pageId) !== 1 || preg_match('/^[a-z0-9]{1,50}$/i', $widgetId) !== 1) {
      return new JsonResponse([
        'success' => FALSE,
      ]);
    }
    $this->config
      ->set('tawk_to_widget_page_id', $pageId)
      ->save();
    $this->config
      ->set('tawk_to_widget_id', $widgetId)
      ->save();
    return new JsonResponse([
      'success' => TRUE,
    ]);
  }

  /**
   * Callback for removing widget with ajax in tawk.to iframe.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   JSON object for JS code.
   */
  public function removeWidget() {
    $this->config
      ->clear('tawk_to_widget_page_id')
      ->save();
    $this->config
      ->clear('tawk_to_widget_id')
      ->save();
    return new JsonResponse([
      'success' => TRUE,
    ]);
  }

}

Members

Namesort descending 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::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 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 protected property The messenger. 29
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.
TawkToWidgetController::$config protected property The settings config.
TawkToWidgetController::$languageManager protected property The language manager. Overrides ControllerBase::$languageManager
TawkToWidgetController::$request protected property The request stack.
TawkToWidgetController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
TawkToWidgetController::removeWidget public function Callback for removing widget with ajax in tawk.to iframe.
TawkToWidgetController::setWidget public function Callback for settting widget with ajax in tawk.to iframe.
TawkToWidgetController::tawkToGetIframeUrl private function Constructs url for configuration iframe.
TawkToWidgetController::TAWK_TO_PLUGINS_URL constant The tawk.to plugins URL.
TawkToWidgetController::widgetsContent public function Constructs a widgets content.
TawkToWidgetController::__construct public function Constructs a TawkToWidgetController object.
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.