eden / path
Path resolver
Installs: 383 091
Dependents: 11
Suggesters: 0
Security: 0
Stars: 1
Watchers: 4
Forks: 0
Open Issues: 0
Requires
- php: >=5.4.1
- eden/array: 4.*
- eden/core: 4.*
- eden/string: 4.*
This package is auto-updated.
Last update: 2024-11-13 21:06:55 UTC
README
====
Install
composer install eden/path
====
Introduction
Instantiate path in this manner.
$path = eden('path', '/some/path');
====
API
====
absolute
Attempts to get the full absolute path as described on the server. The path given must exist.
Usage
eden('path', '/some/path')->absolute(string|null $root);
Parameters
string|null $root
- The root path
Returns Eden\Path\Index
Example
eden('path', '/some/path')->absolute();
====
append
Adds a path to the existing one
Usage
eden('path', '/some/path')->append(*string $path);
Parameters
*string $path
- The extra path to append
Returns Eden\Path\Index
Example
eden('path', '/some/path')->append('foo');
====
getArray
Returns the path array
Usage
eden('path', '/some/path')->getArray();
Parameters
Returns array
====
prepend
Adds a path before the existing one
Usage
eden('path', '/some/path')->prepend(*string $path);
Parameters
*string $path
- The path to prepend
Returns Eden\Path\Index
Example
eden('path', '/some/path')->prepend('foo');
====
pop
Remove the last path
Usage
eden('path', '/some/path')->pop();
Parameters
Returns Eden\Path\Index
====
replace
Replaces the last path with this one
Usage
eden('path', '/some/path')->replace(*string $path);
Parameters
*string $path
- replaces the last path with this
Returns Eden\Path\Index
Example
eden('path', '/some/path')->replace('foo');
====
Contributions to Eden are following the Github work flow. Please read up before contributing.
##Setting up your machine with the Eden repository and your fork
- Fork the repository
- Fire up your local terminal create a new branch from the
v4
branch of your fork with a branch name describing what your changes are. Possible branch name types:- bugfix
- feature
- improvement
- Make your changes. Always make sure to sign-off (-s) on all commits made (git commit -s -m "Commit message")
##Making pull requests
- Please ensure to run
phpunit
before making a pull request. - Push your code to your remote forked version.
- Go back to your forked version on GitHub and submit a pull request.
- An Eden developer will review your code and merge it in when it has been classified as suitable.