interface PathUtilityInterface in Drupal 7 to 8/9 Module Upgrader 8

Represents a route path.

Hierarchy

• interface \Drupal\drupalmoduleupgrader\Utility\Path\PathUtilityInterface extends \Doctrine\Common\Collections\Collection

2 files declare their use of PathUtilityInterface

ParameterBinding.php in src/Routing/ParameterBinding.php

ParameterMap.php in src/Routing/ParameterMap.php

File

src/Utility/Path/PathUtilityInterface.php, line 10

Namespace

Drupal\drupalmoduleupgrader\Utility\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();

}

Members

Name	Modifiers	Type	Description	Overrides
PathUtilityInterface::getComponent	public static	function	Returns a new path component wrapping a value.	2
PathUtilityInterface::getParent	public	function	Returns a PathUtilityInterface for the parent path.	1
PathUtilityInterface::hasWildcards	public	function	Returns if there are wildcards in the path.	1
PathUtilityInterface::__construct	public	function	Constructs a path utility.	1
PathUtilityInterface::__toString	public	function	Collapses the path into a string.	1