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: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: <?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;
include_once(__DIR__.'/../../Form.php');
require_once('Field.php');
//require_once('Exception.php');
//require_once('View.php');
abstract class FieldGroup extends Field
{
/**
* Form group pseudo control type,
* unique type accross all form field types.
* @var string
*/
public $Type = '';
/**
* Form control value,
* always as array of string or
* numbers for group of controls.
* @var array
*/
public $Value = array();
/**
* Form group control options to render
* more subcontrol attributes for specified
* submitted values (array keys).
* This property configuration is required.
* Examples:
*
* To configure radio buttons named: 'gender' for 'Female' and 'Male':
* <label for="gender-f">Female:</label>
* <input id="gender-f" type="radio" name="gender" value="f" />
* <label for="gender-m">Male:</label>
* <input id="gender-m" type="radio" name="gender" value="m" />
* use configuration:
* $field->Id = 'gender';
* $field->Options = array(
* 'f' => 'Female',
* 'm' => 'Male',
* );
*
* To configure radio buttons named: 'gender' for 'Female' and 'Male':
* <label for="gender-f" class="female">Female:</label>
* <input id="gender-f" type="radio" name="gender" value="f" class="female" data-any="female-values" />
* <label for="gender-m" class="male">Male:</label>
* <input id="gender-m" type="radio" name="gender" value="m" class="male" data-any="male-values" />
* use configuration:
* $field->Id = 'gender';
* $field->Options = array(
* 'f' => array(
* 'text' => 'Female',
* 'class' => 'female',
* 'attrs' => array('data-any' => 'female-values'),
* ),
* 'm' => array(
* 'text' => 'Male',
* 'class' => 'male',
* 'attrs' => array('data-any' => 'male-values'),
* ),
* );
* @requires
* @var array
*/
public $Options = array();
/**
* Css class for group label.
* @var string[]
*/
public $GroupCssClasses = array();
/**
* Any additional attributes for group label, defined
* as key (for attribute name) and value (for attribute value).
* @var string[]
*/
public $GroupLabelAttrs = array();
/**
* Internal common templates how to render field group elements naturaly.
* @var array|\stdClass
*/
public static $Templates = array(
'label' => '<label for="{id}"{attrs}>{label}</label>',
'control' => '<input id="{id}" name="{name}" type="{type}" value="{value}"{checked}{attrs} />',
'togetherLabelLeft' => '<label for="{id}"{attrs}><span>{label}</span>{control}</label>',
'togetherLabelRight'=> '<label for="{id}"{attrs}>{control}<span>{label}</span></label>',
);
/* setters *******************************************************************************/
/**
* Set form group control options to render
* more values for more specified submitted keys.
* Examples:
*
* To configure radio buttons named: 'gender' for 'Female' and 'Male':
* <label for="gender-f">Female:</label>
* <input id="gender-f" type="radio" name="gender" value="f" />
* <label for="gender-m">Male:</label>
* <input id="gender-m" type="radio" name="gender" value="m" />
* use configuration:
* $field->SetId('gender')
* ->SetOptions(array(
* // field values will be translated if configured
* 'f' => 'Female',
* 'm' => 'Male',
* ));
*
* To configure radio buttons named: 'gender' for 'Female' and 'Male':
* <label for="gender-f" class="female">Female:</label>
* <input id="gender-f" type="radio" name="gender" value="f" class="female" data-any="female-values" />
* <label for="gender-m" class="male">Male:</label>
* <input id="gender-m" type="radio" name="gender" value="m" class="male" data-any="male-values" />
* use configuration:
* $field->SetId('gender')
* ->SetOptions(array(
* 'f' => array(
* 'text' => 'Female', // text keys will be translated if configured
* 'class' => 'female',
* 'attrs' => array('data-any' => 'female-values'),
* ),
* 'm' => array(
* 'text' => 'Male', // text keys will be translated if configured
* 'class' => 'male',
* 'attrs' => array('data-any' => 'male-values'),
* ),
* ));
* @param array $options
*/
public function SetOptions ($options) {
$this->Options = $options;
return $this;
}
/**
* Set css class(es) for group label,
* as array of strings or string with classes
* separated by space.
* @var string|string[]
*/
public function SetGroupCssClasses ($cssClasses) {
if (gettype($cssClasses) == 'array') {
$this->GroupCssClasses = $cssClasses;
} else {
$this->GroupCssClasses = explode(' ', (string)$cssClasses);
}
return $this;
}
/**
* Add css class(es) for group label,
* as array of strings or string with classes
* separated by space.
* @var string|string[]
*/
public function AddGroupCssClass ($cssClasses) {
if (gettype($cssClasses) == 'array') {
$groupCssClasses = $cssClasses;
} else {
$groupCssClasses = explode(' ', (string)$cssClasses);
}
$this->GroupCssClasses = array_merge($this->GroupCssClasses, $groupCssClasses);
return $this;
}
/**
* Set any additional attributes for group label, defined
* as key (for attribute name) and value (for attribute value).
* Any previously defined attributes will be replaced.
* @var string[]
*/
public function SetGroupLabelAttrs ($attrs = array()) {
$this->GroupLabelAttrs = $attrs;
return $this;
}
/**
* Add any additional attributes for group label, defined
* as key (for attribute name) and value (for attribute value).
* All additional attributes will be completed as array merge
* with previous values and new values.
* @var string[]
*/
public function AddGroupLabelAttr ($attr = array()) {
$this->GroupLabelAttrs = array_merge($this->GroupLabelAttrs, $attr);
return $this;
}
/* core methods **************************************************************************/
/*
// use this constructor in extended class to merge control or label automatic templates
public function __construct(array $cfg = array()) {
parent::__construct($cfg);
static::$Templates = (object) array_merge((array)parent::$Templates, (array)self::$Templates);
}
*/
/**
* This method is called internaly from \MvcCore\Ext\Form after field
* is added into form by $form->AddField(); method. Do not use it
* if you are only user of this library.
* - check if there are any options for current controls group
* Parent method:
* - check if field has any name, which is required
* - set up form and field id attribute by form id and field name
* - set up required
* @param \MvcCore\Ext\Form $form
* @throws \MvcCore\Ext\Form\Core\Exception
* @return void
*/
public function OnAdded (\MvcCore\Ext\Form & $form) {
parent::OnAdded($form);
if (!$this->Options) {
$clsName = get_class($this);
include_once('Exception.php');
throw new \MvcCore\Ext\Form\Core\Exception("No 'Options' defined for form field: '$clsName'.");
}
}
/**
* Set up field properties before rendering process.
* - translate all option texts
* Parent method:
* - set up field render mode
* - set up translation boolean
* - translate label if any
* @return void
*/
public function SetUp () {
parent::SetUp();
if (!$this->Translate) return;
$lang = $this->Form->Lang;
$translator = $this->Form->Translator;
foreach ($this->Options as $key => $value) {
if (gettype($value) == 'string') {
// most simple key/value array options configuration
if ($value) $this->Options[$key] = call_user_func($translator, (string)$value, $lang);
} else if (gettype($value) == 'array') {
// advanced configuration with key, text, css class, and any other attributes for single option tag
$optObj = (object) $value;
$text = isset($optObj->text) ? $optObj->text : $key;
if ($text) {
$this->Options[$key]['text'] = call_user_func($translator, (string)$text, $lang);
}
}
}
}
/* rendering ******************************************************************************/
/**
* Render field naturaly by render mode.
* Field shoud 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 () {
$result = '';
if (
$this->Label && (
$this->RenderMode == \MvcCore\Ext\Form::FIELD_RENDER_MODE_NORMAL ||
$this->RenderMode == \MvcCore\Ext\Form::FIELD_RENDER_MODE_LABEL_AROUND
)
) {
$result = $this->RenderLabelAndControl();
} else if ($this->RenderMode == \MvcCore\Ext\Form::FIELD_RENDER_MODE_NO_LABEL || !$this->Label) {
$result = $this->RenderControl();
$errors = $this->RenderErrors();
if ($this->Form->ErrorsRenderMode == \MvcCore\Ext\Form::ERROR_RENDER_MODE_BEFORE_EACH_CONTROL) {
$result = $errors . $result;
} else if ($this->Form->ErrorsRenderMode == \MvcCore\Ext\Form::ERROR_RENDER_MODE_AFTER_EACH_CONTROL) {
$result .= $errors;
}
}
return $result;
}
/**
* 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 () {
if ($this->RenderMode == \MvcCore\Ext\Form::FIELD_RENDER_MODE_NO_LABEL) return $this->RenderControl();
$attrsStr = $this->renderAttrsWithFieldVars(
array(), $this->GroupLabelAttrs, $this->GroupCssClasses, TRUE
);
$template = $this->LabelSide == 'left' ? static::$Templates->togetherLabelLeft : static::$Templates->togetherLabelRight;
include_once('View.php');
$result = View::Format($template, array(
'id' => $this->Id,
'label' => $this->Label,
'control' => $this->RenderControl(),
'attrs' => $attrsStr ? " $attrsStr" : '',
));
$errors = $this->RenderErrors();
if ($this->Form->ErrorsRenderMode == \MvcCore\Ext\Form::ERROR_RENDER_MODE_BEFORE_EACH_CONTROL) {
$result = $errors . $result;
} else if ($this->Form->ErrorsRenderMode == \MvcCore\Ext\Form::ERROR_RENDER_MODE_AFTER_EACH_CONTROL) {
$result .= $errors;
}
return $result;
}
/**
* Render all subcontrols by multiple calls of $field->RenderControlItem();
* @return string
*/
public function RenderControl () {
$result = '';
foreach ($this->Options as $key => $value) {
$result .= $this->RenderControlItem($key, $value);
}
return $result;
}
/**
* Render label tag only without control or specific errors.
* @return string
*/
public function RenderLabel () {
if ($this->RenderMode == \MvcCore\Ext\Form::FIELD_RENDER_MODE_NO_LABEL) return '';
$attrsStr = $this->renderAttrsWithFieldVars(
array(), $this->GroupLabelAttrs, $this->GroupCssClasses
);
include_once('View.php');
return View::Format(static::$Templates->label, array(
'id' => $this->Id,
'label' => $this->Label,
'attrs' => $attrsStr ? " $attrsStr" : '',
));
}
/**
* Render subcontrols with each subcontrol label tag
* and without group label or without group specific errors.
* @return string
*/
public function RenderControlItem ($key, $option) {
$result = '';
$itemControlId = implode(\MvcCore\Ext\Form::HTML_IDS_DELIMITER, array(
$this->Form->Id, $this->Name, $key
));
list(
$itemLabelText,
$labelAttrsStr,
$controlAttrsStr
) = $this->renderControlItemCompleteAttrsClassesAndText($key, $option);
// render control, render label and put it together if necessary
$checked = FALSE;
if (gettype($this->Value) == 'array') {
$checked = in_array($key, $this->Value);
} else {
$checked = $this->Value === $key;
}
include_once('View.php');
$itemControl = View::Format(static::$Templates->control, array(
'id' => $itemControlId,
'name' => $this->Name,
'type' => $this->Type,
'value' => $key,
'checked' => $checked ? ' checked="checked"' : '',
'attrs' => $controlAttrsStr ? " $controlAttrsStr" : '',
));
if ($this->RenderMode == \MvcCore\Ext\Form::FIELD_RENDER_MODE_NORMAL) {
// control and label
$itemLabel = View::Format(static::$Templates->label, array(
'id' => $itemControlId,
'label' => $itemLabelText,
'attrs' => $labelAttrsStr ? " $labelAttrsStr" : '',
));
$result = ($this->LabelSide == 'left') ? $itemControl . $itemLabel : $itemLabel . $itemControl;
} else if ($this->RenderMode == \MvcCore\Ext\Form::FIELD_RENDER_MODE_LABEL_AROUND) {
// control inside label
$result = View::Format(
static::$Templates->{'togetherLabel' . (($this->LabelSide == 'left') ? 'Right' : 'Left')},
array(
'id' => $itemControlId,
'label' => $itemLabelText,
'control' => $itemControl,
'attrs' => $labelAttrsStr ? " $labelAttrsStr" : '',
)
);
}
return $result;
}
/* protected renderers *******************************************************************/
/**
* Complete by $field->Options key and option value:
* - label text
* - label attributes string
* - control attributes string
* @param string $key
* @param string|array $option
* @return array
*/
protected function renderControlItemCompleteAttrsClassesAndText ($key, $option) {
$optionType = gettype($option);
$labelAttrsStr = '';
$controlAttrsStr = '';
$itemLabelText = '';
$originalRequired = $this->Required;
if ($this->Type == 'checkbox') $this->Required = FALSE;
if ($optionType == 'string') {
$itemLabelText = $option ? $option : $key;
$labelAttrsStr = $this->renderLabelAttrsWithFieldVars();
$controlAttrsStr = $this->renderControlAttrsWithFieldVars();
} else if ($optionType == 'array') {
$itemLabelText = $option['text'] ? $option['text'] : $key;
$attrsArr = $this->ControlAttrs;
$classArr = $this->CssClasses;
if (isset($option['attrs']) && gettype($option['attrs']) == 'array') {
$attrsArr = array_merge($this->ControlAttrs, $option['attrs']);
}
if (isset($option['class'])) {
$classArrParam = array();
if (gettype($option['class']) == 'array') {
$classArrParam = $option['class'];
} else if (gettype($option['class']) == 'string') {
$classArrParam = explode(' ', $option['class']);
}
foreach ($classArrParam as $clsValue) if ($clsValue) $classArr[] = $clsValue;
}
$labelAttrsStr = $this->renderAttrsWithFieldVars(
array(), $attrsArr, $classArr
);
$controlAttrsStr = $this->renderAttrsWithFieldVars(
array(), $attrsArr, $classArr, TRUE
);
}
if ($this->Type == 'checkbox') $this->Required = $originalRequired;
return array($itemLabelText, $labelAttrsStr, $controlAttrsStr);
}
}