class LingotekSetupController in Lingotek Translation 8.2

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\LingotekSetupController

File

src/Controller/LingotekSetupController.php, line 13

Namespace

Drupal\lingotek\Controller

class LingotekSetupController extends LingotekControllerBase {

  /**
   * Presents a connection page to Lingotek Services
   *
   * @return array
   *   The connection form.
   */
  public function accountPage() {
    if ($this
      ->setupCompleted()) {
      return $this->formBuilder
        ->getForm(LingotekSettingsAccountForm::class);
    }
    return [
      '#type' => 'markup',
      'markup' => $this->formBuilder
        ->getForm(LingotekSettingsConnectForm::class),
    ];
  }
  public function handshake() {
    if ($this
      ->receivedToken()) {
      $this
        ->saveToken($this
        ->receivedToken());
      $config = \Drupal::configFactory()
        ->getEditable('lingotek.settings');
      $config
        ->set('account.use_production', TRUE)
        ->save();
      $account_info = $this
        ->fetchAccountInfo();
      $this
        ->saveAccountInfo($account_info);
      $this
        ->messenger()
        ->addStatus($this
        ->t('Your account settings have been saved.'));
      $this->logger
        ->notice('Account connected to Lingotek.');

      // No need to show the username and token if everything worked correctly
      // Just go to the community page
      return $this
        ->redirect('lingotek.setup_community');
    }
    else {
      return [
        '#type' => 'markup',
        '#markup' => $this
          ->t('Connecting... Please wait to be redirected'),
        '#attached' => [
          'library' => [
            'lingotek/lingotek.connect',
          ],
        ],
      ];
    }
  }
  public function communityPage() {
    if ($redirect = $this
      ->checkSetup()) {
      return $redirect;
    }
    $communities = $this->lingotek
      ->getCommunities(TRUE);
    if (empty($communities)) {

      // TODO: Log an error that no communities exist.
      return $this
        ->redirect('lingotek.setup_account');
    }
    $config = \Drupal::configFactory()
      ->getEditable('lingotek.settings');
    $config
      ->set('account.resources.community', $communities);
    $config
      ->save();
    if (count($communities) == 1) {

      // No choice necessary. Save and advance to next page.
      $config
        ->set('default.community', current(array_keys($communities)));
      $config
        ->save();

      // update resources based on newly selected community
      $this->lingotek
        ->getResources(TRUE);
      return $this
        ->redirect('lingotek.setup_defaults');
    }
    return [
      '#type' => 'markup',
      'markup' => $this->formBuilder
        ->getForm(LingotekSettingsCommunityForm::class),
    ];
  }
  public function defaultsPage() {
    if ($redirect = $this
      ->checkSetup()) {
      return $redirect;
    }
    $resources = $this->lingotek
      ->getResources();

    // No choice necessary. Save and advance to the next page.
    if (count($resources['project']) == 1 && count($resources['vault']) == 1) {
      $this->lingotek
        ->set('default.project', current(array_keys($resources['project'])));
      $this->lingotek
        ->set('default.vault', current(array_keys($resources['vault'])));
      $this->lingotek
        ->set('default.workflow', array_search('Machine Translation', $resources['workflow']));

      // Assign the project callback
      $new_callback_url = \Drupal::urlGenerator()
        ->generateFromRoute('lingotek.notify', [], [
        'absolute' => TRUE,
      ]);
      $this->lingotek
        ->set('account.callback_url', $new_callback_url);
      $new_response = $this->lingotek
        ->setProjectCallBackUrl($this->lingotek
        ->get('default.project'), $new_callback_url);
      return $this
        ->redirect('lingotek.dashboard');
    }
    return [
      '#type' => 'markup',
      'markup' => $this->formBuilder
        ->getForm(LingotekSettingsDefaultsForm::class),
    ];
  }
  protected function receivedToken() {
    return $this->request
      ->get('access_token');
  }
  protected function saveToken($token) {
    if (!empty($token)) {
      \Drupal::configFactory()
        ->getEditable('lingotek.settings')
        ->set('account.access_token', $token)
        ->save();
    }
  }
  protected function saveAccountInfo($account_info) {
    if (!empty($account_info)) {
      $config = \Drupal::configFactory()
        ->getEditable('lingotek.settings');
      $config
        ->set('account.login_id', $account_info['login_id']);
      $config
        ->save();
    }
  }
  protected function fetchAccountInfo() {
    return $this->lingotek
      ->getAccountInfo();
  }

}

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	4
LingotekControllerBase::getLingotekForm Deprecated	protected	function	Return a Lingotek form (convenience function)
LingotekControllerBase::__construct	public	function	Constructs a LingotekControllerBase object.	4
LingotekSetupController::accountPage	public	function	Presents a connection page to Lingotek Services
LingotekSetupController::communityPage	public	function
LingotekSetupController::defaultsPage	public	function
LingotekSetupController::fetchAccountInfo	protected	function
LingotekSetupController::handshake	public	function
LingotekSetupController::receivedToken	protected	function
LingotekSetupController::saveAccountInfo	protected	function
LingotekSetupController::saveToken	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.