Platform-Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== File class ======

When an instance is created, it is created with a file storage, which can be accessed through the File class.

A file can be added to the store like:

<code php>
$file = new File();
$file->folder = 'Myfolder';
$file->attachFile('/tmp/realfile.txt');
$file->save();
echo 'File saved with ID: '.$file->file_id;
</code>

To get access to the file data afterwards:

<code php>
$file = new File();
$file->loadForRead($file_id);

// Get a psychical path
$file->getCompleteFilename();

// Get an URL
$file->getURL();
</code>

The file is actually saved in the given folder within the storage, so the folder should be a valid folder name. The folder name can be nested such as ''folder/subfolder/subsubfolder/''.

===== Reserved folder names =====

Platform is using some folder names already:

^logs|This is used by the [[Log_class|Log]] system to store logs.|
^temp|This is used by [[Field_class|FieldFile]] form fields to store temporary uploaded files.|