IHF: relative_path helper readme added.

dmitry-ivanov · Mar 15, 2017 · 965b1e7 · 965b1e7
1 parent 274e255
commit 965b1e7
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -56,6 +56,9 @@ Provides Laravel-specific and pure PHP helper functions.
     - [to_rfc2822_email](#to_rfc2822_email)
     - [to_swiftmailer_emails](#to_swiftmailer_emails)
 
+- [Filesystem](#filesystem)
+    - [relative_path](#relative_path)
+
 - [Format](#format)
     - [get_dump](#get_dump)
     - [format_bytes](#format_bytes)
@@ -276,6 +279,26 @@ $address = to_swiftmailer_emails(['address' => 'john.doe@example.com', 'name' =>
 // ["john.doe@example.com" => "John Doe"]
 ```
 
+## Filesystem
+
+#### `relative_path()`
+
+Returns the relative path of a directory given another one:
+
+```php
+$path = relative_path('/var/www/htdocs', '/var/www/htdocs/example')
+
+// '../'
+```
+
+You can pass relative paths as a parameters:
+
+```php
+$path = relative_path('/var/www/htdocs/example/public/../../', '/var/')
+
+// 'www/htdocs/'
+```
+
 ## Format
 
 #### `get_dump()`

diff --git a/tests/HelperFunctions/filesystem/RelativePathTest.php b/tests/HelperFunctions/filesystem/RelativePathTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Illuminated\Helpers\HelperFunctions\Tests\FileSystem;
+namespace Illuminated\Helpers\HelperFunctions\Tests\Filesystem;
 
 use Illuminated\Helpers\HelperFunctions\Tests\TestCase;