FormMacros.php

<?php
/**
 * Addons and code snippets for Nette Framework. (unofficial)
 *
 * @author   Jan Tvrdík
 * @license  MIT
 */

namespace JanTvrdik\Templates;

use Nette;
use Nette\Latte\DefaultMacros;
use Nette\Latte\ParseException;

/**
 * Latte macros for comfortable form rendering.
 *
 * List of modifiers:
 * ------------------
 * {form ...} – class, style
 * {input ...} – value, caption, size, rows, cols, placeholder, class, style
 * {label ...} – text, class, style
 *
 * <code>
 * {form registrationForm}
 *   <p class="error" n:foreach="$formErrors as $error">{$error}</p>
 *   <table>
 *     <tr>
 *       <th>{label name, text => "Username"}</th>
 *       <td>{input name}</td>
 *     </tr>
 *     <tr>
 *       <th>{label password, text => "Password"}</th>
 *       <td>{input password}</td>
 *     </tr>
 *     {formContainer contact}
 *       <tr>
 *         <th>{label mail, text => "E-mail"}</th>
 *         <td>{input mail}</td>
 *       </tr>
 *       <tr>
 *         <th>{label twitter, text => "Twitter"}</th>
 *         <td>{input twitter}</td>
 *       </tr>
 *     {/formContainer}
 *     <tr>
 *       <th></th>
 *       <td>{input register, caption => "Register"}</td>
 *     </tr>
 *   </table>
 * {/form}
 * </code>
 *
 * @author   Jan Marek, Jan Tvrdík, Daniel Robenek
 * @version  2.2
 * @link     http://nette.merxes.cz/form-macros/
 */
class FormMacros
{
	/** @var DefaultMacros */
	protected static $latte;

	/** @var array                 # => Nette\Forms\FormContainer */
	private static $containerStack;



	/**
	 * Static class – cannot be instantiated.
	 */
	final public function __construct()
	{
		throw new \LogicException('Cannot instantiate static class ' . get_class($this));
	}



	/**
	 * Registers form macros.
	 *
	 * @return   void
	 */
	public static function register(DefaultMacros $latte)
	{
		$latte->macros['form'] = '<?php %' . __CLASS__ . '::macroBegin% ?>';
		$latte->macros['/form'] = '<?php ' . __CLASS__ . '::endForm() ?>';
		$latte->macros['formContainer'] = '<?php %' . __CLASS__ . '::macroBeginContainer% ?>';
		$latte->macros['/formContainer'] = '<?php ' . __CLASS__ . '::endContainer() ?>';
		$latte->macros['input'] = '<?php %' . __CLASS__ . '::macroInput% ?>';
		$latte->macros['label'] = '<?php %' . __CLASS__ . '::macroLabel% ?>';
		$latte->macros['inputValue'] = '<?php %' . __CLASS__ . '::macroInputValue% ?>';

		self::$latte = $latte;
	}



	/**
	 * Returns current form.
	 *
	 * @return   Nette\Forms\Form
	 */
	public static function getForm()
	{
		return self::$containerStack[0];
	}



	/**
	 * {form ...}
	 *
	 * @param    string
	 * @return   string
	 */
	public static function macroBegin($content)
	{
		list($name, $modifiers) = self::fetchNameAndModifiers($content);
		return '$formErrors = ' . __CLASS__ . "::beginForm($name, \$control, $modifiers)->getErrors()";
	}



	/**
	 * Helper for {form ...} macro.
	 *
	 * @param    Nette\Forms\Form|string form instance or form name in given control
	 * @param    Nette\Application\UI\PresenterComponent
	 * @param    array             list of modifiers (name => value)
	 * @return   Nette\Forms\Form
	 */
	public static function beginForm($form, Nette\Application\UI\PresenterComponent $control, array $modifiers = NULL)
	{
		$form = ($form instanceof Nette\Forms\Form ? $form : $control->getComponent($form));
		self::$containerStack = array($form);

		if ($modifiers) self::addAttributes($form->getElementPrototype(), $modifiers, array('class', 'style'));
		$form->render('begin');

		return $form;
	}



	/**
	 * Helper for {/form} macro.
	 *
	 * @return   void
	 * @throws   ParseException    if some containers remain unclosed
	 */
	public static function endForm()
	{
		if (count(self::$containerStack) > 1) {
			throw new ParseException('There are some unclosed containers.');
		}
		self::getForm()->render('end');
		self::$containerStack = array();
	}



