Class Form

Responsibility: Main form class with all <form> configuration, attributes, field instances and it's validators. To create any HTML form, you need to instantiate this class, configure an id, action and more.

MvcCore\Controller implements MvcCore\IController uses MvcCore\Controller\Props, MvcCore\Controller\GettersSetters, MvcCore\Controller\Dispatching, MvcCore\Controller\Rendering

MvcCore\Ext\Form implements MvcCore\Ext\IForm uses MvcCore\Ext\Form\InternalProps, MvcCore\Ext\Form\ConfigProps, MvcCore\Ext\Form\GetMethods, MvcCore\Ext\Form\SetMethods, MvcCore\Ext\Form\AddMethods, MvcCore\Ext\Form\FieldMethods, MvcCore\Ext\Form\Session, MvcCore\Ext\Form\Csrf, MvcCore\Ext\Form\Rendering, MvcCore\Ext\Form\Assets, MvcCore\Ext\Form\Submitting

Direct known subclasses

MvcCore\Ext\Auths\Basics\SignInForm, MvcCore\Ext\Auths\Basics\SignOutForm

Namespace: MvcCore\Ext
Located at ext-form/src/MvcCore/Ext/Form.php

Methods summary
`public`	# `__construct( MvcCore\IController $controller = NULL )` Create \MvcCore\Ext\Form instance. Please don't forget to configure at least $form->Id, $form->Action, any control to work with and finally any button:submit/input:submit to submit the form to any URL defined in $form->Action. Create \MvcCore\Ext\Form instance. Please don't forget to configure at least $form->Id, $form->Action, any control to work with and finally any button:submit/input:submit to submit the form to any URL defined in $form->Action. Parameters `$controller`
`protected`	# `throwNewInvalidArgumentException( string $errorMsg )` Throw new `\InvalidArgumentException` with given error message and append automatically current class name, current form id and form class type. Throw new `\InvalidArgumentException` with given error message and append automatically current class name, current form id and form class type. Parameters `$errorMsg` Throws InvalidArgumentException
`public MvcCore\Ext\Form`	# `Init( boolean $submit = FALSE )` Initialize the form, check if form is initialized or not and do it only once. Check if any form id exists and exists only once and initialize translation boolean for better field initializations. This is template method. To define any fields in custom `\MvcCore\Ext\Form` extended class, do it in custom extended `Init()` method and call `parent::Init();` as first line inside your extended `Init()` method. Initialize the form, check if form is initialized or not and do it only once. Check if any form id exists and exists only once and initialize translation boolean for better field initializations. This is template method. To define any fields in custom `\MvcCore\Ext\Form` extended class, do it in custom extended `Init()` method and call `parent::Init();` as first line inside your extended `Init()` method. Parameters `$submit` `TRUE` if form is submitting, `FALSE` otherwise by default. Returns `MvcCore\Ext\Form` Throws RuntimeException No form id property defined or Form id `...` already defined. Overrides `MvcCore\Controller\Dispatching::Init()` Implementation of `MvcCore\Ext\IForm::Init()`
`public MvcCore\Ext\Form`	# `PreDispatch( boolean $submit = FALSE )` Prepare form and it's fields for rendering. Prepare form and it's fields for rendering. This function is called automatically by rendering process if necessary. But if you need to operate with fields in your controller before rendering with real session values and initialized session errors, you can call this method anytime to prepare form for rendering and operate with anything inside. Process all defined fields and call `$field->PreDispatch();` to prepare all fields 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 and/or stored values from session and set up form fields with them. Parameters `$submit` `TRUE` if form is submitting, `FALSE` otherwise by default. Returns `MvcCore\Ext\Form` Overrides `MvcCore\Controller\Dispatching::PreDispatch()` Implementation of `MvcCore\Ext\IForm::PreDispatch()`
`protected`	# `preDispatchLoadErrors( MvcCore\ISession $session )` Initialize form errors from session for all fields in `PreDispatch()` lifecycle moment or earlier from method `GetValues()`. Initialize form errors from session for all fields in `PreDispatch()` lifecycle moment or earlier from method `GetValues()`. Parameters `$session`
`protected`	# `preDispatchLoadValues( MvcCore\ISession $session )` Initialize values from session for all fields in `PreDispatch()` lifecycle moment or earlier from method `GetValues()`. Initialize values from session for all fields in `PreDispatch()` lifecycle moment or earlier from method `GetValues()`. Parameters `$session`
`public string`	# `Translate( string $key, array $replacements = [] )` Translate given string with configured translator and configured language code. Translate given string with configured translator and configured language code. Parameters `$key` A key to translate. `$replacements` An array of replacements to process in translated result. Returns string Translated key or key itself if there is no key in translations store. Throws Exception En exception if translations store is not successful. Implementation of `MvcCore\Ext\IForm::Translate()`

