Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс FieldType

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

 __construct (array $property, array $documentType, $typeClass, array $documentId=null)
 
 getProperty ()
 
 getType ()
 
 getBaseType ()
 
 getTypeClass ()
 
 setTypeClass ($typeClass)
 
 getDocumentType ()
 
 setDocumentType (array $documentType)
 
 getDocumentId ()
 
 setDocumentId (array $documentId)
 
 isMultiple ()
 
 setMultiple ($value)
 
 isRequired ()
 
 getOptions ()
 
 setOptions ($options)
 
 getSettings ()
 
 setSettings (array $settings)
 
 getName ()
 
 getDescription ()
 
 formatValue ($value, $format='printable')
 
 convertValue ($value, $toTypeClass)
 
 mergeValue ($baseValue, $appendValue)
 
 canRenderControl ($renderMode)
 
 renderControl (array $field, $value, $allowSelection, $renderMode)
 
 renderControlOptions ($callbackFunctionName, $value)
 
 extractValue (array $field, array $request, array &$errors=null)
 
 clearValue ($value)
 
 internalizeValue ($context, $value)
 
 externalizeValue ($context, $value)
 
 setValue ($value)
 
 getValue ()
 
 convertPropertyToView (int $viewMode)
 

Открытые статические члены

static getBaseTypesMap ()
 
static isBaseType (string $type)
 
static convertUfType (string $type)
 
static normalizeProperty ($property)
 

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

const BOOL = 'bool'
 
const DATE = 'date'
 
const DATETIME = 'datetime'
 
const DOUBLE = 'double'
 
const FILE = 'file'
 
const INT = 'int'
 
const SELECT = 'select'
 
const INTERNALSELECT = 'internalselect'
 
const STRING = 'string'
 
const TEXT = 'text'
 
const USER = 'user'
 
const TIME = 'time'
 
const RENDER_MODE_DESIGNER = 1
 
const RENDER_MODE_ADMIN = 2
 
const RENDER_MODE_MOBILE = 4
 
const RENDER_MODE_PUBLIC = 8
 
const RENDER_MODE_JN_MOBILE = 16
 
const VALUE_CONTEXT_DOCUMENT = 'Document'
 
const VALUE_CONTEXT_REST = 'rest'
 
const VALUE_CONTEXT_JN_MOBILE = 'jn_mobile'
 

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

 $typeClass
 
 $property
 
 $documentType
 
 $documentId
 

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

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

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

◆ __construct()

__construct ( array $property,
array $documentType,
$typeClass,
array $documentId = null )
Аргументы
array$propertyDocument property.
array$documentTypeDocument type.
string$typeClassType class manager.
null | array$documentId

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

Методы

◆ canRenderControl()

canRenderControl ( $renderMode)
Аргументы
int$renderModeControl render mode.
Возвращает
bool

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

◆ clearValue()

clearValue ( $value)
Аргументы
mixed$valueField value.
Возвращает
void

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

◆ convertPropertyToView()

convertPropertyToView ( int $viewMode)

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

◆ convertUfType()

static convertUfType ( string $type)
static

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

◆ convertValue()

convertValue ( $value,
$toTypeClass )
Аргументы
mixed$valueField value.
string$toTypeClassType class name.
Возвращает
array|bool|float|int|string

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

◆ externalizeValue()

externalizeValue ( $context,
$value )
Аргументы
string$contextContext identification (Document, Variable etc.)
mixed$valueField value.
Возвращает
mixed

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

◆ extractValue()

extractValue ( array $field,
array $request,
array & $errors = null )
Аргументы
array$fieldForm field.
array$requestRequest data.
array&$errorsErrors collection.
Возвращает
array|null

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

◆ formatValue()

formatValue ( $value,
$format = 'printable' )
Аргументы
mixed$valueField value.
string$formatFormat name.
Возвращает
mixed|null|string

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

◆ getBaseType()

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

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

◆ getBaseTypesMap()

static getBaseTypesMap ( )
static

Get list of supported base types.

Возвращает
array

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

◆ getDescription()

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

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

◆ getDocumentId()

getDocumentId ( )
Возвращает
array|null

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

◆ getDocumentType()

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

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

◆ getName()

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

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

◆ getOptions()

getOptions ( )
Возвращает
null|mixed

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

◆ getProperty()

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

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

◆ getSettings()

getSettings ( )

Get field settings. Settings contain additional information that may be required for rendering of field.

Возвращает
array

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

◆ getType()

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

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

