]> git.mxchange.org Git - friendica.git/commitdiff
Update README for Modules
authorPhilipp Holzer <admin@philipp.info>
Wed, 1 May 2019 17:46:18 +0000 (19:46 +0200)
committerPhilipp Holzer <admin@philipp.info>
Wed, 1 May 2019 17:46:18 +0000 (19:46 +0200)
src/Module/README.md

index f888f263266dbdd65f8f527f835fe50b112c3c2b..66a4967f333e51fc8ec37156b45c3475c8972385 100644 (file)
@@ -3,6 +3,21 @@
 The Module namespace contains the different modules of Friendica.
 Each module is loaded through the [`App`](https://github.com/friendica/friendica/blob/develop/src/App.php).
 
+There are mainly two types of modules:
+-      frontend modules to interact with users
+-      backend modules to interact with machine requests
+
+### Frontend modules
+
+This type of modules mainly needs a template, which are generally located at
+[view/templates/](https://github.com/friendica/friendica/tree/develop/view/templates).
+
+A frontend module should extend the [`BaseModule`](https://github.com/friendica/friendica/blob/develop/src/BaseModule.php), especially the `content()` method. 
+
+### Backend modules
+
+This type of modules mainly responds either with `XML` or with `JSON`. 
+
 Rules for Modules:
 -      Named like the call (i.e. https://friendica.test/contact => `Contact`)
 -      Start with capitals and are **not** camelCased.