MVP Architektura

Framework nabízí návrhový model v podobě MVP. Při přípravě dat a jejich výpisu můžete použit tři základní stavební prvky a to Model, Config a Presenter. V rámci frameworku je logika souborů rozdělena následovně:

Model – Model slouží pro přípravu dat. Model data stahuje z DB, připravuje do potřebných struktur a pomocí připravených funkcí je vrací. Velmi často využívá definované data z Configu.
Config – zde jsou definované formuláře, různé statické prvky, názvy tabulek nebo sloupců (v případě využití vlastní tabulkové struktury) a řada potřebných constant.
Presenter – Když už se Model a Config postarají o přípravu dat, presenter je bude všechny vracet a zobrazovat na frontendu vašeho webového projektu.

Jak je celá logika myšlena?

Config udržuje některá nastavení, konstanty a formuláře v podobě zapsaného kódu.
Model spolupracuje s configem a připravuje / stahuje data z DB a připravuje je do potřebné struktury.
Presenter vyžaduje data z modelu, obaluje je HTML kódem, formátuje, vypisuje kolekce a výsledek vrací do layoutu.

Proč MVP používat?

Proč byste měli tento způsob architektury dat vůbec používat? K čemu jsou defakto tři PHP „objekty“ ke zobrazení jedné stránky?

Velmi dobře a přehledně oddělíte potřebnou logiku přípravy dat od samotného layoutu. Vaše layouty budou tak přehledné a po stránce kódů velmi čisté.
Modely jsou navrženy tak, aby maximálně spořily četnost SQL dotazů pro vrácení dat.
Veškerá data spojená s jednou „entitou“ budou mít připravenou jasnou strukturu a nebudete muset některé věci opakovaně zapisovat.

Model

Objekt připravuje data, která většinou připravuje pro presenter, který data následně vypisuje. Model by měl být vytvořen tak, aby neprováděl žádnou logiku – například, zda se některá data mají nebo nemají zobrazit. Měl by mít ale připravenou funkci, která vrátí, zda si uživatel vypsání dat u dané entity nastavil nebo ne. Tuto informaci byste si měli následně vyžádat v presenteru a data zobrazit. Model by neměl obsahovat žádné HTML, neměl by nic echovat. To je práce presenteru.

Ukázkový příklad modelu:


class KT_Car_Model extends KT_WP_Post_Base_Model {
	
	public function __construct( WP_Post $post = null, $postId = null ) {
		parent::__construct( $post, $postId );
	}
	
	// --- veřejné metody ------------
	
	// Funkce vrátí hodnotu z tabulky wp_postmeta, která patří ke konkrétnímu modelu. Jako klíč bude hledat
	// hodnotu uloženou v constantě PRICE na configu modelu
	
	public function getCarPrice(){
		return $price = $this->getMetaValue(KT_Car_Config::PRICE);
	}
	
	public function getMileage(){
		return $mileage = $this->getMetaValue(KT_Car_Config::MILEAGE);
	}
	
	public function getEnginePower(){
		return $enginePower = $this->getMetaValue(KT_Car_Config::ENGINE_POWER);
	}
	
	public function isWithVat(){
		$withVat = $this->getMetaValue(KT_Car_Config::WITH_VAT);
		if(kt_isset_and_not_empty($withVat)){
			return true;
		}
		
		return false;
	}
}

class KT_Car_Model extends KT_WP_Post_Base_Model {

public function __construct( WP_Post $post = null, $postId = null ) {

parent::__construct( $post, $postId );

}

// --- veřejné metody ------------

// Funkce vrátí hodnotu z tabulky wp_postmeta, která patří ke konkrétnímu modelu. Jako klíč bude hledat

// hodnotu uloženou v constantě PRICE na configu modelu

public function getCarPrice(){

return $price = $this->getMetaValue(KT_Car_Config::PRICE);

}

public function getMileage(){

return $mileage = $this->getMetaValue(KT_Car_Config::MILEAGE);

}

public function getEnginePower(){

return $enginePower = $this->getMetaValue(KT_Car_Config::ENGINE_POWER);

}

public function isWithVat(){

$withVat = $this->getMetaValue(KT_Car_Config::WITH_VAT);

if(kt_isset_and_not_empty($withVat)){

return true;

}

return false;

}

Seznam obecných modelů

Config

Objekt, který není potřeba inicializovat. Je to sada statických funkcí a konstant, které udržují nějaký stav bez možnosti zásahu uživatele do nějakého nastavení. Je to soubor, do kterého se odkazujete často na různě definované klíče nebo formuláře, které lze v rámci frameworku velmi jednoduše definovat.

Ukázkový příklad configu:


class KT_Car_Config {
	
        // Definice konstakt s klíče pro wp_postmeta

	const DATA_FIELDSET = "kt-car-data-fieldset";
	const PRICE = "kt-car-price";
	const MILEAGE = "kt-car-mileage";
	const ENGINE_POWER = "kt-car-engine-power";
	const WITH_VAT = "kt-car-with-vat";
	
