How to create your own component

Někdy nastane situace, kdy potřebujete vložit svou vlastní komponentu namísto výchozích vizuálních komponent (TEXT, TEXTAREA, COMBOBOX, CHECKBOX, HTMLAREA, LOOKUP, ...). Ukážeme si, jak to lze za pomocí událostí komponent zvládnout.

Každá komponenta má k dispozici tyto hlavní události, pomocí kterých lze vlastní komponenty implementovat:

onGetCode($recordValues)                              // zobrazuje HTML kód komponenty pro editaci obsahu
onGetDBValue($beforeRecordValues, $afterRecordValues) // vrací hodnotu, která bude uložena do databáze
onGetDisplayValue($recordValues)                      // zobrazuje hodnotu pro výstup na www

Představme si příklad, že potřebujeme vytvořit takovou komponentu, kde uživatel v administraci (aby to nemusel přepočítávat ručně) zadá pouze číselnou hodnotu hmotnosti a současně i vybere měrnou jednotku (g, kg, t) a systém sám převede hodnotu na kilogramy (v poli tabulky potřebujeme mít uloženou hodnotu ve stejných jednotkách) a uloží do databáze. Pro lidštější zobrazení obsahu na webu pak z této společné jednotky opět zobrazí hodnotu v gramech, kilogramech nebo tunách v závislosti na tom, jak velká je hodnota uložená v databázi.

Vytvoříme tedy nové pole weight s SQL typem DOUBLE a komponentou READONLY (tato komponenta obsahuje základní metody pro práci s daty a jejich zobrazování).

Kód pro editaci v administraci

Začneme zobrazením HTML kódu komponenty pro editaci obsahu pomocí metody onGetCode:

// prevedu jednotky z kg na g, kg, t
$value = $recordValues[$this->name];
if ($value < 1)
{
	$unit = "g";
	$value *= 1000;
}
else if ($value >= 1000)
{
	$unit = "t";
	$value /= 1000;
}

$html = "";
// zobrazím komponentu pro textové vstupní pole
$html .= "<input type='text' name='".$this->htmlName."[weight]' size='4' value='".$value."' />";

// zobrazím komponentu pro výběr měrné jednotky
$html .= "<select name='".$this->htmlName."[unit]' value='".$value."' >";
$html .= "<option value='g' ".($unit == "g" ? "selected='selected'" : "").">g</option>";
$html .= "<option value='kg' ".($unit == "kg" ? "selected='selected'" : "").">kg</option>";
$html .= "<option value='t' ".($unit == "t" ? "selected='selected'" : "").">t</option>";
$html .= "</select>";

return($html);

V kódu používáme $this->name a $this->htmlName, tedy výchozí proměnné komponenty, abychom nemuseli při změně jména pole upravovat všechny zdrojové kódy událostí. Po uložení této události se v administraci záznamu tabulky, kam jste tuto komponentu vložili, zobrazí následující komponenta:

Kód pro správné uložení hodnoty do databáze

Vkládané hodnoty jsou z formuláře zasílány najednou jako pole s klíči weight a unit, a proto potřebujeme událost onGetDBValue, která nám tyto hodnoty rozdělí, správně přepočítá na společnou jednotku kg a vrátí hodnotu, která má být následně uložena do databáze:

$value = $beforeRecordValues[$this->name];

if (is_array($value)) // jde o pole, tedy odesláno z administrace
{
	$unit = $value["unit"];
	$weight = $value["weight"];

	if ($unit == "g")
		$weight /= 1000;
	else if ($unit == "t")
		$weight *= 1000;
		
	return($weight);
}
else // nejde o pole, ale hodnotu nechceme ztratit - typicky jde o volání metod insertRecord, updateRecord objektu Table a jiné situace
{
        return($value);
}

Zobrazení hodnoty v přehledu administrace a na www

Poslední nám zbývá už jen samotné zobrazení na webu pomocí šablony. Pokud do šablony vložíte [weight], volá se právě metoda onGetDisplayValue. Protože jsme použili komponentu READONLY, zobrazí se nám nyní hodnota uložená v databázi, tedy hodnota v kilogramech bez uvedení jednotky - tedy pouze desetinné číslo. Abychom mohli zobrazit hodnotu v g, kg a t i s těmito jednotkami, použijeme událost onGetDisplayValue:

// prevedu jednotky z kg na g, kg, t
$value = $recordValues[$this->name];
if ($value < 1)
{
	$unit = "g";
	$value *= 1000;
}
else if ($value >= 1000)
{
	$unit = "t";
	$value /= 1000;
}
else
{
	$unit = "kg";
}

return($value." ".$unit);

Po zadání různých hodnot (400g, 2.6kg, 3t) se pak pomocí této události zobrazí v přehledu následující:

Powered by Visual PHP ™