Changeset View
Changeset View
Standalone View
Standalone View
src/applications/files/engine/PhabricatorFileStorageEngine.php
Show First 20 Lines • Show All 147 Lines • ▼ Show 20 Lines | /* -( Managing File Data )------------------------------------------------- */ | ||||
* Write file data to the backing storage and return a handle which can later | * Write file data to the backing storage and return a handle which can later | ||||
* be used to read or delete it. For example, if the backing storage is local | * be used to read or delete it. For example, if the backing storage is local | ||||
* disk, the handle could be the path to the file. | * disk, the handle could be the path to the file. | ||||
* | * | ||||
* The caller will provide a $params array, which may be empty or may have | * The caller will provide a $params array, which may be empty or may have | ||||
* some metadata keys (like "name" and "author") in it. You should be prepared | * some metadata keys (like "name" and "author") in it. You should be prepared | ||||
* to handle writes which specify no metadata, but might want to optionally | * to handle writes which specify no metadata, but might want to optionally | ||||
* use some keys in this array for debugging or logging purposes. This is | * use some keys in this array for debugging or logging purposes. This is | ||||
* the same dictionary passed to @{method:PhabricatorFile::newFromFileData}, | * the same dictionary passed to @{method:PhabricatorFile::newFromFileData}, TODO | ||||
Lint: Line Too Long: This line is 83 characters long, but the convention is 80 characters. | |||||
Lint: TODO Comment This comment has a TODO. Lint: TODO Comment: This comment has a TODO. | |||||
* so you could conceivably do custom things with it. | * so you could conceivably do custom things with it. | ||||
* | * | ||||
* If you are unable to write for whatever reason (e.g., the disk is full), | * If you are unable to write for whatever reason (e.g., the disk is full), | ||||
* throw an exception. If there are other satisfactory but less-preferred | * throw an exception. If there are other satisfactory but less-preferred | ||||
* storage engines available, they will be tried. | * storage engines available, they will be tried. | ||||
* | * | ||||
* @param string The file data to write. | * @param string The file data to write. | ||||
* @param array File metadata (name, author), if available. | * @param array File metadata (name, author), if available. | ||||
▲ Show 20 Lines • Show All 218 Lines • Show Last 20 Lines |
This line is 83 characters long, but the convention is 80 characters.