revi-archive/phorge-arcanist
1
0
Fork 0
mirror of https://we.phorge.it/source/arcanist.git synced 2024-11-22 06:42:41 +01:00
Code Issues Releases Wiki Activity

Provide more documentation for Arcanist upload stuff

Browse source 
Summary: Ref T8259. Make some highly-ambiguous methods like `setData()` more clear.

Test Plan: reading

Reviewers: btrahan

Reviewed By: btrahan

Subscribers: epriestley

Maniphest Tasks: T8259

Differential Revision: https://secure.phabricator.com/D13038
This commit is contained in:
epriestley 2015-05-27 10:26:27 -07:00
parent 5c7b22e620
commit a36dc81715
2 changed files with 49 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
src/upload/ArcanistFileDataRef.php
View file

@ -33,6 +33,13 @@ final class ArcanistFileDataRef extends Phobject {
/**
* Set a human-readable display filename, like "file.jpg".
*
* This name does not correspond to a path on disk, and is purely for
* human consumption.
*
* @param string Filename.
* @return this
* @task config
*/
public function setName($name) {
@ -50,6 +57,13 @@ final class ArcanistFileDataRef extends Phobject {
/**
* Set the data to upload as a single raw blob.
*
* You can specify file data by calling this method with a single blob of
* data, or by calling @{method:setPath} and providing a path to a file on
* disk.
*
* @param bytes Blob of file data.
* @task config
*/
public function setData($data) {
@ -67,6 +81,16 @@ final class ArcanistFileDataRef extends Phobject {
/**
* Set the data to upload by pointing to a file on disk.
*
* You can specify file data by calling this method with a path, or by
* providing a blob of raw data to @{method:setData}.
*
* The path itself only provides data. If you want to name the file, you
* should also call @{method:setName}.
*
* @param string Path on disk to a file containing data to upload.
* @return this
* @task config
*/
public function setPath($path) {

26
src/upload/ArcanistFileUploader.php
View file

@ -33,6 +33,10 @@ final class ArcanistFileUploader extends Phobject {
/**
* Provide a Conduit client to choose which server to upload files to.
*
* @param ConduitClient Configured client.
* @return this
* @task config
*/
public function setConduitClient(ConduitClient $conduit) {
@ -45,6 +49,10 @@ final class ArcanistFileUploader extends Phobject {
/**
* Add a file to the list of files to be uploaded.
*
* You can optionally provide an explicit key which will be used to identify
* the file. After adding files, upload them with @{method:uploadFiles}.
*
* @param ArcanistFileDataRef File data to upload.
* @param null|string Optional key to use to identify this file.
@ -74,10 +82,19 @@ final class ArcanistFileUploader extends Phobject {
/**
* Upload files to the server.
*
* This transfers all files which have been queued with @{method:addFiles}
* over the Conduit link configured with @{method:setConduitClient}.
*
* This method returns a map of all file data references. If references were
* added with an explicit key when @{method:addFile} was called, the key is
* retained in the result map.
*
* On return, files are either populated with a PHID (indicating a successful
* upload) or a list of errors. See @{class:ArcanistFileDataRef} for
* details.
*
* @return map<string, ArcanistFileDataRef> Files with results populated.
* @task upload
*/
@ -192,6 +209,9 @@ final class ArcanistFileUploader extends Phobject {
/**
* Upload missing chunks of a large file by calling `file.uploadchunk` over
* Conduit.
*
* @task internal
*/
private function uploadChunks(ArcanistFileDataRef $file, $file_phid) {
@ -253,6 +273,8 @@ final class ArcanistFileUploader extends Phobject {
/**
* Upload an entire file by calling `file.upload` over Conduit.
*
* @task internal
*/
private function uploadData(ArcanistFileDataRef $file) {
@ -270,10 +292,12 @@ final class ArcanistFileUploader extends Phobject {
/**
* Write a status message.
*
* @task internal
*/
private function writeStatus($message) {
echo $message."\n";
fwrite(STDERR, $message."\n");
}
}