Bitrix API

Manager

class Manager

Table of Contents

Constants

EVENT_LOAD_TAGS  = 'onLoadRestMarketTags'

Methods

deleteByModule()  : bool
doAgentLoad()  : string
Load tags by module.
doAgentOnceLoad()  : string
Load tags by module.
explodeKey()  : false|array<string|int, string>
Explode key.
finalize()  : null
Save changed tags. Call from static::registerEventHandlerSave().
getKey()  : string
Returns key from params
increment()  : bool
incrementDaily()  : bool
loadByModule()  : bool
Sends event to load tags by module id.
loadTags()  : bool
Sends event to load tags.
onAfterRegisterModule()  : void
onAfterUnRegisterModule()  : void
registerEventHandlerSave()  : mixed
Add a handler to the save changes.
save()  : bool
Adds or updates tags value.
saveList()  : bool
Save list of tag.

Constants

EVENT_LOAD_TAGS

public mixed EVENT_LOAD_TAGS = 'onLoadRestMarketTags'

Methods

deleteByModule()

public static deleteByModule(mixed $moduleId) : bool
Parameters
$moduleId : mixed
Return values
bool

doAgentLoad()

Load tags by module.

public static doAgentLoad(string $moduleId) : string
Parameters
$moduleId : string
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
string

doAgentOnceLoad()

Load tags by module.

public static doAgentOnceLoad(string $moduleId) : string
Parameters
$moduleId : string
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
string

explodeKey()

Explode key.

public static explodeKey(string $key) : false|array<string|int, string>
Parameters
$key : string
Return values
false|array<string|int, string>

finalize()

Save changed tags. Call from static::registerEventHandlerSave().

public static finalize() : null
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
throws
SqlQueryException
Return values
null

getKey()

Returns key from params

public static getKey(mixed $moduleId, mixed $code) : string
Parameters
$moduleId : mixed
$code : mixed
Return values
string

increment()

public static increment(mixed $moduleId, mixed $code[, mixed $plus = true ]) : bool
Parameters
$moduleId : mixed
$code : mixed
$plus : mixed = true
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

incrementDaily()

public static incrementDaily(string $moduleId, string $code) : bool
Parameters
$moduleId : string
$code : string
Return values
bool

loadByModule()

Sends event to load tags by module id.

public static loadByModule(string $moduleId) : bool
Parameters
$moduleId : string
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

loadTags()

Sends event to load tags.

public static loadTags([array<string|int, mixed> $eventParams = [] ]) : bool
Parameters
$eventParams : array<string|int, mixed> = []
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

onAfterRegisterModule()

public static onAfterRegisterModule(Event $event) : void
Parameters
$event : Event

onAfterUnRegisterModule()

public static onAfterUnRegisterModule(Event $event) : void
Parameters
$event : Event

registerEventHandlerSave()

Add a handler to the save changes.

public static registerEventHandlerSave() : mixed

save()

Adds or updates tags value.

public static save(string $moduleId, string $code, string $value[, null|Date $dateValue = null ][, string $type = TagTable::TYPE_DEFAULT ]) : bool
Parameters
$moduleId : string
$code : string
$value : string
$dateValue : null|Date = null
$type : string = TagTable::TYPE_DEFAULT
Return values
bool

saveList()

Save list of tag.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results