You are here

class UserCurrentPathsController in User current paths (user/edit & user/current/*) 2.0.x

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

Defines the User Current Paths controller.

Hierarchy

Expanded class hierarchy of UserCurrentPathsController

File

src/Controller/UserCurrentPathsController.php, line 14

Namespace

Drupal\user_current_paths\Controller
View source
class UserCurrentPathsController extends ControllerBase {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountProxy
   */
  protected $currentUser;

  /**
   * The path validator.
   *
   * @var \Drupal\Core\Path\PathValidator
   */
  protected $pathValidator;

  /**
   * Constructs a UserCurrentPathsController object.
   *
   * @param \Drupal\Core\Session\AccountProxy $current_user
   *   The current user.
   * @param \Drupal\Core\Path\PathValidator $path_validator
   *   The path validator.
   */
  public function __construct(AccountProxy $current_user, PathValidator $path_validator) {
    $this->currentUser = $current_user;
    $this->pathValidator = $path_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('current_user'), $container
      ->get('path.validator'));
  }

  /**
   * Handles wildcard (user/current/*) redirects for the current user.
   *
   * Replaces the second "current" parameter in the URL with the currently
   * logged in user and redirects to the target if the resulting path is valid.
   * Ohterwise throws a NotFoundHttpException. This is safe because the redirect
   * is handled as if the user entered the URL manually with all security
   * checks.
   *
   * @param string $wildcardaction
   *   The wildcart action.
   */
  public function wildcardActionRedirect(string $wildcardaction) {
    $path = '/user/' . $this->currentUser
      ->id();
    if ($wildcardaction != 'view') {

      // /view doesn't exist for user entities
      $path .= '/' . $wildcardaction;
    }
    $url = $this->pathValidator
      ->getUrlIfValid($path);
    if ($url !== FALSE) {

      // Valid internal path:
      return $this
        ->redirect($url
        ->getRouteName(), $url
        ->getRouteParameters(), $url
        ->getOptions());
    }
    throw new NotFoundHttpException();
  }

  /**
   * Handles redirects to the user edit page for the currently logged in user.
   */
  public function editRedirect() {
    $route_name = 'entity.user.edit_form';
    $route_parameters = [
      'user' => $this->currentUser
        ->id(),
    ];
    return $this
      ->redirect($route_name, $route_parameters);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$entityFormBuilder protected property The entity form builder.
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::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.
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.
UserCurrentPathsController::$currentUser protected property The current user. Overrides ControllerBase::$currentUser
UserCurrentPathsController::$pathValidator protected property The path validator.
UserCurrentPathsController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
UserCurrentPathsController::editRedirect public function Handles redirects to the user edit page for the currently logged in user.
UserCurrentPathsController::wildcardActionRedirect public function Handles wildcard (user/current/*) redirects for the current user.
UserCurrentPathsController::__construct public function Constructs a UserCurrentPathsController object.