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: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 639: 640: 641: 642: 643: 644: 645: 646: 647: 648: 649: 650: 651: 652: 653: 654: 655: 656: 657: 658: 659: 660: 661: 662: 663: 664: 665: 666: 667: 668: 669: 670: 671: 672: 673: 674: 675: 676: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: 701: 702: 703: 704: 705: 706: 707: 708: <?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;
interface IField {
/**
* Render label HTML element on the left side from field HTML element.
*/
const LABEL_SIDE_LEFT = 'left';
/**
* Render label HTML element on the right side from field HTML element.
*/
const LABEL_SIDE_RIGHT = 'right';
/**
* Constants used internally and mostly
* in field autofocus setter to define additional
* behaviour for possible duplicate field focus.
*/
const AUTOFOCUS_DUPLICITY_EXCEPTION = 0,
AUTOFOCUS_DUPLICITY_UNSET_OLD_SET_NEW = 1,
AUTOFOCUS_DUPLICITY_QUIETLY_SET_NEW = -1;
/***************************************************************************
* Base Field class *
**************************************************************************/
/**
* Create new form 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\Field
*/
public static function CreateInstance ($cfg = []);
/**
* This INTERNAL method is called from `\MvcCore\Ext\Form` after field
* is added into form instance by `$form->AddField();` method. Do not
* use this method even if you don't develop any form field.
* - 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.
* - Set up translate boolean property.
* @param \MvcCore\Ext\Form $form
* @throws \InvalidArgumentException
* @return \MvcCore\Ext\Forms\Field
*/
public function SetForm (\MvcCore\Ext\IForm $form);
/**
* 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.
* @return void
*/
public function PreDispatch ();
/**
* This INTERNAL method is called from `\MvcCore\Ext\Form`
* in submit processing. Do not use this method even if you
* don't develop form library or any form field.
*
* Submit field value - process raw request value with all
* configured validators and add errors into form if necessary.
* Then return safe processed value by all from validators or `NULL`.
*
* @param array $rawRequestParams Raw request params from MvcCore
* request object based on raw app
* input, `$_GET` or `$_POST`.
* @return string|int|array|NULL
*/
public function Submit (array & $rawRequestParams = []);
/**
* Default implementation for any extended field class to get field specific
* data for validator purposes. If you want to extend any field, you could
* implement this method better and faster. It's only necessary in your
* implementation to return array with keys to be field specific properties
* in camel case and values to be field properties values, which validator
* requires.
* @param array $fieldPropsDefaultValidValues
* @return array
*/
public function & GetValidatorData ($fieldPropsDefaultValidValues = []);
/**
* This INTERNAL method is called from `\MvcCore\Ext\Forms\Field`
* in submit processing. Do not use this method even if you
* don't develop any form field or field validator.
*
* Add form error with given error message containing
* possible replacements for array values.
*
* If there is necessary to translate form elements
* (form has configured property `translator` as `callable`)
* than given error message is translated first before replacing.
*
* Before error message processing for replacements,
* there is automatically assigned into first position into `$errorMsgArgs`
* array (translated) field label or field name and than
* error message is processed for replacements.
*
* If there is given some custom `$replacingCallable` param,
* error message is processed for replacements by custom `$replacingCallable`.
*
* If there is not given any custom `$replacingCallable` param,
* error message is processed for replacements by static `Format()`
* method by configured form view class.
*
* @param string $errorMsg
* @param array $errorMsgArgs
* @param callable $replacingCallable
* @return \MvcCore\Ext\Forms\Field
*/
public function AddValidationError (
$errorMsg = '', array
$errorMsgArgs = [],
callable $replacingCallable = NULL
);
/***************************************************************************
* Getters Field trait *
**************************************************************************/
/**
* Get form field HTML id attribute, completed from form name and field name.
* This value is completed automatically, but you can customize it.
* @return string|NULL
*/
public function GetId ();
/**
* Get form field specific name, used to identify submitted value.
* This value is required for all form fields.
* @return string|NULL
*/
public function GetName ();
/**
* Get form field type, used in `<input type="...">` attribute value.
* Every typed field has it's own string value, but base field type
* `\MvcCore\Ext\Forms\Field` has `NULL`.
* @return string|NULL
*/
public function GetType ();
/**
* Get form field value. It could be string or array, in or float, it depends
* on field implementation. Default value is `NULL`.
* @return string|array|int|float|NULL
*/
public function GetValue ();
/**
* Get form field HTML element css classes strings as array.
* Default value is an empty array to not render HTML `class` attribute.
* @return \string[]
*/
public function & GetCssClasses ();
/**
* Get field title, global HTML attribute, optional.
* @return string|NULL
*/
public function GetTitle ();
/**
* Get collection with field HTML element
* additional attributes by array keys/values.
* There are no system attributes as: `id`, `name`,
* `value`, `readonly`, `disabled`, `class` ...
* Those attributes have it's own configurable
* properties with it's own getters.
* HTML field elements are meant: `<input>,
* <button>, <select>, <textarea> ...`
* Default value is an empty array to not
* render any additional attributes.
* @return array
*/
public function & GetControlAttrs ();
/**
* Get field HTML element additional attribute
* by attribute name and value.
* There are no system attributes as: `id`, `name`,
* `value`, `readonly`, `disabled`, `class` ...
* Those attributes have it's own configurable
* properties with it's own getters.
* HTML field elements are meant: `<input>,
* <button>, <select>, <textarea> ...`
* If attribute doesn't exist, `NULL` is returned.
* @param string $name
* @return mixed
*/
public function GetControlAttr ($name = 'data-*');
/**
* Get list of predefined validator classes ending names or validator instances.
* Validator class must exist in any validators namespace(s) configured by default:
* - `array('\MvcCore\Ext\Forms\Validators\');`
* Or it could exist in any other validators namespaces, configured by method(s):
* - `\MvcCore\Ext\Form::AddValidatorsNamespaces(...);`
* - `\MvcCore\Ext\Form::SetValidatorsNamespaces(...);`
* Every validator class (ending name) or validator instance has to
* implement interface `\MvcCore\Ext\Forms\IValidator` or it could be extended
* from base abstract validator class: `\MvcCore\Ext\Forms\Validator`.
* Every typed field has it's own predefined validators, but you can define any
* validator you want and replace them.
* @return \string[]|\MvcCore\Ext\Forms\Validator[]
*/
public function & GetValidators ();
/**
* Get `TRUE`, if field has configured in it's validators array
* given validator class ending name or validator instance.
* @param string|\MvcCore\Ext\Forms\Validator $validatorNameOrInstance
* @return bool
*/
public function HasValidator ($validatorNameOrInstance);
/**
* Get boolean `TRUE` or string with template relative path
* without `.phtml` or `.php` extension to render
* field by any custom template.
*
* If `TRUE`, path to template is always completed by configured
* `\MvcCore\Ext\Forms\view::SetFieldsDir(...);`
* value, which is `/App/Views/Forms/Fields` by default.
*
* If returned any string with relative path, path is always relative from configured
* `\MvcCore\Ext\Forms\view::SetFieldsDir(...);` value, which is again
* `/App/Views/Forms/Fields` by default.
*
* `FALSE` or `NULL` (`NULL` is default) is returned to render field naturally.
*
* Example:
* ```
* // Render field template prepared in:
* // '/App/Views/Forms/Fields/my-specials/my-field-type.phtml':
*
* \MvcCore\Ext\Forms\View::GetFieldsDir(); // returned by default: 'Forms/Fields'
* $field->GetViewScript(); // returned 'my-specials/my-field-type'
*
* // Or the same by:
* \MvcCore\Ext\Forms\View::GetFieldsDir(); // returned 'Forms/Fields/my-specials'
* $field->GetType(); // returned 'my-field-type'
* $field->GetViewScript(); // returned TRUE
* ```
* @return bool|string|NULL
*/
public function GetViewScript ();
/**
* Get 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->SetJsSupportingFile(...)` 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.
* @return string|NULL
*/
public function GetJsClassName ();
/**
* Get 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.
* @return string|NULL
*/
public function GetJsSupportingFile ();
/**
* Get field supporting css file relative path.
* If you want to use any custom supporting css file
* for any additional purposes for your custom field, you need to
* define path to your css file relatively from configured
* `\MvcCore\Ext\Form::SetCssSupportFilesRootDir(...);` value.
* Than you have to add supporting css 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->SetCssSupportFilesRenderer(...);` method.
* Or you can add your custom supporting css files into response by your
* own and also you can run your helper css also by your own. Is up to you.
* `NULL` by default.
* @return string|NULL
*/
public function GetCssSupportingFile ();
/**
* Get fields (and labels) default templates
* for natural (not customized) field rendering.
* @return array
*/
public static function & GetTemplates ();
/***************************************************************************
* Setters Field trait *
**************************************************************************/
/**
* Set form field HTML id attribute, completed from form name and field name.
* This value is completed automatically, but you can customize it.
* @param string $id
* @return \MvcCore\Ext\Forms\Field
*/
public function SetId ($id = NULL);
/**
* Set form field specific name, used to identify submitted value.
* This value is required for all form fields.
* @requires
* @param string $name
* @return \MvcCore\Ext\Forms\Field
*/
public function SetName ($name = NULL);
/**
* Set form field type, used in `<input type="...">` attribute value.
* Every typed field has it's own string value, but base field type
* `\MvcCore\Ext\Forms\Field` has `NULL`.
* @param string $type
* @return \MvcCore\Ext\Forms\Field
*/
public function SetType ($type = NULL);
/**
* Set form field value. It could be string or array, in or float, it depends
* on field implementation. Default value is `NULL`.
* @param string|array|int|float|NULL $value
* @return \MvcCore\Ext\Forms\Field
*/
public function SetValue ($value);
/**
* Set form field HTML element css classes strings.
* All previously defined css classes will be removed.
* Default value is an empty array to not render HTML `class` attribute.
* You can define css classes as single string, more classes separated
* by space or you can define css classes as array with strings.
* @param string|\string[] $cssClasses
* @return \MvcCore\Ext\Forms\Field
*/
public function SetCssClasses ($cssClasses);
/**
* Set field title, global HTML attribute, optional.
* @param string|NULL $title
* @param boolean|NULL $translateTitle
* @return \MvcCore\Ext\Forms\Field
*/
public function SetTitle ($title, $translateTitle = NULL);
/**
* Add css classes strings for HTML element attribute `class`.
* Given css classes will be added after previously defined css classes.
* Default value is an empty array to not render HTML `class` attribute.
* You can define css classes as single string, more classes separated
* by space or you can define css classes as array with strings.
* @param string|\string[] $cssClasses
* @return \MvcCore\Ext\Forms\Field
*/
public function AddCssClasses ($cssClasses);
/**
* Set collection with field HTML element
* additional attributes by array keys/values.
* Do not use system attributes as: `id`, `name`,
* `value`, `readonly`, `disabled`, `class` ...
* Those attributes have it's own configurable properties
* by setter methods or by constructor config array.
* HTML field elements are meant: `<input>,
* <button>, <select>, <textarea> ...`
* Default value is an empty array to not
* render any additional attributes.
* All previously defined additional field attributes
* will be replaced by given array.
* @param array $attrs
* @return \MvcCore\Ext\Forms\Field
*/
public function SetControlAttrs (array $attrs = []);
/**
* Set field HTML element additional attribute
* by attribute name and value.
* Do not use system attributes as: `id`, `name`,
* `value`, `readonly`, `disabled`, `class` ...
* Those attributes have it's own configurable properties
* by setter methods or by constructor config array.
* HTML field elements are meant: `<input>,
* <button>, <select>, <textarea> ...`
* Given additional field attribute will be directly
* set into additional attributes array and any
* previous attribute with the same name will be overwritten.
* @param string $name
* @param mixed $value
* @return \MvcCore\Ext\Forms\Field
*/
public function SetControlAttr ($name, $value);
/**
* Add (and merge) collection with field HTML element
* additional attributes by array keys/values.
* Do not use system attributes as: `id`, `name`,
* `value`, `readonly`, `disabled`, `class` ...
* Those attributes have it's own configurable properties
* by setter methods or by constructor config array.
* HTML field elements are meant: `<input>,
* <button>, <select>, <textarea> ...`.
* All given additional field attributes
* will be merged with previously defined attributes.
* @param array $attrs
* @return \MvcCore\Ext\Forms\Field
*/
public function AddControlAttrs (array $attrs = []);
/**
* Set list of predefined validator classes ending names or validator instances.
* Validator class must exist in any validators namespace(s) configured by default:
* - `array('\MvcCore\Ext\Forms\Validators\');`
* Or it could exist in any other validators namespaces, configured by method(s):
* - `\MvcCore\Ext\Form::AddValidatorsNamespaces(...);`
* - `\MvcCore\Ext\Form::SetValidatorsNamespaces(...);`
* Every given validator class (ending name) or given validator instance has to
* implement interface `\MvcCore\Ext\Forms\IValidator` or it could be extended
* from base abstract validator class: `\MvcCore\Ext\Forms\Validator`.
* Every typed field has it's own predefined validators, but you can define any
* validator you want and replace them.
* @param \string[]|\MvcCore\Ext\Forms\Validator[] $validatorsNamesOrInstances
* @return \MvcCore\Ext\Forms\Field
*/
public function SetValidators (array $validatorsNamesOrInstances = []);
/**
* Add list of predefined validator classes ending names or validator instances.
* Validator class must exist in any validators namespace(s) configured by default:
* - `array('\MvcCore\Ext\Forms\Validators\');`
* Or it could exist in any other validators namespaces, configured by method(s):
* - `\MvcCore\Ext\Form::AddValidatorsNamespaces(...);`
* - `\MvcCore\Ext\Form::SetValidatorsNamespaces(...);`
* Every given validator class (ending name) or given validator instance has to
* implement interface `\MvcCore\Ext\Forms\IValidator` or it could be extended
* from base abstract validator class: `\MvcCore\Ext\Forms\Validator`.
* Every typed field has it's own predefined validators, but you can define any
* validator you want and replace them.
* @param \string[]|\MvcCore\Ext\Forms\Validator[] $validatorsNamesOrInstances,...
* @return \MvcCore\Ext\Forms\Field
*/
public function AddValidators ($validatorsNamesOrInstances = []);
/**
* Remove predefined validator by given class ending name or by given validator instance.
* Validator class must exist in any validators namespace(s) configured by default:
* - `array('\MvcCore\Ext\Forms\Validators\');`
* Or it could exist in any other validators namespaces, configured by method(s):
* - `\MvcCore\Ext\Form::AddValidatorsNamespaces(...);`
* - `\MvcCore\Ext\Form::SetValidatorsNamespaces(...);`
* Every given validator class (ending name) or given validator instance has to
* implement interface `\MvcCore\Ext\Forms\IValidator` or it could be extended
* from base abstract validator class: `\MvcCore\Ext\Forms\Validator`.
* Every typed field has it's own predefined validators, but you can define any
* validator you want and replace them.
* @param \string[]|\MvcCore\Ext\Forms\Validator[] $validatorNameOrInstance,...
* @return \MvcCore\Ext\Forms\Field
*/
public function RemoveValidator ($validatorNameOrInstance);
/**
* Set boolean `TRUE` or string with template relative path
* without `.phtml` or `.php` extension, if you want to render
* field by any custom template.
*
* If `TRUE` given, path to template
* is completed by configured `\MvcCore\Ext\Forms\view::SetFieldsDir(...);`
* value, which is `/App/Views/Forms/Fields` by default.
*
* If any string with relative path given, path must be relative from configured
* `\MvcCore\Ext\Forms\view::SetFieldsDir(...);` value, which is again
* `/App/Views/Forms/Fields` by default.
*
* To render field naturally, set `FALSE`, empty string or `NULL` (`NULL` is default).
*
* Example:
* ```
* // To render field template prepared in:
* // '/App/Views/Forms/Fields/my-specials/my-field-type.phtml':
*
* \MvcCore\Ext\Forms\View::SetFieldsDir('Forms/Fields'); // by default
* $field->SetViewScript('my-specials/my-field-type');
*
* // Or you can do the same by:
* \MvcCore\Ext\Forms\View::SetFieldsDir('Forms/Fields/my-specials');
* $field->SetType('my-field-type');
* ```
* @param bool|string|NULL $boolOrViewScriptPath
* @return \MvcCore\Ext\Forms\Field
*/
public function SetViewScript ($boolOrViewScriptPath = NULL);
/**
* Set 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->SetJsSupportingFile(...)` 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.
* @param string $jsClass
* @return \MvcCore\Ext\Forms\Field
*/
public function SetJsClassName ($jsClassName);
/**
* Set 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.
* @param string $jsFullFile
* @return \MvcCore\Ext\Forms\Field
*/
public function SetJsSupportingFile ($jsSupportingFilePath);
/**
* Set field supporting css file relative path.
* If you want to use any custom supporting css file
* for any additional purposes for your custom field, you need to
* define path to your css file relatively from configured
* `\MvcCore\Ext\Form::SetCssSupportFilesRootDir(...);` value.
* Than you have to add supporting css 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->SetCssSupportFilesRenderer(...);` method.
* Or you can add your custom supporting css files into response by your
* own and also you can run your helper css also by your own. Is up to you.
* `NULL` by default.
* @param string $cssFullFile
* @return \MvcCore\Ext\Forms\Field
*/
public function SetCssSupportingFile ($cssSupportingFilePath);
/**
* Set boolean flag about field visible texts and error messages translation.
* This flag is automatically assigned from `$field->form->GetTranslate();`
* flag in `$field->Init();` method.
* @param bool $translate
* @return \MvcCore\Ext\Forms\Field
*/
public function SetTranslate ($translate);
/**
* Add field error message text to render it in rendering process.
* This method is only for rendering purposes, not to add errors
* into session. It's always called internally from `\MvcCore\Ext\Form`
* in render preparing process. To add form error properly,
* use `$field->form->AddError($errorMsg, $fieldNames);` method instead.
* @param string $errorMsg
* @return \MvcCore\Ext\Forms\Field
*/
public function AddError ($errorMsg);
/**
* Set field (or label) default template for natural
* (not customized with `*.phtml` view) field rendering.
* @param string $templateName Template name in array `static::$templates`.
* @param string $templateCode Template HTML code with prepared replacements.
* @return string Newly configured template value.
*/
public static function SetTemplate ($templateName = 'control', $templateCode = '');
/**
* Set fields (and labels) default templates for natural
* (not customized with `*.phtml` view) field rendering.
* @param array|\stdClass $templates
* @return array
*/
public static function SetTemplates ($templates = []);
/***************************************************************************
* Rendering Field trait *
**************************************************************************/
/**
* Render field in full mode (with configured label), naturally or by custom template.
* @return string
*/
public function Render ();
/**
* 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 ();
/**
* 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 ();
/**
* 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 ();
/**
* 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 ();
/**
* 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 ();
/**
* 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 ();
/**
* 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 ();
}