Bitrix API

Double extends Base

Class Double

Table of Contents

Methods

addError()  : mixed
addErrors()  : void
addFormat()  : void
canRenderControl()  : bool
clearValueMultiple()  : void
clearValueSingle()  : void
compareValues()  : int
convertFrom()  : null
convertPropertyToView()  : array<string|int, mixed>
convertTo()  : null|mixed
convertValueMultiple()  : array<string|int, mixed>
convertValueSingle()  : bool|int|float|string
externalizeValue()  : mixed
externalizeValueMultiple()  : mixed
externalizeValueSingle()  : mixed
extractValueMultiple()  : array<string|int, mixed>
extractValueSingle()  : mixed|null
formatValueMultiple()  : string
formatValueSingle()  : mixed|null
getConversionMap()  : array<string|int, mixed>
Return conversion map for current type.
getErrors()  : array<string|int, mixed>
getFormats()  : array<string|int, mixed>
Get formats list.
getName()  : string
Gets the name of the field type.
getType()  : string
internalizeValue()  : mixed
internalizeValueMultiple()  : mixed
internalizeValueSingle()  : mixed
mergeValue()  : mixed
renderControlMultiple()  : string
renderControlOptions()  : string
renderControlSingle()  : string
toSingleValue()  : mixed
Normalize single value.
validateValueMultiple()  : array<string|int, mixed>
validateValueSingle()  : mixed

Methods

addError()

public static addError(mixed $error) : mixed
Parameters
$error : mixed

Error description.

addErrors()

public static addErrors(array<string|int, mixed> $errors) : void
Parameters
$errors : array<string|int, mixed>

Errors description.

addFormat()

public static addFormat(string $name, array<string|int, mixed> $options) : void
Parameters
$name : string

Format name.

$options : array<string|int, mixed>

Format options.

Tags
throws
ArgumentException

canRenderControl()

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

Control render mode.

Return values
bool

clearValueMultiple()

public static clearValueMultiple(FieldType $fieldType, mixed $value) : void
Parameters
$fieldType : FieldType

Document field type.

$value : mixed

Field value.

clearValueSingle()

public static clearValueSingle(FieldType $fieldType, mixed $value) : void
Parameters
$fieldType : FieldType

Document field type.

$value : mixed

Field value.

compareValues()

public static compareValues(mixed $valueA, mixed $valueB) : int
Parameters
$valueA : mixed

First value.

$valueB : mixed

Second value.

Return values
int —

Returns 1, -1 or 0

convertFrom()

public static convertFrom(FieldType $fieldType, mixed $value, string $fromTypeClass) : null
Parameters
$fieldType : FieldType

Document field type.

$value : mixed

Field value.

$fromTypeClass : string

Type class name.

Return values
null

convertPropertyToView()

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

convertTo()

public static convertTo(FieldType $fieldType, mixed $value, string $toTypeClass) : null|mixed
Parameters
$fieldType : FieldType

Document field type.

$value : mixed

Field value.

$toTypeClass : string

Type class name.

Return values
null|mixed

convertValueMultiple()

public static convertValueMultiple(FieldType $fieldType, mixed $value, string $toTypeClass) : array<string|int, mixed>
Parameters
$fieldType : FieldType

Document field type.

$value : mixed

Field value.

$toTypeClass : string

Type class name.

Return values
array<string|int, mixed>

convertValueSingle()

public static convertValueSingle(FieldType $fieldType, mixed $value, string $toTypeClass) : bool|int|float|string
Parameters
$fieldType : FieldType

Document field type.

$value : mixed

Field value.

$toTypeClass : string

Type class name.

Tags
throws
ArgumentException
Return values
bool|int|float|string

externalizeValue()

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

Document field type.

$context : string

Context identification (Document, Variable etc.)

$value : mixed

Field value.

externalizeValueMultiple()

public static externalizeValueMultiple(FieldType $fieldType, string $context, mixed $value) : mixed
Parameters
$fieldType : FieldType

Document field type.

$context : string

Context identification (Document, Variable etc.)

$value : mixed

Field value.

externalizeValueSingle()

