Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2024-12-23 13:20:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README for Modules

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

18
src/Module/README.md
View file

@ -16,10 +16,16 @@ A frontend module should extend the [`BaseModule`](https://github.com/friendica/
### Backend modules
This type of modules mainly responds either with `XML` or with `JSON`.
This type of modules mainly responds either with encoded `XML` or with `JSON` output.
It isn't intended to respond with human readable text.
Rules for Modules:
- Named like the call (i.e. https://friendica.test/contact => `Contact`)
- Start with capitals and are **not** camelCased.
- Directly interacting with a given request (POST or GET)
- Extending [`BaseModule`](https://github.com/friendica/friendica/blob/develop/src/BaseModule.php).
A frontend module should extend the [`BaseModule`](https://github.com/friendica/friendica/blob/develop/src/BaseModule.php), especially the `rawContent()` method.
### Routing
Every module needs to be accessed within a route.
The routing mechanism is using a PSR-7 based routing and the routes are defined inside [`Router->collectRoutes()`](https://github.com/friendica/friendica/blob/develop/src/App/Router.php).
Use the given routes as a pattern for further routes.
The routing library can be found [here](https://github.com/thephpleague/route).