1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext;

/**
 * Responsibility: Main form class with all `<form>` configuration, attributes,
 *                 field instances and it's validators. To create any HTML form,
 *                 you need to instantiate this class, configure an id, action 
 *                 and more.
 */
class       Form 
extends     \MvcCore\Controller
implements  \MvcCore\Ext\IForm {

    /**
     * MvcCore Extension - Form - version:
     * Comparison by PHP function version_compare();
     * @see http://php.net/manual/en/function.version-compare.php
     */
    const VERSION = '5.0.0';

    use \MvcCore\Ext\Form\InternalProps;
    use \MvcCore\Ext\Form\ConfigProps;
    use \MvcCore\Ext\Form\GetMethods;
    use \MvcCore\Ext\Form\SetMethods;
    use \MvcCore\Ext\Form\AddMethods;
    use \MvcCore\Ext\Form\FieldMethods;
    use \MvcCore\Ext\Form\Session;
    use \MvcCore\Ext\Form\Csrf;
    use \MvcCore\Ext\Form\Rendering;
    use \MvcCore\Ext\Form\Assets;
    use \MvcCore\Ext\Form\Submitting;

    /**
     * Create \MvcCore\Ext\Form instance.
     * Please don't forget to configure at least $form->Id, $form->Action,
     * any control to work with and finally any button:submit/input:submit
     * to submit the form to any URL defined in $form->Action.
     * @param \MvcCore\Controller|NULL $controller
     * @return void
     */
    public function __construct (\MvcCore\IController $controller = NULL) {
        /** @var $controller \MvcCore\Controller */
        if ($controller === NULL) {
            $controller = \MvcCore\Ext\Form::GetCallerControllerInstance();
            if ($controller === NULL) 
                $controller = \MvcCore\Application::GetInstance()->GetController();
            if ($controller === NULL) $this->throwNewInvalidArgumentException(
                'There was not possible to determinate caller controller, '
                .'where is form instance create. Provide `$controller` instance explicitly '
                .'by first `\MvcCore\Ext\Form::__construct($controller);` argument.'
            );
        }
        $controller->AddChildController($this, $this->id);
        if (static::$jsSupportFilesRootDir === NULL || static::$cssSupportFilesRootDir === NULL) {
            $baseAssetsPath = str_replace('\\', '/', __DIR__) . '/Forms/assets';
            if (static::$jsSupportFilesRootDir === NULL)
                static::$jsSupportFilesRootDir = $baseAssetsPath;
            if (static::$cssSupportFilesRootDir === NULL)
                static::$cssSupportFilesRootDir = $baseAssetsPath;
        }
        if (self::$sessionClass === NULL)
            self::$sessionClass = $this->application->GetSessionClass();
        if (self::$toolClass === NULL)
            self::$toolClass = $this->application->GetToolClass();
    }

    /**
     * Throw new `\InvalidArgumentException` with given
     * error message and append automatically current class name,
     * current form id and form class type.
     * @param string $errorMsg 
     * @throws \InvalidArgumentException 
     */
    protected function throwNewInvalidArgumentException ($errorMsg) {
        $str = '['.get_class().'] ' . $errorMsg . ' ('
            . 'form id: `'.$this->id . '`, '
            . 'form type: `'.get_class($this->form).'`'
        .')';
        throw new \InvalidArgumentException($str);
    }

    /**
     * Initialize the form, check if form is initialized or not and do it only once.
     * Check if any form id exists and exists only once and initialize translation 
     * boolean for better field initializations. This is template method. To define 
     * any fields in custom `\MvcCore\Ext\Form` extended class, do it in custom 
     * extended `Init()` method and call `parent::Init();` as first line inside 
     * your extended `Init()` method.
     * @param bool $submit `TRUE` if form is submitting, `FALSE` otherwise by default.
     * @throws \RuntimeException No form id property defined or Form id `...` already defined.
     * @return \MvcCore\Ext\Form
     */
    public function Init ($submit = FALSE) {
        if ($this->dispatchState > \MvcCore\IController::DISPATCH_STATE_CREATED) 
            return $this;
        parent::Init();
        $this->dispatchState = \MvcCore\IController::DISPATCH_STATE_INITIALIZED;
        if (!$this->id)
            throw new \RuntimeException("No form `id` property defined in `".get_class($this)."`.");
        if (isset(self::$instances[$this->id])) {
            $anotherForm = self::$instances[$this->id];
            if ($anotherForm !== $this)
                throw new \RuntimeException("Form id `".$this->id."` already defined.");
        } else {
            self::$instances[$this->id] = TRUE;
        }
        $this->translate = $this->translator !== NULL && is_callable($this->translator);
        return $this;
    }

    /**
     * Prepare form and it's fields for rendering.
     * 
     * This function is called automatically by rendering process if necessary.
     * But if you need to operate with fields in your controller before rendering
     * with real session values and initialized session errors, you can call this
     * method anytime to prepare form for rendering and operate with anything inside.
     * 
     * - Process all defined fields and call `$field->PreDispatch();`
     *   to prepare all fields for rendering process.
     * - Load any possible error from session and set up
     *   errors into fields and into form object to render them properly.
     * - Load any possible previously submitted and/or stored values
     *   from session and set up form fields with them.
     * 
     * @param bool $submit `TRUE` if form is submitting, `FALSE` otherwise by default.
     * @return \MvcCore\Ext\Form
     */
    public function PreDispatch ($submit = FALSE) {
        if ($this->dispatchState > \MvcCore\IController::DISPATCH_STATE_INITIALIZED) 
            return $this;
        $this->viewEnabled = !$submit;
        parent::PreDispatch(); // code: `if ($this->dispatchState < \MvcCore\IController::DISPATCH_STATE_INITIALIZED) $this->Init();` is executed by parent
        
        $session = & $this->getSession();
        $this->preDispatchLoadErrors($session);
        $this->preDispatchLoadValues($session);

        if ($submit) {
            $this->dispatchState = \MvcCore\IController::DISPATCH_STATE_PRE_DISPATCHED;
            return $this;
        }
        
        foreach ($this->fields as $field) 
            // translate fields if necessary and do any rendering preparation stuff
            $field->PreDispatch();
        
        if ($this->translate && $this->translateTitle && $this->title !== NULL)
            $this->title = $this->Translate($this->title);
        
        $viewClass = $this->viewClass;
        $this->view = $viewClass::CreateInstance()
            ->SetForm($this);
        if ($this->viewScript) 
            $this->view
                ->SetController($this->parentController)
                ->SetView($this->parentController->GetView());
        
        if ($this->csrfEnabled)
            $this->SetUpCsrf();
        
        $this->dispatchState = \MvcCore\IController::DISPATCH_STATE_PRE_DISPATCHED;
        
        return $this;
    }
    
    /**
     * Initialize form errors from session for all fields in `PreDispatch()`
     * lifecycle moment or earlier from method `GetValues()`.
     * @param \MvcCore\Session $session 
     * @return void
     */
    protected function preDispatchLoadErrors (\MvcCore\ISession $session) {
        if (!$session->errors) return;
        foreach ($session->errors as $errorMsgAndFieldNames) {
            list($errorMsg, $fieldNames) = array_merge([], $errorMsgAndFieldNames);
            $this->AddError($errorMsg, $fieldNames);
        }
    }

    /**
     * Initialize values from session for all fields in `PreDispatch()`
     * lifecycle moment or earlier from method `GetValues()`.
     * @param \MvcCore\Session $session 
     * @return void
     */
    protected function preDispatchLoadValues (\MvcCore\ISession $session) {
        if (!$session->values) return;
        foreach ($session->values as $fieldName => $fieldValue) {
            if (!array_key_exists($fieldName, $this->fields)) continue;
            $field = $this->fields[$fieldName];
            $configuredFieldValue = $field->GetValue();
            $multiple = FALSE;
            if ($field instanceof \MvcCore\Ext\Forms\Fields\IMultiple)
                $multiple = $field->GetMultiple() ?: FALSE;
            if (
                $configuredFieldValue === NULL || 
                ($multiple && is_array($configuredFieldValue) && count($configuredFieldValue) === 0)
            ) {
                $this->values[$fieldName] = $fieldValue;
                $field->SetValue($fieldValue);
            }
        }
    }

    /**
     * Translate given string with configured translator and configured language code.
     * @param string $key           A key to translate.
     * @param array $replacements   An array of replacements to process in translated result.
     * @throws \Exception           En exception if translations store is not successful.
     * @return string               Translated key or key itself if there is no key in translations store.
     */
    public function Translate ($key, $replacements = []) {
        return call_user_func_array($this->translator, func_get_args());
    }
}