Elgg\Filesystem\Directory\Fly Class Reference

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)
	@inheritDoc More...
	isFile ($path)
	@inheritDoc More...
	getContents ($path)
	@inheritDoc More...
	getFile ($path)
	@inheritDoc More...
	getFiles ($path='', $recursive=true)
	@inheritDoc More...
	getDirectories ($path='', $recursive=true)
	@inheritDoc More...
	getPath ($path='')
	@inheritDoc More...
	includeFile ($path)
	@inheritDoc More...
	putContents ($path, $content)
	@inheritDoc More...

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.

Since

1.10.0

@access private

Definition at line 18 of file Fly.php.

Constructor & Destructor Documentation

__construct()

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.

Member Function Documentation

chroot()

Elgg\Filesystem\Directory\Fly::chroot

(

$path

)

@inheritDoc

Implements Elgg\Filesystem\Directory.

Definition at line 43 of file Fly.php.

createInMemory()

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

static

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

Returns

Directory

Definition at line 166 of file Fly.php.

createLocal()

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.

Returns

Directory

Definition at line 156 of file Fly.php.

getContents()

Elgg\Filesystem\Directory\Fly::getContents

(

$path

)

@inheritDoc

Implements Elgg\Filesystem\Directory.

Definition at line 66 of file Fly.php.

getDirectories()

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

@inheritDoc

Implements Elgg\Filesystem\Directory.

Definition at line 85 of file Fly.php.

getEntries()

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')

Returns

Collection<File|Directory>

Exceptions

Definition at line 100 of file Fly.php.

getFile()

Elgg\Filesystem\Directory\Fly::getFile

(

$path

)

@inheritDoc

Implements Elgg\Filesystem\Directory.

Definition at line 71 of file Fly.php.

getFiles()

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

@inheritDoc

Implements Elgg\Filesystem\Directory.

Definition at line 80 of file Fly.php.

getPath()

Elgg\Filesystem\Directory\Fly::getPath

(

$path = ''

)

@inheritDoc

Implements Elgg\Filesystem\Directory.

Definition at line 120 of file Fly.php.

includeFile()

Elgg\Filesystem\Directory\Fly::includeFile

(

$path

)

@inheritDoc

Implements Elgg\Filesystem\Directory.

Definition at line 140 of file Fly.php.

isFile()

Elgg\Filesystem\Directory\Fly::isFile

(

$path

)

@inheritDoc

Implements Elgg\Filesystem\Directory.

Definition at line 60 of file Fly.php.

putContents()

Elgg\Filesystem\Directory\Fly::putContents	(		$path,
			$content
	)

@inheritDoc

Implements Elgg\Filesystem\Directory.

Definition at line 145 of file Fly.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/Filesystem/Directory/Fly.php