eden/folder

File methods

Eden Folder

• Install
• Introduction
• API
  • create
  • getFiles
  • getFolders
  • getName
  • isFolder
  • remove
  • removeFiles
  • removeFolders
  • truncate
• Contributing

====, _(*1)

, _(*2)

Install

composer install eden/folder, _(*3)

====, _(*4)

, _(*5)

Introduction

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

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

====, _(*7)

, _(*8)

API

====, _(*9)

, _(*10)

create

Creates a folder given the path, _(*11)

Usage

eden('folder', '/some/path/to/folder')->create(int $chmod);

Parameters

• int $chmod - the UNIX permissions level

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

Example

eden('folder', '/some/path/to/folder')->create();

====, _(*13)

, _(*14)

getFiles

Returns a list of files given the path and optionally the pattern, _(*15)

Usage

eden('folder', '/some/path/to/folder')->getFiles(string|null $regex, bool $recursive);

Parameters

• string|null $regex - Regular expression to match files against
• bool $recursive - To recursively look in folders

Returns array, _(*16)

Example

eden('folder', '/some/path/to/folder')->getFiles();

====, _(*17)

, _(*18)

getFolders

Returns a list of folders given the path and optionally the regular expression, _(*19)

Usage

eden('folder', '/some/path/to/folder')->getFolders(string|null $regex, bool $recursive);

Parameters

• string|null $regex - Regular expression to match folders against
• bool $recursive - To recursively look in folders

Returns array, _(*20)

Example

eden('folder', '/some/path/to/folder')->getFolders();

====, _(*21)

, _(*22)

getName

Returns the name of the directory.. just the name, _(*23)

Usage

eden('folder', '/some/path/to/folder')->getName();

Parameters

Returns string - the name, _(*24)

====, _(*25)

, _(*26)

isFolder

Checks to see if this path is a real file, _(*27)

Usage

eden('folder', '/some/path/to/folder')->isFolder(string|null $path);

Parameters

• string|null $path - the path to test against

Returns bool, _(*28)

Example

eden('folder', '/some/path/to/folder')->isFolder();

====, _(*29)

, _(*30)

remove

Removes a folder given the path, _(*31)

Usage

eden('folder', '/some/path/to/folder')->remove();

Parameters

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

====, _(*33)

, _(*34)

removeFiles

Removes files given the path and optionally a regular expression, _(*35)

Usage

eden('folder', '/some/path/to/folder')->removeFiles(string|null regular);

Parameters

• string|null regular - expression

Returns Eden\Folder\Index, _(*36)

Example

eden('folder', '/some/path/to/folder')->removeFiles();

====, _(*37)

, _(*38)

removeFolders

Removes a folder given the path and optionally the regular expression, _(*39)

Usage

eden('folder', '/some/path/to/folder')->removeFolders(string $regex);

Parameters

• string $regex - Regular expression to test against

Returns Eden\Folder\Index, _(*40)

Example

eden('folder', '/some/path/to/folder')->removeFolders();

====, _(*41)

, _(*42)

truncate

Removes files and folder given a path, _(*43)

Usage

eden('folder', '/some/path/to/folder')->truncate();

Parameters

Returns Eden\Folder\Index, _(*44)

====, _(*45)

, _(*46)

Contributing to Eden

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

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.