This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:dev:all:wb-adaption [13.06.2015 16:07] – [Emulierte Namespaces] translated first paragraph mrbaseman | en:dev:all:wb-adaption [13.06.2015 16:39] (current) – finished translation and removed the fixme-paragraph mrbaseman | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)// | ||
- | |||
====== General adjustment for Website Baker ====== | ====== General adjustment for Website Baker ====== | ||
Since WebsiteBaker existed before the appearance of the PHP FIG standards a few adjustments to the standards are required, which are described below. Further adjustments to adhere are included in the chapters on the individual WB versions / WB version groups! | Since WebsiteBaker existed before the appearance of the PHP FIG standards a few adjustments to the standards are required, which are described below. Further adjustments to adhere are included in the chapters on the individual WB versions / WB version groups! | ||
Line 50: | Line 48: | ||
In this mode in class names the underscore ' | In this mode in class names the underscore ' | ||
- | Die Klassenbibliotheken von WebsiteBaker | + | The class libraries of WebsiteBaker |
- | **Klassen des Kerns**: sind im Verzeichnis | + | **The core classes**: reside in the directory |
- | **Klassen der Module**: Klassen der Module im jeweiligen Modulverzeichnis | + | **Classes of modules**: classes of modules in the appropriate module directory |
- | **Klassen des ACP**: (AdminControlPanel => ehem. Backend) sind im Verzeichnis | + | **Classes of ACP**: (AdminControlPanel => Former backend) are located in the directory |
- | **Klassen der third-party libraries**: | + | **Classes of third-party libraries**: |
+ | ==== Filenames ==== | ||
+ | As far as the above-mentioned rules for class names have been complied with, the filename would clearly result from the class name. The class **m_MyModul_PluginAbstract** accordingly can be found in the file **'' | ||
+ | For all other files, only alphanumeric characters and the dash (**-**) are allowed. Spaces are strictly prohibited.\\ | ||
+ | Each file which contains executable PHP code should end with the extension **.php** and be carried out in UpperCamelCase. | ||
+ | |||
+ | ==== Directories ==== | ||
+ | For naming directories the same basis as for files apply. Only alphanumeric characters and a few special characters of standard 7-bit ASCII range <128 (**[color=blue] ! # - . @ ~ [/color]**) are allowed. As with file names, spaces, and the underscore are prohibited. | ||
- | ==== Dateinamen ==== | + | ==== Functions and Methods |
- | Soweit die vorgenannten Regeln für Klassennamen eingehalten wurden, ergeben sich die Dateinamen eindeutig aus den Klassennamen. Die Klasse **m_MyModul_PluginAbstract** findet sich demnach in der Datei **'' | + | |
- | Für alle anderen Dateien sind nur alphanummerische Zeichen und der Bindestrich (**-**) gestattet. Leerzeichen sind völlig verboten.\\ | + | |
- | Jede Datei, die ausführbaren PHP Code enthält sollte mit der Endung **.php** enden und in UpperCamelCase-Schreibweise ausgeführt sein. | + | |
- | ==== Verzeichnise ==== | + | |
- | Zur Benennung von Verzeichnissen gelten die selben Grundlagen wie für Dateien. Es sind nur alphanummerische Zeichen sowie nur wenige Sonderzeichen des Standard 7-Bit-ASCII Bereiches <128 (**[color=blue] ! # - . @ ~ [/color]**) zulässig. Wie bei Dateinamen, sind Leerzeichen und der Unterstrich grundsätzlich verboten. | + | |
- | ==== Funktionen und Methoden | + | |
- | Funktions- und Methodennamen dürfen nur Alphanummerische Zeichen enthalten. Unterstriche sind nicht gestattet. Nummern sind in Funktionsnamen gestattet aber in den meisten Fällen nicht empfohlen. | + | Function and method names may only contain alphanumeric characters. Underscores are not permitted. Numbers are however permitted |
- | Wortreichtum wird generell befürwortet. Funktionsnamen sollten so wortreich wie möglich sein um deren Zweck und Verhalten möglichst genau zu erklären. | + | |
- | Funktionen oder Methoden sollen möglichst immer in // | + | Functions or methods have to be written whenever possible |
- | :!: **Achtung:** Es dürfen niemals doppelte Unterstriche als Prefix für Methoden-, Funktions- oder Variablennamen verwendet werden. Es besteht hier die Gefahr, dass es zu Überschneidungen mit aktuellen oder zukünftigen, PHP-eigenen | + | :!: **Warning:** doulble underscores may never be used as a prefix for method, function, or variable names. There is the danger that it overlaps with current or future, PHP's intrinsic |