annotate core/lib/Drupal/Core/Path/CurrentPathStack.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Path;
Chris@0 4
Chris@0 5 use Symfony\Component\HttpFoundation\Request;
Chris@0 6 use Symfony\Component\HttpFoundation\RequestStack;
Chris@0 7
Chris@0 8 /**
Chris@0 9 * Represents the current path for the current request.
Chris@0 10 *
Chris@0 11 * Note: You should not rely on paths but rather on route names / parameters or
Chris@0 12 * other indicators like context. For some fundamental parts, like routing or
Chris@0 13 * path processing, there is unfortunately no way around dealing with paths.
Chris@0 14 */
Chris@0 15 class CurrentPathStack {
Chris@0 16
Chris@0 17 /**
Chris@0 18 * Static cache of paths.
Chris@0 19 *
Chris@0 20 * @var \SplObjectStorage
Chris@0 21 */
Chris@0 22 protected $paths;
Chris@0 23
Chris@0 24 /**
Chris@0 25 * The request stack.
Chris@0 26 *
Chris@0 27 * @var \Symfony\Component\HttpFoundation\RequestStack
Chris@0 28 */
Chris@0 29 protected $requestStack;
Chris@0 30
Chris@0 31 /**
Chris@0 32 * Constructs a new CurrentPathStack instance.
Chris@0 33 *
Chris@0 34 * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
Chris@0 35 * The request stack.
Chris@0 36 */
Chris@0 37 public function __construct(RequestStack $request_stack) {
Chris@0 38 $this->requestStack = $request_stack;
Chris@0 39 $this->paths = new \SplObjectStorage();
Chris@0 40 }
Chris@0 41
Chris@0 42 /**
Chris@0 43 * Returns the path of the current request.
Chris@0 44 *
Chris@0 45 * @param \Symfony\Component\HttpFoundation\Request $request
Chris@0 46 * (optional) The request.
Chris@0 47 *
Chris@0 48 * @return string
Chris@0 49 * Returns the path, without leading slashes.
Chris@0 50 */
Chris@0 51 public function getPath(Request $request = NULL) {
Chris@0 52 if (!isset($request)) {
Chris@0 53 $request = $this->requestStack->getCurrentRequest();
Chris@0 54 }
Chris@0 55 if (!isset($this->paths[$request])) {
Chris@0 56 $this->paths[$request] = $request->getPathInfo();
Chris@0 57 }
Chris@0 58
Chris@0 59 return $this->paths[$request];
Chris@0 60 }
Chris@0 61
Chris@0 62 /**
Chris@0 63 * Sets the current path.
Chris@0 64 *
Chris@0 65 * @param string $path
Chris@0 66 * The path.
Chris@0 67 * @param \Symfony\Component\HttpFoundation\Request $request
Chris@0 68 * (optional) The request.
Chris@0 69 *
Chris@0 70 * @return $this
Chris@0 71 */
Chris@0 72 public function setPath($path, Request $request = NULL) {
Chris@0 73 if (!isset($request)) {
Chris@0 74 $request = $this->requestStack->getCurrentRequest();
Chris@0 75 }
Chris@0 76 $this->paths[$request] = $path;
Chris@0 77
Chris@0 78 return $this;
Chris@0 79 }
Chris@0 80
Chris@0 81 }