	/**
	 * {formContainer ...}
	 *
	 * @param    string
	 * @return   string
	 */
	public static function macroBeginContainer($content)
	{
		$name = self::$latte->formatString(self::$latte->fetchToken($content));
		return __CLASS__ . '::beginContainer(' . $name . ')';
	}



	/**
	 * Helper for {formContainer ...} macro.
	 *
	 * @param    string            container name
	 * @return   void
	 * @throws   ParseException    if container is not Nette\Forms\FormContainer instance
	 */
	public static function beginContainer($name)
	{
		$container = end(self::$containerStack)->getComponent($name);
		if (!$container instanceof Nette\Forms\Container) {
			throw new ParseException('Form container must be instance of Nette\Forms\FormContainer.');
		}
		self::$containerStack[] = $container;
	}



	/**
	 * Helper for {/formContainer} macro.
	 *
	 * @return   void
	 * @throws   ParseException    if there is no container to close
	 */
	public static function endContainer()
	{
		if (count(self::$containerStack) < 2) {
			throw new ParseException('Trying to close container which is not open.');
		}
		array_pop(self::$containerStack);
	}



	/**
	 * {input ...}
	 *
	 * @param    string
	 * @return   string
	 */
	public static function macroInput($content)
	{
		list($name, $modifiers) = self::fetchNameAndModifiers($content);
		return __CLASS__ . "::input($name, $modifiers)";
	}



	/**
	 * Helper for {input ...} macro.
	 *
	 * @param    string            input name
	 * @param    array             list of modifiers (name => value)
	 * @return   void
	 */
	public static function input($name, array $modifiers = NULL)
	{
		$input = self::getControl($name)->getControl();
		if ($modifiers) {
			self::addAttributes($input, $modifiers, array('value', 'size', 'rows', 'cols', 'placeholder', 'class', 'style'));
			if (isset($modifiers['caption'])) $input->value = $modifiers['caption'];
		}
		echo $input;
	}



	/**
	 * {label ...}
	 *
	 * @param    string
	 * @return   string
	 */
	public static function macroLabel($content)
	{
		list($name, $modifiers) = self::fetchNameAndModifiers($content);
		return __CLASS__ . "::label($name, $modifiers)";
	}



	/**
	 * Helper for {label ...} macro.
	 *
	 * @param    string            input name
	 * @param    array             list of modifiers (name => value)
	 * @return   void
	 */
	public static function label($name, array $modifiers = NULL)
	{
		$label = self::getControl($name)->getLabel();
		if ($modifiers) {
			self::addAttributes($label, $modifiers, array('class', 'style'));
			if (isset($modifiers['text'])) $label->setText($modifiers['text']);
		}
		echo $label;
	}



	/**
	 * {inputValue ...}
	 *
	 * @param    string
	 * @return   string
	 */
	public static function macroInputValue($content)
	{
		$name = self::$latte->formatString(self::$latte->fetchToken($content));
		return __CLASS__ . "::inputValue($name)";
	}



	/**
	 * Helper for {inputValue ...} macro.
	 *
	 * @param    string            input name
	 * @return   void
	 */
	public static function inputValue($name)
	{
		echo self::getControl($name)->getValue();
	}



	/**
	 * Returns form control.
	 *
	 * @param    string            input name
	 * @return   Nette\Forms\IControl
	 */
	protected static function getControl($name)
	{
		return end(self::$containerStack)->getComponent($name);
	}



	/**
	 * Parses given string a returns formatted name and modifiers as array.
	 *
	 * @param    string
	 * @return   array             0 => name, 1 => modifiers
	 */
	protected static function fetchNameAndModifiers($code)
	{
		$name = self::$latte->formatString(self::$latte->fetchToken($code));
		$modifiers = self::$latte->formatArray($code) ?: 'array()';
		return array($name, $modifiers);
	}



	/**
	 * Adds allowed attributes to given element.
	 *
	 * @param    Nette\Utils\Html
	 * @param    array             list of attributes (name => value)
	 * @param    array             list of allowed attributes (# => name)
	 * @return   void
	 */
	protected static function addAttributes(Nette\Utils\Html $el, array $attributes, array $allowedAttributes)
	{
		foreach ($attributes as $attribute => $value) {
			if (!in_array($attribute, $allowedAttributes)) continue;
			if (is_array($el->$attribute)) {
				$el->{$attribute}[] = $value;
			} else {
				$el->$attribute = $value;
			}
		}
	}

}