MeetingService
extends Base
in package
Class MeetingService.
Table of Contents
- DEFAULT_SERVICE = 0
- TABLE_NAME = 's_#__meeting_services'
- Table name.
- STATUS_ACTIVE = 1
- $value : array<string|int, mixed>
- __construct() : mixed
- Constructor.
- generateRoomName() : string
- Generate room name.
- 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.
- getData() : array<string|int, mixed>
- Function to get all the values of the Object.
- getDataFromUrl() : array<string|int, mixed>
- Gets data from URL.
- getDefaultService() : array<string|int, mixed>
- Gets default service data.
- 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).
- getInstance() : self
- Return object instance.
- getKeys() : array<string|int, string>
- Function to get keys.
- getRoomFromUrl() : string
- Gets room name from URL.
- getService() : array<string|int, mixed>
- Gets service data.
- getServices() : array<string|int, mixed>
- Gets services data.
- getUrl() : string
- Gets URL address.
- has() : bool
- Function to check if the key exists.
- isActive() : bool
- Checks if service is active.
- isEmpty() : bool
- Function to check if the key is empty.
- 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.
- validateUrl() : bool
- Check URL.
- getToken() : void
- Gets token.
Constants
DEFAULT_SERVICE
public
int
DEFAULT_SERVICE
= 0
Default service ID
TABLE_NAME
Table name.
public
mixed
TABLE_NAME
= 's_#__meeting_services'
STATUS_ACTIVE
private
int
STATUS_ACTIVE
= 1
Status active
Properties
$value
protected
array<string|int, mixed>
$value
Values
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
- $values : array<string|int, mixed> = []
Return values
mixed —generateRoomName()
Generate room name.
public
generateRoomName([string $prefix = '' ]) : string
Parameters
- $prefix : string = ''
Return values
string —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> —getData()
Function to get all the values of the Object.
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDataFromUrl()
Gets data from URL.
public
getDataFromUrl(string $url) : array<string|int, mixed>
Parameters
- $url : string
Return values
array<string|int, mixed> —getDefaultService()
Gets default service data.
public
static getDefaultService() : array<string|int, mixed>
Return values
array<string|int, mixed> —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
getInstance()
Return object instance.
public
static getInstance([int $serviceId = self::DEFAULT_SERVICE ]) : self
Parameters
- $serviceId : int = self::DEFAULT_SERVICE
Return values
self —getKeys()
Function to get keys.
public
getKeys() : array<string|int, string>
Return values
array<string|int, string> —getRoomFromUrl()
Gets room name from URL.
public
getRoomFromUrl(string $url) : string
Parameters
- $url : string
Return values
string —getService()
Gets service data.
public
static getService(int $serviceId) : array<string|int, mixed>
Parameters
- $serviceId : int
Return values
array<string|int, mixed> —getServices()
Gets services data.
public
static getServices() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUrl()
Gets URL address.
public
getUrl(array<string|int, mixed> $data[, int|null $userId = null ][, bool|null $moderator = false ]) : string
Parameters
- $data : array<string|int, mixed>
- $userId : int|null = null
- $moderator : bool|null = false
Return values
string —has()
Function to check if the key exists.
public
has(string $key) : bool
Parameters
- $key : string
Return values
bool —isActive()
Checks if service is active.
public
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 —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 —validateUrl()
Check URL.
public
validateUrl(string $url) : bool
Parameters
- $url : string
Return values
bool —getToken()
Gets token.
private
getToken(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>