doc/de/Plugins.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     Addon::registerHook($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 14-Feb-2012 generiert): Bitte schau in die Quellcodes für Details zu Hooks, die oben nicht dokumentiert sind.
 193
 194 boot.php:                       Addon::callHooks('login_hook',$o);
 195
 196 boot.php:                       Addon::callHooks('profile_sidebar_enter', $profile);
 197
 198 boot.php:                       Addon::callHooks('profile_sidebar', $arr);
 199
 200 boot.php:                       Addon::callHooks("proc_run", $arr);
 201
 202 include/contact_selectors.php:  Addon::callHooks('network_to_name', $nets);
 203
 204 include/api.php:                Addon::callHooks('logged_in', $a->user);
 205
 206 include/api.php:                Addon::callHooks('logged_in', $a->user);
 207
 208 include/queue.php:              Addon::callHooks('queue_predeliver', $a, $r);
 209
 210 include/queue.php:              Addon::callHooks('queue_deliver', $a, $params);
 211
 212 include/text.php:               Addon::callHooks('contact_block_end', $arr);
 213
 214 include/text.php:               Addon::callHooks('smilie', $s);
 215
 216 include/text.php:               Addon::callHooks('prepare_body_init', $item);
 217
 218 include/text.php:               Addon::callHooks('prepare_body', $prep_arr);
 219
 220 include/text.php:               Addon::callHooks('prepare_body_final', $prep_arr);
 221
 222 include/nav.php:                Addon::callHooks('page_header', $a->page['nav']);
 223
 224 include/auth.php:               Addon::callHooks('authenticate', $addon_auth);
 225
 226 include/bbcode.php:             Addon::callHooks('bbcode',$Text);
 227
 228 include/oauth.php:              Addon::callHooks('logged_in', $a->user);
 229
 230 include/acl_selectors.php:      Addon::callHooks($a->module . '_pre_' . $selname, $arr);
 231
 232 include/acl_selectors.php:      Addon::callHooks($a->module . '_post_' . $selname, $o);
 233
 234 include/acl_selectors.php:      Addon::callHooks('contact_select_options', $x);
 235
 236 include/acl_selectors.php:      Addon::callHooks($a->module . '_pre_' . $selname, $arr);
 237
 238 include/acl_selectors.php:      Addon::callHooks($a->module . '_post_' . $selname, $o);
 239
 240 include/acl_selectors.php:      Addon::callHooks($a->module . '_pre_' . $selname, $arr);
 241
 242 include/acl_selectors.php:      Addon::callHooks($a->module . '_post_' . $selname, $o);
 243
 244 include/notifier.php:           Addon::callHooks('notifier_normal',$target_item);
 245
 246 include/notifier.php:           Addon::callHooks('notifier_end',$target_item);
 247
 248 include/items.php:              Addon::callHooks('atom_feed', $atom);
 249
 250 include/items.php:              Addon::callHooks('atom_feed_end', $atom);
 251
 252 include/items.php:              Addon::callHooks('atom_feed_end', $atom);
 253
 254 include/items.php:              Addon::callHooks('parse_atom', $arr);
 255
 256 include/items.php:              Addon::callHooks('post_remote',$arr);
 257
 258 include/items.php:              Addon::callHooks('atom_author', $o);
 259
 260 include/items.php:              Addon::callHooks('atom_entry', $o);
 261
 262 include/bb2diaspora.php:        Addon::callHooks('bb2diaspora',$Text);
 263
 264 include/cronhooks.php:          Addon::callHooks('cron', $d);
 265
 266 include/security.php:           Addon::callHooks('logged_in', $a->user);
 267
 268 include/html2bbcode.php:        Addon::callHooks('html2bbcode', $text);
 269
 270 include/Contact.php:            Addon::callHooks('remove_user',$r[0]);
 271
 272 include/Contact.php:            Addon::callHooks('contact_photo_menu', $args);
 273
 274 include/conversation.php:       Addon::callHooks('conversation_start',$cb);
 275
 276 include/conversation.php:       Addon::callHooks('render_location',$locate);
 277
 278 include/conversation.php:       Addon::callHooks('display_item', $arr);
 279
 280 include/conversation.php:       Addon::callHooks('render_location',$locate);
 281
 282 include/conversation.php:       Addon::callHooks('display_item', $arr);
 283
 284 include/conversation.php:       Addon::callHooks('item_photo_menu', $args);
 285
 286 include/conversation.php:       Addon::callHooks('jot_tool', $jotplugins);
 287
 288 include/conversation.php:       Addon::callHooks('jot_networks', $jotnets);
 289
 290 index.php:                      Addon::callHooks('init_1');
 291
 292 index.php:                      Addon::callHooks('app_menu', $arr);
 293
 294 index.php:                      Addon::callHooks('page_end', $a->page['content']);
 295
 296 mod/photos.php:                 Addon::callHooks('photo_post_init', $_POST);
 297
 298 mod/photos.php:                 Addon::callHooks('photo_post_file',$ret);
 299
 300 mod/photos.php:                 Addon::callHooks('photo_post_end',$foo);
 301
 302 mod/photos.php:                 Addon::callHooks('photo_post_end',$foo);
 303
 304 mod/photos.php:                 Addon::callHooks('photo_post_end',$foo);
 305
 306 mod/photos.php:                 Addon::callHooks('photo_post_end',intval($item_id));
 307
 308 mod/photos.php:                 Addon::callHooks('photo_upload_form',$ret);
 309
 310 mod/friendica.php:              Addon::callHooks('about_hook', $o);
 311
 312 mod/editpost.php:               Addon::callHooks('jot_tool', $jotplugins);
 313
 314 mod/editpost.php:               Addon::callHooks('jot_networks', $jotnets);
 315
 316 mod/parse_url.php:              Addon::callHooks('parse_link', $arr);
 317
 318 mod/home.php:                   Addon::callHooks('home_init',$ret);
 319
 320 mod/home.php:                   Addon::callHooks("home_content",$o);
 321
 322 mod/contacts.php:               Addon::callHooks('contact_edit_post', $_POST);
 323
 324 mod/contacts.php:               Addon::callHooks('contact_edit', $arr);
 325
 326 mod/settings.php:               Addon::callHooks('addon_settings_post', $_POST);
 327
 328 mod/settings.php:               Addon::callHooks('connector_settings_post', $_POST);
 329
 330 mod/settings.php:               Addon::callHooks('settings_post', $_POST);
 331
 332 mod/settings.php:               Addon::callHooks('addon_settings', $settings_addons);
 333
 334 mod/settings.php:               Addon::callHooks('connector_settings', $settings_connectors);
 335
 336 mod/settings.php:               Addon::callHooks('settings_form',$o);
 337
 338 mod/register.php:               Addon::callHooks('register_account', $newuid);
 339
 340 mod/like.php:                   Addon::callHooks('post_local_end', $arr);
 341
 342 mod/xrd.php:                    Addon::callHooks('personal_xrd', $arr);
 343
 344 mod/item.php:                   Addon::callHooks('post_local_start', $_REQUEST);
 345
 346 mod/item.php:                   Addon::callHooks('post_local',$datarray);
 347
 348 mod/item.php:                   Addon::callHooks('post_local_end', $datarray);
 349
 350 mod/profile.php:                Addon::callHooks('profile_advanced',$o);
 351
 352 mod/profiles.php:               Addon::callHooks('profile_post', $_POST);
 353
 354 mod/profiles.php:               Addon::callHooks('profile_edit', $arr);
 355
 356 mod/tagger.php:                 Addon::callHooks('post_local_end', $arr);
 357
 358 mod/cb.php:                     Addon::callHooks('cb_init');
 359
 360 mod/cb.php:                     Addon::callHooks('cb_post', $_POST);
 361
 362 mod/cb.php:                     Addon::callHooks('cb_afterpost');
 363
 364 mod/cb.php:                     Addon::callHooks('cb_content', $o);
 365
 366 mod/directory.php:              Addon::callHooks('directory_item', $arr);