friendica/src/Module
..
ActivityPub
Admin
Api
Blocklist/Domain
Calendar
Contact
Conversation
DFRN
Debug
Diaspora
Filer
HTTPException
Item
Media
Moderation
Notifications
OAuth
OStatus
Post
Profile
Search
Security
Settings
Special
Update
User
WellKnown
About.php
AccountManagementControlDocument.php
Acctlink.php
Apps.php
Attach.php
BaseAdmin.php
BaseApi.php
BaseModeration.php
BaseNotifications.php
BaseProfile.php
BaseSearch.php
BaseSettings.php
Bookmarklet.php
Contact.php
Credits.php
Delegation.php
Directory.php
Feed.php
FollowConfirm.php
FriendSuggest.php
Friendica.php
Group.php
HCard.php
Hashtag.php
Help.php
Home.php
Install.php
Invite.php
Magic.php
Maintenance.php
Manifest.php
NoScrape.php
NodeInfo110.php
NodeInfo120.php
NodeInfo210.php
Oembed.php
OpenSearch.php
Owa.php
ParseUrl.php
PermissionTooltip.php
Photo.php
Proxy.php
PublicRSAKey.php
README.md
RandomProfile.php
ReallySimpleDiscovery.php
Register.php
Response.php
RobotsTxt.php
Smilies.php
Statistics.php
Theme.php
ThemeDetails.php
ToggleMobile.php
Tos.php
Welcome.php
Xrd.php

README.md

Friendica\Module

The Module namespace contains the different modules of Friendica. Each module is loaded through the App.

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/.

A frontend module should extend the BaseModule, especially the content() method.

Backend modules

This type of modules mainly responds either with encoded XML or with JSON output. It isn't intended to respond with human readable text.

A frontend module should extend the BaseModule, especially the rawContent() method.

Routing

Every module needs to be accessed within a route. The routes are defined inside Router->collectRoutes().

Use the given routes as a pattern for further routes.

The routing library and further documentation can be found here.