1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. File
  7. \
  8. ProtectedDirectory

ProtectedDirectory

class ProtectedDirectory (View source)

A value object representing a protected directory.

Properties

protected string $title

The directory title.
protected string $path

The directory path.
protected bool $private

If the directory is private (or public).

Methods

__construct(string $title, string $path, bool $private = FALSE)

ProtectedDirectory constructor.

string
getTitle()

Gets the title.

string
getPath()

Gets the directory path.

bool
isPrivate()

Is the directory private (or public).

Details

at line 41
__construct(string $title, string $path, bool $private = FALSE)

ProtectedDirectory constructor.

Parameters

string $title

The directory title.
string $path

The path to the directory.
bool $private

(optional) Whether the directory is private or public (default).

at line 53
string getTitle()

Gets the title.

Return Value

string

The Title.

at line 63
string getPath()

Gets the directory path.

Return Value

string

The directory path.

at line 73
bool isPrivate()

Is the directory private (or public).

Return Value

bool

TRUE if the directory is private, FALSE if it is public.