DealChannelBinding
Class DealChannelBinding Managing of Deal bindings to external channels.
Table of Contents
Methods
- attach() : mixed
- detach() : mixed
- exists() : bool
- Check if specified Deal has bindings to channel.
- getAll() : array<string|int, mixed>
- Get all bindings to channels for specified Deal.
- register() : void
- Register binding to the channel for specified Deal.
- synchronize() : mixed
- Synchronize Deal statistics.
- unregister() : void
- Unregister binding to the channel for specified Deal.
- unregisterAll() : void
- Unregister bindings to all channels for specified Deal.
Methods
attach()
public
static attach(mixed $srcEntityTypeID, mixed $srcEntityID, mixed $dstEntityID) : mixed
Parameters
- $srcEntityTypeID : mixed
- $srcEntityID : mixed
- $dstEntityID : mixed
detach()
public
static detach(mixed $srcEntityTypeID, mixed $srcEntityID, mixed $dstEntityID) : mixed
Parameters
- $srcEntityTypeID : mixed
- $srcEntityID : mixed
- $dstEntityID : mixed
exists()
Check if specified Deal has bindings to channel.
public
static exists(int $ID) : bool
Parameters
- $ID : int
-
Deal ID.
Tags
Return values
boolgetAll()
Get all bindings to channels for specified Deal.
public
static getAll(int $ID) : array<string|int, mixed>
Parameters
- $ID : int
-
Deal ID.
Tags
Return values
array<string|int, mixed>register()
Register binding to the channel for specified Deal.
public
static register(int $ID, ChannelType $typeID[, array<string|int, mixed> $params = null ]) : void
Parameters
- $ID : int
-
Deal ID.
- $typeID : ChannelType
-
Channel Type ID.
- $params : array<string|int, mixed> = null
-
Array of binding parameters. For example ORIGIN_ID and COMPONENT_ID.
Tags
synchronize()
Synchronize Deal statistics.
public
static synchronize(int $ID, array<string|int, mixed> $fields) : mixed
Parameters
- $ID : int
-
Deal ID
- $fields : array<string|int, mixed>
-
Deal Fields
Tags
unregister()
Unregister binding to the channel for specified Deal.
public
static unregister(int $ID, ChannelType $typeID) : void
Parameters
- $ID : int
-
Deal ID.
- $typeID : ChannelType
-
Channel Type ID.
Tags
unregisterAll()
Unregister bindings to all channels for specified Deal.
public
static unregisterAll(int $ID) : void
Parameters
- $ID : int
-
Deal ID.