prepare PHP Path

Author: indianmodassir

.mailmap

@@ -1,2 +1,2 @@
-Shahzada Modassir <modassirdev@gmail.com>
+Shahzada Modassir <shahzadamodassir@gmail.com>
 Shahzadi Afsara <shahzadiafsara@gmail.com>

AUTHORS

@@ -1,2 +1,2 @@
-Shahzada Modassir <modassirdev@gmail.com>
+Shahzada Modassir <shahzadamodassir@gmail.com>
 Shahzadi Afsara <shahzadiafsara@gmail.com>

CHANGELOG.md

@@ -1,91 +1,2 @@
 # Release Notes
-## [Unreleased](https://github.com/lazervel/path/compare/v9.2.0...v10.0.0)
-
-## [10.0.0](https://github.com/lazervel/path/compare/v9.2.0...v10.0.0) - 15 November 2024
-- [BC BREAK] Since v8.x, Due to significant updates in the library, all previous configurations may no longer work as expected. Users will need to reconfigure their settings to align with the new structure and behavior introduced in this update.
-- Review the updated documentation for `Path` to understand the new behavior.
-- Ensure that any calls to these methods are updated to accommodate these changes.
-- Affected `Path::canonicalize()` of output behaviour.
-- Affected `Path::resolve()` of output behaviour.
-- Affected `Path::normalize()` of output behaviour.
-- Affected `Path::optimize()` of output behaviour.
-- Affected `Path::join()` of output behaviour.
-- Affected `Path::relative()` of output behaviour.
-- Affected `Path::UrlToPath()` of output behaviour.
-- Affected `Path::toNamespcedPath()` of output behaviour.
-- Added `Path::toNamespcedPath()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::removeExt()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::hasExt()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::changeExt()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::localBase()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-
-## [9.2.0](https://github.com/lazervel/path/compare/v9.1.1...v9.2.0) - 09 November 2024
-- Fixed bugs `Path::tmp()` that caused [e.g., incorrect output], changes output behaviour. see [CHANGELOG](https://github.com/lazervel/path/compare/v9.1.1...v9.2.0)
-
-## [9.1.0](https://github.com/lazervel/path/compare/v9.0.0...v9.1.0) - 08 November 2024
-- Added `Path::apply()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::real()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Removed Temporarily `Path::callMap()` This method has been temporarily removed due to performance issues. It will be reintroduced in a future version (v9.3.0) after optimizations are completed.
-- Fixed bugs `Path::canonicalize()` that caused [e.g., incorrect output].
-- Fixed bugs `Path::isLocal()` that caused [e.g., incorrect output].
-- Fixed bugs `Path::rootname()` that caused [e.g., incorrect output].
-
-## [9.0.0](https://github.com/lazervel/path/compare/v8.2.2...v9.0.0) - 08 November 2024
-- [BC BREAK] Since v8.x, Due to significant updates in the library, all previous configurations may no longer work as expected. Users will need to reconfigure their settings to align with the new structure and behavior introduced in this update.
-- Review the updated documentation for `Path` to understand the new behavior.
-- Ensure that any calls to these methods are updated to accommodate these changes.
-- Affected `Path::canonicalize()` of output behaviour.
-- Affected `Path::resolve()` of output behaviour.
-- Affected `Path::normalize()` of output behaviour.
-- Affected `Path::optimize()` of output behaviour.
-- Affected `Path::join()` of output behaviour.
-- Affected `Path::relative()` of output behaviour.
-- Affected `Path::UrlToPath()` of output behaviour.
-- Affected `Path::toNamespcedPath()` of output behaviour.
-- Added `Path::toNamespcedPath()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-
-## [8.2.0](https://github.com/lazervel/path/releases/tag/v8.2.0) - 04 November 2024
-- Added `Path::pathToURL()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::UrlToPath()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-
-## [8.1.0](https://github.com/lazervel/path/releases/tag/v8.1.0) - 02 November 2024
-- Added `Path::callMap()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::checkLength()` method in PHP `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-
-## [8.0.1](https://github.com/lazervel/path/releases/tag/v8.0.1) - 01 November 2024
-- Fixed error handling for method calls to prevent unexpected runtime errors of `Path::extname()`, `Path::filename()` and `Path::info()`.
-- Enhanced validation checks to ensure proper usage of properties and methods, reducing the likelihood of errors.
-
-## [8.0.0](https://github.com/lazervel/path/compare/v7.3.0...v8.0.0) - 01 November 2024
-- [BC BREAK] Since v8.x, Due to significant updates in the library, all previous configurations may no longer work as expected. Users will need to reconfigure their settings to align with the new structure and behavior introduced in this update.
-- Review the updated documentation for `Path::resolve()`, `Path::normalize()`, `Path::join()`, and `Path::optimize()` and `Path::relative()` to understand the new behavior.
-- Ensure that any calls to these methods are updated to accommodate these changes.
-
-## [7.3.0](https://github.com/lazervel/path/releases/tag/v7.3.0) - 31 October 2024
-- Added `Path::canonicalize()` method in `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::optimize()` method in `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-
-## [7.2.0](https://github.com/lazervel/path/releases/tag/v7.2.0) - 30 October 2024
-- Added `Path::isAbsolute()` method in `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::isLocal()` method in `path` develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-
-## [7.1.0](https://github.com/lazervel/path/releases/tag/v7.1.0) - 30 October 2024
-- Added `Path::info()` method to get information about a file path, develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::basename()` method develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::extname()` method develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::filename()` method develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::tmp()` method develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::format()` method develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added `Path::parse()` method develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-
-## [7.0.0](https://github.com/lazervel/path/releases/tag/v7.0.0) - 29 October 2024
-- Removed `Path::separate()` method that is no longer available.
-- Removed `Path::real()` method that is no longer available.
-- Renamed method `Path::filePaths()` to `Path::combine()` for clarity and consistency.
-- Fixed bugs in method `Path::combine` that caused [e.g., incorrect output, duplicate combination, etc.].
-
-## [6.0.0](https://github.com/lazervel/path/releases/tag/v6.0.0) - 29 October 2024
-- Added new feature `Path::win32` property for `win32` (Windows) platform, develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-- Added new feature `Path::posix` property for `posix` (Linux/macOs) platform, develope by [@shahzadamodassir](https://github.com/shahzadamodassir).
-
-**Suggest:** We allow to use PHP `path` library version from [7.0.0](https://github.com/lazervel/path/releases/tag/v7.0.0) to [latest](https://github.com/lazervel/path/releases/latest) Recomended [latest](https://github.com/lazervel/path/releases/latest) version for best performance.
+## [Unreleased](https://github.com/lazervel/path/releases/v1.0.0)

README.md

@@ -12,7 +12,7 @@ PHP Path Help with handling or manipulating file and directory path.
 <a href="https://github.com/lazervel/path/releases"><img src="https://img.shields.io/github/release/lazervel/path.svg?style=flat-square" alt="Latest Version"></img></a>
 </p>
 
-## Installation
+## Composer Installation
 
 Installation is super-easy via [Composer](https://getcomposer.org)
 
@@ -24,7 +24,6 @@ or add it by hand to your `composer.json` file.
 
 ## The Features of PHP Path
 - [Path::basename($path[, $suffix])](#pathbasenamepath-suffix)
-- [Path::callMap($method, $args)](#pathcallmapmethod-args)
 - [Path::canonicalize($path)](#pathcanonicalizepath)
 - [Path::changeExt($path, $newExt)]()
 - [Path::combine($paths, $names)](#pathcombinepaths-names)
@@ -85,11 +84,6 @@ Path::basename('/home/local/user/example.html', '.html');
 // Returns: 'example'
 ```
 
