class SetTimezoneController in Timezone Detect 8

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\timezone_detect\Controller\SetTimezoneController implements ContainerInjectionInterface

File

src/Controller/SetTimezoneController.php, line 17

Namespace

Drupal\timezone_detect\Controller

class SetTimezoneController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $account;

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

  /**
   * @var \Drupal\Core\Access\CsrfTokenGenerator
   */
  protected $tokenGenerator;

  /**
   * SetTimezoneController constructor.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   * @param \Drupal\Core\Session\AccountProxyInterface $account
   * @param \Psr\Log\LoggerInterface $logger
   * @param \Drupal\Core\Access\CsrfTokenGenerator $tokenGenerator
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   */
  public function __construct(Request $request, AccountProxyInterface $account, LoggerInterface $logger, CsrfTokenGenerator $tokenGenerator, ConfigFactoryInterface $configFactory) {
    $this->request = $request;
    $this->account = $account;
    $this->logger = $logger;
    $this->tokenGenerator = $tokenGenerator;
    $this->configFactory = $configFactory;
  }

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

  /**
   * Update the users timezone.
   */
  public function updateTimezone() {
    $response = new AjaxResponse();

    // If they are logged in, set some data.
    if ($this->account
      ->isAuthenticated()) {

      // Check for $_POST data.
      // Timezone should be an IANA/Olson timezone id provided via $_POST.
      $timezone = Html::escape($this->request->request
        ->get('timezone'));
      if (!isset($timezone)) {
        $this->logger
          ->error('Attempting to set timezone for user @uid, but no timezone found in $_POST data; aborting.', [
          '@uid' => $this->account
            ->id(),
        ]);
        unset($_SESSION['timezone_detect']['update_timezone']);
        return $response;
      }

      // Make sure we have a valid session token to prevent cross-site request
      // forgery.
      $token = $this->request->request
        ->get('token');
      if (!isset($token) || !$this->tokenGenerator
        ->validate($token)) {
        $this->logger
          ->error('Attempting to set timezone for user @uid, but session token in $_POST data is empty or invalid; aborting.', [
          '@uid' => $this->account
            ->ui(),
        ]);
        unset($_SESSION['timezone_detect']['update_timezone']);
        return $response;
      }

      // Keep track of the last submitted timezone in case it's not valid so
      // that we don't keep POSTing it on every request.
      $_SESSION['timezone_detect']['current_timezone'] = $timezone;

      // Check valid timezone id.
      $zone_list = timezone_identifiers_list();
      if (!in_array($timezone, $zone_list)) {
        $this->logger
          ->error('Attempting to set timezone for user @uid to @timezone, but that does not appear to be a valid timezone id; aborting.', [
          '@uid' => $this->account
            ->id(),
          '@timezone' => $timezone,
        ]);
        unset($_SESSION['timezone_detect']['update_timezone']);
        return $response;
      }

      // Save timezone to account.
      User::load($this->account
        ->id())
        ->set('timezone', $timezone)
        ->save();
      if ($this->configFactory
        ->get('timezone_detect.settings')
        ->get('watchdog')) {
        $this->logger
          ->notice('Set timezone for user @uid to @timezone.', [
          '@uid' => $this->account
            ->id(),
          '@timezone' => $timezone,
        ]);
      }
    }

    // Unset session flag regarldess of whether they are logged in or not to
    // avoid repeated attempts at this process that are likely to fail.
    unset($_SESSION['timezone_detect']['update_timezone']);
    return $response;
  }

}

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::$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::$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	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.
SetTimezoneController::$account	protected	property
SetTimezoneController::$logger	protected	property
SetTimezoneController::$request	protected	property
SetTimezoneController::$tokenGenerator	protected	property
SetTimezoneController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
SetTimezoneController::updateTimezone	public	function	Update the users timezone.
SetTimezoneController::__construct	public	function	SetTimezoneController constructor.
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.