LibraryFileManager Class Reference

Wrapper class for uploading files to a site/press' library directory. More...

List of all members.

Public Member Functions
&	copyFromTemporaryFile (&$temporaryFile, $libraryFileType)
	deleteFile ($fileId)
	generateFileName ($type, $originalFileName)
	getBasePath ()
	getFileSuffixFromType ($type)
	getNameFromType ($type)
	getTitleKeyFromType ($type)
&	getTypeNameMap ()
&	getTypeSuffixMap ()
&	getTypeTitleKeyMap ()
	LibraryFileManager ($pressId)

---

Detailed Description

Wrapper class for uploading files to a site/press' library directory.

Definition at line 19 of file LibraryFileManager.inc.php.

---

Member Function Documentation

& LibraryFileManager.copyFromTemporaryFile	(	&$	temporaryFile,
		$	libraryFileType
	)

Routine to copy a library file from a temporary file.

Parameters:

$temporaryFile

object

Returns:

LibraryFile the generated file, prepared as much as possible for insert (false if upload failed)

Definition at line 91 of file LibraryFileManager.inc.php.

References getBasePath().

LibraryFileManager.deleteFile

(

$

fileId

)

Delete a file by ID.

Parameters:

$fileId

int

Returns:

int number of files removed

Definition at line 45 of file LibraryFileManager.inc.php.

References getBasePath().

LibraryFileManager.generateFileName	(	$	type,
		$	originalFileName
	)

Generate a filename for a library file.

Parameters:

	$type	int LIBRARY_FILE_TYPE_...
	$originalFileName	string

Returns:

string

Definition at line 60 of file LibraryFileManager.inc.php.

References getFileSuffixFromType().

LibraryFileManager.getBasePath

(

)

Get the base path for file storage.

Returns:

string

Definition at line 36 of file LibraryFileManager.inc.php.

Referenced by copyFromTemporaryFile(), and deleteFile().

LibraryFileManager.getFileSuffixFromType

(

$

type

)

Get the file suffix for the given file type

Parameters:

$type

int LIBRARY_FILE_TYPE_...

Definition at line 112 of file LibraryFileManager.inc.php.

References getTypeSuffixMap().

Referenced by generateFileName().

LibraryFileManager.getNameFromType

(

$

type

)

Get the symbolic name from the type

Parameters:

$type

int LIBRARY_FILE_TYPE_...

Definition at line 136 of file LibraryFileManager.inc.php.

References getTypeNameMap().

LibraryFileManager.getTitleKeyFromType

(

$

type

)

Get the display name locale key from the type title

Parameters:

$type

int LIBRARY_FILE_TYPE_...

Definition at line 164 of file LibraryFileManager.inc.php.

References getTypeTitleKeyMap().

& LibraryFileManager.getTypeNameMap

(

)

Get the type => name mapping array

Returns:

array

Definition at line 173 of file LibraryFileManager.inc.php.

Referenced by getNameFromType().

& LibraryFileManager.getTypeSuffixMap

(

)

Get the type => suffix mapping array

Returns:

array

Definition at line 121 of file LibraryFileManager.inc.php.

Referenced by getFileSuffixFromType().

& LibraryFileManager.getTypeTitleKeyMap

(

)

Get the type => locale key mapping array

Returns:

array

Definition at line 149 of file LibraryFileManager.inc.php.

Referenced by getTitleKeyFromType().

LibraryFileManager.LibraryFileManager

(

$

pressId

)

Constructor

Parameters:

$pressId

int

Definition at line 27 of file LibraryFileManager.inc.php.

---

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

• classes/file/LibraryFileManager.inc.php