2011-07-29 19:00:16 +02:00
|
|
|
<?php
|
|
|
|
|
Rename Conduit classes
Summary: Ref T5655. Rename Conduit classes and provide a `getAPIMethodName` method to declare the API method.
Test Plan:
```
> echo '{}' | arc --conduit-uri='http://phabricator.joshuaspence.com' call-conduit user.whoami
Waiting for JSON parameters on stdin...
{"error":null,"errorMessage":null,"response":{"phid":"PHID-USER-lioqffnwn6y475mu5ndb","userName":"josh","realName":"Joshua Spence","image":"http:\/\/phabricator.joshuaspence.com\/res\/1404425321T\/phabricator\/3eb28cd9\/rsrc\/image\/avatar.png","uri":"http:\/\/phabricator.joshuaspence.com\/p\/josh\/","roles":["admin","verified","approved","activated"]}}
```
Reviewers: epriestley, #blessed_reviewers
Reviewed By: epriestley, #blessed_reviewers
Subscribers: epriestley, Korvin, hach-que
Maniphest Tasks: T5655
Differential Revision: https://secure.phabricator.com/D9991
2014-07-25 02:54:15 +02:00
|
|
|
final class FileInfoConduitAPIMethod extends FileConduitAPIMethod {
|
|
|
|
|
|
|
|
public function getAPIMethodName() {
|
|
|
|
return 'file.info';
|
|
|
|
}
|
2011-07-29 19:00:16 +02:00
|
|
|
|
|
|
|
public function getMethodDescription() {
|
2015-05-22 09:27:56 +02:00
|
|
|
return pht('Get information about a file.');
|
2011-07-29 19:00:16 +02:00
|
|
|
}
|
|
|
|
|
2015-04-13 00:59:07 +02:00
|
|
|
protected function defineParamTypes() {
|
2011-07-29 19:00:16 +02:00
|
|
|
return array(
|
|
|
|
'phid' => 'optional phid',
|
|
|
|
'id' => 'optional id',
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2015-04-13 00:59:07 +02:00
|
|
|
protected function defineReturnType() {
|
2011-07-29 19:00:16 +02:00
|
|
|
return 'nonempty dict';
|
|
|
|
}
|
|
|
|
|
2015-04-13 00:59:07 +02:00
|
|
|
protected function defineErrorTypes() {
|
2011-07-29 19:00:16 +02:00
|
|
|
return array(
|
2015-05-22 09:27:56 +02:00
|
|
|
'ERR-NOT-FOUND' => pht('No such file exists.'),
|
2011-07-29 19:00:16 +02:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function execute(ConduitAPIRequest $request) {
|
|
|
|
$phid = $request->getValue('phid');
|
|
|
|
$id = $request->getValue('id');
|
|
|
|
|
2013-09-30 18:38:13 +02:00
|
|
|
$query = id(new PhabricatorFileQuery())
|
|
|
|
->setViewer($request->getUser());
|
2011-07-29 19:00:16 +02:00
|
|
|
if ($id) {
|
2013-09-30 18:38:13 +02:00
|
|
|
$query->withIDs(array($id));
|
2011-07-29 19:00:16 +02:00
|
|
|
} else {
|
2013-09-30 18:38:13 +02:00
|
|
|
$query->withPHIDs(array($phid));
|
2011-07-29 19:00:16 +02:00
|
|
|
}
|
|
|
|
|
2013-09-30 18:38:13 +02:00
|
|
|
$file = $query->executeOne();
|
|
|
|
|
2011-07-29 19:00:16 +02:00
|
|
|
if (!$file) {
|
|
|
|
throw new ConduitException('ERR-NOT-FOUND');
|
|
|
|
}
|
|
|
|
|
2015-03-17 14:33:30 +01:00
|
|
|
$uri = $file->getInfoURI();
|
2011-07-29 19:00:16 +02:00
|
|
|
|
|
|
|
return array(
|
|
|
|
'id' => $file->getID(),
|
|
|
|
'phid' => $file->getPHID(),
|
|
|
|
'objectName' => 'F'.$file->getID(),
|
|
|
|
'name' => $file->getName(),
|
|
|
|
'mimeType' => $file->getMimeType(),
|
|
|
|
'byteSize' => $file->getByteSize(),
|
|
|
|
'authorPHID' => $file->getAuthorPHID(),
|
|
|
|
'dateCreated' => $file->getDateCreated(),
|
|
|
|
'dateModified' => $file->getDateModified(),
|
|
|
|
'uri' => PhabricatorEnv::getProductionURI($uri),
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|