public, protected, private Funktionen

ecomeback · 12.08.2007, 23:42

Vielleicht kann mir jemand von euch weiter helfen.

Ich schaue mir derzeit viel anderen Code an und versuche stilistisch und technisch die Idee hinter den jeweiligen Skripten zu durchschauen. Nun ist mir aufgefallen, dass oft
@access {public|protected|private}
vor den Funktionen notiert wird. Dabei werden oft (nicht immer!) die Funktionen mit einem Prefix eingeleitet. Ohne für "public", _ für "protected" und __ für "private".

Also also Beispiel

Code:

/** 
 * [...]
 *@access private
 */
function __doSomething() {}

In PHP5 könnte man ja gleich schreiben

Code:

private function __doSomething() {}

Ich nehme an, dass man das aufgrund der Abwärtskompatibilität zu PHP4 das nicht macht. Was ich allerdings nicht verstehe, wie man darauf kommt die Funktion als private zu deklarieren. Sollte ein __ mich daran hindern von "außen" zuzugreifen? Wird dieses _, __ also an igendeiner Stelle geprüft oder ist das lediglich ein Hinweis? Also konkret: Warum wird die Funktion als private deklariert, wenn man theoretisch doch darauf zugreifen kann? Oder soll das zunächst nur ein Hinweis sein, dass man es nicht macht, wenn man ggf. als Team entwickelt?

brian johnson · 13.08.2007, 01:10

Zitat:

Ich nehme an, dass man das aufgrund der Abwärtskompatibilität zu PHP4 das nicht macht.

genau. is nur ne notiz für später...

KingCrunch · 13.08.2007, 02:50

Ähm ... Nene, so is das nicht ganz korrekt. Die @-Notation ist für PHPDoc, wird zum Beispiel von PHPDocumentor ausgewertet. Das sieht man auch schon daran, dass hinter dem einleitenden Multi-Comment-Tag /* gleich noch ein Stern folgt und sowieso jede Zeile mit einem Stern beginnt. Einmal wird es wie gesagt von PHPDocumentor ausgewertet, Zweitens ist es für geübte Leser einfacher da durchzuschauen (da kann noch wesentlich mehr stehen) und Drittens können diverse Editoren dies auch auswerten, um Hilfestellungen zu Funktionen und Methoden zu geben (PDT auf Eclipse zB).

Wenn man ernsthaft in PHP5 programmieren will, dann kann man es nicht nur so, wie erwähnt, schreiben, sondern man sollte es auch auf jeden Fall. Auch wenn man davor den DocBlock noch setzt ist es einfach stilistischer besser, weil damit jedem (vorallem dem PHP-Parser) klar ist, was gemeint ist.

Woran du nu hängen geblieben bist, sind einfach die DocBlocks. Dienen in erster Linie zur Dokumentation, aber können (wie gesagt zB Editoren) auch anderweitig ausgewertet werden. Für den Programmablauf sind sie völlig unerheblich und können (mehr oder weniger) vom Entwickler frei gesetzt werden. Genauso gut könnte er auch @access public setzen und trotzdem vor function ein private. Wär nur nich besonders sinnvoll.

Übrigens:
Doppelter Unterstrich bei Funktionsnamen tunlichst vermeiden. Die sind PHP selbst für besondere Funktionen (Siehe Handbuch: Magic Methods) vorbehalten. Üblich ist kein Unterstrich für public, ein Unterstrich für private und protected und zwei Unterstriche für (vordefinierte) Magic-Methods.

Zergling-new · 13.08.2007, 12:12

Ja, das mit den magischen Methoden muss man dann wissen, andererseits finde ich das Konzept der Benennung, zumindest wenn PHP 4 noch im Spiel ist, nicht unbedingt schlecht.

http://de3.php.net/oop5.magic

Zitat:

The function names __construct, __destruct (see Constructors and Destructors), __call, __get, __set, __isset, __unset (see Overloading), __sleep, __wakeup, __toString, __set_state, __clone and __autoload are magical in PHP classes. You cannot have functions with these names in any of your classes unless you want the magic functionality associated with them.

KingCrunch · 13.08.2007, 18:09

Benutze die Bennenung auch für PHP5 weiter, allerdings reicht meines Erachtens ein einfacher Unterstrich für protected und private aus. Oder anders gesagt: Also ohne Unterstrich is offen zugänglich, als mit einfach für "intern".

ecomeback · 19.08.2007, 22:16

Vielen Dank für die ausführliche Darstellung,

bezüglich der Doku war mir das schon klar. Was mich nur irritiert hat ist, das man es im Kommentar als "private" deklariert und dann die Funktion selbst nicht als solche "aufschreibt". Im gewissen Sinne hat das natürlich mit Konvention zu tun, allerdings hindert mich so niemand daran die Funktion außerhalb der Klasse aufzurufen. Gerde vor dem Hintergrund, dass nicht alle Funktionen die als protected genkennzeichnet sind mit einem Unterstrich gekennzeichnet sind. Da stellt sich dann die Frage wo der "Fehler" ist. Kommentar per Copy und Paste versemmelt, Unterstrich vergessen, oder soll das so. Das ist natürlich inkonsequent und nicht immer klar ersichtlich.

Mein angesproche "Prüfung" solche Funktionen aufzurufen geht in die Richtung, dass es vielleicht ein Pattern gibt, dass den Aufruf von Funktionen steuern könnte und somit den direkten Aufruf unterbindet. Aber ich denke das wäre sicherlich nicht sonderlich sinnvoll, wenn es überhaupt möglich ist.

Zergling-new · 19.08.2007, 22:29

Es ist nicht ganz einfach, denn beim Entwickeln wechselt man teilweise zwischen public, protected und private Deklarationen.

ecomeback · 19.08.2007, 23:08

Ich kann mir das schon vorstellen, dass das nicht ganz einfach ist. Gibt es denn so komplexe Editoren, die das gesamte Konstrukt "im Blick" haben. Wäre doch gut, wenn man merkt, dass eine als public gekennzeichnet Funktion "plötzlich" private ist. Gibt es also Hilfen, die mir helfen Veränderungen und ggf. Konflikte ggf. auch über die DocBlocks als sturktuelles Mittel darstellen oder ist das mehr Wunschdenken?

brian johnson · 20.08.2007, 01:31

Zitat:

Zitat von KingCrunch

Benutze die Bennenung auch für PHP5 weiter, allerdings reicht meines Erachtens ein einfacher Unterstrich für protected und private aus. Oder anders gesagt: Also ohne Unterstrich is offen zugänglich, als mit einfach für "intern".

ist für php5 allerdings ein bisschen idiotisch. was ich besser fand, war, wie ich zuletzt in nem kunden script gesehen hab, wenn man einfache unterstriche für funktionen benutzt die durch interfaces definiert wurden. auch wenn die nich so häufig sind...

Zergling-new · 20.08.2007, 10:37

Zitat:

Zitat von brian johnson

wenn man einfache unterstriche für funktionen benutzt die durch interfaces definiert wurden

Du meinst Klassen? Hm?!

Themen-Optionen
Druckbare Version zeigen Jemanden per E-Mail auf dieses Thema hinweisen
Thema bewerten
Thema bewerten:

Ähnliche Themen
Thema	Autor	Forum	Antworten	Letzter Beitrag
[Erledigt] Transparente Runde Ecken bei Thumbnial realisieren	tomtaz	PHP Tipps 2008	3	08.07.2008 01:20
Templatesystem mit Funktionen und Variablen drin?	BartTheDevil89	PHP Tipps 2008	6	01.07.2008 09:32
Protected Eigenschaft in der eigenenen Klasse nicht anpre...	HStev	PHP-Fortgeschrittene	2	30.05.2008 18:47
GD-Spezialisten gesucht....wer kann helfen?	rezix	PHP Tipps 2008	12	26.02.2008 17:55
welche funktionen deaktivieren	brian johnson	PHP-Fortgeschrittene	4	15.11.2007 09:25
Klassen und externe Funktionen ?	ssm	PHP-Fortgeschrittene	17	18.07.2007 11:59
eine Variable für alle Funktionen definieren	Wing	PHP Tipps 2007	16	24.06.2007 21:02
Funktionen überprüfen und Grafik Funktionen	hans.karl2	PHP Tipps 2006	10	31.07.2006 20:08
Funktionen in Funktionen - ist das gut?	Schneckenkind	PHP Tipps 2006	23	10.06.2006 13:39
Globale Variabeln in Funktionen	finerip	PHP Tipps 2007	3	28.11.2005 16:00
Code Syntax Highlighting	imported_Lumio	PHP-Fortgeschrittene	9	16.08.2005 11:06
Eure Ideen sind gefragt: eigene Funktionen verwalten		PHP-Fortgeschrittene	12	17.01.2005 15:00
error: Zugriff auf protected variable aus extendet klasse		PHP Tipps 2004	3	26.09.2004 23:39
Funktionen Erklärung	TheSkaterFriend	PHP Tipps 2004	14	11.06.2004 22:05

12.08.2007, 23:42
ecomeback Benutzer Registriert seit: 01.07.2007 Beiträge: 47 PHP-Kenntnisse: Fortgeschritten	public, protected, private Funktionen Vielleicht kann mir jemand von euch weiter helfen. Ich schaue mir derzeit viel anderen Code an und versuche stilistisch und technisch die Idee hinter den jeweiligen Skripten zu durchschauen. Nun ist mir aufgefallen, dass oft @access {public\|protected\|private} vor den Funktionen notiert wird. Dabei werden oft (nicht immer!) die Funktionen mit einem Prefix eingeleitet. Ohne für "public", _ für "protected" und __ für "private". Also also Beispiel Code: /** * [...] @access private / function __doSomething() {} In PHP5 könnte man ja gleich schreiben Code: private function __doSomething() {} Ich nehme an, dass man das aufgrund der Abwärtskompatibilität zu PHP4 das nicht macht. Was ich allerdings nicht verstehe, wie man darauf kommt die Funktion als private zu deklarieren. Sollte ein __ mich daran hindern von "außen" zuzugreifen? Wird dieses _, __ also an igendeiner Stelle geprüft oder ist das lediglich ein Hinweis? Also konkret: Warum wird die Funktion als private deklariert, wenn man theoretisch doch darauf zugreifen kann? Oder soll das zunächst nur ein Hinweis sein, dass man es nicht macht, wenn man ggf. als Team entwickelt?


Mister Ad PHP Code Flüsterer Registriert seit: 21.08.2005 Beiträge: 4682 PHP-Kenntnisse: Fortgeschritten

13.08.2007, 02:50
KingCrunch Erfahrener Benutzer Registriert seit: 13.08.2007 Beiträge: 1.976	Ähm ... Nene, so is das nicht ganz korrekt. Die @-Notation ist für PHPDoc, wird zum Beispiel von PHPDocumentor ausgewertet. Das sieht man auch schon daran, dass hinter dem einleitenden Multi-Comment-Tag /* gleich noch ein Stern folgt und sowieso jede Zeile mit einem Stern beginnt. Einmal wird es wie gesagt von PHPDocumentor ausgewertet, Zweitens ist es für geübte Leser einfacher da durchzuschauen (da kann noch wesentlich mehr stehen) und Drittens können diverse Editoren dies auch auswerten, um Hilfestellungen zu Funktionen und Methoden zu geben (PDT auf Eclipse zB). Wenn man ernsthaft in PHP5 programmieren will, dann kann man es nicht nur so, wie erwähnt, schreiben, sondern man sollte es auch auf jeden Fall. Auch wenn man davor den DocBlock noch setzt ist es einfach stilistischer besser, weil damit jedem (vorallem dem PHP-Parser) klar ist, was gemeint ist. Woran du nu hängen geblieben bist, sind einfach die DocBlocks. Dienen in erster Linie zur Dokumentation, aber können (wie gesagt zB Editoren) auch anderweitig ausgewertet werden. Für den Programmablauf sind sie völlig unerheblich und können (mehr oder weniger) vom Entwickler frei gesetzt werden. Genauso gut könnte er auch @access public setzen und trotzdem vor function ein private. Wär nur nich besonders sinnvoll. Übrigens: Doppelter Unterstrich bei Funktionsnamen tunlichst vermeiden. Die sind PHP selbst für besondere Funktionen (Siehe Handbuch: Magic Methods) vorbehalten. Üblich ist kein Unterstrich für public, ein Unterstrich für private und protected und zwei Unterstriche für (vordefinierte) Magic-Methods. __________________ Nicht jeder Fehler ist ein Bug.

13.08.2007, 18:09
KingCrunch Erfahrener Benutzer Registriert seit: 13.08.2007 Beiträge: 1.976	Benutze die Bennenung auch für PHP5 weiter, allerdings reicht meines Erachtens ein einfacher Unterstrich für protected und private aus. Oder anders gesagt: Also ohne Unterstrich is offen zugänglich, als mit einfach für "intern". __________________ Nicht jeder Fehler ist ein Bug.

19.08.2007, 22:16
ecomeback Benutzer Registriert seit: 01.07.2007 Beiträge: 47 PHP-Kenntnisse: Fortgeschritten	Vielen Dank für die ausführliche Darstellung, bezüglich der Doku war mir das schon klar. Was mich nur irritiert hat ist, das man es im Kommentar als "private" deklariert und dann die Funktion selbst nicht als solche "aufschreibt". Im gewissen Sinne hat das natürlich mit Konvention zu tun, allerdings hindert mich so niemand daran die Funktion außerhalb der Klasse aufzurufen. Gerde vor dem Hintergrund, dass nicht alle Funktionen die als protected genkennzeichnet sind mit einem Unterstrich gekennzeichnet sind. Da stellt sich dann die Frage wo der "Fehler" ist. Kommentar per Copy und Paste versemmelt, Unterstrich vergessen, oder soll das so. Das ist natürlich inkonsequent und nicht immer klar ersichtlich. Mein angesproche "Prüfung" solche Funktionen aufzurufen geht in die Richtung, dass es vielleicht ein Pattern gibt, dass den Aufruf von Funktionen steuern könnte und somit den direkten Aufruf unterbindet. Aber ich denke das wäre sicherlich nicht sonderlich sinnvoll, wenn es überhaupt möglich ist.

19.08.2007, 22:29
Zergling-new Erfahrener Benutzer Registriert seit: 21.05.2008 Beiträge: 9.937	Es ist nicht ganz einfach, denn beim Entwickeln wechselt man teilweise zwischen public, protected und private Deklarationen.

19.08.2007, 23:08
ecomeback Benutzer Registriert seit: 01.07.2007 Beiträge: 47 PHP-Kenntnisse: Fortgeschritten	Ich kann mir das schon vorstellen, dass das nicht ganz einfach ist. Gibt es denn so komplexe Editoren, die das gesamte Konstrukt "im Blick" haben. Wäre doch gut, wenn man merkt, dass eine als public gekennzeichnet Funktion "plötzlich" private ist. Gibt es also Hilfen, die mir helfen Veränderungen und ggf. Konflikte ggf. auch über die DocBlocks als sturktuelles Mittel darstellen oder ist das mehr Wunschdenken?