From 8a875b5ea1d6e83d8b2b5a07c0ffa3b84aa6c76f Mon Sep 17 00:00:00 2001 From: Jamie Snape Date: Wed, 28 Oct 2015 10:26:56 -0400 Subject: [PATCH] Fix legacy API help page --- modules/api/library/APIEnabledNotification.php | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/modules/api/library/APIEnabledNotification.php b/modules/api/library/APIEnabledNotification.php index e5f7554ff..7a99422f5 100644 --- a/modules/api/library/APIEnabledNotification.php +++ b/modules/api/library/APIEnabledNotification.php @@ -24,12 +24,20 @@ */ class ApiEnabled_Notification extends MIDAS_Notification { + /** @var string */ + public $moduleName = 'api'; + + /** @var array */ + public $_moduleComponents = array('Api'); + /** * This function is for getting the web API methods defined in the API * component of the implementing class. To enable this add the following * line to your init function. * * $this->enableWebAPI(); + * + * @return array */ public function getWebApiHelp() { @@ -81,7 +89,11 @@ public function getWebApiHelp() /** * Returns the actual method in your module corresponding to the requested method, - * or false if the method doesn't exist. + * or false if the method does not exist. + * + * @param array $params parameters + * + * @return false|array */ public function findWebApiMethod($params) { @@ -97,6 +109,8 @@ public function findWebApiMethod($params) /** * Add to your init function to enable the web api for your module. This will * work provided you've created an ApiComponent. + * + * @param string $moduleName module name */ public function enableWebAPI($moduleName) {