	public static function getDataFieldset(){
		$fieldset = new KT_Form_Fieldset(self::DATA_FIELDSET, __("Parametry vozidela", KT_DOMAIN));
		
		$fieldset->addText(self::PRICE, __("Cena vozu", KT_DOMAIN))
			->setInputType(KT_Text_Field::INPUT_NUMBER)
			->addRule(KT_Field_Validator::INTEGER, __("Cena musí být celé číslo", KT_DOMAIN))
			->addRule(KT_Field_Validator::REQUIRED, __("Cena vozu musí být vyplněna", KT_DOMAIN));
		
		$fieldset->addText(self::MILEAGE, __("Stav tachometru", KT_DOMAIN))
			->setInputType(KT_Text_Field::INPUT_NUMBER)
			->addRule(KT_Field_Validator::INTEGER, __("Stav tachometru musí být celé číslo", KT_DOMAIN))
			->addRule(KT_Field_Validator::MIN_NUMBER, __("Stav tachometru musý být větší než 0", KT_DOMAIN), 1);
		
		$fieldset->addText(self::ENGINE_POWER, __("Výkon motoru", KT_DOMAIN))
			->setInputType(KT_Text_Field::INPUT_NUMBER)
			->addRule(KT_Field_Validator::INTEGER, __("Výkon motoru musí být celé číslo", KT_DOMAIN))
			->addRule(KT_Field_Validator::MIN_NUMBER, __("Výkon motoru musí být větší než 0", KT_DOMAIN), 1);
		
		$fieldset->addSwitch(self::WITH_VAT, __("Odpis DPH", KT_DOMAIN))
			->setValue(KT_Switch_Field::NO);
		
		return $fieldset;
	}
	
}

class KT_Car_Config {

// Definice konstakt s klíče pro wp_postmeta

const DATA_FIELDSET = "kt-car-data-fieldset";

const PRICE = "kt-car-price";

const MILEAGE = "kt-car-mileage";

const ENGINE_POWER = "kt-car-engine-power";

const WITH_VAT = "kt-car-with-vat";

public static function getDataFieldset(){

$fieldset = new KT_Form_Fieldset(self::DATA_FIELDSET, __("Parametry vozidela", KT_DOMAIN));

$fieldset->addText(self::PRICE, __("Cena vozu", KT_DOMAIN))

->setInputType(KT_Text_Field::INPUT_NUMBER)

->addRule(KT_Field_Validator::INTEGER, __("Cena musí být celé číslo", KT_DOMAIN))

->addRule(KT_Field_Validator::REQUIRED, __("Cena vozu musí být vyplněna", KT_DOMAIN));

$fieldset->addText(self::MILEAGE, __("Stav tachometru", KT_DOMAIN))

->setInputType(KT_Text_Field::INPUT_NUMBER)

->addRule(KT_Field_Validator::INTEGER, __("Stav tachometru musí být celé číslo", KT_DOMAIN))

->addRule(KT_Field_Validator::MIN_NUMBER, __("Stav tachometru musý být větší než 0", KT_DOMAIN), 1);

$fieldset->addText(self::ENGINE_POWER, __("Výkon motoru", KT_DOMAIN))

->setInputType(KT_Text_Field::INPUT_NUMBER)

->addRule(KT_Field_Validator::INTEGER, __("Výkon motoru musí být celé číslo", KT_DOMAIN))

->addRule(KT_Field_Validator::MIN_NUMBER, __("Výkon motoru musí být větší než 0", KT_DOMAIN), 1);

$fieldset->addSwitch(self::WITH_VAT, __("Odpis DPH", KT_DOMAIN))

->setValue(KT_Switch_Field::NO);

return $fieldset;

}

Presenter

Pokud už máme model, který nám data připravuje, máme také config, který udržuje „nastavení“ modelu, můžeme již připravit presenter. Ten se bude starat o přípravu a výpis dat do samotného layoutu. Bude z modelu stahovat data, může připravovat některou část HTML kódu a bude data formátovat dle potřeby.

Ukázkový příklad presenteru


class KT_Car_Presenter extends KT_WP_Post_Base_Presenter {
	
	public function __construct( $post ) {
		$model = new KT_Car_Model( $post );
		$this->setModel( $model );
	}
	
	// --- gettery ------------
	
	/**
	 * @return \KT_Car_Model
	 */
	public function getModel(){
		return parent::getModel();
	}
	
	// --- veřejné funkce ------------
	
	public function renderPrice(){
		$carPrice = $this->getModel()->getCarPrice();

		echo "Cena vozidla: " . number_format($carPrice, 0, "", " ") . " CZK";
		
	}
	
	public function renderMileage(){
		$mileage = $this->getModel()->getMileage();
		
		if(kt_isset_and_not_empty($mileage)){
			echo "Najeto: " . number_form($mileage, 0, "", " ") . " KM";
		}
	}

	public function renderEnginePower(){ 
		$enginePower = $this->getModel()->getEnginePower();

		if(kt_isset_and_not_empty($enginePower)){ 
			echo "Výkon motoru: " . $enginePower . " Kw";
		}
	} 

	public function renderWithVat(){
		if($this->getModel()->isWithVat()){
			$html = __("Ano", KT_DOMAIN);
		} else {
			$html = __("Ne", KT_DOMAIN);
		}
		
		echo "Možnost odpisu DPH: " . $html;
	}
}

class KT_Car_Presenter extends KT_WP_Post_Base_Presenter {

public function __construct( $post ) {

$model = new KT_Car_Model( $post );

$this->setModel( $model );

}

// --- gettery ------------

/**

* @return \KT_Car_Model

public function getModel(){

return parent::getModel();

}

// --- veřejné funkce ------------

public function renderPrice(){

$carPrice = $this->getModel()->getCarPrice();

echo "Cena vozidla: " . number_format($carPrice, 0, "", " ") . " CZK";

}

public function renderMileage(){

$mileage = $this->getModel()->getMileage();

if(kt_isset_and_not_empty($mileage)){

echo "Najeto: " . number_form($mileage, 0, "", " ") . " KM";

}

public function renderEnginePower(){

$enginePower = $this->getModel()->getEnginePower();

if(kt_isset_and_not_empty($enginePower)){

echo "Výkon motoru: " . $enginePower . " Kw";

}

public function renderWithVat(){

if($this->getModel()->isWithVat()){

$html = __("Ano", KT_DOMAIN);

} else {

$html = __("Ne", KT_DOMAIN);

}

echo "Možnost odpisu DPH: " . $html;

}