Formulář jako znovupoužitelná komponenta

Protože jsem na tom nějaký ten den strávil a protože v tomto spousta začátečníků lítá, tak sem hodím návod jak vytvořit znovupoužitelnou komponentu formuláře. Oproti prvotní minimalistické verzi se mi komponenta trochu rozrostla, snahou bylo DRY při opakovaném použití. (Většinu takto stavěných formulářů používám dvakrát. Ve Front modulu a pak znovu v administraci.)

Budu popisovat tvorbu komponenty TestFormComponent. Jako základ použiju skeleton.

Soubor /components/TestForm.php:

<?php
class TestForm extends Control
{
	/* vychozi hodnoty */
	public $defaults = array();

	/* nastaveni komponenty */
	public $settings = array();

	/* promenne pro obsluhu udalosti */
	public $saveData = null;
	public $onOkClick = array();
	public $onCancelClick = array();

	/** v konstruktoru urcime defaultni nastaveni */
	public function  __construct($defaults = null)
	{
		parent::__construct();

		if (isset ($defaults))
			$this->defaults = $defaults;

		$this->onOkClick[] = callback($this, 'okClick');
		$this->onCancelClick[] = callback($this, 'cancelClick');
	}

	/** metoda pro vykresleni komponenty */
	public function render()
	{
		$template = $this->template;
		$template->setFile(dirname(__FILE__) . '/testTemplate.phtml');
		$template->render();
	}

	/** tovarnicka na formular */
	public function createComponentTestForm($name)
	{
		$form = new AppForm($this, $name);

		// pridame nejaka formularova policka
		$form->addText('input', 'popisek inputu')
			->addRule(Form::MAX_LENGTH, 'Maximální délka smí být %d znaků', 8)
			->addRule(~Form::NUMERIC, 'Čísla se neuznávají');

		// dulezite je odesilaci tlacitko
		$form->addSubmit('ok', 'OK')
			->onClick = $this->onOkClick;

		// zobrazeni CancelButtonu se da vypnout v presenteru prepinacem: settings['cancelButtonDisabled'] = TRUE;
		if (!isset($this->settings['cancelButtonDisabled']) || $this->settings['cancelButtonDisabled'] == FALSE)
		{
			$form->addSubmit('cancel', 'Cancel!')
				->setValidationScope(FALSE) // formular se nebude validovat
				->onClick = $this->onCancelClick;
		}

		// pokud jeste nedoslo k odeslani, tak pri vykresleni formulare nastavime vychozi hodnoty
		if(!$form->isSubmitted())
			$form->setDefaults($this->defaults);

		return $form;
	}

	/** Zpracovani formulare po kliknuti na tlacitko "Ok" */
	public function okClick(SubmitButton $button)
	{
		debug::fireLog('Prednastavena obsluha udalosti onOkClick v komponente.');

		/* ziskani hodnot z formulare */
		$values = $button->getForm()->getValues();
		debug::fireLog($values);

		/* nacteni hodnot $setings */
		$settings = $this->settings;
		debug::fireLog($settings);

		/* zkusime data ulozit */
		if(isset($this->saveData))
		{
			call_user_func($this->saveData, $button); // misto promenne button je mozne predavat rovnou data k ulozeni, to je na vas
		}
		elseif(end($this->onOkClick) == callback($this, 'okClick'))
		{
			throw new Exception("Nemohu ulozit data z formulare! Neni k dispozici metoda k ulozeni dat, ani jiz nenasleduje zadna obsluha v presenteru.");
		}

		/* pokud je prave vykonavana metoda jedinou obsluhou udalosti, tak implicitne presmerovat */
		if(end($this->onOkClick) == callback($this, 'okClick'))
			$this->getPresenter()->redirect("this");
	}