Methods inherited from MvcCore\IController
AddChildController(), AssetAction(), AssetUrl(), CreateInstance(), Dispatch(), GetActionName(), GetApplication(), GetCallerControllerInstance(), GetChildController(), GetChildControllers(), GetConfig(), GetControllerName(), GetEnvironment(), GetLayout(), GetParam(), GetParentController(), GetRenderMode(), GetRequest(), GetResponse(), GetRouter(), GetSessionNamespace(), GetSystemConfig(), GetUser(), GetView(), GetViewEnabled(), GetViewScriptPath(), GetViewScriptsPath(), HtmlResponse(), IsAjax(), JsonResponse(), JsonpResponse(), Redirect(), Render(), RenderError(), RenderNotFound(), SetActionName(), SetApplication(), SetChildControllers(), SetControllerName(), SetEnvironment(), SetIsAjax(), SetLayout(), SetParentController(), SetRenderMode(), SetRequest(), SetResponse(), SetRouter(), SetUser(), SetView(), SetViewEnabled(), SetViewScriptsPath(), Terminate(), TextResponse(), Url(), XmlResponse(), __toString()

Methods inherited from MvcCore\Ext\IForm
AddAcceptCharset(), AddCsrfErrorHandler(), AddCssClasses(), AddCssSupportFile(), AddError(), AddField(), AddFields(), AddJsSupportFile(), AddValidatorsNamespaces(), ClearSession(), ConvertBytesFromHumanForm(), ConvertBytesIntoHumanForm(), GetAcceptCharsets(), GetAction(), GetAttributes(), GetAutoComplete(), GetAutoFocusedFormField(), GetBaseTabIndex(), GetById(), GetCsrf(), GetCssClasses(), GetCssSupportFiles(), GetCssSupportFilesRenderer(), GetCssSupportFilesRootDir(), GetDefaultErrorMsg(), GetDefaultFieldsRenderMode(), GetDefaultRequired(), GetEnctype(), GetErrorUrl(), GetErrors(), GetErrorsRenderMode(), GetField(), GetFieldNextAutoTabIndex(), GetFields(), GetFieldsByPhpClass(), GetFieldsByType(), GetFirstFieldByPhpClass(), GetFirstFieldByType(), GetFormTagRenderingStatus(), GetId(), GetJsSupportFiles(), GetJsSupportFilesRenderer(), GetJsSupportFilesRootDir(), GetLang(), GetLocale(), GetMethod(), GetNextStepUrl(), GetNoValidate(), GetPhpIniSizeLimit(), GetPrevStepUrl(), GetResult(), GetSessionExpiration(), GetSuccessUrl(), GetTarget(), GetTitle(), GetTranslate(), GetTranslator(), GetValidator(), GetValidatorsNamespaces(), GetValues(), GetViewClass(), GetViewScript(), HasField(), ProcessCsrfErrorHandlersQueue(), RemoveField(), RenderBegin(), RenderContent(), RenderEnd(), RenderErrors(), RenderSupportingCss(), RenderSupportingJs(), SaveSession(), SetAcceptCharsets(), SetAction(), SetAttributes(), SetAutoComplete(), SetAutoFocusedFormField(), SetBaseTabIndex(), SetCssClasses(), SetCssSupportFiles(), SetCssSupportFilesRenderer(), SetCssSupportFilesRootDir(), SetDefaultFieldsRenderMode(), SetDefaultRequired(), SetEnableCsrf(), SetEnctype(), SetErrorUrl(), SetErrors(), SetErrorsRenderMode(), SetFields(), SetFormTagRenderingStatus(), SetId(), SetJsSupportFiles(), SetJsSupportFilesRenderer(), SetJsSupportFilesRootDir(), SetLang(), SetLocale(), SetMethod(), SetNextStepUrl(), SetNoValidate(), SetPrevStepUrl(), SetResult(), SetSessionExpiration(), SetSuccessUrl(), SetTarget(), SetTitle(), SetTranslator(), SetUpCsrf(), SetValidatorsNamespaces(), SetValues(), SetViewClass(), SetViewScript(), Submit(), SubmitAllFields(), SubmitCsrfTokens(), SubmitSetStartResultState(), SubmitValidateMaxPostSizeIfNecessary(), SubmittedRedirect()

Methods used from MvcCore\Ext\Form\GetMethods
ConvertBytesFromHumanForm(), ConvertBytesIntoHumanForm(), GetAcceptCharsets(), GetAction(), GetAttributes(), GetAutoComplete(), GetAutoFocusedFormField(), GetBaseTabIndex(), GetById(), GetCssClasses(), GetCssSupportFiles(), GetCssSupportFilesRenderer(), GetCssSupportFilesRootDir(), GetDefaultFieldsRenderMode(), GetDefaultRequired(), GetEnctype(), GetErrorUrl(), GetErrors(), GetErrorsRenderMode(), GetFieldNextAutoTabIndex(), GetFormTagRenderingStatus(), GetId(), GetJsSupportFiles(), GetJsSupportFilesRenderer(), GetJsSupportFilesRootDir(), GetLang(), GetLocale(), GetMethod(), GetNextStepUrl(), GetNoValidate(), GetPhpIniSizeLimit(), GetPrevStepUrl(), GetResult(), GetSessionExpiration(), GetSuccessUrl(), GetTarget(), GetTitle(), GetTranslate(), GetTranslator(), GetValidatorsNamespaces(), GetValues(), GetViewClass(), GetViewScript()

Methods used from MvcCore\Ext\Form\SetMethods
SetAcceptCharsets(), SetAction(), SetAttributes(), SetAutoComplete(), SetAutoFocusedFormField(), SetBaseTabIndex(), SetCssClasses(), SetCssSupportFiles(), SetCssSupportFilesRenderer(), SetCssSupportFilesRootDir(), SetDefaultFieldsRenderMode(), SetDefaultRequired(), SetEnctype(), SetErrorUrl(), SetErrors(), SetErrorsRenderMode(), SetFormTagRenderingStatus(), SetId(), SetJsSupportFiles(), SetJsSupportFilesRenderer(), SetJsSupportFilesRootDir(), SetLang(), SetLocale(), SetMethod(), SetNextStepUrl(), SetNoValidate(), SetPrevStepUrl(), SetResult(), SetSessionExpiration(), SetSuccessUrl(), SetTarget(), SetTitle(), SetTranslator(), SetValidatorsNamespaces(), SetValues(), SetViewClass(), SetViewScript()

Methods used from MvcCore\Ext\Form\AddMethods
`AddAcceptCharset(), AddCsrfErrorHandler(), AddCssClasses(), AddCssSupportFile(), AddError(), AddJsSupportFile(), AddValidatorsNamespaces()`

Methods used from MvcCore\Ext\Form\FieldMethods
`AddField(), AddFields(), GetField(), GetFields(), GetFieldsByPhpClass(), GetFieldsByType(), GetFirstFieldByPhpClass(), GetFirstFieldByType(), HasField(), RemoveField(), SetFields()`

Methods used from MvcCore\Ext\Form\Session
`ClearSession(), SaveSession(), getSession()`

Methods used from MvcCore\Ext\Form\Csrf
`GetCsrf(), ProcessCsrfErrorHandlersQueue(), SetEnableCsrf(), SetUpCsrf(), SubmitCsrfTokens()`

Methods used from MvcCore\Ext\Form\Rendering
`Render(), RenderBegin(), RenderContent(), RenderEnd(), RenderErrors(), RenderSupportingCss(), RenderSupportingJs(), cleanSessionErrorsAfterRender()`

Methods used from MvcCore\Ext\Form\Assets
`absolutizeSupportingFilePath(), completeSupportingFilesToRender(), renderSupportingFile()`

Methods used from MvcCore\Ext\Form\Submitting
`GetDefaultErrorMsg(), GetValidator(), Submit(), SubmitAllFields(), SubmitSetStartResultState(), SubmitValidateMaxPostSizeIfNecessary(), SubmittedRedirect(), encodeAcceptCharsetsArrayOrString(), encodeAcceptCharsetsString(), submitAllFieldsEncodeAcceptCharsets()`

