Bitrix API

PropertyTypeSettings

FinalYes

Table of Contents

Methods

__construct()  : mixed
appendHiddenFields()  : void
appendShowedFields()  : void
createByUserType()  : self
Factory method for creating and filling an instance with html settings or editor fields.
getDefaultValueHtml()  : string|null
getPropertyType()  : string
Property type (is simple).
getSettingsHtml()  : string|null
getSetValues()  : array<string|int, mixed>
getUserType()  : string|null
Property user type.
isShownField()  : bool
Checking whether the field is displayed.

Methods

__construct()

public __construct(string $propertyType[, string|null $userType = null ]) : mixed
Parameters
$propertyType : string
$userType : string|null = null

appendHiddenFields()

public appendHiddenFields(array<string|int, mixed> $fields) : void
Parameters
$fields : array<string|int, mixed>

appendShowedFields()

public appendShowedFields(array<string|int, mixed> $fields) : void
Parameters
$fields : array<string|int, mixed>

createByUserType()

Factory method for creating and filling an instance with html settings or editor fields.

public static createByUserType(string $propertyType, string $userType, array<string|int, mixed> $propertyFields[, string|null $htmlName = 'USER_TYPE_SETTINGS' ]) : self
Parameters
$propertyType : string
$userType : string
$propertyFields : array<string|int, mixed>
$htmlName : string|null = 'USER_TYPE_SETTINGS'
Return values
self

getDefaultValueHtml()

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

getPropertyType()

Property type (is simple).

public getPropertyType() : string

If property with user type (as S:HTML), this method returns S.

Return values
string

getSetValues()

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

getUserType()

Property user type.

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

isShownField()

Checking whether the field is displayed.

public isShownField(string $fieldName) : bool
Parameters
$fieldName : string
Return values
bool

        
On this page

Search results