Class AFormField

Abstract form field

XLite\Base\SuperClass

XLite\Base\Singleton

XLite\Base

XLite\Core\Handler

XLite\View\AView

XLite\View\FormField\AFormField

Direct known subclasses

XLite\View\FormField\Input\AInput, XLite\View\FormField\Label\ALabel, XLite\View\FormField\Select\ASelect, XLite\View\FormField\Separator\ASeparator, XLite\View\FormField\Textarea\ATextarea

Indirect known subclasses

Abstract
Namespace: XLite\View\FormField
Since: 1.0.0
See: ____class_see____
Located at XLite/View/FormField/AFormField.php

Methods summary
`abstract public string`	# `getFieldType( )` Return field type Return field type Returns `string` Since 1.0.0 See ____func_see____
`abstract protected string`	# `getFieldTemplate( )` Return field template Return field template Returns `string` Since 1.0.0 See ____func_see____
`public string`	# `getName( )` Return field name Return field name Returns `string` Since 1.0.0 See ____func_see____
`public mixed`	# `getValue( )` Return field value Return field value Returns `mixed` Since 1.0.0 See ____func_see____
`public`	# `setValue( mixed $value )` Set value Set value Parameters `$value` `mixed` Value to set Since 1.0.0 See ____func_see____
`public string`	# `getLabel( )` getLabel getLabel Returns `string` Since 1.0.0 See ____func_see____
`public string`	# `getFieldId( )` Return a value for the "id" attribute of the field input tag Return a value for the "id" attribute of the field input tag Returns `string` Since 1.0.0 See ____func_see____
`public mixed`	# `validate( )` Validate field value Validate field value Returns `mixed` Since 1.0.0 See ____func_see____
`public array`	# `getCSSFiles( )` Get a list of CSS files required to display the widget properly Get a list of CSS files required to display the widget properly Returns `array` Since 1.0.0 See ____func_see____
`public`	# `__construct( array $params = array() )` Save current form reference and sections list, and initialize the cache Save current form reference and sections list, and initialize the cache Parameters `$params` `array` Widget params OPTIONAL Since 1.0.0 See ____func_see____
`public string`	# `getWrapperClass( )` Register CSS class to use for wrapper block (SPAN) of input field. It is usable to make unique changes of the field. Register CSS class to use for wrapper block (SPAN) of input field. It is usable to make unique changes of the field. Returns `string` Since 1.0.1 See ____func_see____
`protected string`	# `getDefaultTemplate( )` Return widget default template Return widget default template Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getDir( )` Return name of the folder with templates Return name of the folder with templates Returns `string` Since 1.0.0 See ____func_see____
`protected boolean`	# `checkSavedValue( )` checkSavedValue checkSavedValue Returns `boolean` Since 1.0.0 See ____func_see____
`protected boolean`	# `getValidityFlag( )` Get validity flag (and run field validation procedire) Get validity flag (and run field validation procedire) Returns `boolean` Since 1.0.0 See ____func_see____
`protected mixed`	# `sanitize( )` Sanitize value Sanitize value Returns `mixed` Since 1.0.13 See ____func_see____
`protected array`	# `getCommonAttributes( )` getCommonAttributes getCommonAttributes Returns `array` Since 1.0.0 See ____func_see____
`protected`	# `setCommonAttributes( array $attrs )` setCommonAttributes setCommonAttributes Parameters `$attrs` `array` Field attributes to prepare Since 1.0.0 See ____func_see____
`protected array`	# `assembleClasses( array $classes )` Assemble classes Assemble classes Parameters `$classes` `array` Classes Returns `array` Since 1.0.13 See ____func_see____
`protected array`	# `assembleValidationRules( )` Assemble validation rules Assemble validation rules Returns `array` Since 1.0.13 See ____func_see____
`protected array`	# `prepareAttributes( array $attrs )` prepareAttributes prepareAttributes Parameters `$attrs` `array` Field attributes to prepare Returns `array` Since 1.0.0 See ____func_see____
`protected boolean`	# `isRequired( )` Check if field is required Check if field is required Returns `boolean` Since 1.0.0 See ____func_see____
`protected array`	# `getAttributes( )` getAttributes getAttributes Returns `array` Since 1.0.0 See ____func_see____
`protected string`	# `getAttributesCode( )` Return HTML representation for widget attributes Return HTML representation for widget attributes Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getInlineJSCode( )` Some JavaScript code to insert Some JavaScript code to insert Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getDefaultName( )` getDefaultName getDefaultName Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getDefaultValue( )` getDefaultValue getDefaultValue Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getDefaultLabel( )` getDefaultLabel getDefaultLabel Returns `string` Since 1.0.0 See ____func_see____
`protected array`	# `getDefaultAttributes( )` Get default attributes Get default attributes Returns `array` Since 1.0.0 See ____func_see____
`protected boolean`	# `getDefaultParamFieldOnly( )` Getter for Field-only flag Getter for Field-only flag Returns `boolean` Since 1.0.0 See ____func_see____
`protected`	# `defineWidgetParams( )` Define widget params Define widget params Since 1.0.0 See ____func_see____
`protected boolean`	# `checkFieldValue( )` Check field value validity Check field value validity Returns `boolean` Since 1.0.0 See ____func_see____
`protected boolean`	# `checkFieldValidity( )` Check field validity Check field validity Returns `boolean` Since 1.0.0 See ____func_see____
`protected string`	# `getRequiredFieldErrorMessage( )` Get required field error message Get required field error message Returns `string` Since 1.0.0 See ____func_see____
`protected boolean`	# `checkFieldAccessability( )` checkFieldAccessability checkFieldAccessability Returns `boolean` Since 1.0.0 See ____func_see____
`protected mixed`	# `callFormMethod( string $method, array $args = array() )` callFormMethod callFormMethod Parameters `$method` `string` Class method to call `$args` `array` Call arguments OPTIONAL Returns `mixed` Since 1.0.0 See ____func_see____
`protected boolean`	# `isVisible( )` Check if widget is visible Check if widget is visible Returns `boolean` Since 1.0.0 See ____func_see____
`protected string`	# `getDefaultWrapperClass( )` Get default wrapper class Get default wrapper class Returns `string` Since 1.0.13 See ____func_see____

