ElggDiskFilestore Class Reference

Inheritance diagram for ElggDiskFilestore:

Public Member Functions
	__construct ($directory_root="")
	Construct a disk filestore using the given directory root.
	open (ElggFile $file, $mode)
	Open a file for reading, writing, or both.
	write ($f, $data)
	Write data to a file.
	read ($f, $length, $offset=0)
	Read data from a file.
	close ($f)
	Close a file pointer.
	delete (ElggFile $file)
	Delete an ElggFile file.
	seek ($f, $position)
	Seek to the specified position.
	tell ($f)
	Return the current location of the internal pointer.
	eof ($f)
	Tests for end of file on a file pointer.
	getFileSize (ElggFile $file)
	Returns the file size of an ElggFile file.
	getFilenameOnFilestore (ElggFile $file)
	Returns the filename as saved on disk for an ElggFile object.
	grabFile (ElggFile $file)
	Returns the contents of the ElggFile file.
	exists (ElggFile $file)
	Tests if an ElggFile file exists.
	getSize ($prefix= '', $container_guid)
	Returns the size of all data stored under a directory in the disk store.
	getParameters ()
	Returns a list of attributes to save to the database when saving the ElggFile object using this file store.
	setParameters (array $parameters)
	Sets parameters that should be saved to database.
Protected Member Functions
	make_directory_root ($dirroot)
	Create a directory $dirroot.
	makeDirectoryRoot ($dirroot)
	Create a directory $dirroot.
	make_file_matrix ($identifier)
	Construct a file path matrix for an entity.
	makeFileMatrix ($guid)
	Construct a file path matrix for an entity.
	user_file_matrix ($guid)
	Construct a filename matrix.

Detailed Description

Definition at line 12 of file ElggDiskFilestore.php.

Constructor & Destructor Documentation

ElggDiskFilestore::__construct ( $ directory_root = "" )

Construct a disk filestore using the given directory root.

Parameters:

string

$directory_root Root directory, must end in "/"

Definition at line 28 of file ElggDiskFilestore.php.

Member Function Documentation

ElggDiskFilestore::close ( $ f )

Close a file pointer.

Parameters:

resource

$f A file pointer resource

Returns:: bool

Reimplemented from ElggFilestore.

Definition at line 130 of file ElggDiskFilestore.php.

ElggDiskFilestore::delete ( ElggFile $ file )

Delete an ElggFile file.

Parameters:

ElggFile

$file File to delete

Returns:: bool

Reimplemented from ElggFilestore.

Definition at line 141 of file ElggDiskFilestore.php.

ElggDiskFilestore::eof ( $ f )

Tests for end of file on a file pointer.

Parameters:

resource

$f File pointer resource

Returns:: bool

Reimplemented from ElggFilestore.

Definition at line 180 of file ElggDiskFilestore.php.

ElggDiskFilestore::exists ( ElggFile $ file )

Tests if an ElggFile file exists.

Parameters:

ElggFile

$file File object

Returns:: bool

Reimplemented from ElggFilestore.

Definition at line 235 of file ElggDiskFilestore.php.

ElggDiskFilestore::getFilenameOnFilestore ( ElggFile $ file )

Returns the filename as saved on disk for an ElggFile object.

Parameters:

ElggFile

$file File object

Returns:: string The full path of where the file is stored

Reimplemented from ElggFilestore.

Definition at line 202 of file ElggDiskFilestore.php.

ElggDiskFilestore::getFileSize ( ElggFile $ file )

Returns the file size of an ElggFile file.

Parameters:

ElggFile

$file File object

Returns:: int The file size

Reimplemented from ElggFilestore.

Definition at line 191 of file ElggDiskFilestore.php.

ElggDiskFilestore::getParameters ( )

Returns a list of attributes to save to the database when saving the ElggFile object using this file store.

Returns:: array

Reimplemented from ElggFilestore.

Definition at line 380 of file ElggDiskFilestore.php.

ElggDiskFilestore::getSize	(	$	prefix = `''`,
		$	container_guid
	)

Returns the size of all data stored under a directory in the disk store.

