Documentation

Shared extends Atom
in package

Common shared object

Tags
copyright

2009-2021 Vitex@hippy.cz (G)

author

Vitex vitex@hippy.cz

Table of Contents

$configuration  : array
Pole konfigurací.
$debug  : bool
Flag debugovacího režimu.
$frameworkVersion  : string
Version of EasePHP Framework
$messages  : array
Array of Status Messages
$userSessionName  : string
session item name with user object
$instance  : Shared
Saves obejct instace (singleton...).
__construct()  : mixed
Inicializace sdílené třídy.
__toString()  : string
Magická funkce pro všechny potomky.
appName()  : string
Application name or "EaseFramework" fallback
draw()  : string
Default Draw method.
getConfigValue()  : mixed
Vrací konfigurační hodnotu pod klíčem.
getObjectName()  : string
Vrací jméno objektu.
instanced()  : Shared
Vrací se.
loadConfig()  : array
Load Configuration values from json file $this->configFile and define UPPERCASE keys
loadStatusMessages()  : array
logger()  : Logger
Vrací instanci objektu logování.
msgFile()  : mixed
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
Vrací, případně i založí objekt uživatele.

Properties

$configuration

Pole konfigurací.

public array $configuration = []

$debug

Flag debugovacího režimu.

public bool $debug = false

$frameworkVersion

Version of EasePHP Framework

public static string $frameworkVersion = '0.5'

$messages

Array of Status Messages

public array $messages = []

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

Magická funkce pro všechny potomky.

public __toString() : string
Return values
string

appName()

Application name or "EaseFramework" fallback

public static appName() : string
Return values
string

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

Vrací jméno objektu.

public getObjectName() : string
Return values
string

loadConfig()

Load Configuration values from json file $this->configFile and define UPPERCASE keys

public loadConfig(string $configFile[, bool $defineConstants = false ]) : array
Parameters
$configFile : string

Path to file with configuration

$defineConstants : bool = false

false to do not define constants

Return values
array

full configuration array

loadStatusMessages()

public static loadStatusMessages([string $sessID = 'EaseStatusMessages' ]) : array
Parameters
$sessID : string = 'EaseStatusMessages'
Return values
array

logger()

Vrací instanci objektu logování.

public static logger() : Logger
Return values
Logger

msgFile()

public static msgFile([mixed $sessID = 'EaseStatusMessages' ]) : mixed
Parameters
$sessID : mixed = 'EaseStatusMessages'
Return values
mixed

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
link

Dokumentace a priklad

Return values
Shared

user()

Vrací, případně i založí objekt uživatele.

public static user([User|Anonym|string $user = null ][, string $candidat = 'User' ][, string $userSessionName = 'User' ]) : User
Parameters
$user : User|Anonym|string = null

objekt nového uživatele nebo název třídy

$candidat : string = 'User'
$userSessionName : string = 'User'
Return values
User

Search results