doc/de/Addons.md

   1 Friendica Addon/Entwicklung
   2 ==============
   3
   4 * [Zur Startseite der Hilfe](help)
   5
   6 Bitte schau dir das Beispiel-Addon "randplace" für ein funktionierendes Beispiel für manche der hier aufgeführten Funktionen an.
   7 Das Facebook-Addon bietet ein Beispiel dafür, die "addon"- und "module"-Funktion gemeinsam zu integrieren.
   8 Addons arbeiten, indem sie Event Hooks abfangen.
   9 Module arbeiten, indem bestimmte Seitenanfragen (durch den URL-Pfad) abgefangen werden.
  10
  11 Addon-Namen können keine Leerstellen oder andere Interpunktionen enthalten und werden als Datei- und Funktionsnamen genutzt.
  12 Du kannst einen lesbaren Namen im Kommentarblock eintragen.
  13 Jedes Addon muss beides beinhalten - eine Installations- und eine Deinstallationsfunktion, die auf dem Addon-Namen basieren; z.B. "addon1name_install()".
  14 Diese beiden Funktionen haben keine Argumente und sind dafür verantwortlich, Event Hooks zu registrieren und abzumelden (unregistering), die dein Addon benötigt.
  15 Die Installations- und Deinstallationsfunktionfunktionen werden auch ausgeführt (z.B. neu installiert), wenn sich das Addon nach der Installation ändert - somit sollte deine Deinstallationsfunktion keine Daten zerstört und deine Installationsfunktion sollte bestehende Daten berücksichtigen.
  16 Zukünftige Extensions werden möglicherweise "Setup" und "Entfernen" anbieten.
  17
  18 Addons sollten einen Kommentarblock mit den folgenden vier Parametern enthalten:
  19
  20     /*
  21      * Name: My Great Addon
  22      * Description: This is what my addon does. It's really cool.
  23      * Version: 1.0
  24      * Author: John Q. Public <john@myfriendicasite.com>
  25      */
  26
  27 Registriere deine Addon-Hooks während der Installation.
  28
  29     \Friendica\Core\Hook::register($hookname, $file, $function);
  30
  31 $hookname ist ein String und entspricht einem bekannten Friendica-Hook.
  32
  33 $file steht für den Pfadnamen, der relativ zum Top-Level-Friendicaverzeichnis liegt.
  34 Das *sollte* "addon/addon_name/addon_name.php' sein.
  35
  36 $function ist ein String und der Name der Funktion, die ausgeführt wird, wenn der Hook aufgerufen wird.
  37
  38 Argumente
  39 ---
  40
  41 Deine Hook-Callback-Funktion wird mit mindestens einem und bis zu zwei Argumenten aufgerufen
  42
  43     function myhook_function(App $a, &$b) {
  44
  45     }
  46
  47 Wenn du Änderungen an den aufgerufenen Daten vornehmen willst, musst du diese als Referenzvariable (mit "&") während der Funktionsdeklaration deklarieren.
  48
  49 $a ist die Friendica "App"-Klasse, die eine Menge an Informationen über den aktuellen Friendica-Status beinhaltet, u.a. welche Module genutzt werden, Konfigurationsinformationen, Inhalte der Seite zum Zeitpunkt des Hook-Aufrufs.
  50 Es ist empfohlen, diese Funktion "$a" zu nennen, um seine Nutzung an den Gebrauch an anderer Stelle anzugleichen.
  51
  52 $b kann frei benannt werden.
  53 Diese Information ist speziell auf den Hook bezogen, der aktuell bearbeitet wird, und beinhaltet normalerweise Daten, die du sofort nutzen, anzeigen oder bearbeiten kannst.
  54 Achte darauf, diese mit "&" zu deklarieren, wenn du sie bearbeiten willst.
  55
  56
  57 Module
  58 ---
  59
  60 Addons können auch als "Module" agieren und alle Seitenanfragen für eine bestimte URL abfangen.
  61 Um ein Addon als Modul zu nutzen, ist es nötig, die Funktion "addon_name_module()" zu definieren, die keine Argumente benötigt und nichts weiter machen muss.
  62
  63 Wenn diese Funktion existiert, wirst du nun alle Seitenanfragen für "http://example.com/addon_name" erhalten - mit allen URL-Komponenten als zusätzliche Argumente.
  64 Diese werden in ein Array $a->argv geparst und stimmen mit $a->argc überein, wobei sie die Anzahl der URL-Komponenten abbilden.
  65 So würde http://example.com/addon/arg1/arg2 nach einem Modul "addon" suchen und seiner Modulfunktion die $a-App-Strukur übergeben (dies ist für viele Komponenten verfügbar). Das umfasst:
  66
  67     $a->argc = 3
  68     $a->argv = array(0 => 'addon', 1 => 'arg1', 2 => 'arg2');
  69
  70 Deine Modulfunktionen umfassen oft die Funktion addon_name_content(App $a), welche den Seiteninhalt definiert und zurückgibt.
  71 Sie können auch addon_name_post(App $a) umfassen, welches vor der content-Funktion aufgerufen wird und normalerweise die Resultate der POST-Formulare handhabt.
  72 Du kannst ebenso addon_name_init(App $a) nutzen, was oft frühzeitig aufgerufen wird und das Modul initialisert.
  73
  74
  75 Derzeitige Hooks
  76 ---
  77
  78 **'authenticate'** - wird aufgerufen, wenn sich der User einloggt.
  79     $b ist ein Array
  80         'username' => der übertragene Nutzername
  81         'password' => das übertragene Passwort
  82         'authenticated' => setze das auf einen anderen Wert als "0", damit der User sich authentifiziert
  83         'user_record' => die erfolgreiche Authentifizierung muss auch einen gültigen Nutzereintrag aus der Datenbank zurückgeben
  84
  85 **'logged_in'** - wird aufgerufen, sobald ein Nutzer sich erfolgreich angemeldet hat.
  86     $b beinhaltet den $a->Nutzer-Array
  87
  88
  89 **'display_item'** - wird aufgerufen, wenn ein Beitrag für die Anzeige formatiert wird.
  90     $b ist ein Array
  91         'item' => Die Item-Details (Array), die von der Datenbank ausgegeben werden
  92         'output' => Die HTML-Ausgabe (String) des Items, bevor es zur Seite hinzugefügt wird
  93
  94 **'post_local'** - wird aufgerufen, wenn der Statusbeitrag oder ein Kommentar im lokalen System eingetragen wird.
  95     $b ist das Item-Array der Information, die in der Datenbank hinterlegt wird.
  96         {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
  97
  98 **'post_local_end'** - wird aufgerufen, wenn ein lokaler Statusbeitrag oder Kommentar im lokalen System gespeichert wird.
  99     $b ist das Item-Array einer Information, die gerade in der Datenbank gespeichert wurden.
 100         {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
 101
 102 **'post_remote'** - wird aufgerufen, wenn ein Beitrag aus einer anderen Quelle empfangen wird. Dies kann auch genutzt werden, um lokale Aktivitäten oder systemgenerierte Nachrichten zu veröffentlichen/posten.
 103     $b ist das Item-Array einer Information, die in der Datenbank und im Item gespeichert ist.
 104         {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
 105
 106 **'settings_form'** - wird aufgerufen, wenn die HTML-Ausgabe für die Einstellungsseite generiert wird.
 107     $b ist die HTML-Ausgabe (String) der Einstellungsseite vor dem finalen "</form>"-Tag.
 108
 109 **'settings_post'** - wird aufgerufen, wenn die Einstellungsseiten geladen werden.
 110     $b ist der $_POST-Array
 111
 112 **'addon_settings'** - wird aufgerufen, wenn die HTML-Ausgabe der Addon-Einstellungsseite generiert wird.
 113     $b ist die HTML-Ausgabe (String) der Addon-Einstellungsseite vor dem finalen "</form>"-Tag.
 114
 115 **'addon_settings_post'** - wird aufgerufen, wenn die Addon-Einstellungsseite geladen wird.
 116     $b ist der $_POST-Array
 117
 118 **'profile_post'** - wird aufgerufen, wenn die Profilseite angezeigt wird.
 119     $b ist der $_POST-Array
 120
 121 **'profile_edit'** - wird aufgerufen, bevor die Profil-Bearbeitungsseite angezeigt wird.
 122     $b ist ein Array
 123         'profile' => Profileintrag (Array) aus der Datenbank
 124         'entry' => die HTML-Ausgabe (string) des generierten Eintrags
 125
 126 **'profile_advanced'** - wird aufgerufen, wenn die HTML-Ausgabe für das "Advanced profile" generiert wird; stimmt mit dem "Profil"-Tab auf der Profilseite der Nutzer überein.
 127     $b ist die HTML-Ausgabe (String) des erstellten Profils
 128     (Die Details des Profil-Arrays sind in $a->profile)
 129
 130 **'directory_item'** - wird von der Verzeichnisseite aufgerufen, wenn ein Item für die Anzeige formatiert wird.
 131     $b ist ein Array
 132         'contact' => Kontakteintrag (Array) einer Person aus der Datenbank
 133         'entry' => die HTML-Ausgabe (String) des generierten Eintrags
 134
 135 **'profile_sidebar_enter'** - wird aufgerufen, bevor die Sidebar "Kurzprofil" einer Seite erstellt wird.
 136     $b ist der Profil-Array einer Person
 137
 138 **'profile_sidebar'** - wird aufgerufen, wenn die Sidebar "Kurzprofil" einer Seite erstellt wird.
 139     $b ist ein Array
 140         'profile' => Kontakteintrag (Array) einer Person aus der Datenbank
 141         'entry' => die HTML-Ausgabe (String) des generierten Eintrags
 142
 143 **'contact_block_end'** - wird aufgerufen, wenn der Block "Kontakte/Freunde" der Profil-Sidebar komplett formatiert wurde.
 144     $b ist ein Array
 145           'contacts' => Array von "contacts"
 146           'output' => die HTML-Ausgabe (String) des Kontaktblocks
 147
 148 **'bbcode'** - wird während der Umwandlung von bbcode auf HTML aufgerufen.
 149     $b ist der konvertierte Text (String)
 150
 151 **'html2bbcode'** - wird während der Umwandlung von HTML zu bbcode aufgerufen (z.B. bei Nachrichtenbeiträgen).
 152     $b ist der konvertierte Text (String)
 153
 154 **'page_header'** - wird aufgerufen, nachdem der Bereich der Seitennavigation geladen wurde.
 155     $b ist die HTML-Ausgabe (String) der "nav"-Region
 156
 157 **'personal_xrd'** - wird aufgerufen, bevor die Ausgabe der persönlichen XRD-Datei erzeugt wird.
 158     $b ist ein Array
 159         'user' => die hinterlegten Einträge der Person
 160         'xml' => die komplette XML-Datei die ausgegeben wird
 161
 162 **'home_content'** - wird aufgerufen, bevor die Ausgabe des Homepage-Inhalts erstellt wird; wird nicht eingeloggten Nutzern angezeigt.
 163     $b ist die HTML-Ausgabe (String) der Auswahlregion
 164
 165 **'contact_edit'** - wird aufgerufen, wenn die Kontaktdetails vom Nutzer auf der "Kontakte"-Seite bearbeitet werden.
 166     $b ist ein Array
 167         'contact' => Kontakteintrag (Array) des abgezielten Kontakts
 168         'output' => die HTML-Ausgabe (String) der "Kontakt bearbeiten"-Seite
 169
 170 **'contact_edit_post'** - wird aufgerufen, wenn die "Kontakt bearbeiten"-Seite ausgegeben wird.
 171     $b ist der $_POST-Array
 172
 173 **'init_1'** - wird aufgerufen, kurz nachdem die Datenbank vor Beginn der Sitzung geöffnet wird.
 174     $b wird nicht genutzt
 175
 176 **'page_end'** - wird aufgerufen, nachdem die Funktion des HTML-Inhalts komplett abgeschlossen ist.
 177     $b ist die HTML-Ausgabe (String) vom Inhalt-"div"
 178
 179 **'avatar_lookup'** - wird aufgerufen, wenn der Avatar geladen wird.
 180     $b ist ein Array
 181         'size' => Größe des Avatars, der geladen wird
 182         'email' => Email-Adresse, um nach dem Avatar zu suchen
 183         'url' => generierte URL (String) des Avatars
 184
 185 **'nav_info'**
 186  - wird aufgerufen nachdem in include/nav,php der Inhalt des Navigations Menüs erzeugt wurde.
 187  - $b ist ein Array, das $nav wiederspiegelt.
 188
 189 Komplette Liste der Hook-Callbacks
 190 ---
 191
 192 Eine komplette Liste aller Hook-Callbacks mit den zugehörigen Dateien (am 01-Apr-2018 generiert): Bitte schau in die Quellcodes für Details zu Hooks, die oben nicht dokumentiert sind.
 193
 194 ### index.php
 195
 196     Hook::callAll('init_1');
 197     Hook::callAll('app_menu', $arr);
 198     Hook::callAll('page_content_top', DI::page()['content']);
 199     Hook::callAll($a->module.'_mod_init', $placeholder);
 200     Hook::callAll($a->module.'_mod_init', $placeholder);
 201     Hook::callAll($a->module.'_mod_post', $_POST);
 202     Hook::callAll($a->module.'_mod_afterpost', $placeholder);
 203     Hook::callAll($a->module.'_mod_content', $arr);
 204     Hook::callAll($a->module.'_mod_aftercontent', $arr);
 205     Hook::callAll('page_end', DI::page()['content']);
 206
 207 ### include/api.php
 208
 209     Hook::callAll('logged_in', $a->user);
 210     Hook::callAll('authenticate', $addon_auth);
 211     Hook::callAll('logged_in', $a->user);
 212
 213 ### include/enotify.php
 214
 215     Hook::callAll('enotify', $h);
 216     Hook::callAll('enotify_store', $datarray);
 217     Hook::callAll('enotify_mail', $datarray);
 218     Hook::callAll('check_item_notification', $notification_data);
 219
 220 ### include/conversation.php
 221
 222     Hook::callAll('conversation_start', $cb);
 223     Hook::callAll('render_location', $locate);
 224     Hook::callAll('display_item', $arr);
 225     Hook::callAll('display_item', $arr);
 226     Hook::callAll('item_photo_menu', $args);
 227     Hook::callAll('jot_tool', $jotplugins);
 228
 229 ### mod/directory.php
 230
 231     Hook::callAll('directory_item', $arr);
 232
 233 ### mod/xrd.php
 234
 235     Hook::callAll('personal_xrd', $arr);
 236
 237 ### mod/ping.php
 238
 239     Hook::callAll('network_ping', $arr);
 240
 241 ### mod/parse_url.php
 242
 243     Hook::callAll("parse_link", $arr);
 244
 245 ### src/Module/Delegation.php
 246
 247     Hook::callAll('home_init', $ret);
 248
 249 ### mod/acl.php
 250
 251     Hook::callAll('acl_lookup_end', $results);
 252
 253 ### mod/network.php
 254
 255     Hook::callAll('network_content_init', $arr);
 256     Hook::callAll('network_tabs', $arr);
 257
 258 ### mod/friendica.php
 259
 260     Hook::callAll('about_hook', $o);
 261
 262 ### mod/subthread.php
 263
 264     Hook::callAll('post_local_end', $arr);
 265
 266 ### mod/profiles.php
 267
 268     Hook::callAll('profile_post', $_POST);
 269     Hook::callAll('profile_edit', $arr);
 270
 271 ### mod/settings.php
 272
 273     Hook::callAll('addon_settings_post', $_POST);
 274     Hook::callAll('connector_settings_post', $_POST);
 275     Hook::callAll('display_settings_post', $_POST);
 276     Hook::callAll('settings_post', $_POST);
 277     Hook::callAll('addon_settings', $settings_addons);
 278     Hook::callAll('connector_settings', $settings_connectors);
 279     Hook::callAll('display_settings', $o);
 280     Hook::callAll('settings_form', $o);
 281
 282 ### mod/photos.php
 283
 284     Hook::callAll('photo_post_init', $_POST);
 285     Hook::callAll('photo_post_file', $ret);
 286     Hook::callAll('photo_post_end', $foo);
 287     Hook::callAll('photo_post_end', $foo);
 288     Hook::callAll('photo_post_end', $foo);
 289     Hook::callAll('photo_post_end', $foo);
 290     Hook::callAll('photo_post_end', intval($item_id));
 291     Hook::callAll('photo_upload_form', $ret);
 292
 293 ### mod/profile.php
 294
 295     Hook::callAll('profile_advanced', $o);
 296
 297 ### mod/home.php
 298
 299     Hook::callAll('home_init', $ret);
 300     Hook::callAll("home_content", $content);
 301
 302 ### mod/poke.php
 303
 304     Hook::callAll('post_local_end', $arr);
 305
 306 ### mod/contacts.php
 307
 308     Hook::callAll('contact_edit_post', $_POST);
 309     Hook::callAll('contact_edit', $arr);
 310
 311 ### mod/tagger.php
 312
 313     Hook::callAll('post_local_end', $arr);
 314
 315 ### mod/uexport.php
 316
 317     Hook::callAll('uexport_options', $options);
 318
 319 ### mod/register.php
 320
 321     Hook::callAll('register_post', $arr);
 322     Hook::callAll('register_form', $arr);
 323
 324 ### mod/item.php
 325
 326     Hook::callAll('post_local_start', $_REQUEST);
 327     Hook::callAll('post_local', $datarray);
 328     Hook::callAll('post_local_end', $datarray);
 329
 330 ### mod/editpost.php
 331
 332     Hook::callAll('jot_tool', $jotplugins);
 333
 334 ### src/Network/FKOAuth1.php
 335
 336     Hook::callAll('logged_in', $a->user);
 337
 338 ### src/Render/FriendicaSmartyEngine.php
 339
 340     Hook::callAll("template_vars", $arr);
 341
 342 ### src/Model/Item.php
 343
 344     Hook::callAll('post_local', $item);
 345     Hook::callAll('post_remote', $item);
 346     Hook::callAll('post_local_end', $posted_item);
 347     Hook::callAll('post_remote_end', $posted_item);
 348     Hook::callAll('tagged', $arr);
 349     Hook::callAll('post_local_end', $new_item);
 350     Hook::callAll('put_item_in_cache', $hook_data);
 351     Hook::callAll('prepare_body_init', $item);
 352     Hook::callAll('prepare_body_content_filter', $hook_data);
 353     Hook::callAll('prepare_body', $hook_data);
 354     Hook::callAll('prepare_body_final', $hook_data);
 355
 356 ### src/Model/Contact.php
 357
 358     Hook::callAll('contact_photo_menu', $args);
 359     Hook::callAll('follow', $arr);
 360
 361 ### src/Model/Profile.php
 362
 363     Hook::callAll('profile_sidebar_enter', $profile);
 364     Hook::callAll('profile_sidebar', $arr);
 365     Hook::callAll('profile_tabs', $arr);
 366     Hook::callAll('zrl_init', $arr);
 367
 368 ### src/Model/Event.php
 369
 370     Hook::callAll('event_updated', $event['id']);
 371     Hook::callAll("event_created", $event['id']);
 372
 373 ### src/Model/User.php
 374
 375     Hook::callAll('register_account', $uid);
 376     Hook::callAll('remove_user', $user);
 377
 378 ### src/Content/ContactBlock.php
 379
 380     Hook::callAll('contact_block_end', $arr);
 381
 382 ### src/Content/Text/BBCode.php
 383
 384     Hook::callAll('bbcode', $text);
 385     Hook::callAll('bb2diaspora', $text);
 386
 387 ### src/Content/Text/HTML.php
 388
 389     Hook::callAll('html2bbcode', $message);
 390
 391 ### src/Content/Smilies.php
 392
 393     Hook::callAll('smilie', $params);
 394
 395 ### src/Content/Feature.php
 396
 397     Hook::callAll('isEnabled', $arr);
 398     Hook::callAll('get', $arr);
 399
 400 ### src/Content/ContactSelector.php
 401
 402     Hook::callAll('network_to_name', $nets);
 403
 404 ### src/Content/OEmbed.php
 405
 406     Hook::callAll('oembed_fetch_url', $embedurl, $j);
 407
 408 ### src/Content/Nav.php
 409
 410     Hook::callAll('page_header', DI::page()['nav']);
 411     Hook::callAll('nav_info', $nav);
 412
 413 ### src/Core/Authentication.php
 414
 415     Hook::callAll('logged_in', $a->user);
 416
 417 ### src/Core/StorageManager
 418
 419     Hook::callAll('storage_instance', $data);
 420
 421 ### src/Module/PermissionTooltip.php
 422
 423     Hook::callAll('lockview_content', $item);
 424
 425 ### src/Worker/Directory.php
 426
 427     Hook::callAll('globaldir_update', $arr);
 428
 429 ### src/Worker/Notifier.php
 430
 431     Hook::callAll('notifier_end', $target_item);
 432
 433 ### src/Module/Login.php
 434
 435     Hook::callAll('authenticate', $addon_auth);
 436     Hook::callAll('login_hook', $o);
 437
 438 ### src/Module/Logout.php
 439
 440     Hook::callAll("logging_out");
 441
 442 ### src/Object/Post.php
 443
 444     Hook::callAll('render_location', $locate);
 445     Hook::callAll('display_item', $arr);
 446
 447 ### src/Core/ACL.php
 448
 449     Hook::callAll('contact_select_options', $x);
 450     Hook::callAll($a->module.'_pre_'.$selname, $arr);
 451     Hook::callAll($a->module.'_post_'.$selname, $o);
 452     Hook::callAll($a->module.'_pre_'.$selname, $arr);
 453     Hook::callAll($a->module.'_post_'.$selname, $o);
 454     Hook::callAll('jot_networks', $jotnets);
 455
 456 ### src/Core/Authentication.php
 457
 458     Hook::callAll('logged_in', $a->user);
 459
 460 ### src/Core/Hook.php
 461
 462     self::callSingle(self::getApp(), 'hook_fork', $fork_hook, $hookdata);
 463
 464 ### src/Core/L10n/L10n.php
 465
 466     Hook::callAll('poke_verbs', $arr);
 467
 468 ### src/Core/Worker.php
 469
 470     Hook::callAll("proc_run", $arr);
 471
 472 ### src/Util/Emailer.php
 473
 474     Hook::callAll('emailer_send_prepare', $email);
 475     Hook::callAll("emailer_send", $hookdata);
 476
 477 ### src/Util/Map.php
 478
 479     Hook::callAll('generate_map', $arr);
 480     Hook::callAll('generate_named_map', $arr);
 481     Hook::callAll('Map::getCoordinates', $arr);
 482
 483 ### src/Util/Network.php
 484
 485     Hook::callAll('avatar_lookup', $avatar);
 486
 487 ### src/Util/ParseUrl.php
 488
 489     Hook::callAll("getsiteinfo", $siteinfo);
 490
 491 ### src/Protocol/DFRN.php
 492
 493     Hook::callAll('atom_feed_end', $atom);
 494     Hook::callAll('atom_feed_end', $atom);
 495
 496 ### src/Protocol/Email.php
 497
 498     Hook::callAll('email_getmessage', $message);
 499     Hook::callAll('email_getmessage_end', $ret);