Class AView

Abstract widget

XLite\Base\SuperClass

XLite\Base\Singleton

XLite\Base

XLite\Core\Handler

XLite\View\AView

Direct known subclasses

Indirect known subclasses

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

Methods summary
`abstract protected string`	# `getDefaultTemplate( )` Return widget default template Return widget default template Returns `string` Since 1.0.0 See ____func_see____
`public static array`	# `getAllowedTargets( )` Return list of allowed targets Return list of allowed targets Returns `array` Since 1.0.0 See ____func_see____
`public static array`	# `getTail( )` Get templates tail Get templates tail Returns `array` Since 1.0.0 See ____func_see____
`public mixed`	# `__get( string $name )` Use current controller context Use current controller context Parameters `$name` `string` Property name Returns `mixed` Since 1.0.0 See ____func_see____
`public mixed`	# `__call( string $method, array $args = array() )` Use current controller context Use current controller context Parameters `$method` `string` Method name `$args` `array` Call arguments OPTIONAL Returns `mixed` Since 1.0.0 See ____func_see____
`public`	# `__clone( )` Copy widget params Copy widget params Since 1.0.0 See ____func_see____
`public XLite\View\AView`	# `getWidget( array $params = array(), string $class = null, string $name = null )` Return widget object Return widget object Parameters `$params` `array` Widget params OPTIONAL `$class` `string` Widget class OPTIONAL `$name` `string` Widget class OPTIONAL Returns `XLite\View\AView` Since 1.0.0 See ____func_see____
`public boolean`	# `checkVisibility( )` Check if widget is visible Check if widget is visible Returns `boolean` Since 1.0.0 See ____func_see____
`public`	# `display( )` Attempts to display widget using its template Attempts to display widget using its template Since 1.0.0 See ____func_see____
`public string`	# `getContent( )` Return viewer output Return viewer output Returns `string` Since 1.0.0 See ____func_see____
`public boolean`	# `isDisplayRequired( array $targets )` Check for current target Check for current target Parameters `$targets` `array` List of allowed targets Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `isDisplayRequiredForMode( array $modes )` Check for current mode Check for current mode Parameters `$modes` `array` List of allowed modes Returns `boolean` Since 1.0.0 See ____func_see____
`public XLite\Model\Language`	# `getCurrentLanguage( )` Get current language Get current language Returns `XLite\Model\Language` Since 1.0.0 See ____func_see____
`public mixed`	# `get( string $name )` FIXME - backward compatibility FIXME - backward compatibility Parameters `$name` `string` Property name Returns `mixed` Since 1.0.0 See ____func_see____
`protected string`	# `getTemplate( )` Return current template Return current template Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getTemplateFile( string $template = null )` Return full template file name Return full template file name Parameters `$template` `string` Template file name OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`protected XLite\View\AView`	# `getChildWidget( string $class = null )` Return instance of the child widget Return instance of the child widget Parameters `$class` `string` Child widget class OPTIONAL Returns `XLite\View\AView` Since 1.0.0 See ____func_see____
`protected array`	# `getDefaultModes( )` Return list of the modes allowed by default Return list of the modes allowed by default Returns `array` Since 1.0.0 See ____func_see____
`protected`	# `defineWidgetParams( )` Define widget parameters Define widget parameters Since 1.0.0 See ____func_see____
`protected boolean`	# `checkTarget( )` Check visibility according to the current target Check visibility according to the current target Returns `boolean` Since 1.0.0 See ____func_see____
`protected boolean`	# `checkMode( )` Check if current mode is allowable Check if current mode is allowable Returns `boolean` Since 1.0.0 See ____func_see____
`protected`	# `initView( )` Called before the includeCompiledFile() Called before the includeCompiledFile() Since 1.0.0 See ____func_see____
`protected`	# `closeView( )` Called after the includeCompiledFile() Called after the includeCompiledFile() 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`	# `includeCompiledFile( string $original = null )` Compile and display a template Compile and display a template Parameters `$original` `string` Template file name OPTIONAL Since 1.0.0 See ____func_see____
`protected`	# `getRequestParamValue( string $name )` FIXME - must be removed FIXME - must be removed Parameters `$name` `string` Param name Since 1.0.0 See ____func_see____
`public static array`	# `getRegisteredResources( $type = null )` Return list of all registered resources Return list of all registered resources Returns `array` Since 1.0.0 See ____func_see____
`public static array`	# `getRegisteredMetas( )` Return list of all registered meta tags Return list of all registered meta tags Returns `array` Since 1.0.0 See ____func_see____
`public static array`	# `getRegisteredNamespaces( )` Return list of all registered namespaces Return list of all registered namespaces Returns `array` Since 1.0.0 See ____func_see____
`protected static array`	# `getResourcesSchema( )` Get list of methods, priorities and interfaces for the resources Get list of methods, priorities and interfaces for the resources Returns `array` Since 1.0.13 See ____func_see____
`protected static array`	# `getResourcesTypeSchema( )` Get common schema for an element in the resources list Get common schema for an element in the resources list Returns `array` Since 1.0.13 See ____func_see____
`public array`	# `getCSSFiles( )` Register CSS files Register CSS files Returns `array` Since 1.0.0 See ____func_see____
`public array`	# `getJSFiles( )` Register JS files Register JS files Returns `array` Since 1.0.0 See ____func_see____
`public array`	# `getMetaTags( )` Register Meta tags Register Meta tags Returns `array` Since 1.0.0 See ____func_see____
`public array`	# `getNamespaces( )` Register Meta tags Register Meta tags Returns `array` Since 1.0.0 See ____func_see____
`protected array`	# `getCommonFiles( )` Register files from common repository Register files from common repository Returns `array` Since 1.0.0 See ____func_see____
`protected array`	# `getThemeFiles( )` Return theme common files Return theme common files Returns `array` Since 1.0.13 See ____func_see____
`protected`	# `getResources( )` Return list of widget resources Return list of widget resources Since 1.0.0 See ____func_see____
`protected array`	# `getValidationEngineLanguageResource( )` Return resource structure for validation engine language file. By default there are several ready-to-use language files from validationEngine project. The translation module is able to use its own language validation file. It should decorate this method for this case. Return resource structure for validation engine language file. By default there are several ready-to-use language files from validationEngine project. The translation module is able to use its own language validation file. It should decorate this method for this case. Returns `array` Since 1.0.0 See ____func_see____
`protected string`	# `getValidationEngineLanguageFile( )` Return validation engine language file path. By default there are several ready-to-use language files from validationEngine project. The translation module is able to use its own language validation file. It should decorate this method for this case. Return validation engine language file path. By default there are several ready-to-use language files from validationEngine project. The translation module is able to use its own language validation file. It should decorate this method for this case. Returns `string` Since 1.0.0 See ____func_see____
`protected`	# `registerResourcesForCurrentWidget( )` Register widget resources Register widget resources Since 1.0.0 See ____func_see____
`protected`	# `registerResources( array $resources, initeger $index, string $interface = null )` Common method to register resources Common method to register resources Parameters `$resources` `array` List of resources to register `$index` `initeger` Position in list `$interface` `string` Interface OPTIONAL Since 1.0.13 See ____func_see____
`protected`	# `registerMetas( )` Register meta data Register meta data Since 1.0.15 See ____func_see____
`protected`	# `registerNamespaces( )` Register meta data Register meta data Since 1.0.15 See ____func_see____
`protected array`	# `prepareResource( array $data, string $interface = null )` Common method to register resources Common method to register resources Parameters `$data` `array` Resource description `$interface` `string` Interface OPTIONAL Returns `array` Since 1.0.13 See ____func_see____
`public static`	# `__constructStatic( )` So called "static constructor". NOTE: do not call the "parent::__constructStatic()" explicitly: it will be called automatically So called "static constructor". NOTE: do not call the "parent::__constructStatic()" explicitly: it will be called automatically Since 1.0.0 See ____func_see____
`protected`	# `displayViewListContent( string $list, array $arguments = array() )` Display view list content Display view list content Parameters `$list` `string` List name `$arguments` `array` List common arguments OPTIONAL Since 1.0.0 See ____func_see____
`protected`	# `displayNestedViewListContent( string $part, array $params = array() )` Display a nested view list Display a nested view list Parameters `$part` `string` Suffix that should be appended to the name of a parent list (will be delimited with a dot) `$params` `array` Widget params OPTIONAL Since 1.0.0 See ____func_see____
`protected`	# `displayInheritedViewListContent( string $part, array $params = array() )` Display a inherited view list Display a inherited view list Parameters `$part` `string` Suffix that should be appended to the name of a inherited list (will be delimited with a dot) `$params` `array` Widget params OPTIONAL Since 1.0.0 See ____func_see____
`protected string`	# `getNestedListName( string $part )` Combines the nested list name from the parent list name and a suffix Combines the nested list name from the parent list name and a suffix Parameters `$part` `string` Suffix to be added to the parent list name Returns `string` Since 1.0.0 See ____func_see____
`protected array`	# `getNestedViewList( string $part, array $arguments = array() )` Get a nested view list Get a nested view list Parameters `$part` `string` Suffix of the nested list name `$arguments` `array` List common arguments OPTIONAL Returns `array` Since 1.0.0 See ____func_see____
`protected string`	# `getInheritedListName( string $part )` Combines the inherited list name from the parent list name and a suffix Combines the inherited list name from the parent list name and a suffix Parameters `$part` `string` Suffix to be added to the inherited list name Returns `string` Since 1.0.0 See ____func_see____
`protected array`	# `getInheritedViewList( string $part, array $arguments = array() )` Get a inherited view list Get a inherited view list Parameters `$part` `string` Suffix of the inherited list name `$arguments` `array` List common arguments OPTIONAL Returns `array` Since 1.0.0 See ____func_see____
`public`	# `displayCommentedData( array $data )` Display plain array as JS array Display plain array as JS array Parameters `$data` `array` Plain array Since 1.0.0 See ____func_see____
`public string`	# `formatPrice( float $value, XLite\Model\Currency $currency = null )` Format price Format price Parameters `$value` `float` Price `$currency` `XLite\Model\Currency` Currency OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `formatSize( integer $size )` Format file size Format file size Parameters `$size` `integer` Size in bytes Returns `string` Since 1.0.10 See ____func_see____
`public boolean`	# `isViewListVisible( string $list, array $arguments = array() )` Check - view list is visible or not Check - view list is visible or not Parameters `$list` `string` List name `$arguments` `array` List common arguments OPTIONAL Returns `boolean` Since 1.0.0 See ____func_see____
`protected string`	# `buildListItemClass( string $listName )` Build list item class Build list item class Parameters `$listName` `string` List name Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `formatFileSize( integer $size )` Prepare human-readable output for file size Prepare human-readable output for file size Parameters `$size` `integer` Size in bytes Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `concat( )` concat concat Returns `string` Since 1.0.0 See ____func_see____
`protected boolean`	# `isSelected( mixed $val1, mixed $val2, mixed $val3 = null )` Compares two values Compares two values Parameters `$val1` `mixed` Value 1 `$val2` `mixed` Value 2 `$val3` `mixed` Value 3 OPTIONAL Returns `boolean` Since 1.0.0 See ____func_see____
`protected mixed`	# `getArrayField( array $array, string $field )` Helper to get array field values Helper to get array field values Parameters `$array` `array` Array to get field value `$field` `string` Field name Returns `mixed` Since 1.0.6 See ____func_see____
`protected mixed`	# `getObjectField( object $object, string $field, boolean $isGetter = true )` Helper to get object field values Helper to get object field values Parameters `$object` `object` Object to get field value `$field` `string` Field name `$isGetter` `boolean` Flag OPTIONAL Returns `mixed` Since 1.0.0 See ____func_see____
`protected string`	# `truncate( mixed $base, mixed $field, integer $length = 0, string $etc = '...', mixed $breakWords = false )` Truncates the baseObject property value to specified length Truncates the baseObject property value to specified length Parameters `$base` `mixed` String or object instance to get field value from `$field` `mixed` String length or field to get value `$length` `integer` Field length to truncate to OPTIONAL `$etc` `string` String to add to truncated field value OPTIONAL `$breakWords` `mixed` Word wrap flag OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `formatDate( mixed $base, string $field = null, string $format = null )` Format date Format date Parameters `$base` `mixed` String or object instance to get field value from `$field` `string` Field to get value OPTIONAL `$format` `string` Date format OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `formatTime( mixed $base, string $field = null, string $format = null )` Format timestamp Format timestamp Parameters `$base` `mixed` String or object instance to get field value from `$field` `string` Field to get value OPTIONAL `$format` `string` Date format OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`protected`	# `addSlashes( mixed $base, string $field = null )` Add slashes Add slashes Parameters `$base` `mixed` String or object instance to get field value from `$field` `string` Field to get value OPTIONAL Since 1.0.0 See ____func_see____
`protected boolean`	# `isEmpty( mixed $data )` Check if data is empty Check if data is empty Parameters `$data` `mixed` Data to check Returns `boolean` Since 1.0.0 See ____func_see____
`protected array`	# `split( array $array, integer $count )` Split an array into chunks Split an array into chunks Parameters `$array` `array` Array to split `$count` `integer` Chunks count Returns `array` Since 1.0.0 See ____func_see____
`protected integer`	# `inc( integer $value, integer $inc = 1 )` Increment Increment Parameters `$value` `integer` Value to increment `$inc` `integer` Increment OPTIONAL Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `rand( )` Get random number TODO - rarely used function; probably, should be removed Get random number TODO - rarely used function; probably, should be removed Returns `integer` Since 1.0.0 See ____func_see____
`protected string`	# `getRowClass( integer $row, string $oddCSSClass, string $evenCSSClass = null )` For the "zebra" tables For the "zebra" tables Parameters `$row` `integer` Row index `$oddCSSClass` `string` First CSS class `$evenCSSClass` `string` Second CSS class OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`protected array`	# `getViewList( string $list, array $arguments = array() )` Get view list Get view list Parameters `$list` `string` List name `$arguments` `array` List common arguments OPTIONAL Returns `array` Since 1.0.0 See ____func_see____
`protected array`	# `getViewListChildren( string $list )` getViewListChildren getViewListChildren Parameters `$list` `string` List name Returns `array` Since 1.0.0 See ____func_see____
`protected static string`	# `detectCurrentViewZone( )` Detect current view zone Detect current view zone Returns `string` Since 1.0.0 See ____func_see____
`protected`	# `addViewListChild( array & $list, array $properties, integer $weight = 0 )` addViewListChild addViewListChild Parameters `$list` `array` &$list List to modify `$properties` `array` Node properties `$weight` `integer` Node position OPTIONAL Since 1.0.0 See ____func_see____
`protected array`	# `defineViewList( string $list )` Define view list Define view list Parameters `$list` `string` List name Returns `array` Since 1.0.0 See ____func_see____
`protected string`	# `getViewListClass( )` Get view list class name Get view list class name Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `postprocessContent( string $content )` Content postprocessing Content postprocessing Parameters `$content` `string` Content Returns `string` Since 1.0.0 See ____func_see____
`protected DOMXPath`	# `getXpathByContent( string $content )` Get XPath by content Get XPath by content Parameters `$content` `string` Content Returns `DOMXPath` Since 1.0.0 See ____func_see____
`protected string`	# `getViewListContent( string $list, array $arguments = array() )` Get view list content Get view list content Parameters `$list` `string` List name `$arguments` `array` List common arguments OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`protected DOMNamedNodeMap\|`	# `getViewListContentAsNodes( string $list )` Get view list content as nodes list Get view list content as nodes list Parameters `$list` `string` List name Returns `DOMNamedNodeMap\|` Since 1.0.0 See ____func_see____
`protected string`	# `insertViewListByXpath( string $content, string $query, string $list, string $insertPosition = XLite\View\AView::INSERT_BEFORE )` Insert view list by XPath query Insert view list by XPath query Parameters `$content` `string` Content `$query` `string` XPath query `$list` `string` List name `$insertPosition` `string` Insert position code OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`protected`	# `applyXpathPatches( DOMNamedNodeMap $places, DOMNamedNodeMap $patches, string $baseInsertType )` Apply XPath-based patches Apply XPath-based patches Parameters `$places` `DOMNamedNodeMap` Patch placeholders `$patches` `DOMNamedNodeMap` Patches `$baseInsertType` `string` Patch insert type Since 1.0.0 See ____func_see____
`protected string`	# `insertViewListByPattern( string $content, string $pattern, string $list, string $replace = '%s' )` Insert view list by regular expression pattern Insert view list by regular expression pattern Parameters `$content` `string` Content `$pattern` `string` Pattern (PCRE) `$list` `string` List name `$replace` `string` Replace pattern OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getListName( )` Return internal list name Return internal list name Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getNamePostedData( string $field, integer $id = null )` getNamePostedData getNamePostedData Parameters `$field` `string` Field name `$id` `integer` Model object ID OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getNameToDelete( integer $id )` getNameToDelete getNameToDelete Parameters `$id` `integer` Model object ID Returns `string` Since 1.0.0 See ____func_see____
`protected boolean`	# `isDeveloperMode( )` Checks if specific developer mode is defined Checks if specific developer mode is defined Returns `boolean` Since 1.0.0 See ____func_see____
`protected string`	# `getCurrencySymbol( )` Return currency symbol Return currency symbol Returns `string` Since 1.0.0 See ____func_see____
`public static`	# `removeWidgetFromList( string $name, boolean $isTemplate = true, string $list = null, string $zone = null )` Remove widget from list Remove widget from list Parameters `$name` `string` Class/template name `$isTemplate` `boolean` Flag OPTIONAL `$list` `string` List name OPTIONAL `$zone` `string` Zone name OPTIONAL Since 1.0.17 See ____func_see____

