Bu belge geliştiriciler ve geliştirici takımları veya Zend Framework üzerinde geliştirme yapanlar için yönergeler ve kaynaklar sağlamaktadır. Kapsanan konular : PHP Dosya Biçimlemesi İsimlendirme Kuralları Kodlama Stili Satıriçi Belgelendirme Her geliştirme projesinde iyi kodlama standartları önemlidir , ama bilhassa birden fazla geliştirici aynı proje üstünde çalıştığında önemlidir.Kodlama standartlarına sahip olmak kodun yüksek kaliteli , az hatalı ve kolayca bakıma alınabilir olmasını sağlamaktadır. Sadece PHP kodu içeren dosyalar için kapama etiketi ("?>") kullanılmamalı. PHP tarafından ihtiyaç duyulmamaktadır.Bunu eklememek takip eden whitespace karakterlerin kazayla çıktıya eklenmesini önlemektedir. ÖNEMLİ:__HALT_COMPILER() ile ikili herhangi veri dahil edilebilir olmasına rağmen herhangi bir Zend Framework PHP dosyasıyla veya bunlardan türetilen dosyalarda dahil etme engellenmiştir. Bu özelliğin kullanımına sadece bazı özel kurulum betiklerinde izin verilmiştir. Satırbaşı boşluğu olarak tab olmadan 4 boşluk kullanın. Hedef satır uzunluğu 80 karakterdir , örn. geliştiriciler mümkün olduğunca kodu pratik olan 80-sütün sınırına yakın tutmalılar.Gene de daha uzun satırlar kabul edilebilir.Herhangi bir satır PHP kodunun maksimum uzunluğu 120 karakterdir. Satır sonlandırma unix metin dosyaları için standart bir yöntemdir.Satırlar mutlaka linefeed(LF) ile bitmelidir.Linefeed'ler ordinal olarak 10 veya onaltılık olarak 0x0A şeklinde temsil edilir. Carriage return(CR)'leri Macintosh bilgisayarlardaki gibi (0x0D) kullanmayın. Carriage return/linefeed kombinasyonunu (CRLF) Windows bilgisayarlardaki gibi (0x0D, 0x0A) kullanmayın. Zend Framework sınıfların isimlerini bulundukları dizinlere eşlenmesini sağlayan bir isimlendirme kuralına sahip. Zend Framework'ün kök dizini altındaki tüm sınıfların hiyerarşik olarak barındırıldığı "Zend/" dizinidir. Sınıf isimleri sadece alfanümerik karakterlerden oluşabilir. Numaralar sınıf isimlerinde kullanılabilirler ancak bu kullanım uygun bulunmamaktadır. Altçizgilerin sadece konum ayıracının yerine kullanılmasına izin verilir -- "Zend/Db/Table.php" dosya adı mutlaka "Zend_Db_Table" sınıfına eşleme yapmalıdır. Eğer sınıf adı birden çok kelimeden oluşuyorsa , her yeni kelimenin ilk harfi büyük harfe çevrilmelidir. Ardışık büyütülmüş harflere izin verilmez, ör. "Zend_Pdf" sınıf ismi kabul edilirken "Zend_PDF" sınıf adı kabul edilmez. Zend tarafından veya katılımcı ortak firmalardan biri tarafından yazılan ve Zend Framework ile dağıtılan Zend Framework sınıfları "Zend_" ile başlamalı ve bundan dolayı hiyerarşik olarak "Zend/" dizini içinde yerini almalı. Bunlar sınıflar için kabul edilebilir isimler : ÖNEMLİ: Framework ile çalışan fakat framework'ün bir parçası olmayan kod ör. framework'ün son kullanıcısı tarafından yazılan ve Zend veya framework'e ortak şirketlerin olmayan kod asla "Zend_" ile başlamamalıdır. Arayüz sınıfları diğer sınıflarla aynı kurallara uymalıdır (yukarıya bakın) , buna rağmen aşağıdaki örneklerde olduğu gibi mutlaka "Interface" kelimesi ile bitmeli : Diğer tüm dosyalar için sadece alfanümerik karakterler , altçizgiler ve tire karakteri ("-") kullanılabilir. Boşluklar ve geri kalan karakterler kullanılamaz. PHP kodu içeren her dosya mutlaka ".php" dosya uzantısına sahip olmalıdır. Bu örnekler yukarıdaki bölümdeki sınıf isimlerini içererek kabul edilebilen dosya isimleri göstermektedir : Dosya isimleri yukarıda açıklandığı gibi sınıf adına göre eşleşmeyi takip etmelidir. Fonksiyon isimleri sadece alfanümerik karakterler içerebilir. Altçizgiler fonksiyon isimlerinde kullanılamaz. Numaralar kullanılabilir ancak bu kullanım uygun bulunmamaktadır Fonksiyon isimleri her zaman küçük harfle başlamalı. Fonksiyon ismi birden fazla kelimeden oluştuğunda her kelimenin ilk harfi büyük olmalı. Buna genellikle "camelCaps" metodu denir. Verbosity is encouraged. Function names should be as verbose as is practical to enhance the understandability of code. These are examples of acceptable names for functions: For object-oriented programming, accessors for objects should always be prefixed with either "get" or "set". When using design patterns, such as the singleton or factory patterns, the name of the method should contain the pattern name where practical to make the pattern more readily recognizable. Functions in the global scope ("floating functions") are permitted but discouraged. It is recommended that these functions should be wrapped in a static class. Variable names may only contain alphanumeric characters. Underscores are not permitted. Numbers are permitted in variable names but are discouraged. For class member variables that are declared with the "private" or "protected" construct, the first character of the variable name must be a single underscore. This is the only acceptable usage of an underscore in a function name. Member variables declared "public" may never start with an underscore. Like function names (see section 3.3, above) variable names must always start with a lowercase letter and follow the "camelCaps" capitalization convention. Verbosity is encouraged. Variables should always be as verbose as practical. Terse variable names such as "$i" and "$n" are discouraged for anything other than the smallest loop contexts. If a loop contains more than 20 lines of code, the variables for the indices need to have more descriptive names. Constants may contain both alphanumeric characters and the underscore. Numbers are permitted in constant names. Constants must always have all letters capitalized. To enhance readablity, words in constant names must be separated by underscore characters. For example, EMBED_SUPPRESS_EMBED_EXCEPTION is permitted but EMBED_SUPPRESSEMBEDEXCEPTION is not. Constants must be defined as class members by using the "const" construct. Defining constants in the global scope with "define" is permitted but discouraged. PHP code must always be delimited by the full-form, standard PHP tags: ]]> Short tags are never allowed. For files containing only PHP code, the closing tag must always be omitted (See ). When a string is literal (contains no variable substitutions), the apostrophe or "single quote" must always used to demarcate the string: When a literal string itself contains apostrophes, it is permitted to demarcate the string with quotation marks or "double quotes". This is especially encouraged for SQL statements: The above syntax is preferred over escaping apostrophes. Variable substitution is permitted using either of these two forms: For consistency, this form is not permitted: Strings may be concatenated using the "." operator. A space must always be added before and after the "." operator to improve readability: When concatenating strings with the "." operator, it is permitted to break the statement into multiple lines to improve readability. In these cases, each successive line should be padded with whitespace such that the "."; operator is aligned under the "=" operator: Negative numbers are not permitted as indices. An indexed array may be started with any non-negative number, however this is discouraged and it is recommended that all arrays have a base index of 0. When declaring indexed arrays with the array construct, a trailing space must be added after each comma delimiter to improve readability: It is also permitted to declare multiline indexed arrays using the "array" construct. In this case, each successive line must be padded with spaces such that beginning of each line aligns as shown below: When declaring associative arrays with the array construct, it is encouraged to break the statement into multiple lines. In this case, each successive line must be padded with whitespace such that both the keys and the values are aligned: 'firstValue', 'secondKey' => 'secondValue');]]> Classes must be named by following the naming conventions. The brace is always written on the line underneath the class name ("one true brace" form). Every class must have a documentation block that conforms to the PHPDocumentor standard. Any code within a class must be indented four spaces. Only one class is permitted per PHP file. Placing additional code in a class file is permitted but discouraged. In these files, two blank lines must separate the class from any additional PHP code in the file. This is an example of an acceptable class declaration: Member variables must be named by following the variable naming conventions. Any variables declared in a class must be listed at the top of the class, prior to declaring any functions. The var construct is not permitted. Member variables always declare their visibility by using one of the private, protected, or public constructs. Accessing member variables directly by making them public is permitted but discouraged in favor of accessor variables (set/get). Functions must be named by following the naming conventions. Functions inside classes must always declare their visibility by using one of the private, protected, or public constructs. Like classes, the brace is always written on the line underneath the function name ("one true brace" form). There is no space between the function name and the opening parenthesis for the arguments. Functions in the global scope are strongly discouraged. This is an example of an acceptable function declaration in a class: NOTE: Passing by-reference is permitted in the function declaration only: Call-time pass by-reference is prohibited. The return value must not be enclosed in parentheses. This can hinder readability and can also break code if a method is later changed to return by reference. bar); } /** * RIGHT */ public function bar() { return $this->bar; } }]]> Function arguments are separated by a single trailing space after the comma delimiter. This is an example of an acceptable function call for a function that takes three arguments: Call-time pass by-reference is prohibited. See the function declarations section for the proper way to pass function arguments by-reference. For functions whose arguments permitted arrays, the function call may include the "array" construct and can be split into multiple lines to improve readability. In these cases, the standards for writing arrays still apply: Control statements based on the if and elseif constructs must have a single space before the opening parenthesis of the conditional, and a single space after the closing parenthesis. Within the conditional statements between the parentheses, operators must be separated by spaces for readability. Inner parentheses are encouraged to improve logical grouping of larger conditionals. The opening brace is written on the same line as the conditional statement. The closing brace is always written on its own line. Any content within the braces must be indented four spaces. For "if" statements that include "elseif" or "else", the formatting must be as in these examples: PHP allows for these statements to be written without braces in some circumstances. The coding standard makes no differentiation and all "if", "elseif" or "else" statements must use braces. Use of the "elseif" construct is permitted but highly discouraged in favor of the "else if" combination. Control statements written with the "switch" construct must have a single space before the opening parenthesis of the conditional statement, and also a single space after the closing parenthesis. All content within the "switch" statement must be indented four spaces. Content under each "case" statement must be indented an additional four spaces. The construct default may never be omitted from a switch statement. NOTE: It is sometimes useful to write a case statement which falls through to the next case by not including a break or return in that case. To distinguish these cases from bugs, any case statement where break or return are omitted must contain the comment "// break intentionally omitted". All documentation blocks ("docblocks") must be compatible with the phpDocumentor format. Describing the phpDocumentor format is beyond the scope of this document. For more information, visit: http://phpdoc.org/ All source code file written for the Zend Framework or that operates with the framework must contain a "file-level" docblock at the top of each file and a "class-level" docblock immediately above each class. Below are examples of such docblocks. Every file that contains PHP code must have a header block at the top of the file that contains these phpDocumentor tags at a minimum: Every class must have a docblock that contains these phpDocumentor tags at a minimum: Every function, including object methods, must have a docblock that contains at a minimum: A description of the function All of the arguments All of the possible return values It is not necessary to use the "@access" tag because the access level is already known from the "public", "private", or "protected" construct used to declare the function. If a function/method may throw an exception, use @throws: