PAMI\Message\Event\CELEvent

Event triggered when a CEL log message is generated

PHP Version 5

Constants

EOL

const EOL = "\r\n"

EOM

const EOM = "\r\n\r\n"

Properties

$rawContent

protected string $rawContent

Holds original message.

  • Visibility: protected

$channelVariables

protected array<mixed,string> $channelVariables

Metadata. Specific channel variables.

  • Visibility: protected

$lines

protected array<mixed,string> $lines

Message content, line by line. This is what it gets sent or received literally.

  • Visibility: protected

$variables

protected array<mixed,string> $variables

Metadata. Message variables (key/value).

  • Visibility: protected

$keys

protected array<mixed,string> $keys

Metadata. Message "keys" i.e: Action: login

  • Visibility: protected

$createdDate

protected integer $createdDate

Created date (unix timestamp).

  • Visibility: protected

Methods

getAMAFlags

string PAMI\Message\Event\CELEvent::getAMAFlags()

Returns key: 'AMAFlags'.

  • Visibility: public

getAccountCode

string PAMI\Message\Event\CELEvent::getAccountCode()

Returns key: 'AccountCode'.

  • Visibility: public

getAppData

string PAMI\Message\Event\CELEvent::getAppData()

Returns key: 'AppData'.

  • Visibility: public

getApplication

string PAMI\Message\Event\CELEvent::getApplication()

Returns key: 'Application'.

  • Visibility: public

getCallerIDani

string PAMI\Message\Event\CELEvent::getCallerIDani()

Returns key: 'CallerIDani'.

  • Visibility: public

getCallerIDdnid

string PAMI\Message\Event\CELEvent::getCallerIDdnid()

Returns key: 'CallerIDdnid'.

  • Visibility: public

getCallerIDname

string PAMI\Message\Event\CELEvent::getCallerIDname()

Returns key: 'CallerIDname'.

  • Visibility: public

getCallerIDnum

string PAMI\Message\Event\CELEvent::getCallerIDnum()

Returns key: 'CallerIDnum'.

  • Visibility: public

getCallerIDrdnis

string PAMI\Message\Event\CELEvent::getCallerIDrdnis()

Returns key: 'CallerIDrdnis'.

  • Visibility: public

getChannel

string PAMI\Message\Event\CELEvent::getChannel()

Returns key: 'Channel'.

  • Visibility: public

getContext

string PAMI\Message\Event\CELEvent::getContext()

Returns key: 'Context'.

  • Visibility: public

getEvent

string PAMI\Message\Event\CELEvent::getEvent()

Returns key: 'Event'.

  • Visibility: public

getEventName

string PAMI\Message\Event\CELEvent::getEventName()

Returns key: 'EventName'.

  • Visibility: public

getEventTime

string PAMI\Message\Event\CELEvent::getEventTime()

Returns key: 'EventTime'.

  • Visibility: public

getExten

string PAMI\Message\Event\CELEvent::getExten()

Returns key: 'Exten'.

  • Visibility: public

getExtra

string PAMI\Message\Event\CELEvent::getExtra()

Returns key: 'Extra'.

  • Visibility: public

getLinkedID

string PAMI\Message\Event\CELEvent::getLinkedID()

Returns key: 'LinkedID'.

  • Visibility: public

getPeer

string PAMI\Message\Event\CELEvent::getPeer()

Returns key: 'Peer'.

  • Visibility: public

getPeerAccount

string PAMI\Message\Event\CELEvent::getPeerAccount()

Returns key: 'PeerAccount'.

  • Visibility: public

getPrivilege

string PAMI\Message\Event\CELEvent::getPrivilege()

Returns key: 'Privilege'.

  • Visibility: public

getTimestamp

string PAMI\Message\Event\CELEvent::getTimestamp()

Returns key: 'Timestamp'.

  • Visibility: public

getUniqueID

string PAMI\Message\Event\CELEvent::getUniqueID()

Returns key: 'UniqueID'.

  • Visibility: public

getUserfield

string PAMI\Message\Event\CELEvent::getUserfield()

Returns key: 'Userfield'.

  • Visibility: public

getName

string PAMI\Message\Event\EventMessage::getName()

Returns key 'Event'.

__sleep

array<mixed,string> PAMI\Message\Message::__sleep()

Serialize function.

getEventList

string PAMI\Message\IncomingMessage::getEventList()

Returns key 'EventList'. In respones, this will surely be a "start". In events, should be a "complete".

getRawContent

string PAMI\Message\IncomingMessage::getRawContent()

Returns the original message content without parsing.

getAllChannelVariables

array PAMI\Message\IncomingMessage::getAllChannelVariables()

Returns the channel variables for all reported channels.

https://github.com/marcelog/PAMI/issues/85

The channel names will be lowercased.

getChannelVariables

array PAMI\Message\IncomingMessage::getChannelVariables(string $channel)

Returns the channel variables for the given channel.

https://github.com/marcelog/PAMI/issues/85

Arguments

  • $channel string - <p>Channel name. If not given, will return variables for the "current" channel.</p>

__construct

void PAMI\Message\Message::__construct()

Constructor.

getCreatedDate

integer PAMI\Message\Message::getCreatedDate()

Returns created date.

setVariable

void PAMI\Message\Message::setVariable(string $key, string $value)

Adds a variable to this message.

Arguments

  • $key string - <p>Variable name.</p>
  • $value string - <p>Variable value.</p>

getVariable

string PAMI\Message\Message::getVariable(string $key)

Returns a variable by name.

Arguments

  • $key string - <p>Variable name.</p>

setKey

void PAMI\Message\Message::setKey(string $key, string $value)

Adds a variable to this message.

Arguments

  • $key string - <p>Key name (i.e: Action).</p>
  • $value string - <p>Key value.</p>

getKey

string PAMI\Message\Message::getKey(string $key)

Returns a key by name.

Arguments

  • $key string - <p>Key name (i.e: Action).</p>

getKeys

array<mixed,string> PAMI\Message\Message::getKeys()

Returns all keys for this message.

getVariables

array<mixed,string> PAMI\Message\Message::getVariables()

Returns all variabels for this message.

finishMessage

string PAMI\Message\Message::finishMessage($message)

Returns the end of message token appended to the end of a given message.

Arguments

  • $message mixed

serializeVariable

string PAMI\Message\Message::serializeVariable(string $key, string $value)

Returns the string representation for an ami action variable.

Arguments

  • $key string
  • $value string

serialize

string PAMI\Message\Message::serialize()

Gives a string representation for this message, ready to be sent to ami.

getActionID

string PAMI\Message\Message::getActionID()

Returns key: 'ActionID'.