Bitrix API

StatusField extends StringField

Table of Contents

Constants

EXPORT_CONTEXT  = 'export'
GRID_CONTEXT  = 'grid'
KANBAN_CONTEXT  = 'kanban'
MOBILE_CONTEXT  = 'mobile'
TYPE  = 'status'

Methods

addDisplayParam()  : Field
addDisplayParams()  : Field
createByType()  : Field
createFromBaseField()  : Field
createFromUserField()  : Field
getContext()  : string
getDisplayParam()  : mixed
getDisplayParams()  : array<string|int, mixed>
getFormattedValue()  : array<string|int, mixed>|string
getId()  : string
getPreparedEntityValue()  : mixed
getTitle()  : string
getType()  : string
getUserFieldParams()  : array<string|int, mixed>
isExportContext()  : bool
isGridContext()  : bool
isKanbanContext()  : bool
isMobileContext()  : bool
isMultiple()  : bool
isUserField()  : bool
isValueEmpty()  : bool
loadLinkedEntities()  : void
needDisplayRawValue()  : bool
prepareField()  : void
prepareLinkedEntities()  : void
setContext()  : $this
setDisplayParams()  : Field
setDisplayRawValue()  : Field
setEntityTypeId()  : Field
setId()  : Field
setIsMultiple()  : Field
setIsUserField()  : Field
setTitle()  : Field
setUserFieldParams()  : Field
setWasRenderedAsHtml()  : Field
useLinkedEntities()  : bool
wasRenderedAsHtml()  : bool

Constants

EXPORT_CONTEXT

public mixed EXPORT_CONTEXT = 'export'

GRID_CONTEXT

public mixed GRID_CONTEXT = 'grid'

KANBAN_CONTEXT

public mixed KANBAN_CONTEXT = 'kanban'

MOBILE_CONTEXT

public mixed MOBILE_CONTEXT = 'mobile'

Methods

addDisplayParam()

public addDisplayParam(string $paramId, mixed $paramValue) : Field
Parameters
$paramId : string
$paramValue : mixed
Return values
Field

addDisplayParams()

public addDisplayParams(array<string|int, mixed> $displayParams) : Field
Parameters
$displayParams : array<string|int, mixed>
Return values
Field

createByType()

public static createByType(string $type[, string $id = '' ]) : Field
Parameters
$type : string
$id : string = ''
Return values
Field

createFromBaseField()

public static createFromBaseField(string $id, array<string|int, mixed> $baseFieldInfo) : Field
Parameters
$id : string
$baseFieldInfo : array<string|int, mixed>
Return values
Field

createFromUserField()

public static createFromUserField(string $id, array<string|int, mixed> $userFieldInfo) : Field
Parameters
$id : string
$userFieldInfo : array<string|int, mixed>
Return values
Field

getContext()

public getContext() : string
Return values
string

getDisplayParam()

public getDisplayParam(string $paramId[, mixed $defaultValue = null ]) : mixed
Parameters
$paramId : string
$defaultValue : mixed = null

getDisplayParams()

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

getFormattedValue()

public getFormattedValue(mixed $fieldValue[, int|null $itemId = null ][, Options|null $displayOptions = null ]) : array<string|int, mixed>|string
Parameters
$fieldValue : mixed
$itemId : int|null = null
$displayOptions : Options|null = null
Tags
throws
Exception
Return values
array<string|int, mixed>|string

getId()

public getId() : string
Return values
string

getPreparedEntityValue()

public getPreparedEntityValue(array<string|int, mixed> $linkedEntitiesValues, string $fieldValueType, mixed $fieldValueId) : mixed
Parameters
$linkedEntitiesValues : array<string|int, mixed>
$fieldValueType : string
$fieldValueId : mixed

getTitle()

public getTitle() : string
Return values
string

getType()

public getType() : string
Return values
string

getUserFieldParams()

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

isExportContext()

public isExportContext() : bool
Return values
bool

isGridContext()

public isGridContext() : bool
Return values
bool

isKanbanContext()

public isKanbanContext() : bool
Return values
bool

isMobileContext()

public isMobileContext() : bool
Return values
bool

isMultiple()

public isMultiple() : bool
Return values
bool

isUserField()

public isUserField() : bool
Return values
bool

isValueEmpty()

public isValueEmpty(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

loadLinkedEntities()

public loadLinkedEntities(array<string|int, mixed> &$linkedEntitiesValues, array<string|int, mixed> $linkedEntity) : void
Parameters
$linkedEntitiesValues : array<string|int, mixed>
$linkedEntity : array<string|int, mixed>

needDisplayRawValue()

public needDisplayRawValue() : bool
Return values
bool

prepareLinkedEntities()

public prepareLinkedEntities(array<string|int, mixed> &$linkedEntities, mixed $fieldValue, int $itemId, string $fieldId) : void
Parameters
$linkedEntities : array<string|int, mixed>
$fieldValue : mixed
$itemId : int
$fieldId : string

setContext()

public setContext(string $context) : $this
Parameters
$context : string
Return values
$this

setDisplayParams()

public setDisplayParams(array<string|int, mixed> $displayParams) : Field
Parameters
$displayParams : array<string|int, mixed>
Return values
Field

setDisplayRawValue()

public setDisplayRawValue(bool $displayRawValue) : Field
Parameters
$displayRawValue : bool
Return values
Field

setEntityTypeId()

public setEntityTypeId(int $entityTypeId) : Field
Parameters
$entityTypeId : int
Return values
Field

setId()

public setId(string $id) : Field
Parameters
$id : string
Return values
Field

setIsMultiple()

public setIsMultiple(bool $isMultiple) : Field
Parameters
$isMultiple : bool
Return values
Field

setIsUserField()

public setIsUserField(bool $isUserField) : Field
Parameters
$isUserField : bool
Return values
Field

setTitle()

public setTitle(string $title) : Field
Parameters
$title : string
Return values
Field

setUserFieldParams()

public setUserFieldParams(array<string|int, mixed> $userFieldParams) : Field
Parameters
$userFieldParams : array<string|int, mixed>
Return values
Field

setWasRenderedAsHtml()

public setWasRenderedAsHtml(bool $wasRenderedAsHtml) : Field
Parameters
$wasRenderedAsHtml : bool
Return values
Field

useLinkedEntities()

public useLinkedEntities() : bool
Return values
bool

wasRenderedAsHtml()

public wasRenderedAsHtml() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results