Initial commit

Author: AntikCz

.gitignore

@@ -0,0 +1,2 @@
+tests/temp/log
+tests/temp/cache

README.md

@@ -0,0 +1,71 @@
+# Rozšiření pro WebChemistry\Forms\Form
+
+## Instalace
+
+**Composer**
+```
+composer require webchemistry/forms-wizard
+```
+
+**Config**
+
+```yaml
+extensions:
+    - WebChemistry\Forms\Controls\DI\WizardExtension
+```
+
+## Komponenta
+
+```php
+class Wizard extends WebChemistry\Forms\Wizard\Component {
+
+    protected function finish() {
+        $values = $this->getValues();
+    }
+
+    protected function createStep1() {
+        $form = $this->getForm();
+
+        $form->addText('name', 'Uživatelské jméno')
+            ->setRequired();
+
+        $form->addSubmit(self::NEXT_SUBMIT_NAME, 'Další');
+
+        return $form;
+    }
+
+    protected function createStep2() {
+        $form = $this->getForm();
+
+        $form->addText('email', 'Email')
+            ->setRequired();
+
+        $form->addSubmit(self::PREV_SUBMIT_NAME, 'Zpět');
+        $form->addSubmit(self::FINISH_SUBMIT_NAME, 'Registrovat');
+
+        return $form;
+    }
+}
+```
+
+## Šablona
+
+```html
+<div n:wizard="wizard">
+    <ul n:if="!$wizard->isSuccess()">
+        <li n:foreach="$wizard->steps as $step" n:class="$wizard->isDisabled($step) ? disabled, $wizard->isActive($step) ? active"><a n:tag-if="$wizard->useLink($step)" n:href="changeStep! $step">{$step}</a></li>
+    </ul>
+
+    {step 1}
+        {control $form}
+    {/step}
+
+    {step 2}
+        {control $form}
+    {/step}
+
+    {step success}
+        Úspěšně jste se registroval/a.
+    {/step}
+</div>
+```

codeception.yml

@@ -0,0 +1,22 @@
+actor: Tester
+paths:
+    tests: tests
+    log: tests/_output
+    data: tests/_data
+    support: tests/_support
+    envs: tests/_envs
+settings:
+    bootstrap: _bootstrap.php
+    colors: false
+    memory_limit: 1024M
+    reset: true
+extensions:
+    enabled:
+        - Codeception\Extension\RunFailed
+modules:
+    config:
+        Db:
+            dsn: ''
+            user: ''
+            password: ''
+            dump: tests/_data/dump.sql

composer.json

@@ -0,0 +1,12 @@
+{
+  "name": "webchemistry/forms-wizard",
+  "type": "library",
+  "description": "Component for WebChemistry\\Forms\\Form",
+  "keywords": ["nette", "webchemistry", "forms", "wizard"],
+  "require": {
+    "webchemistry/forms": "@dev"
+  },
+  "autoload": {
+    "classmap": ["src/"]
+  }
+}

src/DI/WizardExtension.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace WebChemistry\Forms\Controls\DI;
+
+use Nette\DI\CompilerExtension;
+
+class WizardExtension extends CompilerExtension {
+
+	/**
+	 * Adjusts DI container before is compiled to PHP class. Intended to be overridden by descendant.
+	 *
+	 * @return void
+	 */
+	public function beforeCompile() {
+		$builder = $this->getContainerBuilder();
+
+		$builder->getDefinition('nette.latteFactory')
+				->addSetup('WebChemistry\Forms\Controls\Wizard\Macros::install(?)', array('@self'));
+	}
+
+}