◆ getTypeClass()

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

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

◆ getValue()

getValue ( )
Возвращает
mixed

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

◆ internalizeValue()

internalizeValue ( $context,
$value )
Аргументы
string$contextContext identification (Document, Variable etc.)
mixed$valueField value.
Возвращает
mixed

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

◆ isBaseType()

static isBaseType ( string $type)
static

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

◆ isMultiple()

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

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

◆ isRequired()

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

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

◆ mergeValue()

mergeValue ( $baseValue,
$appendValue )
Аргументы
array$baseValueBase value.
mixed$appendValueValue to append.
Возвращает
mixed Merge result.

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

◆ normalizeProperty()

static normalizeProperty ( $property)
static

Normalize property structure.

Аргументы
string | array$propertyDocument property.
Возвращает
array

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

◆ renderControl()

renderControl ( array $field,
$value,
$allowSelection,
$renderMode )
Аргументы
array$fieldForm field.
mixed$valueField value.
bool$allowSelectionAllow selection flag.
int$renderModeControl render mode.
Возвращает
string

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

◆ renderControlOptions()

renderControlOptions ( $callbackFunctionName,
$value )
Аргументы
string$callbackFunctionNameClient callback function name.
mixed$valueField value.
Возвращает
string

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

◆ setDocumentId()

setDocumentId ( array $documentId)
Аргументы
array$documentIdDocument id.
Возвращает
$this

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

◆ setDocumentType()

setDocumentType ( array $documentType)
Аргументы
array$documentTypeDocument type.
Возвращает
$this

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

◆ setMultiple()

setMultiple ( $value)
Аргументы
bool$valueMultiple flag.
Возвращает
$this

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

◆ setOptions()

setOptions ( $options)
Аргументы
mixed$optionsOptions data.
Возвращает
$this

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

◆ setSettings()

setSettings ( array $settings)

set field settings. Settings contain additional information that may be required for rendering of field.

Аргументы
array$settingsSettings array.
Возвращает
$this

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

◆ setTypeClass()

setTypeClass ( $typeClass)

Set type class manager.

Аргументы
string$typeClassType class name.
Возвращает
$this
Исключения
Main

ArgumentException

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

◆ setValue()

setValue ( $value)
Аргументы
$value
Возвращает
void

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

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

◆ $documentId

array $documentId
protected

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

◆ $documentType

array $documentType
protected

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

◆ $property

array $property
protected

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

◆ $typeClass

Bitrix Bizproc BaseType Base $typeClass
protected

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

◆ BOOL

const BOOL = 'bool'

Base type BOOL

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

◆ DATE

const DATE = 'date'

Base type DATE

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

◆ DATETIME

const DATETIME = 'datetime'

Base type DATETIME

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

◆ DOUBLE

const DOUBLE = 'double'

Base type DOUBLE

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

◆ FILE

const FILE = 'file'

Base type FILE

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

◆ INT

const INT = 'int'

Base type INT

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

◆ INTERNALSELECT

const INTERNALSELECT = 'internalselect'

Base type INTERNALSELECT

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

◆ RENDER_MODE_ADMIN

const RENDER_MODE_ADMIN = 2

Control render mode - Admin panel

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

◆ RENDER_MODE_DESIGNER

const RENDER_MODE_DESIGNER = 1

Control render mode - Bizproc Designer

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

◆ RENDER_MODE_JN_MOBILE

const RENDER_MODE_JN_MOBILE = 16

Control render mode - Native mobile controls

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

◆ RENDER_MODE_MOBILE

const RENDER_MODE_MOBILE = 4

Control render mode - Mobile application

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

◆ RENDER_MODE_PUBLIC

const RENDER_MODE_PUBLIC = 8

Control render mode - Automation designer

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

◆ SELECT

const SELECT = 'select'

Base type SELECT

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

◆ STRING

const STRING = 'string'

Base type STRING

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

◆ TEXT

const TEXT = 'text'

Base type TEXT

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

◆ TIME

const TIME = 'time'

Base type TIME

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

◆ USER

const USER = 'user'

Base type USER

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

◆ VALUE_CONTEXT_DOCUMENT

const VALUE_CONTEXT_DOCUMENT = 'Document'

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

◆ VALUE_CONTEXT_JN_MOBILE

const VALUE_CONTEXT_JN_MOBILE = 'jn_mobile'

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

◆ VALUE_CONTEXT_REST

const VALUE_CONTEXT_REST = 'rest'

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