Parameters:

	string	$prefix Optional/ The prefix to check under.
	string	$container_guid The guid of the entity whose data you want to check.

Returns:: int|false

Definition at line 247 of file ElggDiskFilestore.php.

ElggDiskFilestore::grabFile ( ElggFile $ file )

Returns the contents of the ElggFile file.

Parameters:

ElggFile

$file File object

Returns:: mixed

Reimplemented from ElggFilestore.

Definition at line 224 of file ElggDiskFilestore.php.

ElggDiskFilestore::make_directory_root ( $ dirroot ) [protected]

Create a directory $dirroot.

Parameters:

string

$dirroot The full path of the directory to create

Exceptions:

IOException

Returns:: true

Definition at line 264 of file ElggDiskFilestore.php.

ElggDiskFilestore::make_file_matrix ( $ identifier ) [protected]

Construct a file path matrix for an entity.

Parameters:

int

$identifier The guide of the entity to store the data under.

Returns:: str The path where the entity's data will be stored.

Definition at line 330 of file ElggDiskFilestore.php.

ElggDiskFilestore::makeDirectoryRoot ( $ dirroot ) [protected]

Create a directory $dirroot.

Parameters:

string

$dirroot The full path of the directory to create

Exceptions:

IOException

Returns:: true

Definition at line 278 of file ElggDiskFilestore.php.

ElggDiskFilestore::makeFileMatrix ( $ guid ) [protected]

Construct a file path matrix for an entity.

Parameters:

int

$guid The guide of the entity to store the data under.

Returns:: str The path where the entity's data will be stored.

Definition at line 343 of file ElggDiskFilestore.php.

ElggDiskFilestore::open	(	ElggFile $	file,
		$	mode
	)

Open a file for reading, writing, or both.

Note:: All files are opened binary safe.

Warning:: This will try to create the a directory if it doesn't exist, even in read-only mode.

Parameters:

	ElggFile	$file The file to open
	string	$mode read, write, or append.

Exceptions:

InvalidParameterException

Returns:: resource File pointer resource

Reimplemented from ElggFilestore.

Definition at line 52 of file ElggDiskFilestore.php.

ElggDiskFilestore::read	(	$	f,
		$	length,
		$	offset = `0`
	)

Read data from a file.

Parameters:

	resource	$f File pointer resource
	int	$length The number of bytes to read
	inf	$offset The number of bytes to start after

Returns:: mixed Contents of file or false on fail.

Reimplemented from ElggFilestore.

Definition at line 115 of file ElggDiskFilestore.php.

ElggDiskFilestore::seek	(	$	f,
		$	position
	)

Seek to the specified position.

Parameters:

	resource	$f File resource
	int	$position Position in bytes

Returns:: bool

Reimplemented from ElggFilestore.

Definition at line 158 of file ElggDiskFilestore.php.

ElggDiskFilestore::setParameters ( array $ parameters )

Sets parameters that should be saved to database.

Parameters:

array

$parameters Set parameters to save to DB for this filestore.

Returns:: bool

Reimplemented from ElggFilestore.

Definition at line 391 of file ElggDiskFilestore.php.

ElggDiskFilestore::tell ( $ f )

Return the current location of the internal pointer.

Parameters:

resource

$f File pointer resource

Returns:: int|false

Reimplemented from ElggFilestore.

Definition at line 169 of file ElggDiskFilestore.php.

ElggDiskFilestore::user_file_matrix ( $ guid ) [protected]

Construct a filename matrix.

Generates a matrix using the entity's creation time and unique guid.

File path matrixes are: YYYY/MM/DD/guid/

Parameters:

int

$guid The entity to contrust a matrix for

Returns:: str The

Definition at line 368 of file ElggDiskFilestore.php.

ElggDiskFilestore::write	(	$	f,
		$	data
	)

Write data to a file.

Parameters:

	resource	$f File pointer resource
	mixed	$data The data to write.

Returns:: bool

Reimplemented from ElggFilestore.

Definition at line 102 of file ElggDiskFilestore.php.

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

engine/classes/ElggDiskFilestore.php

ElggDiskFilestore Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation