Bitrix API

BaseObject

AbstractYes

Table of Contents

Constants

ERROR_PARAMS_ENTITY_ID  = 'params0003'
ERROR_PARAMS_FORUM_ID  = 'params0001'
ERROR_PARAMS_TOPIC_ID  = 'params0002'

Methods

__construct()  : mixed
getApplication()  : CMain
getEntity()  : Entity
Returns entity which manage all rights. For example forum topic or task
getErrors()  : array<string|int, mixed>
getForum()  : array<string|int, mixed>
Returns forum
getTopic()  : array<string|int, mixed>
Returns forum topic
getUser()  : User
getUserUnreadMessageId()  : mixed
hasErrors()  : bool
setForumFields()  : $this
Redefines forum params
setUserAsRead()  : mixed
setUserLocation()  : mixed

Constants

ERROR_PARAMS_ENTITY_ID

public mixed ERROR_PARAMS_ENTITY_ID = 'params0003'

ERROR_PARAMS_FORUM_ID

public mixed ERROR_PARAMS_FORUM_ID = 'params0001'

ERROR_PARAMS_TOPIC_ID

public mixed ERROR_PARAMS_TOPIC_ID = 'params0002'

Methods

__construct()

public __construct(mixed $forumId, mixed $entity[, mixed $userId = null ]) : mixed
Parameters
$forumId : mixed
$entity : mixed
$userId : mixed = null

getApplication()

public getApplication() : CMain
Return values
CMain

getEntity()

Returns entity which manage all rights. For example forum topic or task

public getEntity() : Entity
Return values
Entity

getErrors()

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

getForum()

Returns forum

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

getTopic()

Returns forum topic

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

getUserUnreadMessageId()

public getUserUnreadMessageId() : mixed

hasErrors()

public hasErrors() : bool
Return values
bool

setForumFields()

Redefines forum params

public setForumFields(array<string|int, mixed> $params) : $this
Parameters
$params : array<string|int, mixed>

Array(key=>value, key2=>value2) of fields to redefine forum fields.

Return values
$this

setUserLocation()

public setUserLocation() : mixed

        
On this page

Search results