-<?php\r
-\r
-namespace Friendica;\r
-\r
-/**\r
- * All modules in Friendica should extend BaseModule, although not all modules\r
- * need to extend all the methods described here\r
- *\r
- * @author Hypolite Petovan mrpetovan@gmail.com\r
- */\r
-abstract class BaseModule extends BaseObject\r
-{\r
- /**\r
- * @brief Initialization method common to both content() and post()\r
- *\r
- * Extend this method if you need to do any shared processing before both\r
- * content() or post()\r
- */\r
- public static function init()\r
- {\r
-\r
- }\r
-\r
- /**\r
- * @brief Module GET method to display any content\r
- *\r
- * Extend this method if the module is supposed to return any display\r
- * through a GET request. It can be an HTML page through templating or a\r
- * XML feed or a JSON output.\r
- *\r
- * @return string\r
- */\r
- public static function content()\r
- {\r
- $o = '';\r
-\r
- return $o;\r
- }\r
-\r
- /**\r
- * @brief Module POST method to process submitted data\r
- *\r
- * Extend this method if the module is supposed to process POST requests.\r
- * Doesn't display any content\r
- */\r
- public static function post()\r
- {\r
- // goaway('module');\r
- }\r
-\r
- /**\r
- * @brief Called after post()\r
- *\r
- * Unknown purpose\r
- */\r
- public static function afterpost()\r
- {\r
-\r
- }\r
-}\r
+<?php
+
+namespace Friendica;
+
+/**
+ * All modules in Friendica should extend BaseModule, although not all modules
+ * need to extend all the methods described here
+ *
+ * The filename of the module in src/Module needs to match the class name
+ * exactly to make the module available.
+ *
+ * @author Hypolite Petovan <hypolite@mrpetovan.com>
+ */
+abstract class BaseModule extends BaseObject
+{
+ /**
+ * @brief Initialization method common to both content() and post()
+ *
+ * Extend this method if you need to do any shared processing before both
+ * content() or post()
+ */
+ public static function init()
+ {
+ }
+
+ /**
+ * @brief Module GET method to display raw content from technical endpoints
+ *
+ * Extend this method if the module is supposed to return communication data,
+ * e.g. from protocol implementations.
+ */
+ public static function rawContent()
+ {
+ }
+
+ /**
+ * @brief Module GET method to display any content
+ *
+ * Extend this method if the module is supposed to return any display
+ * through a GET request. It can be an HTML page through templating or a
+ * XML feed or a JSON output.
+ *
+ * @return string
+ */
+ public static function content()
+ {
+ $o = '';
+
+ return $o;
+ }
+
+ /**
+ * @brief Module POST method to process submitted data
+ *
+ * Extend this method if the module is supposed to process POST requests.
+ * Doesn't display any content
+ */
+ public static function post()
+ {
+ // goaway('module');
+ }
+
+ /**
+ * @brief Called after post()
+ *
+ * Unknown purpose
+ */
+ public static function afterpost()
+ {
+
+ }
+}