Open Journal Systems  3.3.0
LibraryFile.inc.php
1 <?php
2 
17 define('LIBRARY_FILE_TYPE_CONTRACT', 0x00001);
18 define('LIBRARY_FILE_TYPE_MARKETING', 0x00002);
19 define('LIBRARY_FILE_TYPE_PERMISSION', 0x00003);
20 define('LIBRARY_FILE_TYPE_REPORT', 0x00004);
21 define('LIBRARY_FILE_TYPE_OTHER', 0x00005);
22 
23 import('lib.pkp.classes.file.FileManager');
24 
25 class LibraryFile extends DataObject {
26 
31  function getFilePath() {
32  $contextId = $this->getContextId();
33 
34  return Config::getVar('files', 'files_dir') . '/contexts/' . $contextId . '/library/' . $this->getServerFileName();
35  }
36 
37  //
38  // Get/set methods
39  //
44  function getContextId() {
45  return $this->getData('contextId');
46  }
47 
52  function setContextId($contextId) {
53  $this->setData('contextId', $contextId);
54  }
55 
60  function getSubmissionId() {
61  return $this->getData('submissionId');
62  }
63 
68  function setSubmissionId($submissionId) {
69  $this->setData('submissionId', $submissionId);
70  }
71 
76  function getServerFileName() {
77  return $this->getData('fileName');
78  }
79 
84  function setServerFileName($fileName) {
85  $this->setData('fileName', $fileName);
86  }
87 
92  function getOriginalFileName() {
93  return $this->getData('originalFileName');
94  }
95 
100  function setOriginalFileName($originalFileName) {
101  $this->setData('originalFileName', $originalFileName);
102  }
103 
109  function setName($name, $locale) {
110  $this->setData('name', $name, $locale);
111  }
112 
118  function getName($locale) {
119  return $this->getData('name', $locale);
120  }
121 
126  function getLocalizedName() {
127  return $this->getLocalizedData('name');
128  }
129 
134  function getFileType() {
135  return $this->getData('fileType');
136  }
137 
142  function setFileType($fileType) {
143  $this->setData('fileType', $fileType);
144  }
145 
150  function getType() {
151  return $this->getData('type');
152  }
153 
158  function setType($type) {
159  $this->setData('type', $type);
160  }
161 
166  function getDateUploaded() {
167  return $this->getData('dateUploaded');
168  }
169 
174  function setDateUploaded($dateUploaded) {
175  return $this->SetData('dateUploaded', $dateUploaded);
176  }
177 
182  function getDateModified() {
183  return $this->getData('dateModified');
184  }
185 
190  function setDateModified($dateModified) {
191  return $this->SetData('dateModified', $dateModified);
192  }
193 
198  function getFileSize() {
199  return $this->getData('fileSize');
200  }
201 
202 
207  function setFileSize($fileSize) {
208  return $this->SetData('fileSize', $fileSize);
209  }
210 
215  function getNiceFileSize() {
216  $fileManager = new FileManager();
217  return $fileManager->getNiceFileSize($this->getData('fileSize'));
218  }
219 
224  function getDocumentType() {
225  $fileManager = new FileManager();
226  return $fileManager->getDocumentType($this->getFileType());
227  }
228 
233  function getPublicAccess() {
234  return $this->getData('publicAccess');
235  }
236 
241  function setPublicAccess($publicAccess) {
242  $this->setData('publicAccess', $publicAccess);
243  }
244 }
245 
246 
LibraryFile\getDateModified
getDateModified()
Definition: LibraryFile.inc.php:182
DataObject\getData
& getData($key, $locale=null)
Definition: DataObject.inc.php:100
DataObject\getLocalizedData
getLocalizedData($key, $preferredLocale=null)
Definition: DataObject.inc.php:71
LibraryFile\getDocumentType
getDocumentType()
Definition: LibraryFile.inc.php:224
DataObject
Any class with an associated DAO should extend this class.
Definition: DataObject.inc.php:18
LibraryFile\getType
getType()
Definition: LibraryFile.inc.php:150
LibraryFile\setType
setType($type)
Definition: LibraryFile.inc.php:158
LibraryFile\getContextId
getContextId()
Definition: LibraryFile.inc.php:44
LibraryFile\getPublicAccess
getPublicAccess()
Definition: LibraryFile.inc.php:233
LibraryFile\setContextId
setContextId($contextId)
Definition: LibraryFile.inc.php:52
LibraryFile\getFileType
getFileType()
Definition: LibraryFile.inc.php:134
LibraryFile\setName
setName($name, $locale)
Definition: LibraryFile.inc.php:109
LibraryFile\getFilePath
getFilePath()
Definition: LibraryFile.inc.php:31
LibraryFile\getOriginalFileName
getOriginalFileName()
Definition: LibraryFile.inc.php:92
LibraryFile\setOriginalFileName
setOriginalFileName($originalFileName)
Definition: LibraryFile.inc.php:100
LibraryFile\setFileSize
setFileSize($fileSize)
Definition: LibraryFile.inc.php:207
LibraryFile\setSubmissionId
setSubmissionId($submissionId)
Definition: LibraryFile.inc.php:68
Config\getVar
static getVar($section, $key, $default=null)
Definition: Config.inc.php:35
LibraryFile\getServerFileName
getServerFileName()
Definition: LibraryFile.inc.php:76
LibraryFile\getName
getName($locale)
Definition: LibraryFile.inc.php:118
LibraryFile\setDateModified
setDateModified($dateModified)
Definition: LibraryFile.inc.php:190
LibraryFile\getNiceFileSize
getNiceFileSize()
Definition: LibraryFile.inc.php:215
LibraryFile\getFileSize
getFileSize()
Definition: LibraryFile.inc.php:198
LibraryFile\getLocalizedName
getLocalizedName()
Definition: LibraryFile.inc.php:126
LibraryFile\setPublicAccess
setPublicAccess($publicAccess)
Definition: LibraryFile.inc.php:241
LibraryFile\setDateUploaded
setDateUploaded($dateUploaded)
Definition: LibraryFile.inc.php:174
LibraryFile
Library file class.
Definition: LibraryFile.inc.php:25
FileManager
Class defining basic operations for file management.
Definition: FileManager.inc.php:35
LibraryFile\setFileType
setFileType($fileType)
Definition: LibraryFile.inc.php:142
LibraryFile\getDateUploaded
getDateUploaded()
Definition: LibraryFile.inc.php:166
LibraryFile\getSubmissionId
getSubmissionId()
Definition: LibraryFile.inc.php:60
LibraryFile\setServerFileName
setServerFileName($fileName)
Definition: LibraryFile.inc.php:84
DataObject\setData
setData($key, $value, $locale=null)
Definition: DataObject.inc.php:132