Bitrix API

Base

AbstractYes

Table of Contents

Constants

FIELD_ID  = ''
Real field identifier.
TYPE_ID  = ''
Real field type identifier.

Methods

checkAllowedOperation()  : bool
checkAllowedProductType()  : bool
checkRestictions()  : bool
clearCache()  : void
create()  : Result
getAllowedOperations()  : array<string|int, mixed>
getAllowedProductTypeList()  : array<string|int, mixed>
getConfig()  : array<string|int, mixed>|null
Returns field config or null, if field is not allowed.
getDescription()  : array<string|int, mixed>|null
Returns field description or null, if field is not allowed.
getFieldId()  : string
getGridAction()  : array<string|int, mixed>|null
getGroupActionRequest()  : array<string|int, mixed>|null
getOperationSelectFieldList()  : array<string|int, mixed>
getTitle()  : string
getTypeId()  : string
getUiDescription()  : array<string|int, mixed>|null
getUserFieldBaseParam()  : array<string|int, mixed>
isAllowed()  : bool
isExists()  : bool
load()  : array<string|int, mixed>|null
prepareValue()  : array<string|int, mixed>
renderAdminFormControl()  : string|null
updateProductFormConfiguration()  : void

Constants

FIELD_ID

Real field identifier.

public string FIELD_ID = ''

Unique in the whole project. Required.

TYPE_ID

Real field type identifier.

public string TYPE_ID = ''

Contains interface class name - children from \Bitrix\Catalog\Product\SystemField\Type\Base. Required.

Methods

checkAllowedOperation()

public static checkAllowedOperation(string $operation) : bool
Parameters
$operation : string
Return values
bool

checkAllowedProductType()

public static checkAllowedProductType(int $type) : bool
Parameters
$type : int
Return values
bool

checkRestictions()

public static checkRestictions(array<string|int, mixed> $restrictions) : bool
Parameters
$restrictions : array<string|int, mixed>
Return values
bool

clearCache()

public static clearCache() : void

create()

public static create() : Result
Return values
Result

getAllowedOperations()

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

getAllowedProductTypeList()

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

getConfig()

Returns field config or null, if field is not allowed.

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

array or null. if returns array, his keys are case sensitive:

  • array FIELD - description of user field. Required. Contains all data for create user field.
Other keys in context interface class (user field type).

getDescription()

Returns field description or null, if field is not allowed.

public static getDescription() : array<string|int, mixed>|null

Contains identifier and interface class.

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

array or null. if returns array, his keys are case sensitive:

  • string ID - constains copy of className::FIELD_ID from real class.
  • string TYPE - constains copy of className::TYPE_ID from real class.
  • string TITLE - contains field name.

getFieldId()

public static getFieldId() : string
Return values
string

getGridAction()

public static getGridAction(ProductGroupAction $panel) : array<string|int, mixed>|null
Parameters
$panel : ProductGroupAction
Return values
array<string|int, mixed>|null

getGroupActionRequest()

public static getGroupActionRequest(ProductGroupAction $panel) : array<string|int, mixed>|null
Parameters
$panel : ProductGroupAction
Return values
array<string|int, mixed>|null

getOperationSelectFieldList()

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

getTitle()

public static getTitle() : string
Return values
string

getTypeId()

public static getTypeId() : string
Return values
string

getUiDescription()

public static getUiDescription(array<string|int, mixed> $restrictions) : array<string|int, mixed>|null
Parameters
$restrictions : array<string|int, mixed>
Return values
array<string|int, mixed>|null

getUserFieldBaseParam()

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

isAllowed()

public abstract static isAllowed() : bool
Return values
bool

isExists()

public static isExists() : bool
Return values
bool

load()

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

prepareValue()

public static prepareValue(string $operation, array<string|int, mixed> $productRow) : array<string|int, mixed>
Parameters
$operation : string
$productRow : array<string|int, mixed>
Return values
array<string|int, mixed>

renderAdminFormControl()

public static renderAdminFormControl(array<string|int, mixed> $field, array<string|int, mixed> $product, array<string|int, mixed> $config) : string|null
Parameters
$field : array<string|int, mixed>
$product : array<string|int, mixed>
$config : array<string|int, mixed>
Return values
string|null

updateProductFormConfiguration()

public static updateProductFormConfiguration() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results