class LingotekWorkbenchRedirectController in Lingotek Translation 4.0.x

Controller for redirecting to the Lingotek TMS workbench.

@package Drupal\lingotek\Controller

Hierarchy

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

File

src/Controller/LingotekWorkbenchRedirectController.php, line 21

Namespace

Drupal\lingotek\Controller

class LingotekWorkbenchRedirectController extends LingotekControllerBase {

  /**
   * The time service.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * Constructs a LingotekControllerBase object.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The Request instance.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\lingotek\LingotekInterface $lingotek
   *   The lingotek service.
   * @param \Drupal\lingotek\LanguageLocaleMapperInterface $language_locale_mapper
   *   The language-locale mapper.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   */
  public function __construct(Request $request, ConfigFactoryInterface $config_factory, LingotekInterface $lingotek, LanguageLocaleMapperInterface $language_locale_mapper, FormBuilderInterface $form_builder, LoggerInterface $logger, TimeInterface $time = NULL) {
    parent::__construct($request, $config_factory, $lingotek, $language_locale_mapper, $form_builder, $logger);
    $this->time = $time;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('request_stack')
      ->getCurrentRequest(), $container
      ->get('config.factory'), $container
      ->get('lingotek'), $container
      ->get('lingotek.language_locale_mapper'), $container
      ->get('form_builder'), $container
      ->get('logger.channel.lingotek'), $container
      ->get('datetime.time'));
  }

  /**
   * Redirects to the workbench of the given document and locale in the TMS.
   */
  public function redirectToWorkbench($doc_id, $locale) {

    // Get account settings to build workbench link.
    $account = $this
      ->config('lingotek.account');

    // Generate the uri to the Lingotek Workbench.
    $uri = $this
      ->generateWorkbenchUri($doc_id, $locale, $account);
    return new TrustedRedirectResponse(Url::fromUri($uri)
      ->toString());
  }

  /**
   * Generates a workbench uri for this account given a document id and locale.
   *
   * @param string $document_id
   *   The document id.
   * @param string $locale
   *   Lingotek translation language.
   * @param \Drupal\Core\Config\Config $account
   *   Config with the account settings.
   *
   * @return string
   *   The uri of the workbench for this account for editing this translation.
   */
  protected function generateWorkbenchUri($document_id, $locale, $account) {
    $base_url = $account
      ->get('host');

    // https://{environment}/workbench/document/{uuid}/locale/{es-MX}
    $workbench_uri = $base_url . '/workbench/document/' . $document_id . '/locale/' . $locale;
    return $workbench_uri;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
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::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.
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.
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.
LingotekWorkbenchRedirectController::$time	protected	property	The time service.
LingotekWorkbenchRedirectController::create	public static	function	Instantiates a new instance of this class. Overrides LingotekControllerBase::create
LingotekWorkbenchRedirectController::generateWorkbenchUri	protected	function	Generates a workbench uri for this account given a document id and locale.
LingotekWorkbenchRedirectController::redirectToWorkbench	public	function	Redirects to the workbench of the given document and locale in the TMS.
LingotekWorkbenchRedirectController::__construct	public	function	Constructs a LingotekControllerBase object. Overrides LingotekControllerBase::__construct
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.