eden/path

Path resolver

Eden Path

• Install
• Introduction
• API
  • absolute
  • append
  • getArray
  • prepend
  • pop
  • replace
• Contributing

====, _(*1)

, _(*2)

Install

composer install eden/path, _(*3)

====, _(*4)

, _(*5)

Introduction

Instantiate path in this manner., _(*6)

$path = eden('path', '/some/path');

====, _(*7)

, _(*8)

API

====, _(*9)

, _(*10)

absolute

Attempts to get the full absolute path as described on the server. The path given must exist., _(*11)

Usage

eden('path', '/some/path')->absolute(string|null $root);

Parameters

• string|null $root - The root path

Returns Eden\Path\Index, _(*12)

Example

eden('path', '/some/path')->absolute();

====, _(*13)

, _(*14)

append

Adds a path to the existing one, _(*15)

Usage

eden('path', '/some/path')->append(*string $path);

Parameters

• *string $path - The extra path to append

Returns Eden\Path\Index, _(*16)

Example

eden('path', '/some/path')->append('foo');

====, _(*17)

, _(*18)

getArray

Returns the path array, _(*19)

Usage

eden('path', '/some/path')->getArray();

Parameters

Returns array, _(*20)

====, _(*21)

, _(*22)

prepend

Adds a path before the existing one, _(*23)

Usage

eden('path', '/some/path')->prepend(*string $path);

Parameters

• *string $path - The path to prepend

Returns Eden\Path\Index, _(*24)

Example

eden('path', '/some/path')->prepend('foo');

====, _(*25)

, _(*26)

pop

Remove the last path, _(*27)

Usage

eden('path', '/some/path')->pop();

Parameters

Returns Eden\Path\Index, _(*28)

====, _(*29)

, _(*30)

replace

Replaces the last path with this one, _(*31)

Usage

eden('path', '/some/path')->replace(*string $path);

Parameters

• *string $path - replaces the last path with this

Returns Eden\Path\Index, _(*32)

Example

eden('path', '/some/path')->replace('foo');

====, _(*33)

, _(*34)

Contributing to Eden

Contributions to Eden are following the Github work flow. Please read up before contributing., _(*35)

Setting up your machine with the Eden repository and your fork

1. Fork the repository
2. 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
3. Make your changes. Always make sure to sign-off (-s) on all commits made (git commit -s -m "Commit message")

Making pull requests

1. Please ensure to run phpunit before making a pull request.
2. Push your code to your remote forked version.
3. Go back to your forked version on GitHub and submit a pull request.
4. An Eden developer will review your code and merge it in when it has been classified as suitable.