Deprecated Meldungen functions.api.string.php

[emergence]

über kurz oder lang fliegt das ja raus... dennoch wäre es nett wenn die meldungen aussagekräftiger wären...

zb

Code: Alles auswählen

    cDeprecated('This method is deprecated and is not needed any longer');
    return cString::cleanURLCharacters($sString, $bReplace);

besser, nach dem muster...

Code: Alles auswählen

    cDeprecated('Function '.__FUNCTION__.' is deprecated, use cString::cleanURLCharacters instead');
    return cString::cleanURLCharacters($sString, $bReplace);

[xmurrix]

Wenn ich die Funktion cApiStrCleanURLCharacters testhalber aufrufe, landet folgender Eintrag in der deprecatedlog.txt:

Code: Alles auswählen

// Mit Stacktrace
Deprecated call: cApiStrCleanURLCharacters() [functions.api.string.php(251)]: "This method is deprecated and is not needed any longer"
	cApiStrCleanURLCharacters() called in file cli.php(23)

// Ohne Stacktrace
Deprecated call: cApiStrCleanURLCharacters() [functions.api.string.php(251)]: "This method is deprecated and is not needed any longer"

Mit der vorgeschlagenen Änderung wäre das Ergebnis wie folgt:

Code: Alles auswählen

// Mit Stacktrace
Deprecated call: cApiStrCleanURLCharacters() [functions.api.string.php(251)]: "Function cApiStrCleanURLCharacters is deprecated and is not needed any longer"
	cApiStrCleanURLCharacters() called in file cli.php(23)

// Ohne Stacktrace
Deprecated call: cApiStrCleanURLCharacters() [functions.api.string.php(251)]: "Function cApiStrCleanURLCharacters is deprecated and is not needed any longer"

Das sind in beiden Fällen, also mit und ohne Stacktrace, zu viele Vorkommen von "cApiStrCleanURLCharacters" in einem Logeintrag. Die Funktion cDeprecated() übernimmt schon den Namen der aufrufenden Stelle, die betroffene Datei und die Zeile und daraus kann man ableiten wo die cDeprecated() aufgerufen wurde.

Mit dem jetzigen Status bin ich auch nicht sehr glücklich, das könnte man besser und verständlicher machen. Ich denke, wir sollten uns überlegen, welche Informationen wir in die Log-Einträge (error, warning, deprecated) schreiben wollen und wie das Format genau sein soll.

Wie im Beitrag "function cDeprecated * ergänzung" angemerkt, macht es Sinn, das in den Funktionen cDeprecated(), cWarning(), cError() und cLogError() zu vereinheitlichen.

[emergence]

eigentlich gehts mir mehr um das hier
zb:
, use cString::cleanURLCharacters instead

etwas in der richtung wäre dienlich...

This method is deprecated and is not needed any longer, use cString::cleanURLCharacters instead

bei scanPlugins wird das in der richtung schon gemacht...

Code: Alles auswählen

function scanPlugins($entity) {
    cDeprecated("The function scanPlugins() is deprecated since CONTENIDO 4.10.2, use cScanPlugins() instead.");
    cScanPlugins($entity);
}