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: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: <?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\Field;
/**
* Trait for class `\MvcCore\Ext\Forms\Field` containing field rendering methods.
*/
trait Rendering {
/**
* Render field in full mode (with configured label), naturally or by custom template.
* @return string
*/
public function Render () {
/** @var $this \MvcCore\Ext\Forms\Field */
if ($this->viewScript) {
return $this->RenderTemplate();
} else {
return $this->RenderNaturally();
}
}
/**
* This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering`
* in rendering process. Do not use this method even if you don't develop any form field.
*
* Renders field by configured custom template property `$field->viewScript`.
* This method creates `$view = new \MvcCore\Ext\Form\Core\View();`,
* sets all local context variables into view instance and renders
* configured view instance into result string.
* @return string
*/
public function RenderTemplate () {
/** @var $this \MvcCore\Ext\Forms\Field */
$viewClass = $this->form->GetViewClass();
$formParentController = $this->form->GetParentController();
$view = $viewClass::CreateInstance()
->SetController($formParentController)
->SetView($formParentController->GetView())
->SetForm($this->form)
->SetField($this);
return $view->Render(
$viewClass::GetFieldsDir(),
is_bool($this->viewScript) ? $this->type : $this->viewScript
);
}
/**
* This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering`
* in rendering process. Do not use this method even if you don't develop any form field.
*
* Render field naturally by configured property `$field->renderMode` if any
* or by default render mode without any label. Field should be rendered with
* label beside, label around or without label by local field configuration.
* Also there could be rendered specific field errors before or after field
* if field form is configured in that way.
* @return string
*/
public function RenderNaturally () {
/** @var $this \MvcCore\Ext\Forms\Field */
$result = '';
$renderMode = \MvcCore\Ext\IForm::FIELD_RENDER_MODE_NO_LABEL;
$label = NULL;
if ($this instanceof \MvcCore\Ext\Forms\Fields\ILabel) {
$renderMode = $this->GetRenderMode();
$label = $this->GetLabel();
}
if ($renderMode == \MvcCore\Ext\IForm::FIELD_RENDER_MODE_NORMAL && $label) {
$result = $this->RenderLabelAndControl();
} else if ($renderMode == \MvcCore\Ext\IForm::FIELD_RENDER_MODE_LABEL_AROUND && $label) {
$result = $this->RenderControlInsideLabel();
} else if ($renderMode == \MvcCore\Ext\IForm::FIELD_RENDER_MODE_NO_LABEL || !$label) {
$result = $this->RenderControl();
$errors = $this->RenderErrors();
$formErrorsRenderMode = $this->form->GetErrorsRenderMode();
if ($formErrorsRenderMode !== \MvcCore\Ext\IForm::ERROR_RENDER_MODE_BEFORE_EACH_CONTROL) {
$result = $errors . $result;
} else if ($formErrorsRenderMode !== \MvcCore\Ext\IForm::ERROR_RENDER_MODE_AFTER_EACH_CONTROL) {
$result .= $errors;
}
}
return $result;
}
/**
* This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering`
* in rendering process. Do not use this method even if you don't develop any form field.
*
* Render field control and label by local configuration in left or in right side,
* errors beside if form is configured to render specific errors beside controls.
* @return string
*/
public function RenderLabelAndControl () {
/** @var $this \MvcCore\Ext\Forms\Field */
$result = '';
if ($this->labelSide == \MvcCore\Ext\Forms\IField::LABEL_SIDE_LEFT) {
$result = $this->RenderLabel() . $this->RenderControl();
} else {
$result = $this->RenderControl() . $this->RenderLabel();
}
$errors = $this->RenderErrors();
$formErrorsRenderMode = $this->form->GetErrorsRenderMode();
if ($formErrorsRenderMode == \MvcCore\Ext\IForm::ERROR_RENDER_MODE_BEFORE_EACH_CONTROL) {
$result = $errors . $result;
} else if ($formErrorsRenderMode == \MvcCore\Ext\IForm::ERROR_RENDER_MODE_AFTER_EACH_CONTROL) {
$result .= $errors;
}
return $result;
}
/**
* This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering`
* in rendering process. Do not use this method even if you don't develop any form field.
*
* Render field control inside label by local configuration, render field
* errors beside if form is configured to render specific errors beside controls.
* @return string
*/
public function RenderControlInsideLabel () {
/** @var $this \MvcCore\Ext\Forms\Field */
if ($this->renderMode == \MvcCore\Ext\IForm::FIELD_RENDER_MODE_NO_LABEL)
return $this->RenderControl();
$template = $this->labelSide == \MvcCore\Ext\Forms\IField::LABEL_SIDE_LEFT
? static::$templates->togetherLabelLeft
: static::$templates->togetherLabelRight;
$attrsStr = $this->renderLabelAttrsWithFieldVars();
$formViewClass = $this->form->GetViewClass();
$result = $formViewClass::Format($template, [
'id' => $this->id,
'label' => $this->label,
'control' => $this->RenderControl(),
'attrs' => $attrsStr ? " $attrsStr" : '',
]);
$errors = $this->RenderErrors();
$formErrorsRenderMode = $this->form->GetErrorsRenderMode();
if ($formErrorsRenderMode == \MvcCore\Ext\IForm::ERROR_RENDER_MODE_BEFORE_EACH_CONTROL) {
$result = $errors . $result;
} else if ($formErrorsRenderMode == \MvcCore\Ext\IForm::ERROR_RENDER_MODE_AFTER_EACH_CONTROL) {
$result .= $errors;
}
return $result;
}
/**
* This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering`
* in rendering process. Do not use this method even if you don't develop any form field.
*
* Render control tag only without label or specific errors.
* @return string
*/
public function RenderControl () {
/** @var $this \MvcCore\Ext\Forms\Field */
$attrsStr = $this->renderControlAttrsWithFieldVars();
if (!$this->form->GetFormTagRenderingStatus())
$attrsStr .= (strlen($attrsStr) > 0 ? ' ' : '')
. 'form="' . $this->form->GetId() . '"';
$formViewClass = $this->form->GetViewClass();
return $formViewClass::Format(static::$templates->control, [
'id' => $this->id,
'name' => $this->name,
'type' => $this->type,
'value' => htmlspecialchars_decode(htmlspecialchars($this->value, ENT_QUOTES), ENT_QUOTES),
'attrs' => strlen($attrsStr) > 0 ? ' ' . $attrsStr : '',
]);
}
/**
* This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering`
* in rendering process. Do not use this method even if you don't develop any form field.
*
* Render label tag only without control or specific errors.
* @return string
*/
public function RenderLabel () {
/** @var $this \MvcCore\Ext\Forms\Field */
$renderMode = $this instanceof \MvcCore\Ext\Forms\Fields\ILabel
? $this->GetRenderMode()
: \MvcCore\Ext\IForm::FIELD_RENDER_MODE_NO_LABEL;
if ($renderMode == \MvcCore\Ext\IForm::FIELD_RENDER_MODE_NO_LABEL)
return '';
$attrsStr = $this->renderLabelAttrsWithFieldVars();
$formViewClass = $this->form->GetViewClass();
return $formViewClass::Format(static::$templates->label, [
'id' => $this->id,
'label' => $this->label,
'attrs' => $attrsStr ? " $attrsStr" : '',
]);
}
/**
* This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering`
* in rendering process. Do not use this method even if you don't develop any form field.
*
* Render field specific errors only without control or label.
* @return string
*/
public function RenderErrors () {
/** @var $this \MvcCore\Ext\Forms\Field */
$result = "";
if (
$this->errors &&
$this->form->GetErrorsRenderMode() !== \MvcCore\Ext\IForm::ERROR_RENDER_MODE_ALL_TOGETHER
) {
$result .= '<span class="errors">';
foreach ($this->errors as $key => $errorMessage) {
$errorCssClass = 'error error-' . $this->name . ' error-' . $key;
$result .= "<span class=\"$errorCssClass\">$errorMessage</span>";
}
$result .= '</span>';
}
return $result;
}
/* protected renderers *******************************************************************/
/**
* Complete HTML attributes and css classes strings for label element
* by selected field variables from $this field context
* only if called $fieldVars item in $this field context is
* something different then NULL value.
* Automatically render into attributes and css classes also
* system field properties: 'Disabled', 'Readonly' and 'Required'
* in boolean mode. All named field context properties translate
* into attributes names and css classes strings from PascalCase into
* dashed-case.
* @param string[] $fieldVars
* @return string
*/
protected function renderLabelAttrsWithFieldVars ($fieldVars = []) {
/** @var $this \MvcCore\Ext\Forms\Field */
return $this->renderAttrsWithFieldVars(
$fieldVars, $this->labelAttrs, $this->cssClasses, FALSE
);
}
/**
* Complete HTML attributes and css classes strings for control element
* by selected field variables from $this field context
* only if called $fieldVars item in $this field context is
* something different then NULL value.
* Automatically render into attributes and css classes also
* system field properties: 'Disabled', 'Readonly' and 'Required'
* in boolean mode. All named field context properties translate
* into attributes names and css classes strings from PascalCase into
* dashed-case.
* @param string[] $fieldVars
* @return string
*/
protected function renderControlAttrsWithFieldVars ($fieldVars = []) {
/** @var $this \MvcCore\Ext\Forms\Field */
return $this->renderAttrsWithFieldVars(
$fieldVars, $this->controlAttrs, $this->cssClasses, TRUE
);
}
/**
* Complete HTML attributes and css classes strings for label/control element
* by selected field variables from $this field context
* only if called $fieldVars item in $this field context is
* something different then NULL value.
* Automatically render into attributes and css classes also
* system field properties: 'Disabled', 'Readonly' and 'Required'
* in boolean mode. All named field context properties translate
* into attributes names and css classes strings from PascalCase into
* dashed-case.
* Only if fourth param is false, do not add system attributes in boolean
* mode into attributes, only into css class.
* @param string[] $fieldVars
* @param array $fieldAttrs
* @param array $cssClasses
* @param bool $controlRendering `TRUE` value means control rendering, `FALSE` means label rendering.
* @return string
*/
protected function renderAttrsWithFieldVars (
$fieldVars = [],
$fieldAttrs = [],
$cssClasses = [],
$controlRendering = FALSE
) {
/** @var $this \MvcCore\Ext\Forms\Field */
$attrs = [];
foreach ($fieldVars as $key => $value) {
if (is_numeric($key)) {
$fieldName = $value;
$attrName = strtolower($fieldName);
} else {
$fieldName = $key;
$attrName = strtolower($value);
}
if ($this->{$fieldName} !== NULL) {
if (is_array($this->{$fieldName})) {
$attrs[$attrName] = implode(',', $this->{$fieldName});
} else {
$attrs[$attrName] = (string) $this->{$fieldName};
}
}
}
if ($this instanceof \MvcCore\Ext\Forms\Fields\IVisibleField) {
$boolFieldVars = [
'accessKey' => FALSE,
'autoFocus' => TRUE,
'disabled' => TRUE,
'readOnly' => TRUE,
'required' => TRUE,
];
foreach ($boolFieldVars as $fieldName => $addAlsoAsCssClass) {
if (
isset($this->{$fieldName}) &&
$this->{$fieldName} !== NULL &&
$this->{$fieldName} !== FALSE
) {
$attrName = strtolower($fieldName);
if ($controlRendering) $attrs[$attrName] = $attrName;
if ($addAlsoAsCssClass) $cssClasses[] = $attrName;
}
}
if ($this->tabIndex !== NULL)
$attrs['tabindex'] = $this->tabIndex + $this->form->GetBaseTabIndex();
}
$cssClasses[] = \MvcCore\Tool::GetDashedFromPascalCase($this->name);
$attrs['class'] = implode(' ', array_unique($cssClasses));
$formViewClass = $this->form->GetViewClass();
return $formViewClass::RenderAttrs(
array_merge($fieldAttrs, $attrs)
);
}
}