	/** Zpracovani formulare po kliknuti na tlacitko "Cancel" */
	public function cancelClick(SubmitButton $button)
	{
		debug::fireLog('Prednastavena obsluha udalosti onCancelClick v komponente.');

		/* pokud je prave vykonavana metoda jedinou obsluhou udalosti, tak implicitne presmerovat */
		if(end($this->onCancelClick) == callback($this, 'cancelClick'))
			$this->getPresenter()->redirect("this");
	}

}
?>

Soubor /components/TestFormTemplate.phtml:

<?php
{control $form begin}
{control $form errors}

<p>{$form['input']->label} ... {$form['input']->control}</p>
<p>{$form['ok']->control} {$form['cancel']->control}<p>

{control $form end}
?>

Soubor /components/TestTemplate.phtml:

<?php
{include 'testFormTemplate.phtml', form => $control['testForm']}
?>

A nakonec jak tuto komponentu používáme v presenteru:

<?php
class HomepagePresenter extends BasePresenter
{

	public function renderDefault()
	{
	}

	public function createComponentTestForm()
    {
        $cmp =  new TestForm();

		$cmp->defaults['input'] = "default";

		$cmp->settings['cislo'] = 1; // do promenne `settings` lze zapisovat libovolna data ktera ovlivni vykresleni/chovani komponenty (zpracovani je jen na programatorovi)

		$cmp->saveData = array($this, 'testFormSaveData');

		//$cmp->onOkClick = array(); // vypne defaultni zpracovani signalu (ktery na nej zavesila komponenta)
		$cmp->onOkClick[] = callback($this, 'testFormOkClick'); // navesi obsluhu signalu onOkClick (prida metodu na konec seznamu)

		//$cmp->onCancelClick = array(); // vypne defaultni zpracovani signalu (ktery na nej zavesila komponenta)
		$cmp->onCancelClick[] = callback($this, 'testFormCancelClick'); // navesi obsluhu signalu onCancelClick (prida metodu na konec seznamu)

		return $cmp;
    }

	/** Rutina pro ukladani dat z formulare */
	public function testFormSaveData(SubmitButton $button)
	{
		debug::fireLog('Rutina pro ukladani dat z formulare v presenteru.');

		/** ziskani hodnot z formulare */
		$values = $button->getForm()->getValues();
		debug::fireLog($values);

		/** nacteni hodnot $setings */
		$settings = $button->getForm()->getParent()->settings;
		debug::fireLog($settings);
	}

	/** Zpracovani formulare po kliknuti na tlacitko "Ok" v presenteru */
	public function testFormOkClick(SubmitButton $button)
	{
		debug::fireLog('Obsluha udalosti onOkClick v presenteru.');

		/** ziskani hodnot z formulare */
		$values = $button->getForm()->getValues();
		debug::fireLog($values);

		/** nacteni hodnot $setings */
		$settings = $button->getForm()->getParent()->settings;
		debug::fireLog($settings);

		//$this->redirect("this");
	}

	/** Zpracovani formulare po kliknuti na tlacitko "Cancel" v presenteru */
	public function testFormCancelClick(SubmitButton $button)
	{
		debug::fireLog('Obsluha udalosti onCancelClick v presenteru.');

		//$this->redirect("this");
	}

}
?>

Teď je již možné v šabloně volat komponentu jako widget.
Soubor default.phtml

<?php
{widget testForm}
?>

Obslužné metody v presenteru je možné zcela vynechat, případně minimalizovat na redirect na další krok formuláře. Místo metody SaveData() jsem předával komponentě přímo model a komponenta si data uložila sama, ale to není úplně košer. Komponenta se tím spojila s modelem (ale zase si z něho mohla cucat přednastavená data apod.) Chování formuláře lze nastavovat přímo v presenteru, ale pokud nám stačí implicitní chování (typicky např. tlačítko Cancel), tak nemusíme nic nastavovat.

Doufám, že z komentářů je patrné, jak se kód chová, pokud ne, tak dotazy a zlepšováky pište prosím sem.

Večer nebo zítra chci ještě nastudovat možnosti jak uploadovat soubor a hodit sem kompletní ukázkovou aplikaci.