Standardy kódování

Jako IDE pro psaní kódu doporučujeme NetBeans. WordPress má sice vlastní sadu standardů kódování pro PHP, HTML, CSS A JS, kterými by by bylo dobré se řídit. Nicméně obecně doporučujeme ke tvorbě volně dostupné IDE NetBeans, které obsahuje již celkem rozumné a standardní formátování PHP kódů (byť se vylučuje s tím doporučeným od WordPress) – ať žije klávesová zkratka pro Formát (Alt+Shift+F)! Prostě a jednoduše, ať už používáte NetBeans, či phpStorm a jiné editory, tak je vhodné používat automatické formátování a mít své kódy jednotně zformátované.

Doporučujeme se řídit:

všechny názvy složek, souborů, tříd, funkcí atd. by měly být anglicky. Je třeba používat zdravý rozum – při vymýšlení názvů, pojmů, funkcí nebo proměnných se snažíme vždy volit takové kombinace, aby na první pohled bylo patrné, co daná část kódu dělá. Pokud to budete dělat správně, nebudete nuceni každý kód procházet znovu a znovu, abyste s odstupem času zjistili, co přesně dělá.

Vidíte rozdíl zde?


function getpostdata( $id ){
	$data = getdata($id, "kt_");
	
	foreach($data as $key => $val){
		if( $key == "kt_price"){
			continue;
		}
		
		$data2[$key] = $val;
	}
	
	return $data2;
}

function getpostdata( $id ){

$data = getdata($id, "kt_");

foreach($data as $key => $val){

if( $key == "kt_price"){

continue;

}

$data2[$key] = $val;

}

return $data2;

}

Není přeci jenom lepší tento zápis?


function getPostDataFromPostMeta( $post_id ){
	$post = get_post($id);
	$postDataCollection = getAllPostsMetaByPrefix($post_id, "kt_");
	
	foreach($postDataCollection as $metaKey => $metaValue){
		if($metaKey == "kt_price"){
			continue;
		}
		
		$formatedData[$metaKey] = $metaValue;
	}
	
	return $formatedData;
}

function getPostDataFromPostMeta( $post_id ){

$post = get_post($id);

$postDataCollection = getAllPostsMetaByPrefix($post_id, "kt_");

foreach($postDataCollection as $metaKey => $metaValue){

if($metaKey == "kt_price"){

continue;

}

$formatedData[$metaKey] = $metaValue;

}

return $formatedData;

}

Na první pohled je jasně vidět, že jsme v druhém příkladu napsali mnohem více kódu. Bude tedy pracnější a bude nám o trochu déle trvat ho zapsat. Do budoucna nám ale ušetří násobky investovaného času.

Další obecná pravidla, které by se měla dodržovat

názvy složek jsou v množném čísle,
naopak názvy souborů v jednotném čísle,
všechny názvy souborů jsou malými písmeny
všechny soubory začínají předponou kt_
všechny PHP soubory, které se mají vkládat (include, require) končí příponou .inc.php
všechny globální funkce začínají předponou kt_ (u metod uvnitř tříd to není potřeba, ba naopak)

Třídy / PHP Objekty

Protože celý FW pracuje s řadou PHP objektů, věnujeme zde malou kapitolu tomu, jak doporučujeme názvy třídy zapisovat a správně pojmenovávat.

V názvu třídy začínají jednotlivá slova velkým písmenem, kromě prefixů, které jsou celé velkými písmeny a po vzoru PHP jsou jednotlivá slova, resp. prefixy a sufixy odděleny podtržítkem.

co třída, to soubor a název souboru s třídou se jmenuje stejně jako třída + předpona a přípona

Například – budeme mít třídu – model auta


class KT_Car_Model extends KT_WP_Post_Base_Model {
	// tělo třídy
}

class KT_Car_Model extends KT_WP_Post_Base_Model {

// tělo třídy

}

Název PHP soubory ponese tedy název – kt_car_model.inc.php

V tomto postupu byste měli postupovat ve všech dalších třídách / PHP objektech

Abstraktní třídy

Protože abstraktní třída je trochu odlišná od ostatních, rozhodli jsme se udělat i drobný rozdíl v nich. V případě, že se jedná o čistě abstraktní třídu – není schopna se sama inicializovat – používáme na konci suffix base


abstract class KT_Car_Model_Base {
	// tělo třídy
}

abstract class KT_Car_Model_Base {

// tělo třídy

}

U řady tříd v rámci FW si časem všimnete, že spousta z nich má v názvu base, ale není třídou abstraktní. Pokud není opravdu suffix base jako poslední, jedná se pouze o obecnou třídu, která může sloužit jako základní třída, pro další práci. Může být však samostatně inicializovaná.

Dobré znát

Standard phpDocumentor Tags