Bitrix API

ConfigMap

Table of Contents

Constants

VERSION  = 1.1

Methods

__construct()  : array<string|int, mixed>|mixed
getDescriptionConfig()  : array<string|int, mixed>
Gets full description of the all parameters recursively
getGroupByParam()  : string
Returns group of the parameter by its name
getGroupParams()  : mixed
Gets all parameters with group types
getImageParams()  : array<string|int, mixed>
Gets all parameters with type "image"
getLangMessages()  : array<string|int, mixed>
Gets lang messages
getMap()  : mixed
getParamDescription()  : mixed
getParamsByGroups()  : mixed
getParamsByType()  : array<string|int, mixed>
Gets parameters by passed type
has()  : bool
Checks if parameter with passed name is exists in the map
isGroup()  : bool
Checks if parameter with passed $paramName is group

Constants

Methods

__construct()

public __construct() : array<string|int, mixed>|mixed
Tags
throws
SystemException
Return values
array<string|int, mixed>|mixed

getDescriptionConfig()

Gets full description of the all parameters recursively

public getDescriptionConfig() : array<string|int, mixed>
Tags
throws
SystemException
Return values
array<string|int, mixed>

getGroupByParam()

Returns group of the parameter by its name

public getGroupByParam(mixed $paramName) : string
Parameters
$paramName : mixed
Return values
string

getGroupParams()

Gets all parameters with group types

public getGroupParams() : mixed
Tags
throws
SystemException

getImageParams()

Gets all parameters with type "image"

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

getLangMessages()

Gets lang messages

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

getParamDescription()

public getParamDescription(mixed $name, mixed $type) : mixed
Parameters
$name : mixed
$type : mixed

getParamsByGroups()

public getParamsByGroups() : mixed

getParamsByType()

Gets parameters by passed type

public getParamsByType(mixed $paramType) : array<string|int, mixed>
Parameters
$paramType : mixed
Return values
array<string|int, mixed>

has()

Checks if parameter with passed name is exists in the map

public has(mixed $paramName) : bool
Parameters
$paramName : mixed
Return values
bool

isGroup()

Checks if parameter with passed $paramName is group

public isGroup(mixed $paramName) : bool
Parameters
$paramName : mixed
Tags
throws
SystemException
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results