This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
en:dev:all:wb-adaption [13.06.2015 15:09] – [PHP Dateiformatierung] translated headline mrbaseman | en:dev:all:wb-adaption [13.06.2015 16:37] – [Funktionen und Methoden] translated mrbaseman | ||
---|---|---|---|
Line 13: | Line 13: | ||
These 3 areas must be strictly separated and always occur in the exact order. New modules that do not adhere to this basic rule are no longer included in future in the repository, or they are marked as '// | These 3 areas must be strictly separated and always occur in the exact order. New modules that do not adhere to this basic rule are no longer included in future in the repository, or they are marked as '// | ||
===== PHP File Formatting ===== | ===== PHP File Formatting ===== | ||
- | ==== Allgemein | + | ==== General |
- | Für Dateien mit der Endung | + | For files with the extension |
- | Beginnt eine Datei mit PHP Code, so ist zwingend das öffnende | + | If a file starts with PHP code, the opening |
- | Textdateien | + | Particularly users of Windows |
- | Dieser Punkt ist vor allem bei Benutzern von Windows-Umgebungen explizit zu beachten, da unter Unix/ | + | ==== Indentation |
- | ==== Einrücken | + | The standard pitch of the tab should be set to 4 spaces. An indentation generally consists of 4 spaces. Tabs themselves are not allowed at any point and for convenience should be automatically converted by the editor each in 4 spaces. |
- | Die Standardschrittweite des Tabulators ist auf 4 Leerzeichen einzustellen. Ein Einzug besteht grundsätzlich aus 4 Leerzeichen. Tabulatoren selbst sind an keiner Stelle erlaubt und sollten der Einfachheit halber vom Editor automatisch | + | ==== Maximum Line Length |
- | ==== Maximale Zeilenlänge | + | The target line length is 80 characters. Developers should keep each line of their code below 80 characters, as far as is possible and practicable. Nevertheless, |
- | Die Zielzeilenlänge ist 80 Zeichen. Entwickler sollten jede Zeile ihres Codes unter 80 Zeichen halten, soweit das möglich und praktikabel ist. Trotzdem sind längere Zeilen | + | |
- | ==== Zeilenbegrenzung ==== | + | |
- | Die Zeilenbegrenzung folgt der Unix Textdatei Konvention. Zeilen müssen mit einem einzelnen Zeilenvorschubzeichen(**LF**) enden. Zeilenvorschubzeichen werden durch eine ordinale 10, oder durch 0x0A (hexadezimal) dargestellt.\\ | + | |
- | :!: **Beachte: | + | |
- | ===== Namens-Konventionen ===== | + | ==== Line termination |
+ | Line termination follows the Unix text file convention. Lines must end with a single linefeed (**LF**). Newline characters are represented by an ordinal 10, or 0x0A (hexadecimal).\\ | ||
+ | :!: **Note:** Do not use the carriage return (**CR** / 0x0D) as in the conventions of Apple or the combination of carriage return and line feed (**CR/LF** / 0x0D, 0x0A) as specified in the standard for Windows. | ||
- | ==== Allgemeines | + | ===== Naming conventions ===== |
- | WebsiteBaker übernimmt auch hier weitgehendst die PSR in einer an die Besonderheiten von WB angepassten Form. Die wichtigste Abweichung findet sich im Aufbau der Suchpfade für die Dateien. In späteren Versionen wird auch hier eine weitere Annäherung an PSR erfolgen. | + | ==== General |
- | < | + | |
- | **Hinweis: | + | |
- | Die strikte Einhaltung dieser Konventionen ist zwingend erforderlich, | + | |
- | </ | + | |
- | ==== Klassen | + | |
- | Klassennamen müssen in **StudlyCaps** (auch // | + | |
- | ^Bezeichner ^ Status | | + | |
- | |smtp_mailer | [color=red]falsch[/ | + | |
- | |Smtp_Mailer | [color=red]falsch[/ | + | |
- | |SMTPmailer | [color=red]falsch[/ | + | |
- | |SmtpMailer | [color=green]richtig[/ | + | |
- | ==== Abstrakte Klassen und Interfaces | + | Website Baker largely adopts the PSR here as well, in a version slightly adapted to the specific requirements WB. The main difference is found in the structure of the search paths for the files. In later versions also here a further approximation to PSR will take place. |
- | Generell folgen abstrakte Klassen und Interfaces der gleichen Konvention wie Klassen, mit einer zusätzlichen Regel: Die Namen von abstrakten Klassen und Interfaces sollten mit dem Term "**Abstract**" bzw. " | + | < |
+ | **Note:** | ||
+ | Strict compliance with these conventions is imperative so that there can be no homonyms of classes and functions / methods in different modules. The core is thus able to clearly determine the location of the class file based on the class name to reload them using the autoloader optimized on WB. An explicit inclusion of the class files via include () or require () is superfluous. | ||
+ | </ | ||
+ | ==== Classes | ||
+ | Class names must be declared in **StudlyCaps** (also called | ||
+ | ^Identifier ^ Status | | ||
+ | |smtp_mailer | [color=red]wrong[/ | ||
+ | |Smtp_Mailer | [color=red]wrong[/ | ||
+ | |SMTPmailer | [color=red]wrong[/ | ||
+ | |SmtpMailer | [color=green]correct[/ | ||
- | ==== Emulierte Namespaces | + | ==== Abstract classes and interfaces |
- | In diesem Modus ist in Klassennamen zusätzlich der Unterstrich ' | + | In general, abstract classes and interfaces follow the same conventions as classes, with an additional rule: The names of abstract classes and interfaces should end with the term " |
- | Die Klassenbibliotheken von WebsiteBaker sind in mehrere Gruppen aufgeteilt: | + | ==== Emulated namespaces ==== |
- | **Klassen des Kerns**: | + | In this mode in class names the underscore |
- | **Klassen der Module**: Klassen der Module im jeweiligen Modulverzeichnis **'' | + | |
- | **Klassen des ACP**: (AdminControlPanel => ehem. Backend) sind im Verzeichnis **'' | + | |
- | **Klassen der third-party libraries**: | + | |
- | ==== Dateinamen ==== | + | The class libraries of WebsiteBaker are divided into several groups:\\ |
- | Soweit die vorgenannten Regeln für Klassennamen eingehalten wurden, ergeben sich die Dateinamen eindeutig aus den Klassennamen. Die Klasse | + | **The core classes**: reside in the directory **'' |
- | Für alle anderen Dateien sind nur alphanummerische Zeichen und der Bindestrich (**-**) gestattet. Leerzeichen sind völlig verboten.\\ | + | **Classes of modules**: classes of modules |
- | Jede Datei, die ausführbaren PHP Code enthält sollte mit der Endung | + | **Classes of ACP**: (AdminControlPanel => Former backend) are located in the directory **'' |
- | ==== Verzeichnise | + | **Classes of third-party libraries**: lying in the directory **'' |
- | 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 < | + | ==== Filenames |
- | ==== Funktionen und Methoden ==== | + | 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 (**-**) | ||
+ | Each file which contains executable PHP code should end with the extension **.php** and be carried out in UpperCamelCase. | ||
- | 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. | + | ==== Directories ==== |
- | Wortreichtum wird generell befürwortet. Funktionsnamen sollten so wortreich wie möglich sein um deren Zweck und Verhalten möglichst genau zu erklären. | + | 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. |
- | Funktionen oder Methoden sollen möglichst immer in // | + | ==== Functions and Methods ==== |
- | :!: **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 | + | Function and method names may only contain alphanumeric characters. Underscores are not permitted. Numbers are however permitted in function names in most cases however not recommended. Verbosity is generally encouraged. Function names should be as verbose as possible to describe their purpose and behavior as precisely as possible. |
+ | |||
+ | Functions or methods have to be written whenever possible in // | ||
+ | |||
+ | :!: **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 | ||