ContextFileManager Class Reference
Inheritance diagram for ContextFileManager:
Public Member Functions | |
| __construct ($contextId) | |
| getBasePath () | |
 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
Class defining operations for private context file management.
Definition at line 19 of file ContextFileManager.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| ContextFileManager::__construct | ( | $contextId | ) |
Constructor. Create a manager for handling context file uploads.
- Parameters
-
$context Context
Definition at line 31 of file ContextFileManager.inc.php.
References $contextId.
Member Function Documentation
◆ getBasePath()
| ContextFileManager::getBasePath | ( | ) |
Get the base path for file storage
- Returns
- string
Reimplemented from PrivateFileManager.
Reimplemented in BaseSubmissionFileManager.
Definition at line 40 of file ContextFileManager.inc.php.
References Application\getFileDirectories().
Field Documentation
◆ $contextId
| int ContextFileManager::$contextId |
the ID of the associated context
Definition at line 24 of file ContextFileManager.inc.php.
Referenced by __construct(), SubmissionFileManager\__construct(), and BaseSubmissionFileManager\__construct().
The documentation for this class was generated from the following file:
