Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс Entity
+ Граф наследования:Entity:

Открытые члены

 __construct ($component=null)
 
 onIncludeComponentLang ()
 
 onPrepareComponentParams ($params)
 
 executeComponent ()
 
 configureActions ()
 
 getErrorByCode ($code)
 
 getErrors ()
 

Открытые атрибуты

const RESULT_ACTION_TYPE_NONE = 'none'
 
const RESULT_ACTION_TYPE_EVENT = 'event'
 
const RESULT_ACTION_TYPE_CALLBACK = 'callback'
 
const RESULT_ACTION_TYPE_CLASS_METHOD = 'method'
 
const RESULT_ACTION_TYPE_SLIDER = 'slider'
 
const RESULT_DATA_TYPE_NONE = 'none'
 
const RESULT_DATA_TYPE_SET = 'set'
 
const RESULT_DATA_TYPE_FILTER = 'filter'
 
const MODE_PAGE = 'page'
 
const MODE_DIALOG = 'dialog'
 
const MODE_SLIDER = 'slider'
 
const STORAGE_GRID = 'GRID'
 
const STORAGE_GRID_FILTER = 'GRID_FILTER'
 
const STORAGE_ENTITY_IBLOCK = 'IBLOCK_SETTINGS'
 
- Открытые атрибуты унаследованные от Controllerable
const METHOD_ACTION_SUFFIX = 'Action'
 

Защищенные члены

 prepareNodeIds (array &$params)
 
 useImplicitPageNavigation ()
 
 isUsedImplicitPageNavigation ()
 
 disableGridFilter ()
 
 isUsedGridFilter ()
 
 setUseMode ($mode)
 
 getUseMode ()
 
 isPageMode ()
 
 isDialogWindowMode ()
 
 isSliderMode ()
 
 initResultDescription ()
 
 isUsedSliderFilter ()
 
 initEntitySettings ()
 
 checkModules ()
 
 prepareRequest ()
 
 initDefaultSettings ()
 
 getDefaultGridId ()
 
 initSettings ()
 
 prepareResult ()
 
 initClientScope ()
 
 getClientExtensions ()
 
 getClientStyles ()
 
 fillStorageNode ($node, array $nodeValues)
 
 getStorageNode ($node)
 
 setStorageItem ($node, $item, $value)
 
 getStorageItem ($node, $item)
 
 getShowXmlId ()
 
 getGridId ()
 
 getFilterId ()
 
 getNavigationId ()
 
 getPageSizes ()
 
 initGrid ()
 
 initGridConfig ()
 
 initGridColumns ()
 
 initGridPageNavigation ()
 
 getGridNavigationParams ()
 
 getGridFilterDefinition ()
 
 getQuickSearchField ()
 
 getQuickSearchDescription ()
 
 getGridColumnsDescription ()
 
 getUserGridColumnIds ()
 
 getColumns ()
 
 getVisibleColumns ()
 
 initGridOrder ()
 
 modifyGridOrder (array $order)
 
 initGridFilter ()
 
 initGridFilterConfig ()
 
 initGridFilterSettings ()
 
 initGridFilterCurrentPreset ()
 
 prepareGridFilterCurrentPreset ()
 
 getDataOrder ()
 
 getDataFields ()
 
 getDataFilter ()
 
 getDataTitleField ()
 
 getInternalFilter ()
 
 getUserFilter ()
 
 prepareUserFilter ()
 
 compileUserFilter (array $filter)
 
 getData ()
 
 setImplicitNavigationData (\CDBResult $iterator)
 
 getNavigationTitle ()
 
 getGridRows ()
 
 getBinaryDictionary ()
 
 getRowAction (array $row)
 
 getSliderResultDataSet (array $row)
 

Защищенные статические члены

static createFilterId ($gridId)
 
static createNavigationId ($gridId)
 
static isGridFilterRow (array $row)
 
static clearStringValue (string $value)
 
static validateSingleParameter (array &$params, string $field)
 
static validateListParameters (array &$params, array $list)
 

Защищенные данные

 $useMode = self::MODE_PAGE
 
 $errorCollection = null
 
 $gridConfig = null
 
 $storage = []
 
 $defaultSettings = []
 
 $rows = []
 
 $navigation = null
 
 $navigationString = ''
 
 $implicitPageNavigation = false
 
 $useGridFilter = true
 
 $gridFilterConfig = null
 
 $resultAction
 
 $resultActionMap
 

Подробное описание

См. определение в файле entity.php строка 9

Конструктор(ы)

◆ __construct()

__construct ( $component = null)

Base constructor.

Аргументы
\CBitrixComponent | null$componentComponent object if exists.

См. определение в файле entity.php строка 86

Методы

◆ checkModules()

checkModules ( )
protected
Возвращает
void

См. определение в файле entity.php строка 410

◆ clearStringValue()

static clearStringValue ( string $value)
staticprotected

Clear id value.

Аргументы
string$value
Возвращает
string

См. определение в файле entity.php строка 1749

◆ compileUserFilter()

compileUserFilter ( array $filter)
protected
Аргументы
array$filter
Возвращает
array

См. определение в файле entity.php строка 1284

◆ configureActions()

configureActions ( )
Возвращает
array

Замещает Controllerable.

См. определение в файле entity.php строка 172

◆ createFilterId()

static createFilterId ( $gridId)
staticprotected
Аргументы
string$gridId
Возвращает
string

См. определение в файле entity.php строка 442

◆ createNavigationId()

static createNavigationId ( $gridId)
staticprotected
Аргументы
string$gridId
Возвращает
string

См. определение в файле entity.php строка 451

◆ disableGridFilter()

disableGridFilter ( )
protected
Возвращает
void

См. определение в файле entity.php строка 241

◆ executeComponent()

executeComponent ( )
Возвращает
void

См. определение в файле entity.php строка 159

◆ fillStorageNode()

fillStorageNode ( $node,
array $nodeValues )
protected
Аргументы
string$node
array$nodeValues
Возвращает
void

См. определение в файле entity.php строка 642

◆ getBinaryDictionary()

getBinaryDictionary ( )
protected
Возвращает
array

См. определение в файле entity.php строка 1687

◆ getClientExtensions()

getClientExtensions ( )
protected
Возвращает
array

См. определение в файле entity.php строка 618

◆ getClientStyles()

getClientStyles ( )
protected
Возвращает
array

См. определение в файле entity.php строка 626

◆ getColumns()

getColumns ( )
protected
Возвращает
array

См. определение в файле entity.php строка 986

◆ getData()

getData ( )
protected
Возвращает
void

См. определение в файле entity.php строка 1598

◆ getDataFields()

getDataFields ( )
protected
Возвращает
array

См. определение в файле entity.php строка 1150

◆ getDataFilter()

getDataFilter ( )
protected
Возвращает
array

См. определение в файле entity.php строка 1163

◆ getDataOrder()

getDataOrder ( )
protected
Возвращает
array

См. определение в файле entity.php строка 1142

◆ getDataTitleField()

getDataTitleField ( )
protected
Возвращает
string

См. определение в файле entity.php строка 1178

◆ getDefaultGridId()

getDefaultGridId ( )
protected
Возвращает
string

См. определение в файле entity.php строка 433

◆ getErrorByCode()

getErrorByCode ( $code)
Аргументы
string$code
Возвращает
Main\Error|null

Замещает Errorable.

См. определение в файле entity.php строка 181

◆ getErrors()

getErrors ( )
Возвращает
array|Main\Error[]

Замещает Errorable.

См. определение в файле entity.php строка 189

◆ getFilterId()

getFilterId ( )
protected
Возвращает
string

См. определение в файле entity.php строка 705

◆ getGridColumnsDescription()

getGridColumnsDescription ( )
protected
Возвращает
array

См. определение в файле entity.php строка 900

◆ getGridFilterDefinition()

getGridFilterDefinition ( )
protected
Возвращает
array

См. определение в файле entity.php строка 818

