Ondřej Flídr Zend Framework Coding Standard

Zend Framework Coding Standard

Proč Coding Standard? Přehlednost Lepší kvalita kódu Méně chyb Ondřej Flídr

Přehlednost

Lepší kvalita kódu

Méně chyb

PHP soubory Nepoužívat ?> Pro odsazení 4 mezery Řádek maximálně 120 znaků Pro konec řádků používat LF Ondřej Flídr

Nepoužívat ?>

Pro odsazení 4 mezery

Řádek maximálně 120 znaků

Pro konec řádků používat LF

Konvence pojmenování - třídy Mapují cestu k souboru Pouze písmena, čísla a podtržítko Ve slovech první písmeno velké, ostatní malá Možno porušit, viz. Zend_ X ml R pc Prefix Zend_ pouze pro oficiální třídy ZF Ondřej Flídr

Mapují cestu k souboru

Pouze písmena, čísla a podtržítko

Ve slovech první písmeno velké, ostatní malá

Možno porušit, viz. Zend_ X ml R pc

Prefix Zend_ pouze pro oficiální třídy ZF

Konvence pojmenování - rozhraní Platí totéž co pro třídy Končí slovem Interface Tím je dán i název souboru Ondřej Flídr

Platí totéž co pro třídy

Končí slovem Interface

Tím je dán i název souboru

Konvence pojmenování - soubory Pouze písmena, čísla, podtržítko a pomlčka Mezera je zakázána! Soubory s PHP kódem mají příponu .php Vyjma View skriptů Ondřej Flídr

Pouze písmena, čísla, podtržítko a pomlčka

Mezera je zakázána!

Soubory s PHP kódem mají příponu .php

Vyjma View skriptů

Konvence pojmenování - funkce Pouze písmena Začíná malým písmenem Víceslovné názvy dodržují camelCase Názvy popisují funkci Akcesory prefixovány get a set Použití globálních funkcí není doporučeno Balit do statických tříd Ondřej Flídr

Pouze písmena

Začíná malým písmenem

Víceslovné názvy dodržují camelCase

Názvy popisují funkci

Akcesory prefixovány get a set

Použití globálních funkcí není doporučeno

Balit do statických tříd

Konvence pojmenování - metody Platí totéž co u funkcí Pokud implementují NV, dodržují pojmenování typické pro tento NV Napr. GetInstance() pro Singleton Private a Protected metody začínají _ Ondřej Flídr

Platí totéž co u funkcí

Pokud implementují NV, dodržují pojmenování typické pro tento NV

Napr. GetInstance() pro Singleton

Private a Protected metody začínají _

Konvence pojmenování – proměnné Pouze písmena a čísla Podtržítko pouze u private a protected camelCase Samovysvětlující Vyjma čítačů v cyklech apod. Ondřej Flídr

Pouze písmena a čísla

Podtržítko pouze u private a protected

camelCase

Samovysvětlující

Vyjma čítačů v cyklech apod.

Konvence pojmenování – konstanty Čísla, velká písmena, podtržítko Slova oddělena _ Pouze jako členy tříd pomocí const Ondřej Flídr

Čísla, velká písmena, podtržítko

Slova oddělena _

Pouze jako členy tříd pomocí const

Styl zápisu kódu – vyznačení PHP Povolený je pouze plný zápis, tj. <?php ?> Short tagy jenom ve view pro zápis <?= ?> Ondřej Flídr

Povolený je pouze plný zápis, tj. <?php ?>

Short tagy jenom ve view pro zápis <?= ?>

Styl zápisu kódu – Řetězce Pokud neobsahuje proměnnou, uzavřít do ' Pokud řetězec obsahuje ', možno použít &quot; Pro spojování řetězců použít . z obou stran oddělenou mezerou 'Lorem ipsum ' . 'dolor sit amet'; Zarovnat zalomení $sql = &quot;SELECT 'name' FROM 'people' &quot; . &quot;WHERE 'name' = 'Susan' &quot; . &quot;ORDER BY 'age' ASC&quot;; Ondřej Flídr

Pokud neobsahuje proměnnou, uzavřít do '

Pokud řetězec obsahuje ', možno použít &quot;

Pro spojování řetězců použít . z obou stran oddělenou mezerou

'Lorem ipsum ' . 'dolor sit amet';

Zarovnat zalomení

