Bitrix API

FieldType

Class FieldType

Table of Contents

Constants

BOOL  = 'bool'
Base type BOOL
DATE  = 'date'
Base type DATE
DATETIME  = 'datetime'
Base type DATETIME
DOUBLE  = 'double'
Base type DOUBLE
FILE  = 'file'
Base type FILE
INT  = 'int'
Base type INT
INTERNALSELECT  = 'internalselect'
Base type INTERNALSELECT
RENDER_MODE_ADMIN  = 2
Control render mode - Admin panel
RENDER_MODE_DESIGNER  = 1
Control render mode - Bizproc Designer
RENDER_MODE_JN_MOBILE  = 16
Control render mode - Native mobile controls
RENDER_MODE_MOBILE  = 4
Control render mode - Mobile application
RENDER_MODE_PUBLIC  = 8
Control render mode - Automation designer
SELECT  = 'select'
Base type SELECT
STRING  = 'string'
Base type STRING
TEXT  = 'text'
Base type TEXT
TIME  = 'time'
Base type TIME
USER  = 'user'
Base type USER
VALUE_CONTEXT_DOCUMENT  = 'Document'
VALUE_CONTEXT_JN_MOBILE  = 'jn_mobile'
VALUE_CONTEXT_REST  = 'rest'

Methods

__construct()  : mixed
canRenderControl()  : bool
clearValue()  : void
convertPropertyToView()  : array<string|int, mixed>
convertUfType()  : string|null
convertValue()  : array<string|int, mixed>|bool|float|int|string
externalizeValue()  : mixed
extractValue()  : array<string|int, mixed>|null
formatValue()  : mixed|null|string
getBaseType()  : string
getBaseTypesMap()  : array<string|int, mixed>
Get list of supported base types.
getDescription()  : null|string
getDocumentId()  : array<string|int, mixed>|null
getDocumentType()  : array<string|int, mixed>
getName()  : null|string
getOptions()  : null|mixed
getProperty()  : array<string|int, mixed>
getSettings()  : array<string|int, mixed>
Get field settings.
getType()  : null|string
getTypeClass()  : string
getValue()  : mixed
internalizeValue()  : mixed
isBaseType()  : bool
isMultiple()  : bool
isRequired()  : bool
mergeValue()  : mixed
normalizeProperty()  : array<string|int, mixed>
Normalize property structure.
normalizePropertyList()  : array<string|int, mixed>
renderControl()  : string
renderControlOptions()  : string
setDocumentId()  : $this
setDocumentType()  : $this
setMultiple()  : $this
setOptions()  : $this
setSettings()  : $this
set field settings.
setTypeClass()  : $this
Set type class manager.
setValue()  : void

Constants

BOOL

Base type BOOL

public mixed BOOL = 'bool'

DATE

Base type DATE

public mixed DATE = 'date'

DATETIME

Base type DATETIME

public mixed DATETIME = 'datetime'

DOUBLE

Base type DOUBLE

public mixed DOUBLE = 'double'

FILE

Base type FILE

public mixed FILE = 'file'

INTERNALSELECT

Base type INTERNALSELECT

public mixed INTERNALSELECT = 'internalselect'

RENDER_MODE_ADMIN

Control render mode - Admin panel

public mixed RENDER_MODE_ADMIN = 2

RENDER_MODE_DESIGNER

Control render mode - Bizproc Designer

public mixed RENDER_MODE_DESIGNER = 1

RENDER_MODE_JN_MOBILE

Control render mode - Native mobile controls

public mixed RENDER_MODE_JN_MOBILE = 16

RENDER_MODE_MOBILE

Control render mode - Mobile application

public mixed RENDER_MODE_MOBILE = 4

RENDER_MODE_PUBLIC

Control render mode - Automation designer

public mixed RENDER_MODE_PUBLIC = 8

SELECT

Base type SELECT

public mixed SELECT = 'select'

STRING

Base type STRING

public mixed STRING = 'string'

TEXT

Base type TEXT

public mixed TEXT = 'text'

TIME

Base type TIME

public mixed TIME = 'time'

USER

Base type USER

public mixed USER = 'user'

VALUE_CONTEXT_DOCUMENT

public mixed VALUE_CONTEXT_DOCUMENT = 'Document'

VALUE_CONTEXT_JN_MOBILE

public mixed VALUE_CONTEXT_JN_MOBILE = 'jn_mobile'

VALUE_CONTEXT_REST

public mixed VALUE_CONTEXT_REST = 'rest'

Methods

__construct()

public __construct(array<string|int, mixed> $property, array<string|int, mixed> $documentType, string $typeClass[, null|array<string|int, mixed> $documentId = null ]) : mixed
Parameters
$property : array<string|int, mixed>

Document property.

$documentType : array<string|int, mixed>

Document type.

$typeClass : string

Type class manager.

$documentId : null|array<string|int, mixed> = null

canRenderControl()

