class CurrentPathHelper in Menu Trail By Path 8

Hierarchy

• class \Drupal\menu_trail_by_path\Path\CurrentPathHelper implements PathHelperInterface

1 string reference to 'CurrentPathHelper'

menu_trail_by_path.services.yml in ./menu_trail_by_path.services.yml

menu_trail_by_path.services.yml

1 service uses CurrentPathHelper

menu_trail_by_path.path_helper in ./menu_trail_by_path.services.yml

Drupal\menu_trail_by_path\Path\CurrentPathHelper

File

src/Path/CurrentPathHelper.php, line 11

Namespace

Drupal\menu_trail_by_path\Path

class CurrentPathHelper implements PathHelperInterface {

  /**
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * The configuration object.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $config;

  /**
   * @var \Drupal\Core\Routing\RequestContext
   */
  private $context;
  public function __construct(RouteMatchInterface $route_match, RequestContext $context, ConfigFactoryInterface $config_factory) {
    $this->routeMatch = $route_match;
    $this->context = $context;
    $this->config = $config_factory
      ->get('menu_trail_by_path.settings');
  }

  /**
   * @inheritdoc
   */
  public function getUrls() {
    $trail_urls = $this
      ->getCurrentPathUrls();
    if ($current_request_url = $this
      ->getCurrentRequestUrl()) {
      $trail_urls[] = $current_request_url;
    }
    return $trail_urls;
  }

  /**
   * Returns the current request Url
   *
   * NOTE: There is a difference between $this->routeMatch->getRouteName and $this->context->getPathInfo()
   * for now it seems more logical to prefer the latter, because that's the "real" url that visitors enter in their browser..
   *
   * @return \Drupal\Core\Url|null
   */
  protected function getCurrentRequestUrl() {
    $current_pathinfo_url = $this
      ->createUrlFromRelativeUri($this->context
      ->getPathInfo());
    if ($current_pathinfo_url
      ->isRouted()) {
      return $current_pathinfo_url;
    }
    elseif ($route_name = $this->routeMatch
      ->getRouteName()) {
      $route_parameters = $this->routeMatch
        ->getRawParameters()
        ->all();
      return new Url($route_name, $route_parameters);
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getPathElements() {
    $path = trim($this->context
      ->getPathInfo(), '/');
    $path_elements = explode('/', $path);

    // Limit the maximum number of path parts.
    if (is_array($path_elements) && ($max_path_parts = $this->config
      ->get('max_path_parts'))) {
      return array_splice($path_elements, 0, $max_path_parts);
    }
    return $path_elements;
  }

  /**
   * @return \Drupal\Core\Url[]
   */
  protected function getCurrentPathUrls() {
    $urls = [];
    $path_elements = $this
      ->getPathElements();
    while (count($path_elements) > 1) {
      array_pop($path_elements);
      $url = $this
        ->createUrlFromRelativeUri('/' . implode('/', $path_elements));
      if ($url
        ->isRouted()) {
        $urls[] = $url;
      }
    }
    return array_reverse($urls);
  }

  /**
   * Create a Url Object from a relative uri (e.g. /news/drupal8-release-party)
   *
   * @param $relativeUri
   * @return Url
   */
  protected function createUrlFromRelativeUri($relativeUri) {

    // @see https://www.drupal.org/node/2810961
    if (UrlHelper::isExternal(substr($relativeUri, 1))) {
      return Url::fromUri('base:' . $relativeUri);
    }
    $relativeUri = str_replace('//', '/', $relativeUri);
    return Url::fromUserInput($relativeUri);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CurrentPathHelper::$config	protected	property	The configuration object.
CurrentPathHelper::$context	private	property
CurrentPathHelper::$routeMatch	protected	property
CurrentPathHelper::createUrlFromRelativeUri	protected	function	Create a Url Object from a relative uri (e.g. /news/drupal8-release-party)
CurrentPathHelper::getCurrentPathUrls	protected	function
CurrentPathHelper::getCurrentRequestUrl	protected	function	Returns the current request Url
CurrentPathHelper::getPathElements	public	function	Returns a list of path elements based on the maximum path parts setting. Overrides PathHelperInterface::getPathElements
CurrentPathHelper::getUrls	public	function	@inheritdoc Overrides PathHelperInterface::getUrls
CurrentPathHelper::__construct	public	function