Methods inherited from XLite\View\AView
__call(), __clone(), __constructStatic(), __get(), addSlashes(), addViewListChild(), applyXpathPatches(), buildListItemClass(), checkMode(), checkTarget(), checkVisibility(), closeView(), concat(), defineViewList(), detectCurrentViewZone(), display(), displayCommentedData(), displayInheritedViewListContent(), displayNestedViewListContent(), displayViewListContent(), formatDate(), formatFileSize(), formatPrice(), formatSize(), formatTime(), get(), getAllowedTargets(), getArrayField(), getChildWidget(), getCommonFiles(), getContent(), getCurrencySymbol(), getCurrentLanguage(), getDefaultModes(), getInheritedListName(), getInheritedViewList(), getJSFiles(), getListName(), getMetaTags(), getNamePostedData(), getNameToDelete(), getNamespaces(), getNestedListName(), getNestedViewList(), getObjectField(), getRegisteredMetas(), getRegisteredNamespaces(), getRegisteredResources(), getRequestParamValue(), getResources(), getResourcesSchema(), getResourcesTypeSchema(), getRowClass(), getTail(), getTemplate(), getTemplateFile(), getThemeFiles(), getValidationEngineLanguageFile(), getValidationEngineLanguageResource(), getViewList(), getViewListChildren(), getViewListClass(), getViewListContent(), getViewListContentAsNodes(), getWidget(), getXpathByContent(), inc(), includeCompiledFile(), initView(), insertViewListByPattern(), insertViewListByXpath(), isDeveloperMode(), isDisplayRequired(), isDisplayRequiredForMode(), isEmpty(), isSelected(), isViewListVisible(), postprocessContent(), prepareResource(), rand(), registerMetas(), registerNamespaces(), registerResources(), registerResourcesForCurrentWidget(), removeWidgetFromList(), split(), truncate()

