Public Member Functions | |
| __construct ($contextId) | |
| & | copyFromTemporaryFile (&$temporaryFile, $libraryFileType) |
| deleteById ($fileId) | |
| generateFileName ($type, $originalFileName) | |
| getBasePath () | |
| getFileSuffixFromType ($type) | |
| getNameFromType ($type) | |
| getTitleKeyFromType ($type) | |
| & | getTypeNameMap () |
| & | getTypeSuffixMap () |
| & | getTypeTitleKeyMap () |
 Public Member Functions inherited from PrivateFileManager | |
| __construct () | |
| Public Member Functions inherited from FileManager | |
| compressFile ($filePath) | |
| copyDir ($source, $dest) | |
| copyFile ($source, $dest) | |
| decompressFile ($filePath) | |
| deleteByPath ($filePath) | |
| downloadByPath ($filePath, $mediaType=null, $inline=false, $fileName=null) | |
| fileExists ($filePath, $type='file') | |
| getDocumentExtension ($type) | |
| getDocumentType ($type) | |
| getExtension ($fileName) | |
| getFirstUploadedPostName () | |
| getImageExtension ($type) | |
| getNiceFileSize ($size) | |
| getUploadedFileName ($fileName) | |
| getUploadedFilePath ($fileName) | |
| getUploadedFileType ($fileName) | |
| getUploadErrorCode ($fileName) | |
| mkdir ($dirPath, $perms=null) | |
| mkdirtree ($dirPath, $perms=null) | |
| parseFileExtension ($fileName) | |
| readFileFromPath ($filePath, $output=false) | |
| rmdir ($dirPath) | |
| rmtree ($file) | |
| setMode ($path, $mask) | |
| truncateFileName ($fileName, $length=127) | |
| uploadedFileExists ($fileName) | |
| uploadError ($fileName) | |
| uploadFile ($fileName, $destFileName) | |
| writeFile ($dest, &$contents) | |
Data Fields | |
| $contextId | |
| Data Fields inherited from PrivateFileManager | |
| $filesDir | |
Detailed Description
Wrapper class for uploading files to a site/context' library directory.
Definition at line 20 of file PKPLibraryFileManager.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| PKPLibraryFileManager::__construct | ( | $contextId | ) |
Constructor
- Parameters
-
$contextId int
Reimplemented in LibraryFileManager.
Definition at line 31 of file PKPLibraryFileManager.inc.php.
References $contextId.
Member Function Documentation
◆ copyFromTemporaryFile()
| & PKPLibraryFileManager::copyFromTemporaryFile | ( | & | $temporaryFile, |
| $libraryFileType | |||
| ) |
Routine to copy a library file from a temporary file.
- Parameters
-
$temporaryFile object $libraryFileType int LIBRARY_FILE_TYPE_...
- Returns
- LibraryFile the generated file, prepared as much as possible for insert (false if upload failed)
Definition at line 96 of file PKPLibraryFileManager.inc.php.
References FileManager\copyFile(), generateFileName(), and DAORegistry\getDAO().
◆ deleteById()
| PKPLibraryFileManager::deleteById | ( | $fileId | ) |
Delete a file by ID.
- Parameters
-
$fileId int
- Returns
- int number of files removed
Definition at line 49 of file PKPLibraryFileManager.inc.php.
References getBasePath(), and DAORegistry\getDAO().
◆ generateFileName()
| PKPLibraryFileManager::generateFileName | ( | $type, | |
| $originalFileName | |||
| ) |
Generate a filename for a library file.
- Parameters
-
$type int LIBRARY_FILE_TYPE_... $originalFileName string
- Returns
- string
Definition at line 64 of file PKPLibraryFileManager.inc.php.
References DAORegistry\getDAO(), FileManager\getExtension(), getFileSuffixFromType(), PKPString\strlen(), PKPString\strpos(), PKPString\substr(), and FileManager\truncateFileName().
Referenced by copyFromTemporaryFile().
◆ getBasePath()
| PKPLibraryFileManager::getBasePath | ( | ) |
Get the base path for file storage.
- Returns
- string
Reimplemented from PrivateFileManager.
Definition at line 40 of file PKPLibraryFileManager.inc.php.
Referenced by deleteById().
◆ getFileSuffixFromType()
| PKPLibraryFileManager::getFileSuffixFromType | ( | $type | ) |
Get the file suffix for the given file type
- Parameters
-
$type int LIBRARY_FILE_TYPE_...
Definition at line 117 of file PKPLibraryFileManager.inc.php.
References getTypeSuffixMap().
Referenced by generateFileName().
◆ getNameFromType()
| PKPLibraryFileManager::getNameFromType | ( | $type | ) |
Get the symbolic name from the type
- Parameters
-
$type int LIBRARY_FILE_TYPE_...
Definition at line 140 of file PKPLibraryFileManager.inc.php.
References getTypeNameMap().
◆ getTitleKeyFromType()
| PKPLibraryFileManager::getTitleKeyFromType | ( | $type | ) |
Get the display name locale key from the type title
- Parameters
-
$type int LIBRARY_FILE_TYPE_...
Definition at line 167 of file PKPLibraryFileManager.inc.php.
References getTypeTitleKeyMap().
◆ getTypeNameMap()
| & PKPLibraryFileManager::getTypeNameMap | ( | ) |
Get the type => name mapping array
- Returns
- array
Definition at line 176 of file PKPLibraryFileManager.inc.php.
Referenced by getNameFromType().
◆ getTypeSuffixMap()
| & PKPLibraryFileManager::getTypeSuffixMap | ( | ) |
Get the type => suffix mapping array
- Returns
- array
Definition at line 126 of file PKPLibraryFileManager.inc.php.
Referenced by getFileSuffixFromType().
◆ getTypeTitleKeyMap()
| & PKPLibraryFileManager::getTypeTitleKeyMap | ( | ) |
Get the type => locale key mapping array
- Returns
- array
Definition at line 153 of file PKPLibraryFileManager.inc.php.
Referenced by getTitleKeyFromType().
Field Documentation
◆ $contextId
| PKPLibraryFileManager::$contextId |
Definition at line 25 of file PKPLibraryFileManager.inc.php.
Referenced by LibraryFileManager\__construct(), and __construct().
The documentation for this class was generated from the following file:
