class LingotekNotificationController in Lingotek Translation 8

Returns responses for lingotek module setup routes.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\lingotek\Controller\LingotekControllerBase uses LingotekSetupTrait
    • class \Drupal\lingotek\Controller\LingotekNotificationController

File

src/Controller/LingotekNotificationController.php, line 19

Namespace

Drupal\lingotek\Controller

class LingotekNotificationController extends LingotekControllerBase {
  public function endpoint(Request $request) {

    /** @var \Drupal\lingotek\LingotekContentTranslationServiceInterface $content_translation_service */
    $content_translation_service = \Drupal::service('lingotek.content_translation');

    /** @var \Drupal\lingotek\LingotekConfigTranslationServiceInterface $config_translation_service */
    $config_translation_service = \Drupal::service('lingotek.config_translation');
    $translation_service = $content_translation_service;
    $request_method = $request
      ->getMethod();
    $http_status_code = Response::HTTP_NOT_IMPLEMENTED;
    $type = $request
      ->get('type');
    $result = array();
    $messages = array();
    $security_token = $request
      ->get('security_token');
    if ($security_token == 1) {
      $http_status_code = Response::HTTP_NOT_IMPLEMENTED;
    }
    parse_str($request
      ->getQueryString(), $params);
    switch ($type) {
      case 'project':

        // all translations for all documents have been completed for the project

        //ex. ?project_id=103956f4-17cf-4d79-9d15-5f7b7a88dee2&progress=100&type=project
        break;
      case 'document':
        break;
      case 'document_uploaded':

        // a document has uploaded and imported successfully for document_id
        $entity = $this
          ->getEntity($request
          ->get('document_id'));

        /** @var LingotekProfile $profile */
        $profile = $this
          ->getProfile($entity);
        if ($entity) {
          if ($entity instanceof ConfigEntityInterface) {
            $translation_service = $config_translation_service;
          }
          $http_status_code = Response::HTTP_OK;
          $translation_service
            ->setSourceStatus($entity, Lingotek::STATUS_CURRENT);
          $result['request_translations'] = $profile
            ->hasAutomaticUpload() ? $translation_service
            ->requestTranslations($entity) : [];
        }
        else {
          $http_status_code = Response::HTTP_NOT_FOUND;
        }
        break;
      case 'phase':
      case 'target':

        // translation (i.e., chinese) has been completed for a document

        //TO-DO: download target for locale_code and document_id (also, progress and complete params can be used as needed)

        //ex. ?project_id=103956f4-17cf-4d79-9d15-5f7b7a88dee2&locale_code=de-DE&document_id=bbf48a7b-b201-47a0-bc0e-0446f9e33a2f&complete=true&locale=de_DE&progress=100&type=target
        $entity = $this
          ->getEntity($request
          ->get('document_id'));

        /** @var LingotekProfile $profile */
        $profile = $this
          ->getProfile($entity);
        if ($entity) {
          if ($entity instanceof ConfigEntityInterface) {
            $translation_service = $config_translation_service;
          }
          $http_status_code = Response::HTTP_OK;
          $locale = $request
            ->get('locale');
          $langcode = $this->languageLocaleMapper
            ->getConfigurableLanguageForLocale($locale)
            ->id();
          $result['set_target_status'] = $translation_service
            ->setTargetStatus($entity, $langcode, Lingotek::STATUS_READY);
          $result['download'] = $profile
            ->hasAutomaticDownloadForTarget($langcode) ? $translation_service
            ->downloadDocument($entity, $locale) : FALSE;
        }
        else {
          $http_status_code = Response::HTTP_NOT_FOUND;
          $messages[] = "Document not found.";
        }
        break;
      default:

        //ignore
        $http_status_code = Response::HTTP_NOT_IMPLEMENTED;
        $messages[] = "Not implemented.";
        break;
    }
    $response = array(
      'service' => 'notify',
      'method' => $request_method,
      'params' => $params,
      'result' => $result,
      'messages' => $messages,
    );
    return JsonResponse::create($response, $http_status_code);
  }
  protected function getProfile($entity) {

    /** @var \Drupal\lingotek\LingotekConfigurationServiceInterface $configuration_service */
    $configuration_service = \Drupal::service('lingotek.configuration');
    $profile = NULL;
    if ($entity instanceof ContentEntityInterface) {
      $profile = $configuration_service
        ->getEntityProfile($entity, FALSE);
    }
    elseif ($entity instanceof ConfigEntityInterface) {
      $profile = $configuration_service
        ->getConfigEntityProfile($entity, FALSE);
    }
    return $profile;
  }
  protected function getEntity($document_id) {

    /** @var \Drupal\lingotek\LingotekContentTranslationServiceInterface $translation_service */
    $translation_service = \Drupal::service('lingotek.content_translation');
    $entity = $translation_service
      ->loadByDocumentId($document_id);
    if ($entity === NULL) {

      /** @var \Drupal\lingotek\LingotekConfigTranslationServiceInterface $translation_service */
      $translation_service = \Drupal::service('lingotek.config_translation');
      $entity = $translation_service
        ->loadByDocumentId($document_id);
    }
    return $entity;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::$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.
LingotekControllerBase::$configFactory	protected	property	The config factory. Overrides ControllerBase::$configFactory
LingotekControllerBase::$formBuilder	protected	property	The form builder. Overrides ControllerBase::$formBuilder
LingotekControllerBase::$languageLocaleMapper	protected	property	The language-locale mapper.
LingotekControllerBase::$logger	protected	property	A logger instance.
LingotekControllerBase::$request	protected	property	A Symfony request instance
LingotekControllerBase::connected	public	function	Checks if site is connected to Lingotek.
LingotekControllerBase::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create	1
LingotekControllerBase::getLingotekForm	protected	function	Return a Lingotek form (convenience function)
LingotekControllerBase::__construct	public	function	Constructs a LingotekControllerBase object.	1
LingotekNotificationController::endpoint	public	function
LingotekNotificationController::getEntity	protected	function
LingotekNotificationController::getProfile	protected	function
LingotekSetupTrait::$lingotek	protected	property	A lingotek connector object
LingotekSetupTrait::checkSetup	protected	function	Verify the Lingotek Translation module has been properly initialized.
LingotekSetupTrait::setupCompleted	public	function	Checks if Lingotek module is completely set up.
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.
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.