This repository was archived by the owner on Sep 10, 2021. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +15
-1
lines changed Expand file tree Collapse file tree 1 file changed +15
-1
lines changed Original file line number Diff line number Diff line change 24
24
*/
25
25
class ApiEnabled_Notification extends MIDAS_Notification
26
26
{
27
+ /** @var string */
28
+ public $ moduleName = 'api ' ;
29
+
30
+ /** @var array */
31
+ public $ _moduleComponents = array ('Api ' );
32
+
27
33
/**
28
34
* This function is for getting the web API methods defined in the API
29
35
* component of the implementing class. To enable this add the following
30
36
* line to your init function.
31
37
*
32
38
* $this->enableWebAPI();
39
+ *
40
+ * @return array
33
41
*/
34
42
public function getWebApiHelp ()
35
43
{
@@ -81,7 +89,11 @@ public function getWebApiHelp()
81
89
82
90
/**
83
91
* Returns the actual method in your module corresponding to the requested method,
84
- * or false if the method doesn't exist.
92
+ * or false if the method does not exist.
93
+ *
94
+ * @param array $params parameters
95
+ *
96
+ * @return false|array
85
97
*/
86
98
public function findWebApiMethod ($ params )
87
99
{
@@ -97,6 +109,8 @@ public function findWebApiMethod($params)
97
109
/**
98
110
* Add to your init function to enable the web api for your module. This will
99
111
* work provided you've created an ApiComponent.
112
+ *
113
+ * @param string $moduleName module name
100
114
*/
101
115
public function enableWebAPI ($ moduleName )
102
116
{
You can’t perform that action at this time.
0 commit comments