Methods used from MvcCore\Controller\GettersSetters
AssetUrl(), GetActionName(), GetApplication(), GetChildController(), GetChildControllers(), GetConfig(), GetControllerName(), GetEnvironment(), GetLayout(), GetParam(), GetParentController(), GetRenderMode(), GetRequest(), GetResponse(), GetRouter(), GetSystemConfig(), GetUser(), GetView(), GetViewEnabled(), GetViewScriptsPath(), IsAjax(), SetActionName(), SetApplication(), SetChildControllers(), SetControllerName(), SetEnvironment(), SetIsAjax(), SetLayout(), SetParentController(), SetRenderMode(), SetRequest(), SetResponse(), SetRouter(), SetUser(), SetView(), SetViewEnabled(), SetViewScriptsPath(), Url()

Methods used from MvcCore\Controller\Dispatching
`AddChildController(), AssetAction(), CreateInstance(), Dispatch(), GetCallerControllerInstance(), GetSessionNamespace(), Redirect(), Terminate(), autoInitializeProperties(), autoInitializeProperty()`

Methods used from MvcCore\Controller\Rendering
`GetViewScriptPath(), HtmlResponse(), JsonResponse(), JsonpResponse(), RenderError(), RenderNotFound(), TextResponse(), XmlResponse(), __toString(), renderWithObFromActionToLayout(), renderWithoutObContinuously()`

Constants summary
`string`	`VERSION` MvcCore Extension - Form - version: Comparison by PHP function version_compare(); MvcCore Extension - Form - version: Comparison by PHP function version_compare(); See http://php.net/manual/en/function.version-compare.php	# `'5.0.0'`

Constants inherited from MvcCore\Controller\IConstants
`DISPATCH_STATE_ACTION_EXECUTED, DISPATCH_STATE_CREATED, DISPATCH_STATE_INITIALIZED, DISPATCH_STATE_PRE_DISPATCHED, DISPATCH_STATE_RENDERED, DISPATCH_STATE_TERMINATED`

Constants inherited from MvcCore\Ext\Form\IConstants
`ENCTYPE_MULTIPART, ENCTYPE_PLAINTEXT, ENCTYPE_URLENCODED, ERROR_RENDER_MODE_AFTER_EACH_CONTROL, ERROR_RENDER_MODE_ALL_TOGETHER, ERROR_RENDER_MODE_BEFORE_EACH_CONTROL, FIELD_RENDER_MODE_LABEL_AROUND, FIELD_RENDER_MODE_NORMAL, FIELD_RENDER_MODE_NO_LABEL, FORM_ASSETS_DIR_REPLACEMENT, HTML_IDS_DELIMITER, METHOD_GET, METHOD_POST, RESULT_ERRORS, RESULT_NEXT_PAGE, RESULT_PREV_PAGE, RESULT_SUCCESS`

Properties used from MvcCore\Controller\Props
`$_assetsMimeTypes, $actionName, $ajax, $allControllers, $application, $autoInitProperties, $autoStartSession, $childControllers, $controllerName, $dispatchState, $environment, $layout, $parentController, $renderMode, $request, $response, $router, $staticPath, $tmpPath, $user, $view, $viewEnabled, $viewScriptsPath`

Properties used from MvcCore\Ext\Form\InternalProps
`$allCssSupportFiles, $allFormsSessions, $allJsSupportFiles, $csrfErrorHandlers, $customResultStates, $defaultErrorMessages, $fieldsAutoTabIndex, $fileSizeUnits, $formTagRendergingStatus, $instances, $jsBaseSupportFile, $sessionClass, $submitFields, $toolClass, $translate, $validators`

Properties used from MvcCore\Ext\Form\ConfigProps
$acceptCharsets, $action, $attributes, $autoComplete, $autoFocusedFormField, $baseTabIndex, $csrfEnabled, $cssClasses, $cssSupportFiles, $cssSupportFilesRenderer, $cssSupportFilesRootDir, $defaultFieldsRenderMode, $defaultRequired, $enctype, $errorUrl, $errors, $errorsRenderMode, $fields, $id, $jsSupportFiles, $jsSupportFilesRenderer, $jsSupportFilesRootDir, $lang, $locale, $method, $nextStepUrl, $noValidate, $prevStepUrl, $result, $sessionExpiration, $successUrl, $target, $title, $translateTitle, $translator, $validatorsNamespaces, $values, $viewClass, $viewScript

Magic properties used from MvcCore\Ext\Form\Rendering
`$view`

Classes

Interfaces

Traits

Exceptions

Functions

Class Form

Direct known subclasses

Parameters

Parameters

Throws

Parameters

Returns

Throws

Overrides

Implementation of

Parameters

Returns

Overrides

Implementation of

Parameters

Parameters

Parameters

Returns

Throws

Implementation of

See