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: 

<?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: define getter and setter for property `customResultState` (`int`)
 *                 to have custom submit result state, for all types of submit 
 *                 buttons and inputs.
 * Interface for classes:
 * - `\MvcCore\Ext\Form`
 *    - `\MvcCore\Ext\Form\FieldMethods`
 *    - `\MvcCore\Ext\Form\Submitting`
 * - `\MvcCore\Ext\Forms\Fields\Image`
 * - `\MvcCore\Ext\Forms\Fields\SubmitButton`
 * - `\MvcCore\Ext\Forms\Fields\SubmitInput`
 */
interface ISubmit {

    /**
     * Get submit button custom result state to move submit request to custom specific target url.
     * There are already build in result states:
     * - `0` (`\MvcCore\Ext\IForm::RESULT_ERRORS`)      - to move submit request to configured error url.
     * - `1` (`\MvcCore\Ext\IForm::RESULT_SUCCESS`)     - to move submit request to configured success url.
     * - `2` (`\MvcCore\Ext\IForm::RESULT_PREV_PAGE`)       - to move submit request to configured previous step url.
     * - `3` (`\MvcCore\Ext\IForm::RESULT_NEXT_PAGE`)       - to move submit request to configured next step url.
     * If you define any new custom result state for your submit button (`4`, `5` ...), 
     * you have to implement `$form->SubmittedRedirect();` method by your own to redirect
     * user submit request by this state to your own specific target url.
     * @return int|NULL
     */
    public function GetCustomResultState ();

    /**
     * Set submit button custom result state to move submit request to custom specific target url.
     * There are already build in result states:
     * - `0` (`\MvcCore\Ext\IForm::RESULT_ERRORS`)      - to move submit request to configured error url.
     * - `1` (`\MvcCore\Ext\IForm::RESULT_SUCCESS`)     - to move submit request to configured success url.
     * - `2` (`\MvcCore\Ext\IForm::RESULT_PREV_PAGE`)       - to move submit request to configured previous step url.
     * - `3` (`\MvcCore\Ext\IForm::RESULT_NEXT_PAGE`)       - to move submit request to configured next step url.
     * If you define any new custom result state for your submit button (`4`, `5` ...), 
     * you have to implement `$form->SubmittedRedirect();` method by your own to redirect
     * user submit request by this state to your own specific target url.
     * @param int|NULL $customResultState 
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetCustomResultState ($customResultState = \MvcCore\Ext\IForm::RESULT_NEXT_PAGE);
}