◆ getGridId()

getGridId ( )
protected
Возвращает
string

См. определение в файле entity.php строка 697

◆ getGridNavigationParams()

getGridNavigationParams ( )
protected
Возвращает
array

См. определение в файле entity.php строка 810

◆ getGridRows()

getGridRows ( )
protected
Возвращает
array

См. определение в файле entity.php строка 1642

◆ getInternalFilter()

getInternalFilter ( )
protected
Возвращает
array

См. определение в файле entity.php строка 1186

◆ getNavigationId()

getNavigationId ( )
protected
Возвращает
string

См. определение в файле entity.php строка 713

◆ getNavigationTitle()

getNavigationTitle ( )
protected
Возвращает
string

См. определение в файле entity.php строка 1634

◆ getPageSizes()

getPageSizes ( )
protected
Возвращает
array

См. определение в файле entity.php строка 721

◆ getQuickSearchDescription()

getQuickSearchDescription ( )
protected
Возвращает
array

См. определение в файле entity.php строка 892

◆ getQuickSearchField()

getQuickSearchField ( )
protected
Возвращает
string|null

См. определение в файле entity.php строка 884

◆ getRowAction()

getRowAction ( array $row)
protected
Аргументы
array$row
Возвращает
string|null

См. определение в файле entity.php строка 1699

◆ getShowXmlId()

getShowXmlId ( )
protected
Возвращает
boolean

См. определение в файле entity.php строка 689

◆ getSliderResultDataSet()

getSliderResultDataSet ( array $row)
protected
Аргументы
array$row
Возвращает
array

См. определение в файле entity.php строка 1729

◆ getStorageItem()

getStorageItem ( $node,
$item )
protected
Аргументы
string$node
string$item
Возвращает
mixed|null

См. определение в файле entity.php строка 679

◆ getStorageNode()

getStorageNode ( $node)
protected
Аргументы
$node
Возвращает
array|null

См. определение в файле entity.php строка 656

◆ getUseMode()

getUseMode ( )
protected
Возвращает
string

См. определение в файле entity.php строка 268

◆ getUserFilter()

getUserFilter ( )
protected
Возвращает
array

См. определение в файле entity.php строка 1199

◆ getUserGridColumnIds()

getUserGridColumnIds ( )
protected
Возвращает
array

См. определение в файле entity.php строка 952

◆ getVisibleColumns()

getVisibleColumns ( )
protected
Возвращает
array

См. определение в файле entity.php строка 994

◆ initClientScope()

initClientScope ( )
protected
Возвращает
void

См. определение в файле entity.php строка 603

◆ initDefaultSettings()

initDefaultSettings ( )
protected
Возвращает
void

См. определение в файле entity.php строка 420

◆ initEntitySettings()

initEntitySettings ( )
protected
Возвращает
void

См. определение в файле entity.php строка 350

◆ initGrid()

initGrid ( )
protected
Возвращает
void

См. определение в файле entity.php строка 731

◆ initGridColumns()

initGridColumns ( )
protected
Возвращает
void

См. определение в файле entity.php строка 750

◆ initGridConfig()

initGridConfig ( )
protected
Возвращает
void

См. определение в файле entity.php строка 742

◆ initGridFilter()

initGridFilter ( )
protected
Возвращает
void

См. определение в файле entity.php строка 1052

◆ initGridFilterConfig()

initGridFilterConfig ( )
protected
Возвращает
void

См. определение в файле entity.php строка 1064

◆ initGridFilterCurrentPreset()

initGridFilterCurrentPreset ( )
protected
Возвращает
void

См. определение в файле entity.php строка 1109

◆ initGridFilterSettings()

initGridFilterSettings ( )
protected
Возвращает
void

См. определение в файле entity.php строка 1072

◆ initGridOrder()

initGridOrder ( )
protected
Возвращает
void

См. определение в файле entity.php строка 1002

◆ initGridPageNavigation()

initGridPageNavigation ( )
protected
Возвращает
void

См. определение в файле entity.php строка 795