public static externalizeValueSingle(FieldType $fieldType, string $context, mixed $value) : mixed
Parameters
$fieldType : FieldType

Document field type.

$context : string

Context identification (Document, Variable etc.)

$value : mixed

Field value.

extractValueMultiple()

public static extractValueMultiple(FieldType $fieldType, array<string|int, mixed> $field, array<string|int, mixed> $request) : array<string|int, mixed>
Parameters
$fieldType : FieldType

Document field type.

$field : array<string|int, mixed>

Form field.

$request : array<string|int, mixed>

Request data.

Return values
array<string|int, mixed>

extractValueSingle()

public static extractValueSingle(FieldType $fieldType, array<string|int, mixed> $field, array<string|int, mixed> $request) : mixed|null
Parameters
$fieldType : FieldType

Document field type.

$field : array<string|int, mixed>

Form field.

$request : array<string|int, mixed>

Request data.

Return values
mixed|null

formatValueMultiple()

public static formatValueMultiple(FieldType $fieldType, mixed $value[, string $format = 'printable' ]) : string
Parameters
$fieldType : FieldType

Document field type.

$value : mixed

Field value.

$format : string = 'printable'

Format name.

Return values
string

formatValueSingle()

public static formatValueSingle(FieldType $fieldType, mixed $value[, string $format = 'printable' ]) : mixed|null
Parameters
$fieldType : FieldType

Document field type.

$value : mixed

Field value.

$format : string = 'printable'

Format name.

Return values
mixed|null

getConversionMap()

Return conversion map for current type.

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

Map.

getErrors()

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

getFormats()

Get formats list.

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

getName()

Gets the name of the field type.

public static getName() : string
Return values
string

getType()

public static getType() : string
Return values
string

internalizeValue()

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

Document field type.

$context : string

Context identification (Document, Variable etc.)

$value : mixed

Field value.

internalizeValueMultiple()

public static internalizeValueMultiple(FieldType $fieldType, string $context, mixed $value) : mixed
Parameters
$fieldType : FieldType

Document field type.

$context : string

Context identification (Document, Variable etc.)

$value : mixed

Field value.

internalizeValueSingle()

public static internalizeValueSingle(FieldType $fieldType, string $context, mixed $value) : mixed
Parameters
$fieldType : FieldType

Document field type.

$context : string

Context identification (Document, Variable etc.)

$value : mixed

Field value.

mergeValue()

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

Document field type.

$baseValue : array<string|int, mixed>

Base value.

$appendValue : mixed

Value to append.

Return values
mixed —

Merge result.

renderControlMultiple()

public static renderControlMultiple(FieldType $fieldType, array<string|int, mixed> $field, mixed $value, bool $allowSelection, int $renderMode) : string
Parameters
$fieldType : FieldType

Document field type.

$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 static renderControlOptions(FieldType $fieldType, string $callbackFunctionName, mixed $value) : string
Parameters
$fieldType : FieldType

Document field type.

$callbackFunctionName : string

Client callback function name.

$value : mixed

Field value.

Return values
string

renderControlSingle()

public static renderControlSingle(FieldType $fieldType, array<string|int, mixed> $field, mixed $value, bool $allowSelection, int $renderMode) : string
Parameters
$fieldType : FieldType

Document field type.

$field : array<string|int, mixed>

Form field.

$value : mixed

Field value.

$allowSelection : bool

Allow selection flag.

$renderMode : int

Control render mode.

Return values
string

toSingleValue()

Normalize single value.

public static toSingleValue(FieldType $fieldType, mixed $value) : mixed
Parameters
$fieldType : FieldType

Document field type.

$value : mixed

Field value.

Return values
mixed —

Normalized value

validateValueMultiple()

public static validateValueMultiple(mixed $value, FieldType $fieldType) : array<string|int, mixed>
Parameters
$value : mixed
$fieldType : FieldType
Return values
array<string|int, mixed>

validateValueSingle()

public static validateValueSingle(mixed $value, FieldType $fieldType) : mixed
Parameters
$value : mixed
$fieldType : FieldType 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results