Documentation

Pbx extends Base
in package

Pbx main class.

Tags
copyright

YetiForce Sp. z o.o

license

YetiForce Public License 4.0 (licenses/LicenseEN.txt or yetiforce.com)

author

Mariusz Krzaczkowski m.krzaczkowski@yetiforce.com

Table of Contents

$value  : mixed
$connectors  : array<string|int, className>
Connector Instances.
__construct()  : mixed
Constructor.
get()  : mixed
Function to get the value for a given key.
getArray()  : array<string|int, mixed>
Function to get the array values for a given key.
getConfig()  : mixed
Function to get the confog param for a given key.
getConnectorInstance()  : className|bool
Get connector instance.
getConnectors()  : className
Get pbx connectors.
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getDefaultInstance()  : self
Get default pbx instance.
getForHtml()  : mixed
Function to get the html encoded value for a given key.
getForSql()  : mixed
Function to get the value if its safe to use for SQL Query (column).
getKeys()  : array<string|int, string>
Function to get keys.
has()  : bool
Function to check if the key exists.
isActive()  : bool
Whether a call is active with the PBX integration.
isEmpty()  : bool
Function to check if the key is empty.
loadUserPhone()  : mixed
Load user phone.
performCall()  : mixed
Perform phone call.
remove()  : mixed
Function to remove the value.
set()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.

Properties

$value

protected mixed $value

$connectors

Connector Instances.

private static array<string|int, className> $connectors = []

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
$values : array<string|int, mixed> = []
Return values
mixed

get()

Function to get the value for a given key.

public get(string $key) : mixed
Parameters
$key : string
Return values
mixed

Value for the given key

getArray()

Function to get the array values for a given key.

public getArray(string $key[, array<string|int, mixed> $value = [] ]) : array<string|int, mixed>
Parameters
$key : string
$value : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getConfig()

Function to get the confog param for a given key.

public getConfig(string $key) : mixed
Parameters
$key : string
Return values
mixed

Value for the given key

getConnectorInstance()

Get connector instance.

public static getConnectorInstance(string $name) : className|bool
Parameters
$name : string
Return values
className|bool

getConnectors()

Get pbx connectors.

public static getConnectors() : className
Return values
className

getData()

Function to get all the values of the Object.

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

getDefaultInstance()

Get default pbx instance.

public static getDefaultInstance() : self
Return values
self

getForHtml()

Function to get the html encoded value for a given key.

public getForHtml(string $key) : mixed
Parameters
$key : string
Return values
mixed

getForSql()

Function to get the value if its safe to use for SQL Query (column).

public getForSql(string $key[, bool $skipEmtpy = true ]) : mixed
Parameters
$key : string
$skipEmtpy : bool = true

Skip the check if string is empty

Return values
mixed

Value for the given key

getKeys()

Function to get keys.

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

has()

Function to check if the key exists.

public has(string $key) : bool
Parameters
$key : string
Return values
bool

isActive()

Whether a call is active with the PBX integration.

public static isActive() : bool
Return values
bool

isEmpty()

Function to check if the key is empty.

public isEmpty(string $key) : bool
Parameters
$key : string
Return values
bool

loadUserPhone()

Load user phone.

public loadUserPhone() : mixed
Return values
mixed

performCall()

Perform phone call.

public performCall(string $targetPhone) : mixed
Parameters
$targetPhone : string
Tags
throws
Exception
Return values
mixed

remove()

Function to remove the value.

public remove(string $key) : mixed
Parameters
$key : string
Return values
mixed

set()

Function to set the value for a given key.

public set(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed
Return values
$this

setData()

Function to set all the values.

public setData(mixed $values) : $this
Parameters
$values : mixed
Return values
$this

        

Search results