+Directory::relativePath()

Author: codemasher

README.md

@@ -80,13 +80,14 @@ output and input `$format` for the functions `Crypto::encrypt()` and `Crypto::de
 
 ### `Directory`
 
-| method                                                                                    | description                                                   |
-|-------------------------------------------------------------------------------------------|---------------------------------------------------------------|
-| `Directory::exists(string $dir):bool`                                                     | Checks whether a directory exists                             |
-| `Directory::isReadable(string $dir):bool`                                                 | Checks whether the given directory is readable                |
-| `Directory::isWritable(string $dir):bool`                                                 | Checks whether the given directory is writable                |
-| `Directory::create(string $dir, int $permissions = 0o777, bool $recursive = true):string` | Creates a directory                                           |
-| `Directory::remove(string $dir):bool`                                                     | Removes a directory                                           |
+| method                                                                                                | description                                        |
+|-------------------------------------------------------------------------------------------------------|----------------------------------------------------|
+| `Directory::exists(string $dir):bool`                                                                 | Checks whether a directory exists                  |
+| `Directory::isReadable(string $dir):bool`                                                             | Checks whether the given directory is readable     |
+| `Directory::isWritable(string $dir):bool`                                                             | Checks whether the given directory is writable     |
+| `Directory::create(string $dir, int $permissions = 0o777, bool $recursive = true):string`             | Creates a directory                                |
+| `Directory::remove(string $dir):bool`                                                                 | Removes a directory                                |
+| `Directory::relativePath(string $path, string $from, string $separator = DIRECTORY_SEPARATOR):string` | Returns the relative path from the given directory |
 
 
 ### `File`

src/Directory.php

@@ -14,14 +14,18 @@
 use InvalidArgumentException;
 use RuntimeException;
 use function clearstatcache;
+use function dirname;
 use function file_exists;
 use function is_dir;
+use function is_file;
 use function is_readable;
 use function is_writable;
 use function mkdir;
 use function rmdir;
 use function sprintf;
+use function str_replace;
 use function trim;
+use const DIRECTORY_SEPARATOR;
 
 /**
  * Basic directory utilities
@@ -100,4 +104,22 @@ public static function remove(string $dir):bool{
 		return true;
 	}
 
+	/**
+	 * Returns the relative path from the given directory (realpath)
+	 */
+	public static function relativePath(string $path, string $from, string $separator = DIRECTORY_SEPARATOR):string{
+		$path = File::realpath($path);
+		$from = File::realpath($from);
+
+		if(is_file($path)){
+			$path = dirname($path);
+		}
+
+		if(is_file($from)){
+			$from = dirname($from);
+		}
+
+		return trim(str_replace([$from, '\\', '/'], ['', $separator, $separator], $path), '\\/');
+	}
+
 }

tests/DirAndFileTest.php

@@ -112,4 +112,11 @@ public function removeDirectoryEmptyNameException():void{
 		Directory::remove('');
 	}
 
+	#[Test]
+	public function relativePath():void{
+		$relative = Directory::relativePath(__DIR__.'/filetest/.gitkeep', __DIR__.'/..', '/');
+
+		$this::assertSame('tests/filetest', $relative);
+	}
+
 }