public canRenderControl(int $renderMode) : bool
Parameters
$renderMode : int

Control render mode.

Return values
bool

clearValue()

public clearValue(mixed $value) : void
Parameters
$value : mixed

Field value.

convertPropertyToView()

public convertPropertyToView(int $viewMode) : array<string|int, mixed>
Parameters
$viewMode : int
Return values
array<string|int, mixed>

convertUfType()

public static convertUfType(string $type) : string|null
Parameters
$type : string
Return values
string|null

convertValue()

public convertValue(mixed $value, string $toTypeClass) : array<string|int, mixed>|bool|float|int|string
Parameters
$value : mixed

Field value.

$toTypeClass : string

Type class name.

Return values
array<string|int, mixed>|bool|float|int|string

externalizeValue()

public externalizeValue(string $context, mixed $value) : mixed
Parameters
$context : string

Context identification (Document, Variable etc.)

$value : mixed

Field value.

extractValue()

public extractValue(array<string|int, mixed> $field, array<string|int, mixed> $request[, array<string|int, mixed> &$errors = null ]) : array<string|int, mixed>|null
Parameters
$field : array<string|int, mixed>

Form field.

$request : array<string|int, mixed>

Request data.

$errors : array<string|int, mixed> = null

Errors collection.

Return values
array<string|int, mixed>|null

formatValue()

public formatValue(mixed $value[, string $format = 'printable' ]) : mixed|null|string
Parameters
$value : mixed

Field value.

$format : string = 'printable'

Format name.

Return values
mixed|null|string

getBaseType()

public getBaseType() : string
Return values
string

getBaseTypesMap()

Get list of supported base types.

public static getBaseTypesMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDescription()

public getDescription() : null|string
Return values
null|string

getDocumentId()

public getDocumentId() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getDocumentType()

public getDocumentType() : array<string|int, mixed>
Return values
array<string|int, mixed>

getName()

public getName() : null|string
Return values
null|string

getOptions()

public getOptions() : null|mixed
Return values
null|mixed

getProperty()

public getProperty() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSettings()

Get field settings.

public getSettings() : array<string|int, mixed>

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

Return values
array<string|int, mixed>

getType()

public getType() : null|string
Return values
null|string

getTypeClass()

public getTypeClass() : string
Return values
string

internalizeValue()

public internalizeValue(string $context, mixed $value) : mixed
Parameters
$context : string

Context identification (Document, Variable etc.)

$value : mixed

Field value.

isBaseType()

public static isBaseType(string $type) : bool
Parameters
$type : string
Return values
bool

isMultiple()

public isMultiple() : bool
Return values
bool

isRequired()

public isRequired() : bool
Return values
bool

mergeValue()

public mergeValue(array<string|int, mixed> $baseValue, mixed $appendValue) : mixed
Parameters
$baseValue : array<string|int, mixed>

Base value.

$appendValue : mixed

Value to append.

Return values
mixed —

Merge result.

normalizeProperty()

Normalize property structure.

public static normalizeProperty(string|array<string|int, mixed> $property) : array<string|int, mixed>
Parameters
$property : string|array<string|int, mixed>

Document property.

Return values
array<string|int, mixed>

normalizePropertyList()

public static normalizePropertyList(array<string|int, mixed> $props) : array<string|int, mixed>
Parameters
$props : array<string|int, mixed>
Return values
array<string|int, mixed>

renderControl()

public renderControl(array<string|int, mixed> $field, mixed $value, bool $allowSelection, int $renderMode) : string
Parameters
$field : array<string|int, mixed>

Form field.

$value : mixed

Field value.

$allowSelection : bool

Allow selection flag.

$renderMode : int

Control render mode.

Return values
string

renderControlOptions()

public renderControlOptions(string $callbackFunctionName, mixed $value) : string
Parameters
$callbackFunctionName : string

Client callback function name.

$value : mixed

Field value.

Return values
string

setDocumentId()

public setDocumentId(array<string|int, mixed> $documentId) : $this
Parameters
$documentId : array<string|int, mixed>

Document id.

Return values
$this

setDocumentType()

public setDocumentType(array<string|int, mixed> $documentType) : $this
Parameters
$documentType : array<string|int, mixed>

Document type.

Return values
$this

setMultiple()

public setMultiple(bool $value) : $this
Parameters
$value : bool

Multiple flag.

Return values
$this

setOptions()

public setOptions(mixed $options) : $this
Parameters
$options : mixed

Options data.

Return values
$this

setSettings()

set field settings.

public setSettings(array<string|int, mixed> $settings) : $this

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

Parameters
$settings : array<string|int, mixed>

Settings array.

Return values
$this

setTypeClass()

Set type class manager.

public setTypeClass(string $typeClass) : $this
Parameters
$typeClass : string

Type class name.

Tags
throws
ArgumentException
Return values
$this

setValue()

public setValue(mixed $value) : void
Parameters
$value : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results