(:redirect 'http://docs.studip.de/develop/Entwickler/Messagebox':)

• success: Für Erfolgsbestätigungen. Speicherung, Änderung usw.
• info: Für allgemeine Hinweise, keine Ergebnisse bei Suchabfragen
• error: Für Fehlermeldungen jeder anderen Art. Fehlende Benutzerrechte, Falsche Eingaben etc.

Mit Stud.IP Version 1.10 (StEP00162) wurde die neue statische Klasse Messagebox eingeführt. Diese soll die Funktionen der msg.inc.php ablösen. Bis einschließlich Version 2.0 liefern die unten beschriebenen Methoden direkt den Text für die Anzeige zurück, ab Stud.IP 2.1 ist der Rückgabewert ein MessageBox-Objekt.

• [$closed]: Wenn dieser optionaler Parameter "true" ist, werden die zusätzlichen Details zugeklappt angezeigt.

In einem Ausgabe-Template würde man es so verwenden:

<!-- Beispiel für eine einfache Info-Nachricht -->
<?= MessageBox::info('Die Suche ergab keine Treffer.') ?>

• debug: Diese Funktion zeigt eine Variable in einer <pre>- Umgebung an. Jeder Entwickler kann sich seine eigene Debug-Meldung erstellen. Dazu muss ein Template namens debug_entwickler.php in templates/shared/ abgespeichert werden oder er nimmt das mitgelieferte Template. Diese Funktion soll ausschließlich einem Entwickler beim Debuggen helfen, indem er Werte einheitlich ausgeben lassen kann.

Seit Version 2.0 gibt es noch folgende Messagebox für Entwickler:

Screenshots

Debug-Meldung

Parameter

Es können mindestens 1 bis maximal 3 Parameter übergeben werden. Diese haben folgende Bedeutung:

• $message: Die Hauptnachricht, die in der MessageBox angezeigt werden soll.
• [$details]: Der 2. Parameter ist optional für zusätzliche Informationen. Diese müssen als array() übergeben werden.
• [$closed]: Wenn dieser optionaler Parameter "true" übergibt, werden die zusätzlichen Details zugeklappt angezeigt.

Seit Version 1.12 gibt es noch folgende Messagebox für Entwickler:

• debug: Diese Funktion zeigt einen Paramter in einer <pre>- Umgebung an. Jeder Entwickler kann sich seine eigene Debug-Meldung erstellen. Dazu muss ein Template namens debug_entwickler.php in templates/shared/ abgespeichert werden.

//Beispiel für eine Debug-Meldung. echo MessageBox::debug($parameter, $optional_title, $optional_template_name);

Aktuell:

Alt:

Attach:step00162b.jpg Δ

• info: Für allgemeine Hinweise, keine Ergebnisse bei Suchabfragen

• lib/calendar/views/insert_date_popup.php

• lib/elearning/ELearningUtils.class.php

• public/request_new_password.php
• public/admin_extern.php
• public/register2.php
• public/export.php
• public/sem_notification.php
• public/admin_elearning_interface.php
• public/forum.php
• public/resources.php
• public/calendar.php

• public/register1.php

• public/browse_elearning.php
• public/evaluation_export.php
• public/elearning_interface.php
• public/my_elearning.php

• lib/msg.inc.php
• lib/include/admin_search_form.inc.php

• exception: Nur für Systemfehler. Wird von unhandledExceptions benutzt.
• error: Für Fehlermeldungen jeder anderen Art. Fehlende Benutzerrechte, Falsche Eingaben etc.
• info: Für allgemeine Hinweise
• success: Für Erfolgsbestätigungen. Speicherung, Änderung usw.

// Beispiel für eine einfache Info-Nachricht echo MessageBox::info('Nachricht');

// Beispiel für eine Error-Nachricht mit zusätzlichen Details echo MessageBox::error('Nachricht', array('optional details', 'more details'));

//Beispiel für eine Success-Nachricht mit zusätzlichen Details, die jedoch zugeklappt sind. echo MessageBox::success('Nachricht', array('optional details'), true);

parse_msg_array()

• lib/classes/StmAbstractAssiVisualization.class.php
• lib/classes/StmInstanceAssiVisualization.class.php
• lib/my_rss_feed.inc.php
• public/show_admission.php
• public/user_activities.php
• public/stm_details.php
• templates/request_password.php

parse_msg()

