Config
in package
Config main class.
Table of Contents
- $jsEnv : array<string|int, mixed>
- Js environment variables.
- api() : mixed
- Gets api configuration.
- component() : mixed
- Gets component configuration.
- db() : mixed
- Gets database configuration.
- debug() : mixed
- Gets debug configuration.
- developer() : mixed
- Gets developer configuration.
- get() : mixed
- Gets configuration for class.
- getJsEnv() : string
- Get all js configuration in json.
- getJsEnvByKey() : mixed
- Get js configuration by key.
- getMaxUploadSize() : int
- Get the maximum size of an uploaded file to the server taking into account CRM configuration and server settings.
- layout() : mixed
- Gets layout configuration.
- main() : mixed
- Gets main configuration.
- module() : mixed
- Gets module configuration.
- performance() : mixed
- Gets performance configuration.
- relation() : mixed
- Gets relation configuration.
- search() : mixed
- Gets search configuration.
- security() : mixed
- Gets security configuration.
- securityKeys() : mixed
- Gets security keys configuration.
- set() : bool
- Set config value.
- setJsEnv() : mixed
- Set js environment variables.
- sounds() : mixed
- Gets sounds configuration.
Properties
$jsEnv
Js environment variables.
private
static array<string|int, mixed>
$jsEnv
= []
Methods
api()
Gets api configuration.
public
static api([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —component()
Gets component configuration.
public
static component(string $component[, string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $component : string
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —db()
Gets database configuration.
public
static db([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —debug()
Gets debug configuration.
public
static debug([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —developer()
Gets developer configuration.
public
static developer([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —get()
Gets configuration for class.
public
static get(string $class[, string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $class : string
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —getJsEnv()
Get all js configuration in json.
public
static getJsEnv() : string
Tags
Return values
string —getJsEnvByKey()
Get js configuration by key.
public
static getJsEnvByKey(string $key) : mixed
Parameters
- $key : string
Return values
mixed —getMaxUploadSize()
Get the maximum size of an uploaded file to the server taking into account CRM configuration and server settings.
public
static getMaxUploadSize([bool $checkMain = true ][, bool $returnInMb = false ]) : int
Parameters
- $checkMain : bool = true
- $returnInMb : bool = false
Return values
int —layout()
Gets layout configuration.
public
static layout([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —main()
Gets main configuration.
public
static main([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —module()
Gets module configuration.
public
static module(string $moduleName[, string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $moduleName : string
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —performance()
Gets performance configuration.
public
static performance([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —relation()
Gets relation configuration.
public
static relation([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —search()
Gets search configuration.
public
static search([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —security()
Gets security configuration.
public
static security([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —securityKeys()
Gets security keys configuration.
public
static securityKeys([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null
Tags
Return values
mixed —set()
Set config value.
public
static set() : bool
Return values
bool —setJsEnv()
Set js environment variables.
public
static setJsEnv(string $key, mixed $value) : mixed
Parameters
- $key : string
- $value : mixed
Return values
mixed —sounds()
Gets sounds configuration.
public
static sounds([string|null $arg = null ][, mixed $default = null ]) : mixed
Parameters
- $arg : string|null = null
- $default : mixed = null