Bitrix API

Tag

Table of Contents

Constants

GROUP_TAGS_CACHE  = 'group'
TASK_TAGS_CACHE  = 'task'
USER_TAGS_CACHE  = 'user'

Methods

__construct()  : mixed
addTag()  : void
addTagToGroup()  : void
addTagToUser()  : void
addToGroupTask()  : void
addToTask()  : void
delete()  : void
deleteGroupTags()  : void
edit()  : void
getGroupId()  : int
getIdByGroup()  : int
getIdByTask()  : int
getIdByUser()  : int
getTaskTags()  : array<string|int, mixed>
isExists()  : bool
isExistsByGroup()  : bool
isExistsByTask()  : bool
isExistsByUser()  : bool
linkTag()  : void
linkTags()  : void
set()  : void
unlinkTag()  : void
unlinkTags()  : void

Constants

GROUP_TAGS_CACHE

public mixed GROUP_TAGS_CACHE = 'group'

TASK_TAGS_CACHE

public mixed TASK_TAGS_CACHE = 'task'

USER_TAGS_CACHE

public mixed USER_TAGS_CACHE = 'user'

Methods

__construct()

public __construct([int $userId = 0 ]) : mixed
Parameters
$userId : int = 0

addTag()

public addTag(string $tagName, int $groupId) : void
Parameters
$tagName : string
$groupId : int
Tags
throws
Exception

addTagToGroup()

public addTagToGroup(string $tagName, int $groupId) : void
Parameters
$tagName : string
$groupId : int
Tags
throws
Exception

addTagToUser()

public addTagToUser(string $tagName) : void
Parameters
$tagName : string
Tags
throws
Exception

addToGroupTask()

public addToGroupTask(int $taskId, int $groupId, array<string|int, mixed> $tagsForAdd) : void
Parameters
$taskId : int
$groupId : int
$tagsForAdd : array<string|int, mixed>
Tags
throws
ArgumentException
throws
SqlQueryException
throws
ObjectPropertyException
throws
SystemException

addToTask()

public addToTask(int $taskId, array<string|int, mixed> $tagsForAdd[, int $userId = 0 ]) : void
Parameters
$taskId : int
$tagsForAdd : array<string|int, mixed>
$userId : int = 0
Tags
throws
ArgumentException
throws
SqlQueryException
throws
ObjectPropertyException
throws
SystemException

delete()

public delete(array<string|int, mixed> $tags) : void
Parameters
$tags : array<string|int, mixed>

deleteGroupTags()

public deleteGroupTags(int $groupId) : void
Parameters
$groupId : int
Tags
throws
SqlQueryException
throws
SystemException
throws
ArgumentException

edit()

public edit(int $tagId, string $newName) : void
Parameters
$tagId : int
$newName : string
Tags
throws
Exception

getGroupId()

public getGroupId(int $taskId) : int
Parameters
$taskId : int
Return values
int

getIdByGroup()

public getIdByGroup(int $groupId, mixed $tag) : int
Parameters
$groupId : int
$tag : mixed
Tags
throws
ObjectPropertyException
throws
SystemException
throws
ArgumentException
Return values
int

getIdByTask()

public getIdByTask(int $taskId, mixed $tag) : int
Parameters
$taskId : int
$tag : mixed
Tags
throws
ObjectPropertyException
throws
SystemException
throws
ArgumentException
Return values
int

getIdByUser()

public getIdByUser(array<string|int, mixed> $tag[, int $userId = 0 ]) : int
Parameters
$tag : array<string|int, mixed>
$userId : int = 0
Tags
throws
ObjectPropertyException
throws
SystemException
throws
ArgumentException
Return values
int

getTaskTags()

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

isExists()

public isExists(string $name, int $groupId, int $taskId) : bool
Parameters
$name : string
$groupId : int
$taskId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

isExistsByGroup()

public isExistsByGroup(int $groupId, string $name) : bool
Parameters
$groupId : int
$name : string
Tags
throws
ObjectPropertyException
throws
SystemException
throws
ArgumentException
Return values
bool

isExistsByTask()

public isExistsByTask(int $taskId, string $name) : bool
Parameters
$taskId : int
$name : string
Tags
throws
ObjectPropertyException
throws
SystemException
throws
ArgumentException
Return values
bool

isExistsByUser()

public isExistsByUser(string $name) : bool
Parameters
$name : string
Tags
throws
ObjectPropertyException
throws
SystemException
throws
ArgumentException
Return values
bool

linkTag()

public linkTag(int $taskId, int $tagId) : void
Parameters
$taskId : int
$tagId : int
Tags
throws
Exception

linkTags()

public linkTags(int $taskId, array<string|int, mixed> $tagIds) : void
Parameters
$taskId : int
$tagIds : array<string|int, mixed>
Tags
throws
ObjectPropertyException
throws
SystemException
throws
ArgumentException

set()

public set(int $taskId, array<string|int, mixed> $tags[, int $oldGroupId = 0 ][, int $newGroupId = 0 ][, bool $onlyAdd = false ]) : void
Parameters
$taskId : int
$tags : array<string|int, mixed>
$oldGroupId : int = 0
$newGroupId : int = 0
$onlyAdd : bool = false
Tags
throws
SystemException
throws
SqlQueryException
throws
ObjectPropertyException
throws
ArgumentException

unlinkTag()

public unlinkTag(int $taskId, int $tagId) : void
Parameters
$taskId : int
$tagId : int
Tags
throws
SqlQueryException
throws
SystemException
throws
ArgumentException

unlinkTags()

public unlinkTags(int $taskId) : void
Parameters
$taskId : int
Tags
throws
SqlQueryException
throws
SystemException
throws
ArgumentException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results