A wrapper around Flysystem that implements Elgg's filesystem API. More...

Inheritance diagram for Elgg\Filesystem\Directory\Fly:

Public Member Functions
	__construct (Filesystem $filesystem, $local_path= '', $chroot= '')
	Use one of the static factory functions to create an instance. More...

	chroot ($path)

	isFile ($path)

	getContents ($path)

	getFile ($path)

	getFiles ($path= '', $recursive=true)

	getDirectories ($path= '', $recursive=true)

	getPath ($path= '')

	includeFile ($path)

	putContents ($path, $content)

Static Public Member Functions
static	createLocal ($path)
	Shorthand for generating a new local filesystem. More...

static	createInMemory ()
	Shorthand for generating a new in-memory-only filesystem. More...

Protected Member Functions
	getEntries ($path= '', $recursive=true, $types=['file', 'dir'])
	List the files and directories in the given directory path. More...

Detailed Description

A wrapper around Flysystem that implements Elgg's filesystem API.

private

Definition at line 18 of file Fly.php.

Constructor & Destructor Documentation

Elgg\Filesystem\Directory\Fly::__construct	(	Filesystem	$filesystem,
			$local_path = `''`,
			$chroot = `''`
	)

Use one of the static factory functions to create an instance.

Parameters

Filesystem	$filesystem	The underlying filesystem implementation. It must have the 'ListFiles' plugin.
string	$local_path	Only applicable for local filesystem.
string	$chroot	Path relative to the underlying filesystem root.

Definition at line 36 of file Fly.php.

Elgg\Filesystem\Directory\Fly::chroot ( $path )

Definition at line 43 of file Fly.php.

static Elgg\Filesystem\Directory\Fly::createInMemory ( )

static

Shorthand for generating a new in-memory-only filesystem.

Definition at line 166 of file Fly.php.

static Elgg\Filesystem\Directory\Fly::createLocal ( $path )

static

Shorthand for generating a new local filesystem.

Parameters

string $path absolute path to directory on local filesystem.

Definition at line 156 of file Fly.php.

Elgg\Filesystem\Directory\Fly::getContents ( $path )

Definition at line 66 of file Fly.php.

Elgg\Filesystem\Directory\Fly::getDirectories	(	$path = `''`,
		$recursive = `true`
	)

Definition at line 85 of file Fly.php.

Elgg\Filesystem\Directory\Fly::getEntries	(		$path = `''`,
			$recursive = `true`,
			$types = `['file'`,
		'dir']
	)

protected

List the files and directories in the given directory path.

Parameters

string	$path	The subdirectory path within this directory
bool	$recursive	Find files and directories recursively
	string[]	$types Entry types to return ('file' and/or 'dir')