====
composer install eden/path
====
Instantiate path in this manner.
$path = eden('path', '/some/path');
====
====
Attempts to get the full absolute path as described on the server. The path given must exist.
eden('path', '/some/path')->absolute(string|null $root);
string|null $root
- The root path
Returns Eden\Path\Index
eden('path', '/some/path')->absolute();
====
Adds a path to the existing one
eden('path', '/some/path')->append(*string $path);
*string $path
- The extra path to append
Returns Eden\Path\Index
eden('path', '/some/path')->append('foo');
====
Returns the path array
eden('path', '/some/path')->getArray();
Returns array
====
Adds a path before the existing one
eden('path', '/some/path')->prepend(*string $path);
*string $path
- The path to prepend
Returns Eden\Path\Index
eden('path', '/some/path')->prepend('foo');
====
Remove the last path
eden('path', '/some/path')->pop();
Returns Eden\Path\Index
====
Replaces the last path with this one
eden('path', '/some/path')->replace(*string $path);
*string $path
- replaces the last path with this
Returns Eden\Path\Index
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.