Shared
extends Atom
in package
Common shared object
Tags
Table of Contents
- $configuration : array<string|int, mixed>
- Pole konfigurací.
- $debug : bool
- Debug mode flag.
- $messages : array<string|int, mixed>
- Array of Status Messages
- $statusMessages : array<string|int, mixed>
- Status messeges lives here
- $userSessionName : string
- session item name with user object
- $instance : Shared
- Saves obejct instace (singleton...).
- __construct() : mixed
- Inicializace sdílené třídy.
- __toString() : string
- Magical function for all descendants (childern).
- appName() : string
- Application name or "Composer project Name" fallback
- appVersion() : string
- Application version or "0.0.0" fallback
- cfg() : string|int|bool|null
- Get configuration from constant or environment
- draw() : string
- Default draw method.
- getConfigValue() : mixed
- Vrací konfigurační hodnotu pod klíčem.
- getObjectName() : string
- Returns object name
- init() : bool
- Load required Initial Configuration
- instanced() : Shared
- Vrací se.
- loadConfig() : array<string|int, mixed>
- Load Configuration values from json file $this->configFile and define UPPERCASE keys
- loadStatusMessages() : array<string|int, mixed>
- Load status Messages from session
- logger() : Regent
- Vrací instanci objektu logování.
- msgFile() : string
- File with stored messages
- saveStatusMessages() : int
- Write remaining messages to temporary file.
- setConfigValue() : mixed
- Nastavuje hodnotu konfiguračního klíče.
- singleton() : Shared
- Pri vytvareni objektu pomoci funkce singleton (ma stejne parametry, jako konstruktor) se bude v ramci behu programu pouzivat pouze jedna jeho Instance (ta prvni).
- user() : User
- Gives you shared User object. Create it first if not exist yet.
Properties
$configuration
Pole konfigurací.
public
array<string|int, mixed>
$configuration
= []
$debug
Debug mode flag.
public
bool
$debug
= false
$messages
Array of Status Messages
public
array<string|int, mixed>
$messages
= []
of Logger\Message
$statusMessages
Status messeges lives here
public
static array<string|int, mixed>
$statusMessages
= []
$userSessionName
session item name with user object
public
static string
$userSessionName
= 'User'
$instance
Saves obejct instace (singleton...).
private
static Shared
$instance
= null
Methods
__construct()
Inicializace sdílené třídy.
public
__construct() : mixed
Return values
mixed —__toString()
Magical function for all descendants (childern).
public
__toString() : string
Return values
string —appName()
Application name or "Composer project Name" fallback
public
static appName() : string
Return values
string —appVersion()
Application version or "0.0.0" fallback
public
static appVersion() : string
Return values
string —cfg()
Get configuration from constant or environment
public
static cfg(string $constant[, mixed $cfg = null ]) : string|int|bool|null
Parameters
- $constant : string
- $cfg : mixed = null
-
Default value
Return values
string|int|bool|null —draw()
Default draw method.
public
draw() : string
Return values
string —getConfigValue()
Vrací konfigurační hodnotu pod klíčem.
public
getConfigValue(string $configName) : mixed
Parameters
- $configName : string
-
klíč
Return values
mixed —getObjectName()
Returns object name
public
getObjectName() : string
Return values
string —init()
Load required Initial Configuration
public
static init([array<string|int, mixed> $configKeys = [] ][, string $envFile = '' ][, bool $exit = true ]) : bool
Parameters
- $configKeys : array<string|int, mixed> = []
- $envFile : string = ''
- $exit : bool = true
-
do exit(1) when unsuccessful ?
Return values
bool —Configuration success
instanced()
Vrací se.
public
static instanced() : Shared
Return values
Shared —loadConfig()
Load Configuration values from json file $this->configFile and define UPPERCASE keys
public
loadConfig(string $configFile[, bool $defineConstants = false ]) : array<string|int, mixed>
Parameters
- $configFile : string
-
Path to file with configuration
- $defineConstants : bool = false
-
false to do not define constants
Return values
array<string|int, mixed> —full configuration array
loadStatusMessages()
Load status Messages from session
public
static loadStatusMessages([string $sessID = 'EaseStatusMessages' ]) : array<string|int, mixed>
Parameters
- $sessID : string = 'EaseStatusMessages'
Return values
array<string|int, mixed> —logger()
Vrací instanci objektu logování.
public
static logger([mixed $loggers = null ]) : Regent
Parameters
- $loggers : mixed = null
Return values
Regent —msgFile()
File with stored messages
public
static msgFile([string $sessID = 'EaseStatusMessages' ]) : string
Parameters
- $sessID : string = 'EaseStatusMessages'
Return values
string —saveStatusMessages()
Write remaining messages to temporary file.
public
saveStatusMessages([mixed $sessID = 'EaseStatusMessages' ]) : int
Parameters
- $sessID : mixed = 'EaseStatusMessages'
Return values
int —bytes saved
setConfigValue()
Nastavuje hodnotu konfiguračního klíče.
public
setConfigValue(string $configName, mixed $configValue) : mixed
Parameters
- $configName : string
-
klíč
- $configValue : mixed
-
hodnota klíče
Return values
mixed —singleton()
Pri vytvareni objektu pomoci funkce singleton (ma stejne parametry, jako konstruktor) se bude v ramci behu programu pouzivat pouze jedna jeho Instance (ta prvni).
public
static singleton() : Shared
Tags
Return values
Shared —user()
Gives you shared User object. Create it first if not exist yet.
public
static user([Person|User|Anonym|string $user = null ][, string $candidat = 'User' ][, string $userSessionName = 'User' ]) : User
Parameters
- $user : Person|User|Anonym|string = null
-
objekt nového uživatele nebo název třídy
- $candidat : string = 'User'
- $userSessionName : string = 'User'