# DirInterface

Chevere\Interfaces\Filesystem\DirInterface

view source

# Description

Describes the component in charge of interacting with filesystem directories.

# Methods

# __construct()

# Parameters

PathInterface $path

THROWS

PathIsFileException
DirTailException

# path()

Provides access to the PathInterface instance.

RETURN

PathInterface

# create()

Creates the directory.

# Parameters

int $mode

THROWS

DirUnableToCreateException

RETURN

void

# exists()

Returns a boolean indicating whether the directory exists.

RETURN

bool

# assertExists()

RETURN

void

# removeContents()

Removes the contents from a path without deleting the path.

THROWS

DirUnableToRemoveException if unable to remove the directory
FileUnableToRemoveException if unable to remove a file in the directory

RETURN

array

# remove()

Removes the directory.

THROWS

DirUnableToRemoveException if unable to remove the directory

RETURN

array

# getChild()

Gets a child DirInterface for the added path.

# Parameters

string $path

THROWS

PathInvalidException

RETURN

DirInterface