$sql = &quot;SELECT 'name' FROM 'people' &quot; . &quot;WHERE 'name' = 'Susan' &quot; . &quot;ORDER BY 'age' ASC&quot;;

Styl zápisu kódu – Pole Číselné indexy nezáporné Prvky oddělené mezerou $array = array(1, 2, 'Zend'); Zarovnat zalomení $array = array(1, 2, 3, 'I', 'Can', 'Haz', 'Cheezburger', 'Lolcat'); U asociativních polí každý prvek na samostatném řádku, pod sebe zarovnat => Ondřej Flídr

Číselné indexy nezáporné

Prvky oddělené mezerou

$array = array(1, 2, 'Zend');

Zarovnat zalomení

$array = array(1, 2, 3, 'I', 'Can', 'Haz', 'Cheezburger', 'Lolcat');

U asociativních polí každý prvek na samostatném řádku, pod sebe zarovnat =>

Styl zápisu kódu – Deklarace tříd Názvy dle konvence pojmenování Pouze jedna třída v jednom souboru Odsazování pomocí mezer V souboru pouze kód třídy Závorky na novém řádku class LoremIpsum { // kod tridy } Ondřej Flídr

Názvy dle konvence pojmenování

Pouze jedna třída v jednom souboru

Odsazování pomocí mezer

V souboru pouze kód třídy

Závorky na novém řádku

class LoremIpsum { // kod tridy }

Styl zápisu kódu – členy tříd Dle příslušné konvence zápisu Zákaz používání var Vždy zapisovat viditelnost pomocí public , private nebo protected Doporučeno použití akcesorů Ondřej Flídr

Dle příslušné konvence zápisu

Zákaz používání var

Vždy zapisovat viditelnost pomocí public , private nebo protected

Doporučeno použití akcesorů

Styl zápisu kódu – deklarace metod Pojmenování dle konvence Vždy uvádět viditelnost pomocí public , protected nebo private Závorky na nový řádek Globální funkce silně nedoporučeny Ondřej Flídr

Pojmenování dle konvence

Vždy uvádět viditelnost pomocí public , protected nebo private

Závorky na nový řádek

Globální funkce silně nedoporučeny

Styl zápisu kódu – volání metod Argumenty odděleny mezerou za čárkou Pokud je argumentem pole, je možno jej zalomit dle konvencí pro pole Ondřej Flídr

Argumenty odděleny mezerou za čárkou

Pokud je argumentem pole, je možno jej zalomit dle konvencí pro pole

Styl zápisu kódu – řídící struktury if / else / else if Podmínky odděleny mezerou z obou stran, operátor také If ($a > 1) { Otevírací složená závorka na řádku s if, ukončovací na novém Ondřej Flídr

if / else / else if

Podmínky odděleny mezerou z obou stran, operátor také

If ($a > 1) {

Otevírací složená závorka na řádku s if, ukončovací na novém

Styl zápisu kódu – řídící struktury switch Proměnná ohraničena mezerou switch ($a) { case odsazeny o 4 mezery, jejich obsah o další Každý switch musí obsahovat default sekci Ondřej Flídr

switch

Proměnná ohraničena mezerou

switch ($a) {

case odsazeny o 4 mezery, jejich obsah o další

Každý switch musí obsahovat default sekci

Styl zápisu kódu – dokumentace Bloky kompatibilní s phpDocumentor Každý soubor s kódem musí obsahovat file-level blok, každá třída musí mít class-level blok Každá metoda musí mít blok minimálně s popisem, všemi argumenty, návratovými hodnotami a vyhazovanými vyjímkami Není nutné používat @access Ondřej Flídr

Bloky kompatibilní s phpDocumentor

Každý soubor s kódem musí obsahovat file-level blok, každá třída musí mít class-level blok

Každá metoda musí mít blok minimálně s popisem, všemi argumenty, návratovými hodnotami a vyhazovanými vyjímkami

Není nutné používat @access

Prostor pro vás Ondřej Flídr ?

?

Dostupnost slidů a kódu http://blog.snipers-softworks.net Včetně doprovodného textu http://ewiki.ilikethis.cz Sekce o certifikaci ZF Kódy, slidy Ondřej Flídr

http://blog.snipers-softworks.net

Včetně doprovodného textu

http://ewiki.ilikethis.cz

Sekce o certifikaci ZF

Kódy, slidy