README

File Managment in PHP

• Files
  • Installation
  • Usage
    • Creating Files Objects
    • Available File Types
    • File Properties
      • RegularFile Properties
      • Link Properties
    • File Methods
      • RegularFile Methods
    • Directory Methods
    • Link Methods

Installation

Install files via Composer:

composer require ali-eltaweel/files

Usage

Creating Files Objects

Instances of the File abstract class can be created using the File::make() which looks for the file type and returns the appropriate class instance, or by directly instantiating a concrete File class.

use Files\{ Directory, File, RegularFile };

$file = File::make('path/to/file');
$file = new RegularFile('path/to/file');

$dir = File::make('path/to/dir');
$dir = new Directory('path/to/dir');

Available File Types

• Fifo
• CharacterDevice
• Directory
• RegularFile
• Symlink

File Properties

RegularFile Properties

Link Properties

File Methods

• copy

copy(Path|string $target): bool

• link

link(Path|string $target): bool

• symlink

symlink(Path|string $target): bool

• rename

rename(Path|string $target): bool

• touch

touch(?int $mtime = null, ?int $atime = null): bool

• remove

remove(): bool

• open

open(): Handles\Handle

RegularFile Methods

• transaction

transaction(callable $work, string $mode = 'r', Lock $lock = Lock::Exclusive): mixed

• setContent

setContent(string $content): int

• getContent

getContent(): ?string

Directory Methods

• mkdir

mkdir(Path|string $name, int $permissions = 0777, bool $recursive = false): ?Directory

• remove

remove(bool $force = false): bool

• foreachChild

foreachChild(callable $callback): void

Link Methods

• chgrpTarget

chgrpTarget(string|int $group): bool

• chownTarget

chownTarget(string|int $user): bool

• readlink

readlink(): ?File

• readlinkRecursively

readlinkRecursively(): ?File