◆ initResultDescription()

initResultDescription ( )
protected
Возвращает
void

См. определение в файле entity.php строка 300

◆ initSettings()

initSettings ( )
protected
Возвращает
void

См. определение в файле entity.php строка 459

◆ isDialogWindowMode()

isDialogWindowMode ( )
protected
Возвращает
bool

См. определение в файле entity.php строка 284

◆ isGridFilterRow()

static isGridFilterRow ( array $row)
staticprotected
Аргументы
array$row
Возвращает
bool

См. определение в файле entity.php строка 1738

◆ isPageMode()

isPageMode ( )
protected
Возвращает
bool

См. определение в файле entity.php строка 276

◆ isSliderMode()

isSliderMode ( )
protected
Возвращает
bool

См. определение в файле entity.php строка 292

◆ isUsedGridFilter()

isUsedGridFilter ( )
protected
Возвращает
bool

См. определение в файле entity.php строка 249

◆ isUsedImplicitPageNavigation()

isUsedImplicitPageNavigation ( )
protected
Возвращает
bool

См. определение в файле entity.php строка 233

◆ isUsedSliderFilter()

isUsedSliderFilter ( )
protected
Возвращает
bool

См. определение в файле entity.php строка 338

◆ modifyGridOrder()

modifyGridOrder ( array $order)
protected
Аргументы
array$order
Возвращает
array

См. определение в файле entity.php строка 1044

◆ onIncludeComponentLang()

onIncludeComponentLang ( )
Возвращает
void

См. определение в файле entity.php строка 95

◆ onPrepareComponentParams()

onPrepareComponentParams ( $params)
Аргументы
array$params
Возвращает
array

См. определение в файле entity.php строка 104

◆ prepareGridFilterCurrentPreset()

prepareGridFilterCurrentPreset ( )
protected
Возвращает
array

См. определение в файле entity.php строка 1134

◆ prepareNodeIds()

prepareNodeIds ( array & $params)
protected
Аргументы
array$params
Возвращает
void

См. определение в файле entity.php строка 198

◆ prepareRequest()

prepareRequest ( )
protected
Возвращает
void

См. определение в файле entity.php строка 415

◆ prepareResult()

prepareResult ( )
protected
Возвращает
void

См. определение в файле entity.php строка 494

◆ prepareUserFilter()

prepareUserFilter ( )
protected
Возвращает
array

См. определение в файле entity.php строка 1211

◆ setImplicitNavigationData()

setImplicitNavigationData ( \CDBResult $iterator)
protected
Аргументы
\CDBResult$iterator
Возвращает
void

См. определение в файле entity.php строка 1604

◆ setStorageItem()

setStorageItem ( $node,
$item,
$value )
protected
Аргументы
string$node
string$item
mixed$value
Возвращает
void

См. определение в файле entity.php строка 669

◆ setUseMode()

setUseMode ( $mode)
protected
Аргументы
string$mode
Возвращает
void

См. определение в файле entity.php строка 258

◆ useImplicitPageNavigation()

useImplicitPageNavigation ( )
protected
Возвращает
void

См. определение в файле entity.php строка 225

◆ validateListParameters()

static validateListParameters ( array & $params,
array $list )
staticprotected

Validate list of parameters with dom element id's.

Аргументы
array&$params
array$list
Возвращает
void

См. определение в файле entity.php строка 1779

◆ validateSingleParameter()

static validateSingleParameter ( array & $params,
string $field )
staticprotected

Validate string parameter with dom element id.

Аргументы
array&$params
string$field
Возвращает
void

См. определение в файле entity.php строка 1761

Данные класса

◆ $defaultSettings

$defaultSettings = []
protected

См. определение в файле entity.php строка 39

◆ $errorCollection

$errorCollection = null
protected

См. определение в файле entity.php строка 32

◆ $gridConfig

Main Grid Options $gridConfig = null
protected

См. определение в файле entity.php строка 35

◆ $gridFilterConfig

$gridFilterConfig = null
protected

См. определение в файле entity.php строка 54

