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: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: <?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 Flídr (https://github.com/mvccore/mvccore)
* @license https://mvccore.github.io/docs/mvccore/4.0.0/LICENCE.md
*/
namespace MvcCore\Ext\Form\Core;
//require_once(__DIR__.'/../Button.php');
//require_once('Helpers.php');
require_once('Field.php');
//include_once('Configuration.php');
//require_once('Validator.php');
//require_once('View.php');
use MvcCore\Ext\Form;
abstract class Base
{
/**
* Initialized state. You can call $form->Init(); method any time you want,
* it automaticly recognize, if it is already initialized or not, but there is
* necessary to call at Init() function begin parent::Init(); call to do it.
* Sometimes you need to work with feelds before rendering outside of form
* and there is necessary to call $form->Init() menthod by yourself, but normaly
* it's called internaly after it is realy needed, so only for render process
* and submit process. This initialization state property has three values:
* 0 - not initialized
* 1 - initialized, but fields are not prepared internaly for rendering
* 2 - all fieds are prepared for rendering (it is processed internaly in
* $form->Render() function, state 2 is not necessary to know.
* @var int
*/
protected $initialized = 0;
/**
* Temporary collection of js files to add after form (directly into html output
* or by external renderer, doesn't metter), this serves only for purposes how to
* determinate to add supporting javascript by field type only once. Keys are relative
* javascript file paths and values are simple dummy booleans.
* @var array
*/
protected static $js = array();
/**
* Temporary collection of css files to add after form (directly into html output
* or by external renderer, doesn't metter), this serves only for purposes how to
* determinate to add supporting css by field type only once. Keys are relative
* css file paths and values are simple dummy booleans.
* @var array
*/
protected static $css = array();
/**
* Simple form javascript assets root directory.
* After \MvcCore\Ext\Form instance is created, this value is completed to library internal
* assets directory. If you want to create any custom field with custom javascript,
* you can do it by loading github package mvccore/simpleform-cusom-js somewhere
* create there any other custom javascript for any custom field and change this value
* to that directory. All supporting javascript for \MvcCore\Ext\Form fields will be loaded from there.
* @var string
*/
protected $jsAssetsRootDir = '';
/**
* Simple form css assets root directory.
* After \MvcCore\Ext\Form instance is created, this value is completed to library internal
* assets directory. If you want to create any custom field with custom css,
* you can do it by creating an empty directory somewhere, by copying every css file from
* library assets directory into it, by creating any other custom css for any custom field
* and by change this value to that directory. All supporting css for \MvcCore\Ext\Form
* fields will be loaded from there.
* @var string
*/
protected $cssAssetsRootDir = '';
/**
* Collection with callable handlers to process anytime CSRF checking cause an error inside form.
* @var array
*/
protected static $csrfErrorHandlers = array();
/**
* Absolutize assets path. Every field has cofigured it's supporting css or js file with
* absolute path replacement inside file path string by '__MVCCORE_FORM_DIR__'.
* Replace now the replacement by prepared properties $form->jsAssetsRootDir or $form->cssAssetsRootDir
* to set path into library assets folder by default or to any other user defined paths.
* @param string $path
* @param string $assetsKey
* @return string
*/
protected function absolutizeAssetPath ($path = '', $assetsKey = '') {
$assetsRootDir = $assetsKey == 'js' ? $this->jsAssetsRootDir : $this->cssAssetsRootDir;
return str_replace(
array('__MVCCORE_FORM_DIR__', '\\'),
array($assetsRootDir, '/'),
$path
);
}
/**
* Clean up after rendering.
* - clean session errors
* @return \MvcCore\Ext\Form|\MvcCore\Ext\Form\Core\Base
*/
protected function cleanUpRenderIfNecessary () {
$this->Errors = array();
include_once('Helpers.php');
Helpers::SetSessionErrors($this->Id, array());
return $this;
}
/**
* Complete css or js supporting files to add after rendered form
* or to add them by external renderer. This function process all
* added assets and filter them to add them finally only one by once.
* @param string $assetsKey
* @return array
*/
protected function completeAssets ($assetsKey = '') {
$files = array();
$assetsKeyUcFirst = ucfirst($assetsKey);
foreach ($this->$assetsKeyUcFirst as $item) {
$files[$this->absolutizeAssetPath($item[0], $assetsKey)] = TRUE;
}
$files = array_keys($files);
foreach ($files as $key => $file) {
if (isset(static::${$assetsKey}[$file])) {
unset($files[$key]);
} else {
static::${$assetsKey}[$file] = TRUE;
}
}
return array_values($files);
}
/**
* Get request path with protocol, domain, port, part but without any possible query string.
* @return string
*/
protected function getRequestPath () {
$requestUri = $_SERVER['REQUEST_URI'];
$lastQuestionMark = mb_strpos($requestUri, '?');
if ($lastQuestionMark !== FALSE) $requestUri = mb_substr($requestUri, 0, $lastQuestionMark);
$protocol = (isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on') ? 'https:' : 'http:';
return $protocol . '//' . $_SERVER['HTTP_HOST'] . $requestUri;
}
/**
* Prepare for rendering.
* - process all defined fields and call $field->setUp();
* to prepare field 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 or stored data
* from session and set up form with them.
* - set initialized state to 2, which means - prepared for rendering
* @return \MvcCore\Ext\Form|\MvcCore\Ext\Form\Core\Base
*/
protected function prepareRenderIfNecessary () {
if ($this->initialized == 2) return $this;
if (!$this->initialized) $this->Init();
foreach ($this->Fields as & $field) {
// translate fields if necessary and do any rendering preparation stuff
$field->SetUp();
}
include_once('Helpers.php');
$errors = Helpers::GetSessionErrors($this->Id);
foreach ($errors as & $errorMsgAndFieldName) {
if (!isset($errorMsgAndFieldName[1])) $errorMsgAndFieldName[1] = '';
list($errorMsg, $fieldName) = $errorMsgAndFieldName;
$this->AddError($errorMsg, $fieldName);
if (isset($this->Fields[$fieldName])) {
// add error classes into settings config where necessary
$fieldInstance = & $this->Fields[$fieldName];
$fieldInstance->AddCssClass('error');
if (method_exists($fieldInstance, 'AddGroupCssClass')) {
$fieldInstance->AddGroupCssClass('error');
}
}
}
$data = Helpers::GetSessionData($this->Id);
if ($data) $this->SetDefaults($data);
include_once('View.php');
$this->View = new View($this);
$this->View->SetUp($this);
$this->initialized = 2;
return $this;
}
/**
* Render supporting js/css file. Add it after renderer form content or call extenal renderer.
* @param string $content
* @param callable $renderer
* @param bool $loadContent
* @param string $absPath
* @return void
*/
protected function renderAssetFile (& $content, & $renderer, $loadContent, $absPath) {
if ($loadContent) {
$content .= trim(file_get_contents($absPath), "\n\r;") . ';';
} else {
call_user_func($renderer, new \SplFileInfo($absPath));
}
}
/**
* Process single field configured validators and add errors where necessary.
* Clean client value to safe value by configured validator classes for this field.
* Return safe value.
* @param string $fieldName
* @param array $rawRequestParams
* @param \MvcCore\Ext\Form\Core\Field $field
* @return string|array
*/
protected function submitField ($fieldName, & $rawRequestParams, \MvcCore\Ext\Form\Core\Field & $field) {
$result = null;
if (!$field->Validators) {
$submitValue = isset($rawRequestParams[$fieldName]) ? $rawRequestParams[$fieldName] : $field->GetValue();
$result = $submitValue;
} else {
include_once('Validator.php');
include_once('Configuration.php');
include_once('View.php');
foreach ($field->Validators as $validatorKey => $validator) {
if ($validatorKey > 0) {
$submitValue = $result; // take previous
} else {
// take submitted or default by SetDefault(array()) call in first verification loop
$submitValue = isset($rawRequestParams[$fieldName]) ? $rawRequestParams[$fieldName] : $field->GetValue();
}
if ($validator instanceof \Closure) {
$safeValue = $validator(
$submitValue, $fieldName, $field, $this
);
} else /*if (gettype($validator) == 'string')*/ {
$validatorInstance = Validator::Create($this, $validator);
$safeValue = $validatorInstance->Validate(
$submitValue, $fieldName, $field
);
}
// set safe value as field submit result value
$result = $safeValue;
}
if (is_null($safeValue)) $safeValue = '';
// add required error message if necessary
if (
(
(gettype($safeValue) == 'string' && strlen($safeValue) === 0) ||
(gettype($safeValue) == 'array' && count($safeValue) === 0)
) && $field->Required
) {
$errorMsg = Configuration::$DefaultMessages[Configuration::REQUIRED];
if ($this->Translate) {
$errorMsg = call_user_func($this->Translator, $errorMsg);
}
$errorMsg = View::Format(
$errorMsg, array($field->Label ? $field->Label : $fieldName)
);
$this->AddError(
$errorMsg, $fieldName
);
}
}
return $result;
}
/**
* Process all fields configured validators and add errors where necessary.
* Clean client values to safe values by configured validator classes for each field.
* After all fields are processed, store clean values and error messages into session
* to use them in any possible future request, where is necessary to fill and submit
* the form again, for example by any error and redirecting to form error url.
* @param array $rawRequestParams
* @return void
*/
protected function submitFields ($rawRequestParams = array()) {
include_once(__DIR__.'/../Button.php');
include_once('Helpers.php');
include_once('Field.php');
foreach ($this->Fields as $fieldName => & $field) {
/** @var $field \MvcCore\Ext\Form\Core\Field */
if ($field->Readonly || $field->Disabled) {
$safeValue = $field->GetValue(); // get by SetDefaults(array()) call
} else {
$safeValue = $this->submitField($fieldName, $rawRequestParams, $field);
}
if (is_null($safeValue)) $safeValue = '';
$field->SetValue($safeValue);
if (!($field instanceof Form\Button)) {
$this->Data[$fieldName] = $safeValue;
}
}
//x($rawRequestParams);
//xxx($this->Data);
Helpers::SetSessionErrors($this->Id, $this->Errors);
Helpers::SetSessionData($this->Id, $this->Data);
}
}