src/Facade.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace WebChemistry\Forms\Controls\Wizard;
+
+use Nette;
+use WebChemistry\Forms\Controls\IWizard;
+use WebChemistry\Forms\Form;
+
+class Facade extends Nette\Object {
+
+	/** @var IWizard */
+	private $wizard;
+
+	/** @var int */
+	private $steps = NULL;
+
+	/**
+	 * @param IWizard $wizard
+	 */
+	public function __construct(IWizard $wizard) {
+		$this->wizard = $wizard;
+	}
+
+	/**
+	 * @return Form
+	 */
+	public function getCurrentComponent() {
+		return $this->wizard->create();
+	}
+
+	/**
+	 * @param int $step
+	 * @return bool
+	 */
+	public function useLink($step) {
+		return !$this->isDisabled($step) && !$this->isCurrent($step);
+	}
+
+	/**
+	 * @param int $step
+	 * @return bool
+	 */
+	public function isCurrent($step) {
+		return $this->getCurrentStep() === $step;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function isSuccess() {
+		return $this->wizard->isSuccess();
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getTotalSteps() {
+		if ($this->steps !== NULL) {
+			return $this->steps;
+		}
+
+		$isEnd = FALSE;
+		$iterator = 1;
+
+		while (!$isEnd) {
+			$component = $this->wizard->getComponent('step' . $iterator, FALSE);
+
+			if ($component) {
+				$iterator++;
+			} else {
+				$isEnd = TRUE;
+			}
+		}
+
+		return $this->steps = $iterator - 1;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getSteps() {
+		return range(1, $this->getTotalSteps());
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function render() {
+		return $this->wizard->render();
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getCurrentStep() {
+		return $this->wizard->getCurrentStep();
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getLastStep() {
+		return $this->wizard->getLastStep();
+	}
+
+	/**
+	 * @param int $step
+	 * @return bool
+	 */
+	public function isActive($step) {
+		return $step === $this->getCurrentStep();
+	}
+
+	/**
+	 * @param int $step
+	 * @return bool
+	 */
+	public function isDisabled($step) {
+		return $step > $this->getLastStep();
+	}
+}

src/IWizard.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace WebChemistry\Forms\Controls;
+
+use Nette\ComponentModel\IComponent;
+use WebChemistry\Forms\Form;
+use WebChemistry\Forms\IProvider;
+
+interface IWizard {
+
+	const PREV_SUBMIT_NAME = 'prev';
+	const NEXT_SUBMIT_NAME = 'next';
+	const FINISH_SUBMIT_NAME = 'finish';
+
+	/**
+	 * @return IWizard
+	 */
+	public function setProvider(IProvider $provider);
+
+	/**
+	 * @return int
+	 */
+	public function getCurrentStep();
+
+	/**
+	 * @return int
+	 */
+	public function getLastStep();
+
+	/**
+	 * @param int $step
+	 * @return IWizard
+	 */
+	public function setStep($step);
+
+	/**
+	 * Returns component specified by name or path.
+	 * @param  string
+	 * @param  bool   throw exception if component doesn't exist?
+	 * @return IComponent|NULL
+	 */
+	public function getComponent($name, $need = TRUE);
+
+	/**
+	 * @return mixed
+	 */
+	public function render();
+
+
+	/**
+	 * @param string $name
+	 * @return Form
+	 */
+	public function create($step = NULL);
+
+	/**
+	 * @return boolean
+	 */
+	public function isSuccess();
+}

src/Macros.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace WebChemistry\Forms\Controls\Wizard;
+
+use Latte\CompileException;
+use Latte\Engine;
+use Latte\Macros\MacroSet;
+use Latte\MacroNode;
+use Latte\PhpWriter;
+use Nette\Bridges\ApplicationLatte\UIMacros;
+use Nette\Utils\Strings;
+
+class Macros extends MacroSet {
+
+	public static function install(Engine $latte) {
+		$me = new self($latte->getCompiler());
+
+		$me->addMacro('wizard', array($me, 'wizardStart'), array($me, 'wizardEnd'));
+		$me->addMacro('step', array($me, 'stepStart'), '}');
+	}
+
+	public function wizardStart(MacroNode $node, PhpWriter $writer) {
+		$words = $node->tokenizer->fetchWords();
+		if (!$words) {
+			throw new CompileException('Missing control name in {wizard}');
+		}
+		$name = $writer->formatWord($words[0]);
+		$method = isset($words[1]) ? ucfirst($words[1]) : '';
+		$method = Strings::match($method, '#^\w*\z#') ? "render$method" : "{\"render$method\"}";
+		$param = $writer->formatArray();
+		if (!Strings::contains($node->args, '=>')) {
+			$param = substr($param, $param[0] === '[' ? 1 : 6, -1); // removes array() or []
+		}
+
+		return ($name[0] === '$' ? "if (is_object($name)) \$_l->tmp = $name; else " : '')
+		. '$_l->tmp = $_control->getComponent(' . $name . '); '
+		. 'if (!$_l->tmp instanceof WebChemistry\Forms\Controls\IWizard) throw new \Exception(\'Wizard must be instance of WebChemistry\Forms\Controls\IWizard\');'
+		. '$wizard = new WebChemistry\Forms\Controls\Wizard\Facade($_l->tmp);';
+	}
+
+	public function stepStart(MacroNode $node, PhpWriter $writer) {
+		$word = $node->tokenizer->fetchWord();
+		if (!is_numeric($word) && !in_array($word, array('success', '"success"', "'success'"))) {
+			throw new CompileException('First parameter in {step} must be a numeric.');
+		}
+
+		if ($word === 'success') {
+			return 'if ($wizard->isSuccess()) {';
+		}
+
+		return 'if ($wizard->getCurrentStep() === ' . $word . ' && !$wizard->isSuccess()) { $wizardForm = $form = $wizard->getCurrentComponent(); ';
+	}
+
+	public function wizardEnd() {}
+}