strk/friendica
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README for Modules

Browse source
This commit is contained in:
Philipp Holzer 2019-05-01 19:46:18 +02:00
parent a4c2de7a0b
commit a338c75c9f
No known key found for this signature in database
GPG key ID: 517BE60E2CE5C8A5
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/Module/README.md
View file

@ -3,6 +3,21 @@
The Module namespace contains the different modules of Friendica. 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). 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: Rules for Modules:
- Named like the call (i.e. https://friendica.test/contact => `Contact`) - Named like the call (i.e. https://friendica.test/contact => `Contact`)
- Start with capitals and are **not** camelCased. - Start with capitals and are **not** camelCased.