www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/drupalmoduleupgrader/src/Utility/Path/PathUtilityInterface.php

   1 <?php
   2
   3 /**
   4  * @file
   5  * Contains \Drupal\drupalmoduleupgrader\Utility\Path\PathUtilityInterface.
   6  */
   7
   8 namespace Drupal\drupalmoduleupgrader\Utility\Path;
   9
  10 use Doctrine\Common\Collections\Collection as CollectionInterface;
  11
  12 /**
  13  * Represents a route path.
  14  */
  15 interface PathUtilityInterface extends CollectionInterface {
  16
  17   /**
  18    * Constructs a path utility.
  19    *
  20    * @param mixed $path
  21    *  The path to wrap, either as a string or an array.
  22    *
  23    * @throws \InvalidArgumentException
  24    */
  25   public function __construct($path);
  26
  27   /**
  28    * Returns a new path component wrapping a value.
  29    *
  30    * @param mixed $value
  31    *  The value to wrap.
  32    *
  33    * @return \Drupal\drupalmoduleupgrader\Utility\Path\PathComponentInterface
  34    */
  35   public static function getComponent($value);
  36
  37   /**
  38    * Returns if there are wildcards in the path.
  39    *
  40    * @return boolean
  41    */
  42   public function hasWildcards();
  43
  44   /**
  45    * Returns a PathUtilityInterface for the parent path.
  46    *
  47    * @return static
  48    *
  49    * @throws \LengthException if the path cannot have a parent (i.e.,
  50    * the path only has one component).
  51    */
  52   public function getParent();
  53
  54   /**
  55    * Collapses the path into a string.
  56    *
  57    * @return string
  58    */
  59   public function __toString();
  60
  61 }