Programmer's Reference Guide

Übersicht

Zend Framework Coding Standard für PHP
Zend Framework's Referenzhandbuch

PHP Dateiformatierung

Allgemein

Für Dateien, welche nur PHP Code beinhalten ist der schliessende Tag ("?>") nicht zugelassen. Er wird von PHP nicht benötigt, und das Weglassen verhindert das versehentlich Leerzeilen in die Antwort eingefügt werden.

Hinweis: Wichtig: Einbeziehen von beliebigen binärischen Daten durch __HALT_COMPILER() ist in den PHP Dateien im Zend Framework oder abgeleiteten Datei verboten. Das Benutzen ist nur für einige Installationsskirpte erlaubt.

Einrücken

Ein Einzug sollte aus 4 Leerzeichen bestehen. Tabulatoren sind nicht erlaubt.

Maximale Zeilenlänge

Die Zielzeilenlänge ist 80 Zeichen. Entwickler sollten jede Zeile Ihres Codes unter 80 Zeichen halten, soweit dies möglich und praktikabel ist. Trotzdem sind längere Zeilen in einigen Fällen erlaubt. Die maximale Länge einer PHP Codezeile beträgt 120 Zeichen.

Zeilenbegrenzung

Die Zeilenbegrenzung folgt der Unix Textdatei Konvention. Zeilen müssen mit einem einzelnen Zeilenvorschubzeichen (LF) enden. Zeilenvorschub Zeicen werden duch eine ordinale 10, oder durch 0x0A (hexadecimal) dargestellt.

Beachte: Benutze nicht den Wagenrücklauf (CR) wie in den Konventionen von Apple's OS (0x0D) oder die Kombination aus Wagenrücklauf und Zeilenvorschub (CRLF) wie im Standard für das Windows OS (0x0D, 0x0A).

Übersicht

Zend Framework Coding Standard für PHP
Zend Framework's Referenzhandbuch

Namens Konventionen

Comments

Posted by: Bernhard on: 2010-03-05 11:55:10 ⁋

Hier vermisse ich den Hinweis, dass das starke Vermischen von HTML und PHP schlechter Stil ist. Eine PHP Datei sollte, wenn sie überhaupt HTML erzeugt strikt zwischen PHP und HTML Teil trennen.
Zum Beispiel

<?php

includes

functions

processing

/***HTML OUTPUT****/
?>
<html>
..
<?php echo $header; ?>
<?php buildTable(...); ?>
</html>

Posted by: tvm on: 2010-07-06 15:05:29 ⁋

$ grep -RP "\t" library/Zend | wc -l
232417

a lot of tabs if you ask me

Posted by: male on: 2011-04-11 13:17:25 ⁋

This is the most informed writing I’ve ever seen on this subject. <a href="http://www.google.com"> search </a>

Posted by: Noob on: 2011-08-31 09:11:32 ⁋

@tvm : Nice one;
@adam : ++;

Nice april fools Zend so fun !

Posted by: adam on: 2011-07-17 13:51:48 ⁋

Omitting the closing tag to prevent the accidental injection of trailing white space? When there is an opening tag, there is *always* a closing tag. That is how proper formatting is done. Zend is trying to solve a mere technical problem by breaking syntax. A very bad idea. And for crying out loud, how come there is a trailing white space? I have been writing php scripts for over 10 years now, since the days of php/fi. Trailing white space was never an issue for me. If it happened, I removed it. That's it. All you need is a good editor and a good ftp program. (BTW, proper editors can automatically remove trailing white spaces for you.)
"Indentation should consist of 4 spaces. Tabs are not allowed." WTF? This, again, makes no sense. This suggests misunderstanding of what certain characters are for. Spaces are *not* for cosmetic formatting of code. Tabs are generally used for indentation - in fact, that is what they were created for. If an editor messes up code indented with tabs, that is a bad editor. Good ones allow the exact setting of tab stops. This is again a very bad approach to solving an otherwise very easy problem.
Maximum Line Length and Line Termination are okay.

Posted by: Trublux on: 2011-11-30 10:14:05 ⁋

adam, you're right.

Posted by: Dominic Watson on: 2011-12-04 02:08:11 ⁋

I strongly agree with adam. Drives me nuts when I'm going through code and I see indentations ranging from 1-4 spaces. 1 tab and you're sorted. One key to indent, one key to delete an indentation.

Spamming space and delete is stupid and its contributing to RSI!

Honestly, I cannot stress enough how much it annoys me when I see 1 space, then 2 spaces, then 3 spaces, then 2 spaces, then 4. I don't mean to but being a little obsessive I waste a lot of time trying to sort them out for readability.

Ctrl + a, open, find+replace, 4 spaces for a tab :P

Posted by: S on: 2011-12-08 04:20:01 ⁋

@adam:
"The closing tag of a PHP block at the end of a file is optional, and in some cases omitting it is helpful when using include() or require(), so unwanted whitespace will not occur at the end of files, and you will still be able to add headers to the response later. It is also handy if you use output buffering, and would not like to see added unwanted whitespace at the end of the parts generated by the included files."
From http://php.net/manual/en/language.basic-syntax.instruction-separation.php