-## Path::callMap($method, $args)
-```php
-// Temporary Unavailable
-```
-
 ## Path::canonicalize($path)
 
 For example, on POSIX:
@@ -188,7 +182,22 @@ explode(Path::delimiter, getenv('PATH'));
 ```
 
 ## Path::dirname($path[, $suffix, $levels])
+
+For example, on POSIX:
+
 ```php
+Path::dirname('/foo/bar/baz/asdf/quux\\abcd\\xyz');
+// Returns: '/foo/bar/baz/asdf'
+```
+
+On Windows:
+
+```php
+Path::dirname('/foo/bar/baz/asdf/quux');
+// Returns: '/foo/bar/baz/asdf'
+
+Path::dirname('/foo/bar/baz/asdf/quux\\abcd\\xyz');
+// Returns: '/foo/bar/baz/asdf/quux\abcd'
 ```
 
 ## Path::extname($path)
@@ -422,7 +431,53 @@ Path::win32::normalize('C:////temp\\\\/\\/\\/foo/bar');
 ```
 
 ## Path::parse($path)
+
+For example, on POSIX:
+
 ```php
+Path::parse('/home/user/dir/file.txt');
+// Returns:
+// [
+//   'root' => '/',
+//   'dir' => '/home/user/dir',
+//   'base' => 'file.txt',
+//   'ext' => '.txt',
+//   'name' => 'file'
+// ]
+```
+
+```
+┌─────────────────────┬────────────┐
+│          dir        │    base    │
+├──────┬              ├──────┬─────┤
+│ root │              │ name │ ext │
+"  /    home/user/dir / file  .txt "
+└──────┴──────────────┴──────┴─────┘
+(All spaces in the "" line should be ignored. They are purely for formatting.)
+```
+
+On Windows:
+
+```php
+path.parse('C:\\path\\dir\\file.txt');
+// Returns:
+// [
+//   'root' => 'C:\\',
+//   'dir' => 'C:\\path\\dir',
+//   'base' => 'file.txt',
+//   'ext' => '.txt',
+//   'name' => 'file'
+// ]
+```
+
+```
+┌─────────────────────┬────────────┐
+│          dir        │    base    │
+├──────┬              ├──────┬─────┤
+│ root │              │ name │ ext │
+" C:\      path\dir   \ file  .txt "
+└──────┴──────────────┴──────┴─────┘
+(All spaces in the "" line should be ignored. They are purely for formatting.)
 ```
 
 ## Path::pathname($path)
@@ -662,6 +717,11 @@ Path::tmp('foot\\bar\\baz');
 
 ## Path::toNamespacedPath($path)
 ```php
+Path::toNamespacedPath('\\foo\\bar/baz\\asdfquux\\abcd\\xyz');
+// Returns: '\\\\?\\G:\\foo\\bar\\baz\\asdfquux\\abcd\\xyz'
+
+Path::toNamespacedPath('//foo\\bar/baz\\asdfquux\\abcd\\xyz');
+// Returns: '\\\\?\\UNC\\foo\\bar\\baz\\asdfquux\\abcd\\xyz'
 ```
 
 ## Path::UrlToPath($url)

composer.json

@@ -4,6 +4,7 @@
   "type": "library",
   "keywords": ["path", "filesys", "fs", "filesystem"],
   "license": "MIT",
+  "homepage": "https://github.com/lazervel",
   "autoload": {
     "psr-4": {
       "Path\\": "src/"
@@ -16,7 +17,7 @@
   "authors": [
     {
       "name": "Shahzada Modassir",
-      "email": "codingmodassir@gmail.com",
+      "email": "shahzadamodassir@gmail.com",
       "homepage": "https://github.com/shahzadamodassir"
     }
   ],