Documentation

Config extends Base
in package

Class Config.

Table of Contents

TABLE_NAME  = 'i_#__magento_config'
Table name.
$value  : mixed
__construct()  : mixed
Constructor.
get()  : mixed
Function to get the value for a given key.
getAllServers()  : array<string|int, mixed>
Get all servers.
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.
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
Function to get object to read configuration.
getKeys()  : array<string|int, string>
Function to get keys.
getLastScan()  : array<string|int, mixed>
Get last scan information.
getServer()  : array<string|int, string>
Get server by id.
has()  : bool
Function to check if the key exists.
isEmpty()  : bool
Function to check if the key is empty.
reload()  : void
Reload integration with magento.
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.
setEndScan()  : void
Set end scan.
setScan()  : void
Save in db last scanned id.

Constants

TABLE_NAME

Table name.

private mixed TABLE_NAME = 'i_#__magento_config'

Properties

$value

protected mixed $value

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

getAllServers()

Get all servers.

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

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>

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()

Function to get object to read configuration.

public static getInstance(int $serverId) : self
Parameters
$serverId : int
Return values
self

getKeys()

Function to get keys.

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

getLastScan()

Get last scan information.

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

getServer()

Get server by id.

public static getServer(int $id) : array<string|int, string>
Parameters
$id : int
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

isEmpty()

Function to check if the key is empty.

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

reload()

Reload integration with magento.

public static reload(int $id) : void
Parameters
$id : int
Return values
void

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

setEndScan()

Set end scan.

public setEndScan(string $type, string $date) : void
Parameters
$type : string
$date : string
Tags
throws
Exception
Return values
void

setScan()

Save in db last scanned id.

public setScan(string $type[, bool|string $name = false ][, bool|int $id = false ]) : void
Parameters
$type : string
$name : bool|string = false
$id : bool|int = false
Tags
throws
Exception
Return values
void

        

Search results