System-Log: Unterschied zwischen den Versionen
Aus Contao Community Documentation
Toflar (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „== Funktionen == Der System-Log ist dafür da, Aktionen die rund um TYPOlight geschehen, zu dokumentieren und registrieren. Er steht auch jedem Entwickler zur Ver…“) |
K (→Für Entwickler) |
||
| (10 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| + | [[Category:Core]] | ||
| + | [[Category:Fehlersuche]] | ||
| + | [[Category:Development]] | ||
| + | [[en:System-Log]] | ||
== Funktionen == | == Funktionen == | ||
| − | Der System-Log ist dafür da, Aktionen die rund um | + | Der System-Log ist dafür da, Aktionen, die rund um Contao geschehen, zu dokumentieren und registrieren. |
| − | Er steht auch jedem Entwickler zur Verfügung, der Logs für seine Erweiterungen schreiben möchte (siehe | + | Er steht auch jedem Entwickler zur Verfügung, der Logs für seine Erweiterungen schreiben möchte (siehe auch die Rubrik [[:Kategorie:Development|Für Entwickler]]). |
Eingefärbt werden die Logeinträge aktuell nach den folgenden Kriterien: | Eingefärbt werden die Logeinträge aktuell nach den folgenden Kriterien: | ||
* Konfiguration und Repository: blau | * Konfiguration und Repository: blau | ||
| + | [[Datei:syslog-repo.png|Systemlog Repository Eintrag]] | ||
* Cron-Jobs: grün | * Cron-Jobs: grün | ||
| + | [[Datei:syslog-cron.png|Systemlog Cron Eintrag]] | ||
* Fehler: rot | * Fehler: rot | ||
| + | [[Datei:syslog-error.png|Systemlog Error Eintrag]] | ||
* Alle anderen Kategorien: schwarz | * Alle anderen Kategorien: schwarz | ||
| + | [[Datei:syslog-normal.png|Systemlog Standard Eintrag]] | ||
== Für Entwickler == | == Für Entwickler == | ||
| − | Die Methode System::log() erledigt | + | Die Methode System::log() erledigt bequem die Einträge. |
| − | Da wahrscheinlich jede Klasse mindestens von System erbt, | + | Da wahrscheinlich jede Klasse mindestens von System erbt, kann man Einträge wie folgt registrieren lassen: |
| − | < | + | |
| + | <source lang="php"> | ||
| + | $this->log($strText, $strFunction, $strAction); | ||
| + | </source> | ||
| + | |||
* $strText = frei wählbarer Text | * $strText = frei wählbarer Text | ||
* $strFunction = Klasse Methode() | * $strFunction = Klasse Methode() | ||
| Zeile 20: | Zeile 32: | ||
Ein Beispiel für einen Cronjob-Eintrag wäre also zum Beispiel: | Ein Beispiel für einen Cronjob-Eintrag wäre also zum Beispiel: | ||
| − | |||
| − | Die zur Verfügung stehenden Kategorien findet | + | <source lang="php"> |
| + | $this->log('Running daily cron jobs', 'CronJobs run()', TL_CRON); | ||
| + | </source> | ||
| + | |||
| + | Die zur Verfügung stehenden Kategorien findet man übrigens in der system/constants.php (Contao 3: system/config/constants.php). | ||
Aktuell gibt es die folgenden: | Aktuell gibt es die folgenden: | ||
Aktuelle Version vom 4. September 2014, 06:54 Uhr
Funktionen
Der System-Log ist dafür da, Aktionen, die rund um Contao geschehen, zu dokumentieren und registrieren. Er steht auch jedem Entwickler zur Verfügung, der Logs für seine Erweiterungen schreiben möchte (siehe auch die Rubrik Für Entwickler).
Eingefärbt werden die Logeinträge aktuell nach den folgenden Kriterien:
- Konfiguration und Repository: blau
- Cron-Jobs: grün
- Fehler: rot
- Alle anderen Kategorien: schwarz
Für Entwickler
Die Methode System::log() erledigt bequem die Einträge. Da wahrscheinlich jede Klasse mindestens von System erbt, kann man Einträge wie folgt registrieren lassen:
$this->log($strText, $strFunction, $strAction);
- $strText = frei wählbarer Text
- $strFunction = Klasse Methode()
- $strAction = Kategorie
Ein Beispiel für einen Cronjob-Eintrag wäre also zum Beispiel:
$this->log('Running daily cron jobs', 'CronJobs run()', TL_CRON);
Die zur Verfügung stehenden Kategorien findet man übrigens in der system/constants.php (Contao 3: system/config/constants.php). Aktuell gibt es die folgenden:
- TL_ERROR
- TL_ACCESS
- TL_GENERAL
- TL_FILES
- TL_CRON
- TL_FORMS
- TL_CONFIGURATION
- TL_NEWSLETTER
- TL_REPOSITORY
