https://github.com/pointybeard/helpers-functions-paths

A collection of helpful functions related to paths, directories, and files names
https://github.com/pointybeard/helpers-functions-paths

Last synced: 9 days ago
JSON representation

A collection of helpful functions related to paths, directories, and files names

• Host: GitHub
• URL: https://github.com/pointybeard/helpers-functions-paths
• Owner: pointybeard
• License: other
• Created: 2019-05-20T00:43:10.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-11-10T13:13:34.000Z (about 4 years ago)
• Last Synced: 2024-10-12T06:20:08.030Z (about 1 month ago)
• Language: PHP
• Size: 7.81 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# PHP Helpers: Path Functions

A collection of helpful functions related to paths, directories, and files names

## Installation

This library is installed via [Composer](http://getcomposer.org/). To install, use `composer require pointybeard/helpers-functions-paths` or add `"pointybeard/helpers-functions-paths": "~1.0"` to your `composer.json` file.

And run composer to update your dependencies:

    $ curl -s http://getcomposer.org/installer | php

    $ php composer.phar update

### Requirements

There are no particuar requirements for this library other than PHP 7.4 or greater.

To include all the [PHP Helpers](https://github.com/pointybeard/helpers) packages on your project, use `composer require pointybeard/helpers` or add `"pointybeard/helpers": "~1.0"` to your composer file.

## Usage

This library is a collection of helpful functions related to paths, directories, and files names. They are included by the vendor autoloader automatically. The functions have a namespace of `pointybeard\Helpers\Functions\Paths`

The following functions are provided:

-   `is_path_absolute(string $path) : bool`

-   `get_relative_path(string $from, string $to, bool $strict = true): string`

Example usage:

```php

getMessage());

}

// string(119) "ERROR! returned: path ../../nonexistent is relative and does not exist! Make sure path exists (or set $strict to false)"

/** Same thing again, but this time with strict checking turned off **/

try{

    Paths\get_relative_path('/var/www/mysite', '../../nonexistent', false);

} catch (\Exception $ex) {

    var_dump('ERROR! returned: ' . $ex->getMessage());

}

// string(84) "ERROR! returned: Both $from and $to paths must be absolute when $strict is disabled!"

```

## Support

If you believe you have found a bug, please report it using the [GitHub issue tracker](https://github.com/pointybeard/helpers-functions-paths/issues),

or better yet, fork the library and submit a pull request.

## Contributing

We encourage you to contribute to this project. Please check out the [Contributing documentation](https://github.com/pointybeard/helpers-functions-paths/blob/master/CONTRIBUTING.md) for guidelines about how to get involved.

## Author

-   Alannah Kearney - https://github.com/pointybeard

-   See also the list of [contributors][ext-contributor] who participated in this project

## License

"PHP Helpers: Path Functions" is released under the [MIT License](http://www.opensource.org/licenses/MIT).

[ext-contributor]: https://github.com/pointybeard-boilerplate/symext-template-extension/contributors