• lib/wiki.inc.php
• lib/admin_semester.inc.php
• lib/extern/admin_extern.inc.php
• lib/forum.inc.php
• lib/raumzeit/themen_expert.php
• lib/classes/smiley.class.php
• lib/calendar/views/export.inc.php
• lib/resources/views/Msg.class.php
• lib/kategorien.inc.php
• lib/edit_about.inc.php
• lib/include/links_admin.inc.php
• public/folder.php
• public/sms_box.php
• public/admin_semester.php
• public/admin_room_requests.php
• public/admin_datafields.php
• public/admin_db_integrity.php
• public/my_stm.php
• public/sem_notification.php
• public/forum.php
• public/eval_config.php
• public/archiv.php
• public/meine_seminare.php
• public/admin_news.php
• public/teilnehmer_aux.php
• public/archiv_assi.php
• public/wiki.php
• public/admin_aux_adjust.php
• public/admin_config.php
• public/edit_about.php
• public/admin_seminare1.php
• public/admin_statusgruppe.php
• public/my_archiv.php
• public/admin_seminare_assi.php
• public/teilnehmer.php
• public/activate_email.php
• public/sem_verify.php
• public/contact_statusgruppen.php
• public/raumzeit.php
• public/freie.php
• public/admin_admission.php
• public/inst_admin.php
• public/admin_modules.php
• public/admin_lock_adjust.php
• public/blockveranstaltungs_assistent.php
• public/admin_banner_ads.php
• public/admin_institut.php
• public/details.php
• public/scm.php
• public/copy_assi.php
• templates/nocookies.php
• templates/browse.php

parse_window()

• lib/vote/vote_edit.inc.php
• lib/functions.php
• lib/calendar/views/insert_date_popup.php
• lib/phplib_local.inc.php
• lib/resources/views/Msg.class.php
• lib/elearning/ELearningUtils.class.php
• lib/include/links_admin.inc.php
• public/seminar_lernmodule.php
• public/request_new_password.php
• public/admin_extern.php
• public/register2.php
• public/export.php
• public/sem_notification.php
• public/admin_elearning_interface.php
• public/forum.php
• public/admin_lernmodule.php
• public/browse_lernmodule.php
• public/resources.php
• public/calendar.php
• public/sendfile.php
• public/edit_about.php
• public/migration2studip.php
• public/register1.php
• public/ilias3_referrer.php
• public/write_topic.php
• public/browse_elearning.php
• public/evaluation_export.php
• public/elearning_interface.php
• public/my_elearning.php

my_msg()

• lib/extern/admin_extern.inc.php
• lib/extern/views/extern_edit_module.inc.php
• lib/classes/guestbook.class.php
• lib/export/export_view.inc.php
• lib/edit_about.inc.php
• public/seminar_lernmodule.php
• public/admin_studiengang.php
• public/migration2studip.php
• public/inst_admin.php

• public/browse_elearning.php
• public/elearning_interface.php
• public/my_elearning.php

my_info()

• lib/extern/admin_extern.inc.php
• lib/extern/views/extern_edit_module.inc.php
• lib/export/export_view.inc.php
• lib/calendar/views/export.inc.php
• lib/calendar/views/edit.inc.php
• lib/calendar/views/insert_date_popup.php
• lib/edit_about.inc.php
• public/seminar_lernmodule.php
• public/admin_elearning_interface.php
• public/admin_lernmodule.php
• public/teilnehmer_aux.php
• public/index.php
• public/edit_about.php
• public/migration2studip.php

Mit Stud.IP Version 1.10 (StEP00162) wurde die neue statische Klasse Messagebox eingeführt. Diese soll die Funktionen der msg.inc.php ablösen.

• app/views/siteinfo/new.php
• app/views/siteinfo/edit.php
• app/views/domain_admin/show.php
• app/views/event_log/admin.php
• app/views/event_log/show.php
• lib/extern/admin_extern.inc.php
• lib/extern/views/extern_edit_module.inc.php
• lib/export/export_studipdata_func.inc.php
• lib/export/export_view.inc.php
• lib/chat/chat_nicklist.php
• lib/chat/chat_status.php
• lib/chat/chat_input.php
• lib/chat/chat_client.php
• lib/edit_about.inc.php
• public/admin_elearning_interface.php
• public/admin_studiengang.php
• public/email_validation.php
• public/migration2studip.php
• public/inst_admin.php
• public/browse_elearning.php
• public/elearning_interface.php
• public/my_elearning.php

Messageboxen

Mit Stud.IP Version 1.10 wurde die neue statische Klasse Messagebox eingeführt. Diese soll die Funktionen der msg.inc.php ablösen.

Folgende 4 Typen der Messagebox gibt es:

• error:
• warning:
• info:
• success:

Funktionshinweise

//TODO

Screenshot

Veraltet: lib/msg.inc.php

Die Funktionen der Datei lib/msg.inc.php dürfen nicht weiter verwendet werden.

Folgende Dateien verwenden noch diese Funktionen:

my_error()

app/views/siteinfo/new.php app/views/siteinfo/edit.php app/views/domain_admin/show.php app/views/event_log/admin.php app/views/event_log/show.php lib/extern/admin_extern.inc.php lib/extern/views/extern_edit_module.inc.php lib/export/export_studipdata_func.inc.php lib/export/export_view.inc.php lib/msg.inc.php lib/chat/chat_nicklist.php lib/chat/chat_status.php lib/chat/chat_input.php lib/chat/chat_client.php lib/edit_about.inc.php public/admin_elearning_interface.php public/admin_studiengang.php public/email_validation.php public/migration2studip.php public/inst_admin.php public/browse_elearning.php public/elearning_interface.php public/my_elearning.php