2011-08-26 21:50:28 +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 PhrictionInfoConduitAPIMethod extends PhrictionConduitAPIMethod {
|
|
|
|
|
|
|
|
public function getAPIMethodName() {
|
|
|
|
return 'phriction.info';
|
|
|
|
}
|
2011-08-26 21:50:28 +02:00
|
|
|
|
|
|
|
public function getMethodDescription() {
|
2014-05-19 21:41:12 +02:00
|
|
|
return pht('Retrieve information about a Phriction document.');
|
2011-08-26 21:50:28 +02:00
|
|
|
}
|
|
|
|
|
2015-04-13 00:59:07 +02:00
|
|
|
protected function defineParamTypes() {
|
2011-08-26 21:50:28 +02:00
|
|
|
return array(
|
|
|
|
'slug' => 'required string',
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2015-04-13 00:59:07 +02:00
|
|
|
protected function defineReturnType() {
|
2011-08-26 21:50:28 +02:00
|
|
|
return 'nonempty dict';
|
|
|
|
}
|
|
|
|
|
2015-04-13 00:59:07 +02:00
|
|
|
protected function defineErrorTypes() {
|
2011-08-26 21:50:28 +02:00
|
|
|
return array(
|
2015-05-22 09:27:56 +02:00
|
|
|
'ERR-BAD-DOCUMENT' => pht('No such document exists.'),
|
2011-08-26 21:50:28 +02:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function execute(ConduitAPIRequest $request) {
|
|
|
|
$slug = $request->getValue('slug');
|
|
|
|
|
2014-05-19 21:41:12 +02:00
|
|
|
$document = id(new PhrictionDocumentQuery())
|
|
|
|
->setViewer($request->getUser())
|
|
|
|
->withSlugs(array(PhabricatorSlug::normalize($slug)))
|
|
|
|
->needContent(true)
|
|
|
|
->executeOne();
|
|
|
|
if (!$document) {
|
2011-08-26 21:50:28 +02:00
|
|
|
throw new ConduitException('ERR-BAD-DOCUMENT');
|
|
|
|
}
|
|
|
|
|
2014-05-19 21:41:12 +02:00
|
|
|
return $this->buildDocumentInfoDictionary(
|
|
|
|
$document,
|
|
|
|
$document->getContent());
|
2011-08-26 21:50:28 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
}
|