Methods inherited from XLite\Core\Handler
`buildFullURL(), buildURL(), buildURLArguments(), buildURLPath(), getParam(), getParamsHash(), getPostedData(), getPrefixPostedData(), getPrefixSelected(), getRequestDataByPrefix(), getSelected(), getWidgetParams(), getWidgetSettings(), getWidgetSettingsFilter(), init(), isExported(), setWidgetParams(), validateAttributes()`

Methods inherited from XLite\Base
`getComplex(), is(), isComplex(), set(), setComplex(), setProperties()`

Methods inherited from XLite\Base\Singleton
`getInstance(), resetInstance()`

Methods inherited from XLite\Base\SuperClass
`doDie(), t()`

Constants summary
`string`	`PARAM_VALUE`	`'value'`	# Widget param names Widget param names
`string`	`PARAM_REQUIRED`	`'required'`	#
`string`	`PARAM_ATTRIBUTES`	`'attributes'`	#
`string`	`PARAM_NAME`	`'fieldName'`	#
`string`	`PARAM_ID`	`'fieldId'`	#
`string`	`PARAM_LABEL`	`'label'`	#
`string`	`PARAM_COMMENT`	`'comment'`	#
`string`	`PARAM_HELP`	`'help'`	#
`string`	`PARAM_FIELD_ONLY`	`'fieldOnly'`	#
`string`	`PARAM_WRAPPER_CLASS`	`'wrapperClass'`	#
`string`	`PARAM_IS_ALLOWED_FOR_CUSTOMER`	`'isAllowedForCustomer'`	#
`string`	`FIELD_TYPE_LABEL`	`'label'`	# Available field types Available field types
`string`	`FIELD_TYPE_TEXT`	`'text'`	#
`string`	`FIELD_TYPE_PASSWORD`	`'password'`	#
`string`	`FIELD_TYPE_SELECT`	`'select'`	#
`string`	`FIELD_TYPE_CHECKBOX`	`'checkbox'`	#
`string`	`FIELD_TYPE_RADIO`	`'radio'`	#
`string`	`FIELD_TYPE_TEXTAREA`	`'textarea'`	#
`string`	`FIELD_TYPE_SEPARATOR`	`'separator'`	#

Constants inherited from XLite\View\AView
`INSERT_AFTER, INSERT_BEFORE, PARAM_MODES, PARAM_TEMPLATE, REPLACE, RESOURCE_CSS, RESOURCE_JS`

Constants inherited from XLite\Core\Handler
`PARAM_AJAX_TARGET, PARAM_AJAX_WIDGET, PARAM_DUMP_STARTED, PARAM_IS_EXPORTED, PARAM_SILENT`

Properties summary
`protected string`	`$name`	`null`	# name name Since 1.0.0 See ____var_see____
`protected boolean`	`$validityFlag`	`null`	# validityFlag validityFlag Since 1.0.0 See ____var_see____
`protected boolean`	`$isAllowedForCustomer`	`true`	# Determines if this field is visible for customers or not Determines if this field is visible for customers or not Since 1.0.0 See ____var_see____
`protected string`	`$errorMessage`		# Error message Error message Since 1.0.13 See ____var_see____

Properties inherited from XLite\View\AView
`$countDeep, $countLevel, $isCloned, $metas, $namedWidgets, $namespaces, $resources, $tail, $viewLists`

Properties inherited from XLite\Core\Handler
`$widgetParams`

Properties inherited from XLite\Base
`$singletons`

Properties inherited from XLite\Base\Singleton
`$instances`

Namespaces

Classes

Class AFormField

Direct known subclasses

Indirect known subclasses

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Parameters

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Parameters

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Parameters

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns