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: 

<?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\Forms\Fields;

/**
 * Responsibility: init, pre-dispatch and render `<button type="reset">`
 *                 with default text `Reset` and it's supporting JS code.
 *                 Button has no validator and no custom result state.
 */
class ResetButton extends \MvcCore\Ext\Forms\Fields\Button {

    /**
     * Possible values: `reset`.
     * @var string
     */
    protected $type = 'reset-button';

    /**
     * Default visible button text - `Reset`.
     * This button text is automatically checked, if there is at least any 
     * visible text and automatically translated, if any translator `callable` 
     * defined in form instance.
     * @var string
     */
    protected $value = 'Reset';

    /**
     * Supporting javascript full javascript class name.
     * If you want to use any custom supporting javascript prototyped class
     * for any additional purposes for your custom field, you need to use
     * `$field->jsSupportingFile` property to define path to your javascript file
     * relatively from configured `\MvcCore\Ext\Form::SetJsSupportFilesRootDir(...);`
     * value. Than you have to add supporting javascript file path into field form 
     * in `$field->PreDispatch();` method to render those files immediately after form
     * (once) or by any external custom assets renderer configured by:
     * `$form->SetJsSupportFilesRenderer(...);` method.
     * Or you can add your custom supporting javascript files into response by your 
     * own and also you can run your helper javascripts also by your own. Is up to you.
     * `NULL` by default.
     * @var string
     */
    protected $jsClassName = 'MvcCoreForm.Reset';

    /**
     * Field supporting javascript file relative path.
     * If you want to use any custom supporting javascript file (with prototyped 
     * class) for any additional purposes for your custom field, you need to 
     * define path to your javascript file relatively from configured 
     * `\MvcCore\Ext\Form::SetJsSupportFilesRootDir(...);` value. 
     * Than you have to add supporting javascript file path into field form 
     * in `$field->PreDispatch();` method to render those files immediately after form
     * (once) or by any external custom assets renderer configured by:
     * `$form->SetJsSupportFilesRenderer(...);` method.
     * Or you can add your custom supporting javascript files into response by your 
     * own and also you can run your helper javascripts also by your own. Is up to you.
     * `NULL` by default.
     * @var string
     */
    protected $jsSupportingFile = \MvcCore\Ext\IForm::FORM_ASSETS_DIR_REPLACEMENT . '/fields/reset.js';

    /**
     * Standard field control natural template string.
     * @var string
     */
    public static $templates = [
        'control'   => '<button id="{id}" name="{name}" type="reset"{attrs}>{value}</button>',
    ];

    /**
     * Create new form `<button type="reset" />` control instance.
     * @param array $cfg Config array with public properties and it's 
     *                   values which you want to configure, presented 
     *                   in camel case properties names syntax.
     * @throws \InvalidArgumentException
     * @return \MvcCore\Ext\Forms\Fields\ButtonInput
     */
    public function __construct (array $cfg = []) {
        parent::__construct($cfg);
        static::$templates = (object) self::$templates;
    }
    
    /**
     * This INTERNAL method is called from `\MvcCore\Ext\Form` just before
     * field is naturally rendered. It sets up field for rendering process.
     * Do not use this method even if you don't develop any form field.
     * - Set up field render mode if not defined.
     * - Translate label text if necessary.
     * - Translate value text if necessary.
     * - Set up tab-index if necessary.
     * - Add supporting javascript file.
     * @return void
     */
    public function PreDispatch () {
        parent::PreDispatch();
        $this->form->AddJsSupportFile(
            $this->jsSupportingFile, $this->jsClassName, [$this->name]
        );
    }
}