This class defines the interface for all elgg data repositories. More...

Inheritance diagram for Elgg\Filesystem\Filestore:

Public Member Functions
	open (\ElggFile $file, string $mode)
	Attempt to open the file $file for storage or writing. More...

	write ($f, string $data)
	Write data to a given file handle. More...

	read ($f, int $length, int $offset=0)
	Read data from a filestore. More...

	seek ($f, int $position)
	Seek a given position within a file handle. More...

	eof ($f)
	Return a whether the end of a file has been reached. More...

	tell ($f)
	Return the current position in an open file. More...

	close ($f)
	Close a given file handle. More...

	delete (\ElggFile $file, bool $follow_symlinks=true)
	Delete the file associated with a given file handle. More...

	getFileSize (\ElggFile $file)
	Return the size in bytes for a given file. More...

	getFilenameOnFilestore (\ElggFile $file)
	Return the filename of a given file as stored on the filestore. More...

	getParameters ()
	Get the filestore's creation parameters as an associative array. More...

	setParameters (array $parameters)
	Set the parameters from the associative array produced by $this->getParameters(). More...

	grabFile (\ElggFile $file)
	Get the contents of the whole file. More...

	exists (\ElggFile $file)
	Return whether a file physically exists or not. More...

Detailed Description

This class defines the interface for all elgg data repositories.

Definition at line 8 of file Filestore.php.

Member Function Documentation

◆ close()

Elgg\Filesystem\Filestore::close ( $f )

abstract

Close a given file handle.

Parameters

mixed $f The file handle

Returns: bool

Reimplemented in Elgg\Filesystem\Filestore\DiskFilestore.

◆ delete()

Elgg\Filesystem\Filestore::delete	(	\ElggFile	$file,
		bool	$follow_symlinks = `true`
	)

abstract

Delete the file associated with a given file handle.

Parameters

\ElggFile	$file	The file
bool	$follow_symlinks	If true, will also delete the target file if the current file is a symlink

Returns: bool

Reimplemented in Elgg\Filesystem\Filestore\DiskFilestore.

◆ eof()

Elgg\Filesystem\Filestore::eof ( $f )

abstract

Return a whether the end of a file has been reached.

Parameters

mixed $f The file handle.

Returns: boolean

Reimplemented in Elgg\Filesystem\Filestore\DiskFilestore.

◆ exists()

Elgg\Filesystem\Filestore::exists ( \ElggFile $file )

abstract

Return whether a file physically exists or not.

Parameters

\ElggFile $file The file

Returns: bool

Reimplemented in Elgg\Filesystem\Filestore\DiskFilestore.

◆ getFilenameOnFilestore()

Elgg\Filesystem\Filestore::getFilenameOnFilestore ( \ElggFile $file )

abstract

Return the filename of a given file as stored on the filestore.

Parameters

\ElggFile $file The file

Returns: string

Reimplemented in Elgg\Filesystem\Filestore\TempDiskFilestore, and Elgg\Filesystem\Filestore\DiskFilestore.

◆ getFileSize()

Elgg\Filesystem\Filestore::getFileSize ( \ElggFile $file )

abstract

Return the size in bytes for a given file.

Parameters

\ElggFile $file The file

Returns: int

Reimplemented in Elgg\Filesystem\Filestore\DiskFilestore.

◆ getParameters()

Elgg\Filesystem\Filestore::getParameters ( )

abstract

Get the filestore's creation parameters as an associative array.

Used for serialisation and for storing the creation details along side a file object.

Returns: array

Reimplemented in Elgg\Filesystem\Filestore\TempDiskFilestore, and Elgg\Filesystem\Filestore\DiskFilestore.

◆ grabFile()

Elgg\Filesystem\Filestore::grabFile ( \ElggFile $file )

abstract

Get the contents of the whole file.

Parameters

mixed $file The file handle.

Returns: mixed The file contents.

Reimplemented in Elgg\Filesystem\Filestore\DiskFilestore.

◆ open()

Elgg\Filesystem\Filestore::open	(	\ElggFile	$file,
		string	$mode
	)

abstract

Attempt to open the file $file for storage or writing.

Parameters

\ElggFile	$file	A file
string	$mode	"read", "write", "append"

Returns: mixed A handle to the opened file or false on error.

Reimplemented in Elgg\Filesystem\Filestore\DiskFilestore.

◆ read()

Elgg\Filesystem\Filestore::read	(		$f,
		int	$length,
		int	$offset = `0`
	)

abstract

Read data from a filestore.

Parameters

mixed	$f	The file handle
int	$length	Length in bytes to read.
int	$offset	The optional offset.

Returns: mixed String of data or false on error.

Reimplemented in Elgg\Filesystem\Filestore\DiskFilestore.

◆ seek()

Elgg\Filesystem\Filestore::seek	(		$f,
		int	$position
	)

abstract

Seek a given position within a file handle.

Parameters

mixed	$f	The file handle.
int	$position	The position.

Returns: int 0 for success, or -1

Reimplemented in Elgg\Filesystem\Filestore\DiskFilestore.

◆ setParameters()

Elgg\Filesystem\Filestore::setParameters ( array $parameters )

abstract

Set the parameters from the associative array produced by $this->getParameters().

Parameters

array $parameters A list of parameters

Returns: bool

Reimplemented in Elgg\Filesystem\Filestore\TempDiskFilestore, and Elgg\Filesystem\Filestore\DiskFilestore.

◆ tell()

Elgg\Filesystem\Filestore::tell ( $f )

abstract

Return the current position in an open file.

Parameters

mixed $f The file handle.

Returns: int|false

Reimplemented in Elgg\Filesystem\Filestore\DiskFilestore.

◆ write()

Elgg\Filesystem\Filestore::write	(		$f,
		string	$data
	)

abstract

Write data to a given file handle.

Parameters

mixed	$f	The file handle - exactly what this is depends on the file system
string	$data	The binary string of data to write

Returns: int Number of bytes written

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

engine/classes/Elgg/Filesystem/Filestore.php

Public Member Functions

Detailed Description

Member Function Documentation

◆ close()

◆ delete()

◆ eof()

◆ exists()

◆ getFilenameOnFilestore()

◆ getFileSize()

◆ getParameters()

◆ grabFile()

◆ open()

◆ read()

◆ seek()

◆ setParameters()

◆ tell()

◆ write()