Bitrix API

Event extends BaseObject

Table of Contents

Constants

EVENT_FIELD_BALLOT_TEMPLATE  = self::EVENT_FIELD_NAME . "[#ID#][BALLOT][#QUESTION_ID#]"
EVENT_FIELD_EXTRAS_TEMPLATE  = self::EVENT_FIELD_NAME . "[#ID#][EXTRAS][#ENTITY_ID#]"
EVENT_FIELD_MESSAGE_TEMPLATE  = self::EVENT_FIELD_NAME . "[#ID#][MESSAGE][#QUESTION_ID#][#ANSWER_ID#]"
EVENT_FIELD_NAME  = "bx_vote_event"
EVENT_FIELD_BALLOT_TEMPLATE - is a template to catch voting [#ID#][BALLOT][#QUESTION_ID#][#ANSWER_ID#][MESSAGE] - template for text

Methods

__construct()  : mixed
Event constructor.
add()  : Dictionary|null
calculateStatistic()  : void
canEdit()  : bool
canRead()  : bool
check()  : array<string|int, mixed>
deleteEvent()  : bool
getApplication()  : CMain
getDataFromRequest()  : mixed
getErrorByCode()  : Error|null
getErrors()  : array<string|int, Error>
getExtrasFieldName()  : mixed
getFieldName()  : mixed
getId()  : int
getMessageFieldName()  : mixed
getUser()  : CUser
init()  : void
exists only for child class
loadFromId()  : BaseObject
loadUserGroups()  : array<string|int, mixed>
resetStatistic()  : void
setValid()  : bool
shutdown()  : mixed
Debug function

Constants

EVENT_FIELD_BALLOT_TEMPLATE

public mixed EVENT_FIELD_BALLOT_TEMPLATE = self::EVENT_FIELD_NAME . "[#ID#][BALLOT][#QUESTION_ID#]"

EVENT_FIELD_EXTRAS_TEMPLATE

public mixed EVENT_FIELD_EXTRAS_TEMPLATE = self::EVENT_FIELD_NAME . "[#ID#][EXTRAS][#ENTITY_ID#]"

EVENT_FIELD_MESSAGE_TEMPLATE

public mixed EVENT_FIELD_MESSAGE_TEMPLATE = self::EVENT_FIELD_NAME . "[#ID#][MESSAGE][#QUESTION_ID#][#ANSWER_ID#]"

EVENT_FIELD_NAME

EVENT_FIELD_BALLOT_TEMPLATE - is a template to catch voting [#ID#][BALLOT][#QUESTION_ID#][#ANSWER_ID#][MESSAGE] - template for text

public mixed EVENT_FIELD_NAME = "bx_vote_event"

Methods

__construct()

Event constructor.

public __construct(Vote $vote) : mixed
Parameters
$vote : Vote

add()

public add(array<string|int, mixed> $eventFields, array<string|int, mixed> $ballot[, mixed $setCounter = true ]) : Dictionary|null
Parameters
$eventFields : array<string|int, mixed>
$ballot : array<string|int, mixed>
$setCounter : mixed = true
Return values
Dictionary|null

calculateStatistic()

public static calculateStatistic(int $voteId) : void
Parameters
$voteId : int

Vote Id.

canEdit()

public canEdit(int $userId) : bool
Parameters
$userId : int

User ID.

Return values
bool

canRead()

public canRead(int $userId) : bool
Parameters
$userId : int

User ID.

Return values
bool

check()

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

deleteEvent()

public static deleteEvent(int $eventId) : bool
Parameters
$eventId : int

Event ID.

Return values
bool

getDataFromRequest()

public static getDataFromRequest(mixed $id, array<string|int, mixed> $request) : mixed
Parameters
$id : mixed
$request : array<string|int, mixed>

getErrorByCode()

public getErrorByCode(string|int $code) : Error|null
Parameters
$code : string|int

The code of the error.

Tags
inheritdoc

Returns an error with the necessary code.

Return values
Error|null

getExtrasFieldName()

public static getExtrasFieldName(mixed $id, mixed $name) : mixed
Parameters
$id : mixed
$name : mixed

getFieldName()

public static getFieldName(mixed $id, mixed $questionId) : mixed
Parameters
$id : mixed
$questionId : mixed

getMessageFieldName()

public static getMessageFieldName(mixed $id, mixed $questionId, mixed $answerId) : mixed
Parameters
$id : mixed
$questionId : mixed
$answerId : mixed

init()

exists only for child class

public init() : void

loadFromId()

public static loadFromId(int $id[, bool $shouldBeNewIfIdIsNull = false ]) : BaseObject
Parameters
$id : int

Entity ID.

$shouldBeNewIfIdIsNull : bool = false
Return values
BaseObject

loadUserGroups()

public static loadUserGroups(int $userId) : array<string|int, mixed>
Parameters
$userId : int

User ID.

Return values
array<string|int, mixed>

resetStatistic()

public static resetStatistic(int $voteId) : void
Parameters
$voteId : int

Vote Id.

setValid()

public static setValid(int $eventId, string $valid) : bool
Parameters
$eventId : int

Event ID.

$valid : string

Validation ("Y" || "N").

Return values
bool

shutdown()

Debug function

public static shutdown() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results