Bitrix API

ClientFieldHelper

Table of Contents

Methods

__construct()  : mixed
addPrefixToFieldId()  : string
Add CONTACT_/COMPANY_ to beginning of $fieldId
addPrefixToFieldName()  : string
Add entity name prefix to field name (caption) Result looks like "Contact: $fieldName"
getEntityClass()  : string
getEntityTitle()  : string
getFieldIdWithoutPrefix()  : string
Remove CONTACT_/COMPANY_ from beginning of $fieldId
getFieldName()  : string
Get field name (caption) Entity name prefix may be included, like "Contact: Last name"
getFieldPrefix()  : string
Will return "CONTACT_" or "COMPANY_"

Methods

__construct()

public __construct(int $entityTypeId) : mixed
Parameters
$entityTypeId : int

addPrefixToFieldId()

Add CONTACT_/COMPANY_ to beginning of $fieldId

public addPrefixToFieldId(string $fieldId) : string
Parameters
$fieldId : string
Return values
string

addPrefixToFieldName()

Add entity name prefix to field name (caption) Result looks like "Contact: $fieldName"

public addPrefixToFieldName(string $fieldName) : string
Parameters
$fieldName : string
Return values
string

getFieldIdWithoutPrefix()

Remove CONTACT_/COMPANY_ from beginning of $fieldId

public getFieldIdWithoutPrefix(string $fieldId) : string
Parameters
$fieldId : string
Return values
string

getFieldName()

Get field name (caption) Entity name prefix may be included, like "Contact: Last name"

public getFieldName(string $fieldIdWithoutPrefix[, bool $addPrefix = false ]) : string
Parameters
$fieldIdWithoutPrefix : string
$addPrefix : bool = false
Return values
string

getFieldPrefix()

Will return "CONTACT_" or "COMPANY_"

public getFieldPrefix() : string
Return values
string

        
On this page

Search results