README.md

Path

This library provides a utility methods for file system paths.

Usage

use Phine\Path\Path;

var_export(Path::canonical('/path/to/../canonicalize'));
// /path/canonicalize

var_export(Path::copy('/path/to/copy', '/path/to/copy/to'));
// 123 (number of files or empty directories copied)

var_export(Path::current());
// /home/user

var_export(Path::isAbsolute('/path/to/../test'));
// true

var_export(Path::isAbsolute('../test'));
// false

var_export(Path::isLocal('path/to/test'));
// true

var_export(Path::isLocal('\\windows\share'));
// false

var_export(Path::isLocal('http://example.com/'));
// false

var_export(Path::join(array('path', 'to', 'test'));
// path/to/test
// path\\to\\test

var_export(Path::remove('/path/to/recursively/remove'));
// 123 (number of paths removed)

var_export(Path::split('/path/to/test'));
// array('path', 'to', 'test')

var_export(Path::split('C:\\path\\to\\test'));
// array('C:', 'path', 'to', 'test')

Requirement

• PHP >= 5.3.3
• Phine Exception >= 1.0

Installation

Via Composer:

$ composer require "phine/path=~1.0"

Documentation

You can find the documentation in the docs/ directory.

License

This library is available under the MIT license.