Methods inherited from XLite\Core\Handler
`__construct(), 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`	`RESOURCE_JS`	`'js'`	# Resource types Resource types
`string`	`RESOURCE_CSS`	`'css'`	#
`string`	`PARAM_TEMPLATE`	`'template'`	# Common widget parameter names Common widget parameter names
`string`	`PARAM_MODES`	`'modes'`	#
`string`	`INSERT_BEFORE`	`'before'`	# View list insertation position View list insertation position
`string`	`INSERT_AFTER`	`'after'`	#
`string`	`REPLACE`	`'replace'`	#

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

Properties summary
`protected static integer`	`$countDeep`	`0`	# Deep count Deep count Since 1.0.0 See ____var_see____
`protected static integer`	`$countLevel`	`0`	# Level count Level count Since 1.0.0 See ____var_see____
`protected static array`	`$resources`	`array()`	# Widgets resources collector Widgets resources collector Since 1.0.0 See ____var_see____
`protected static array`	`$metas`	`array()`	# Widgets meta collector Widgets meta collector Since 1.0.0 See ____var_see____
`protected static array`	`$namespaces`	`array()`	# HTML namespaces HTML namespaces Since 1.0.0 See ____var_see____
`protected static array`	`$tail`	`array()`	# Templates tail Templates tail Since 1.0.0 See ____var_see____
`protected boolean`	`$isCloned`	`false`	# isCloned isCloned Since 1.0.0 See ____var_see____
`protected array`	`$namedWidgets`	`array()`	# "Named" widgets cache "Named" widgets cache Since 1.0.0 See ____var_see____
`protected array`	`$viewLists`	`array()`	# View lists (cache) View lists (cache) Since 1.0.0 See ____var_see____

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

Properties inherited from XLite\Base
`$singletons`

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

Namespaces

Classes

Class AView

Direct known subclasses

Indirect known subclasses

Returns

Since

See

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Since

See

Returns

Since

See

Returns

Since

See

Since

See

Since

See

Returns

Since

See