Bitrix API

Manager

Table of Contents

Methods

deleteByAppCode()  : void
Deletes all Engines by Application code.
getByCode()  : Item|null
Returns Engine by code.
getCollection()  : Collection
Returns collection of Engines.
getList()  : array<string|int, mixed>
Returns collection of Engines.
hasEngine()  : bool
Checks Engine exists by code.
hasEngines()  : bool
Checks ThirdParty Engines exists.
register()  : int
Registers new custom Engine.
unRegister()  : bool
Remove existing custom Engine.

Methods

deleteByAppCode()

Deletes all Engines by Application code.

public static deleteByAppCode(string $appCode) : void
Parameters
$appCode : string

Application code.

getByCode()

Returns Engine by code.

public static getByCode(string $code) : Item|null
Parameters
$code : string

Engine's code.

Return values
Item|null

getCollection()

Returns collection of Engines.

public static getCollection([array<string|int, mixed>|null $data = null ]) : Collection
Parameters
$data : array<string|int, mixed>|null = null

Maybe an array with filter and limit key.

Return values
Collection

getList()

Returns collection of Engines.

public static getList([array<string|int, mixed>|null $data = null ][, mixed $service = null ][, mixed $server = null ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>|null = null

Maybe an array with filter and limit key.

$service : mixed = null

During REST executes.

$server : mixed = null

During REST executes.

Return values
array<string|int, mixed>

hasEngine()

Checks Engine exists by code.

public static hasEngine(string $code) : bool
Parameters
$code : string

Engine's code.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

hasEngines()

Checks ThirdParty Engines exists.

public static hasEngines() : bool
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

register()

Registers new custom Engine.

public static register(array{name: string, code: string, category: string, completions_url: string, settings: array|null} $data[, mixed $service = null ][, mixed $server = null ]) : int
Parameters
$data : array{name: string, code: string, category: string, completions_url: string, settings: array|null}
$service : mixed = null

During REST executes.

$server : mixed = null

During REST executes.

Tags
throws
RestException
throws
Exception
Return values
int

unRegister()

Remove existing custom Engine.

public static unRegister(array<string|int, mixed> $data[, mixed $service = null ][, mixed $server = null ]) : bool
Parameters
$data : array<string|int, mixed>

Array contains fields: ['code'].

$service : mixed = null

During REST executes.

$server : mixed = null

During REST executes.

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results