Bitrix API

PromptService

Table of Contents

Methods

__construct()  : mixed
addCategoriesForPrompt()  : void
addTranslateNames()  : void
changeActivatePrompt()  : void
changeActivatePrompts()  : Result
createPrompt()  : AddResult|UpdateResult
fillChildrenForItems()  : void
getAccessiblePrompt()  : Item|null
getAccessiblePromptList()  : array<string|int, Item>
getChildrenPromptListByIds()  : array<string|int, mixed>
getMainPromptDataByCode()  : array{: int|null, : bool|null}
getMainPromptDataByCodes()  : array<string|int, mixed>
getMainPromptDataWithAuthorByCode()  : array<string|int, mixed>|array<string|int, null>
getMainPromptDataWithTextByCode()  : array{: int, : bool, : string}
getPromptByCodes()  : array<string|int, mixed>|null
getPromptByIdForUpdate()  : PromptForUpdateDto|array<string|int, mixed>
getPromptIdByCode()  : int|null
getPromptIdInAccessibleList()  : int|null
getPromptIdsByCodes()  : array<string|int, mixed>
getSystemsPromptsByCategory()  : array<string|int, mixed>
savePrompt()  : mixed

Methods

addCategoriesForPrompt()

public addCategoriesForPrompt(array<string|int, mixed> $categories, int $promptId[, bool $needDeleteOld = false ]) : void
Parameters
$categories : array<string|int, mixed>
$promptId : int
$needDeleteOld : bool = false

addTranslateNames()

public addTranslateNames(array<string|int, mixed> $names, int $promptId[, bool $needDeleteOld = false ]) : void
Parameters
$names : array<string|int, mixed>
$promptId : int
$needDeleteOld : bool = false

changeActivatePrompt()

public changeActivatePrompt(int $promptId, bool $needActivate, int $userId) : void
Parameters
$promptId : int
$needActivate : bool
$userId : int
Tags
throws
Exception

changeActivatePrompts()

public changeActivatePrompts(array<string|int, int> $promptIds, bool $needActivate, int $userId) : Result
Parameters
$promptIds : array<string|int, int>
$needActivate : bool
$userId : int
Return values
Result

fillChildrenForItems()

public fillChildrenForItems(array<string|int, Item> $promptList, array<string|int, mixed> $childPrompts) : void
Parameters
$promptList : array<string|int, Item>
$childPrompts : array<string|int, mixed>

getAccessiblePrompt()

public getAccessiblePrompt(int $userId, string $lang, string $promptCode) : Item|null
Parameters
$userId : int
$lang : string
$promptCode : string
Return values
Item|null

getAccessiblePromptList()

public getAccessiblePromptList(int $userId, string $lang, string $category) : array<string|int, Item>
Parameters
$userId : int
$lang : string
$category : string
Return values
array<string|int, Item>

getChildrenPromptListByIds()

public getChildrenPromptListByIds(array<string|int, mixed> $promptIds, array<string|int, mixed> $forbiddenPromptIds, string $lang) : array<string|int, mixed>
Parameters
$promptIds : array<string|int, mixed>
$forbiddenPromptIds : array<string|int, mixed>
$lang : string
Return values
array<string|int, mixed>

getMainPromptDataByCode()

public getMainPromptDataByCode(string $code) : array{: int|null, : bool|null}
Parameters
$code : string
Return values
array{: int|null, : bool|null}

getMainPromptDataByCodes()

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

getMainPromptDataWithAuthorByCode()

public getMainPromptDataWithAuthorByCode(string $code) : array<string|int, mixed>|array<string|int, null>
Parameters
$code : string
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|array<string|int, null>

getMainPromptDataWithTextByCode()

public getMainPromptDataWithTextByCode(string $code) : array{: int, : bool, : string}
Parameters
$code : string
Return values
array{: int, : bool, : string}

getPromptByCodes()

public getPromptByCodes(array<string|int, mixed> $data) : array<string|int, mixed>|null
Parameters
$data : array<string|int, mixed>
Return values
array<string|int, mixed>|null

getPromptByIdForUpdate()

public getPromptByIdForUpdate(int $promptId, int $userId, array<string|int, mixed> $categoriesList) : PromptForUpdateDto|array<string|int, mixed>
Parameters
$promptId : int
$userId : int
$categoriesList : array<string|int, mixed>
Return values
PromptForUpdateDto|array<string|int, mixed>

getPromptIdByCode()

public getPromptIdByCode(string $code) : int|null
Parameters
$code : string
Return values
int|null

getPromptIdInAccessibleList()

public getPromptIdInAccessibleList(int $userId, int $promptId[, bool|null $ignoreDelete = null ]) : int|null
Parameters
$userId : int
$promptId : int
$ignoreDelete : bool|null = null
Return values
int|null

getPromptIdsByCodes()

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

getSystemsPromptsByCategory()

public getSystemsPromptsByCategory(string $code, string $lang, string|null $roleCode) : array<string|int, mixed>
Parameters
$code : string
$lang : string
$roleCode : string|null
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results