2011-08-30 21:03:58 +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 PHIDInfoConduitAPIMethod extends PHIDConduitAPIMethod {
|
|
|
|
|
|
|
|
public function getAPIMethodName() {
|
|
|
|
return 'phid.info';
|
|
|
|
}
|
2011-08-30 21:03:58 +02:00
|
|
|
|
2012-04-18 23:25:27 +02:00
|
|
|
public function getMethodStatus() {
|
|
|
|
return self::METHOD_STATUS_DEPRECATED;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getMethodStatusDescription() {
|
2015-05-22 09:27:56 +02:00
|
|
|
return pht("Replaced by 'phid.query'.");
|
2012-04-18 23:25:27 +02:00
|
|
|
}
|
|
|
|
|
2011-08-30 21:03:58 +02:00
|
|
|
public function getMethodDescription() {
|
2015-05-22 09:27:56 +02:00
|
|
|
return pht('Retrieve information about an arbitrary PHID.');
|
2011-08-30 21:03:58 +02:00
|
|
|
}
|
|
|
|
|
2015-04-13 00:59:07 +02:00
|
|
|
protected function defineParamTypes() {
|
2011-08-30 21:03:58 +02:00
|
|
|
return array(
|
|
|
|
'phid' => 'required phid',
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2015-04-13 00:59:07 +02:00
|
|
|
protected function defineReturnType() {
|
2011-08-30 21:03:58 +02:00
|
|
|
return 'nonempty dict<string, wild>';
|
|
|
|
}
|
|
|
|
|
2015-04-13 00:59:07 +02:00
|
|
|
protected function defineErrorTypes() {
|
2011-08-30 21:03:58 +02:00
|
|
|
return array(
|
2015-05-22 09:27:56 +02:00
|
|
|
'ERR-BAD-PHID' => pht('No such object exists.'),
|
2011-08-30 21:03:58 +02:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function execute(ConduitAPIRequest $request) {
|
|
|
|
$phid = $request->getValue('phid');
|
|
|
|
|
2013-09-11 21:27:28 +02:00
|
|
|
$handle = id(new PhabricatorHandleQuery())
|
2013-03-01 02:15:09 +01:00
|
|
|
->setViewer($request->getUser())
|
2013-09-11 21:27:28 +02:00
|
|
|
->withPHIDs(array($phid))
|
|
|
|
->executeOne();
|
2011-08-30 21:03:58 +02:00
|
|
|
|
|
|
|
if (!$handle->isComplete()) {
|
|
|
|
throw new ConduitException('ERR-BAD-PHID');
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->buildHandleInformationDictionary($handle);
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|