◆ $implicitPageNavigation

$implicitPageNavigation = false
protected

См. определение в файле entity.php строка 48

◆ $navigation

UI PageNavigation $navigation = null
protected

См. определение в файле entity.php строка 44

◆ $navigationString

$navigationString = ''
protected

См. определение в файле entity.php строка 46

◆ $resultAction

$resultAction
protected
Инициализатор
= [
'TYPE' => self::RESULT_ACTION_TYPE_NONE,
'NAME' => '',
'DATA_TYPE' => self::RESULT_DATA_TYPE_NONE,
'DATA_SET' => []
]

См. определение в файле entity.php строка 56

◆ $resultActionMap

$resultActionMap
protected
Инициализатор
= [
self::MODE_PAGE => [
self::RESULT_ACTION_TYPE_EVENT,
self::RESULT_ACTION_TYPE_CALLBACK,
self::RESULT_ACTION_TYPE_CLASS_METHOD
],
self::MODE_DIALOG => [
self::RESULT_ACTION_TYPE_EVENT,
self::RESULT_ACTION_TYPE_CALLBACK,
self::RESULT_ACTION_TYPE_CLASS_METHOD
],
self::MODE_SLIDER => [
self::RESULT_ACTION_TYPE_EVENT,
self::RESULT_ACTION_TYPE_CALLBACK,
self::RESULT_ACTION_TYPE_CLASS_METHOD,
self::RESULT_ACTION_TYPE_SLIDER
]
]

См. определение в файле entity.php строка 63

◆ $rows

$rows = []
protected

См. определение в файле entity.php строка 41

◆ $storage

$storage = []
protected

См. определение в файле entity.php строка 37

◆ $useGridFilter

$useGridFilter = true
protected

См. определение в файле entity.php строка 51

◆ $useMode

$useMode = self::MODE_PAGE
protected

См. определение в файле entity.php строка 29

◆ MODE_DIALOG

const MODE_DIALOG = 'dialog'

См. определение в файле entity.php строка 22

◆ MODE_PAGE

const MODE_PAGE = 'page'

См. определение в файле entity.php строка 21

◆ MODE_SLIDER

const MODE_SLIDER = 'slider'

См. определение в файле entity.php строка 23

◆ RESULT_ACTION_TYPE_CALLBACK

const RESULT_ACTION_TYPE_CALLBACK = 'callback'

См. определение в файле entity.php строка 13

◆ RESULT_ACTION_TYPE_CLASS_METHOD

const RESULT_ACTION_TYPE_CLASS_METHOD = 'method'

См. определение в файле entity.php строка 14

◆ RESULT_ACTION_TYPE_EVENT

const RESULT_ACTION_TYPE_EVENT = 'event'

См. определение в файле entity.php строка 12

◆ RESULT_ACTION_TYPE_NONE

const RESULT_ACTION_TYPE_NONE = 'none'

См. определение в файле entity.php строка 11

◆ RESULT_ACTION_TYPE_SLIDER

const RESULT_ACTION_TYPE_SLIDER = 'slider'

См. определение в файле entity.php строка 15

◆ RESULT_DATA_TYPE_FILTER

const RESULT_DATA_TYPE_FILTER = 'filter'

См. определение в файле entity.php строка 19

◆ RESULT_DATA_TYPE_NONE

const RESULT_DATA_TYPE_NONE = 'none'

См. определение в файле entity.php строка 17

◆ RESULT_DATA_TYPE_SET

const RESULT_DATA_TYPE_SET = 'set'

См. определение в файле entity.php строка 18

◆ STORAGE_ENTITY_IBLOCK

const STORAGE_ENTITY_IBLOCK = 'IBLOCK_SETTINGS'

См. определение в файле entity.php строка 27

◆ STORAGE_GRID

const STORAGE_GRID = 'GRID'

См. определение в файле entity.php строка 25

◆ STORAGE_GRID_FILTER

const STORAGE_GRID_FILTER = 'GRID_FILTER'

См. определение в файле entity.php строка 26