PathUtilityInterface.php in Drupal 7 to 8/9 Module Upgrader 8

Namespace

Drupal\drupalmoduleupgrader\Utility\Path

File

src/Utility/Path/PathUtilityInterface.php

<?php

namespace Drupal\drupalmoduleupgrader\Utility\Path;

use Doctrine\Common\Collections\Collection as CollectionInterface;

/**
 * Represents a route path.
 */
interface PathUtilityInterface extends CollectionInterface {

  /**
   * Constructs a path utility.
   *
   * @param mixed $path
   *   The path to wrap, either as a string or an array.
   *
   * @throws \InvalidArgumentException
   */
  public function __construct($path);

  /**
   * Returns a new path component wrapping a value.
   *
   * @param mixed $value
   *   The value to wrap.
   *
   * @return \Drupal\drupalmoduleupgrader\Utility\Path\PathComponentInterface
   */
  public static function getComponent($value);

  /**
   * Returns if there are wildcards in the path.
   *
   * @return bool
   */
  public function hasWildcards();

  /**
   * Returns a PathUtilityInterface for the parent path.
   *
   * @return static
   *
   * @throws \LengthException if the path cannot have a parent (i.e.,
   * the path only has one component).
   */
  public function getParent();

  /**
   * Collapses the path into a string.
   *
   * @return string
   */
  public function __toString();

}

Interfaces

Name	Description
PathUtilityInterface	Represents a route path.