User
extends Anonym
in package
User Class
Tags
Table of Contents
- $data : array<string|int, mixed>|null
- Common object data holder.
- $debug : bool
- Debug mode flag.
- $disableColumn : string
- Sloupecek pro docasne zablokovani uctu.
- $easeShared : Shared
- Sdílený objekt frameworku.
- $instance : User|null
- $keyColumn : string
- Key Column for Current Record
- $langCode : string
- Default Language Code.
- $logged : bool
- Login indicator.
- $logger : Regent|null
- Objekt pro logování.
- $loginColumn : string|null
- Sloupeček s loginem.
- $mailColumn : string
- Column for user mail.
- $nameColumn : string
- $objectName : string
- Object name
- $parentObject : Sand|mixed
- Odkaz na vlastnící objekt.
- $passwordColumn : string
- Password Column.
- $permissions : array<string|int, mixed>
- Store of user permissions
- $plaintextField : string
- Plaintext Form input name.
- $settings : array<string|int, mixed>
- Pole uživatelských nastavení.
- $settingsColumn : string
- Sloupeček obsahující serializované rozšířené informace.
- $type : string
- User type.
- $userID : int|null
- ID prave nacteneho uzivatele.
- $userLogin : string|null
- Přihlašovací jméno uživatele.
- __construct() : mixed
- Objekt uživatele aplikace.
- __sleep() : array<string|int, mixed>
- Pro serializaci připraví vše.
- __toString() : string
- Magical function for all descendants (childern).
- addStatusMessage() : bool
- Add message to stack to show or write to file Přidá zprávu do zásobníku pro zobrazení uživateli inbo do logu.
- authentize() : bool
- Try to authentize user
- cleanSatatusMessages() : bool
- Erase all status messages
- dataReset() : mixed
- Vynuluje všechny pole vlastností objektu.
- draw() : mixed
- Vykreslí GrAvatara uživatele.
- encryptPassword() : string
- Zašifruje heslo.
- getData() : array<string|int, mixed>
- Obtain data holded by object
- getDataCount() : int
- Vrací počet položek dat objektu.
- getDataValue() : mixed
- Vrací hodnotu z pole dat pro MySQL.
- getGravatar() : string
- Get either a Gravatar URL or complete image tag for a specified email address.
- getIcon() : string
- Vrací odkaz na url ikony.
- getKeyColumn() : string
- Gives you Current KeyColumn Name
- getLogger() : Regent
- Provide logger object
- getMyKey() : int
- Gives you value of KEY Column
- getName() : string
- Vrací jméno objektu uživatele.
- getObjectName() : string
- Returns object name
- getPermission() : mixed
- Vrací hodnotu uživatelského oprávnění.
- getSettingValue() : mixed
- Vrací hodnotu nastavení.
- getStatusMessages() : array<string|int, mixed>
- Obtain global status messages
- getUserEmail() : string
- Retrun user's mail address.
- getUserID() : int
- Vraci ID přihlášeného uživatele.
- getUserLevel() : int
- Anonymous has a level
- getUserLogin() : string
- Vrací login uživatele.
- getUserName() : string
- Give you user name.
- howToProcess() : string
- How to process
- isAccountEnabled() : bool
- Je učet povolen ?
- isLogged() : bool
- Anonymous cannot be logged.
- loadPermissions() : mixed
- Načte oprávnění.
- logBanner() : mixed
- Add Info about used PHP and EasePHP Library
- loginSuccess() : bool
- Akce provedené po úspěšném přihlášení pokud tam jeste neexistuje zaznam, vytvori se novy.
- logout() : bool
- Provede odhlášení uživatele.
- passwordChange() : bool
- Změní uživateli uložené heslo.
- passwordValidation() : bool
- Ověření hesla.
- remoteToIdentity() : string
- Returns user identity with logname if logged
- setData() : int
- Načte $data do polí objektu.
- setDataValue() : bool
- Set data filed value
- setInit() : mixed
- Object init value stub
- setKeyColumn() : mixed
- Nastaví jméno klíčového sloupečku v shopu.
- setMyKey() : bool
- Nastavuje hodnotu klíčového políčka pro SQL.
- setObjectName() : string
- Nastavení jména objektu uživatele.
- setProperties() : mixed
- Set/override object properties objectName and keyColumn
- setSettings() : mixed
- Nastavuje nastavení.
- setSettingValue() : mixed
- Nastaví položku nastavení.
- setupProperty() : mixed
- Set up one of the properties by 1) array 2) ENV 3) Constant
- setUserLogin() : bool
- Nastavuje login uživatele.
- singleton() : User
- Common instance of User class
- takeData() : int
- Převezme data do aktuálního pole dat.
- tryToLogin() : null|bool
- Pokusí se o přihlášení.
- unsetDataValue() : bool
- Odstrani polozku z pole dat pro MySQL.
- useIdentifier() : mixed
- Use Given value as identifier
- validatePassword() : bool
- Try to validate Password
Properties
$data
Common object data holder.
public
array<string|int, mixed>|null
$data
= null
$debug
Debug mode flag.
public
bool
$debug
= false
$disableColumn
Sloupecek pro docasne zablokovani uctu.
public
string
$disableColumn
= null
$easeShared
Sdílený objekt frameworku.
public
Shared
$easeShared
= null
$instance
public
static User|null
$instance
Singleton is stored here
$keyColumn
Key Column for Current Record
public
string
$keyColumn
= 'id'
$langCode
Default Language Code.
public
string
$langCode
= null
$logged
Login indicator.
public
bool
$logged
= false
$logger
Objekt pro logování.
public
Regent|null
$logger
= null
$loginColumn
Sloupeček s loginem.
public
string|null
$loginColumn
= 'login'
$mailColumn
Column for user mail.
public
string
$mailColumn
= 'email'
$nameColumn
public
string
$nameColumn
= null
Name Column
$objectName
Object name
public
string
$objectName
= 'Molecule'
$parentObject
Odkaz na vlastnící objekt.
public
Sand|mixed
$parentObject
= null
object
$passwordColumn
Password Column.
public
string
$passwordColumn
= 'password'
$permissions
Store of user permissions
public
array<string|int, mixed>
$permissions
= []
$plaintextField
Plaintext Form input name.
public
string
$plaintextField
= 'password'
$settings
Pole uživatelských nastavení.
public
array<string|int, mixed>
$settings
= []
$settingsColumn
Sloupeček obsahující serializované rozšířené informace.
public
string
$settingsColumn
= null
$type
User type.
public
string
$type
= 'Anonymous'
$userID
ID prave nacteneho uzivatele.
public
int|null
$userID
= null
unsigned
$userLogin
Přihlašovací jméno uživatele.
public
string|null
$userLogin
= null
Methods
__construct()
Objekt uživatele aplikace.
public
__construct([int $userID = null ]) : mixed
Parameters
- $userID : int = null
-
ID nebo Login uživatele jenž se má načíst při inicializaci třídy
Return values
mixed —__sleep()
Pro serializaci připraví vše.
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed> —__toString()
Magical function for all descendants (childern).
public
__toString() : string
Return values
string —addStatusMessage()
Add message to stack to show or write to file Přidá zprávu do zásobníku pro zobrazení uživateli inbo do logu.
public
addStatusMessage(string $message[, string $type = 'info' ][, object $caller = null ]) : bool
Parameters
- $message : string
-
text zpravy
- $type : string = 'info'
-
fronta
- $caller : object = null
-
Message source name
Return values
bool —message added
authentize()
Try to authentize user
public
authentize(mixed $plaintext) : bool
Parameters
- $plaintext : mixed
Return values
bool —cleanSatatusMessages()
Erase all status messages
public
cleanSatatusMessages() : bool
Return values
bool —dataReset()
Vynuluje všechny pole vlastností objektu.
public
dataReset() : mixed
Return values
mixed —draw()
Vykreslí GrAvatara uživatele.
public
draw() : mixed
Return values
mixed —encryptPassword()
Zašifruje heslo.
public
static encryptPassword(string $plainTextPassword) : string
Parameters
- $plainTextPassword : string
-
nešifrované heslo (plaintext)
Return values
string —Encrypted password
getData()
Obtain data holded by object
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDataCount()
Vrací počet položek dat objektu.
public
getDataCount() : int
Return values
int —getDataValue()
Vrací hodnotu z pole dat pro MySQL.
public
getDataValue(string $columnName) : mixed
Parameters
- $columnName : string
-
název hodnoty/sloupečku
Return values
mixed —getGravatar()
Get either a Gravatar URL or complete image tag for a specified email address.
public
static getGravatar(string $email[, int $size = 80 ][, string $default = 'mm' ][, string $maxRating = 'g' ]) : string
Parameters
- $email : string
-
The email address
- $size : int = 80
-
Size in pixels, defaults to 80px [ 1 - 512 ]
- $default : string = 'mm'
-
[ 404 | mm | identicon | monsterid | wavatar ]
- $maxRating : string = 'g'
-
Maximum rating (inclusive) [ g | pg | r | x ]
Tags
Return values
string —containing either just a URL or a complete image tag
getIcon()
Vrací odkaz na url ikony.
public
getIcon() : string
Return values
string —url ikony
getKeyColumn()
Gives you Current KeyColumn Name
public
getKeyColumn() : string
Return values
string —getLogger()
Provide logger object
public
getLogger([string|array<string|int, mixed> $options = null ]) : Regent
Parameters
- $options : string|array<string|int, mixed> = null
Return values
Regent —getMyKey()
Gives you value of KEY Column
public
getMyKey([array<string|int, mixed> $data = null ]) : int
Parameters
- $data : array<string|int, mixed> = null
-
data z nichž se vrací hodnota klíče
Return values
int —key column value
getName()
Vrací jméno objektu uživatele.
public
getName() : string
Return values
string —getObjectName()
Returns object name
public
getObjectName() : string
Return values
string —getPermission()
Vrací hodnotu uživatelského oprávnění.
public
getPermission([string $permKeyword = null ]) : mixed
Parameters
- $permKeyword : string = null
-
klíčové slovo oprávnění
Return values
mixed —getSettingValue()
Vrací hodnotu nastavení.
public
getSettingValue([string $settingName = null ]) : mixed
Parameters
- $settingName : string = null
-
jméno nastavení
Return values
mixed —getStatusMessages()
Obtain global status messages
public
getStatusMessages() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUserEmail()
Retrun user's mail address.
public
getUserEmail() : string
Return values
string —getUserID()
Vraci ID přihlášeného uživatele.
public
getUserID() : int
Return values
int —ID uživatele
getUserLevel()
Anonymous has a level
public
getUserLevel() : int
Return values
int —getUserLogin()
Vrací login uživatele.
public
getUserLogin() : string
Return values
string —getUserName()
Give you user name.
public
getUserName() : string
Return values
string —howToProcess()
How to process
public
howToProcess(mixed $identifer) : string
Parameters
- $identifer : mixed
Return values
string —id|name|values|reuse|unknown
isAccountEnabled()
Je učet povolen ?
public
isAccountEnabled() : bool
Return values
bool —isLogged()
Anonymous cannot be logged.
public
isLogged() : bool
Return values
bool —FALSE
loadPermissions()
Načte oprávnění.
public
loadPermissions() : mixed
Return values
mixed —logBanner()
Add Info about used PHP and EasePHP Library
public
logBanner([string $prefix = '' ][, string $suffix = '' ]) : mixed
Parameters
- $prefix : string = ''
-
banner prefix text (default is APPName)
- $suffix : string = ''
-
banner suffix text
Return values
mixed —loginSuccess()
Akce provedené po úspěšném přihlášení pokud tam jeste neexistuje zaznam, vytvori se novy.
public
loginSuccess() : bool
Return values
bool —logout()
Provede odhlášení uživatele.
public
logout() : bool
Return values
bool —true - always logged off
passwordChange()
Změní uživateli uložené heslo.
public
passwordChange(string $newPassword) : bool
Parameters
- $newPassword : string
-
nové heslo
Return values
bool —success
passwordValidation()
Ověření hesla.
public
static passwordValidation(string $plainPassword, string $encryptedPassword) : bool
Parameters
- $plainPassword : string
-
heslo v nešifrované podobě
- $encryptedPassword : string
-
šifrovné heslo
Return values
bool —remoteToIdentity()
Returns user identity with logname if logged
public
static remoteToIdentity() : string
Return values
string —setData()
Načte $data do polí objektu.
public
setData(array<string|int, mixed> $data[, bool $reset = false ]) : int
Parameters
- $data : array<string|int, mixed>
-
asociativní pole dat
- $reset : bool = false
-
vyprazdnit pole před naplněním ?
Return values
int —počet načtených položek
setDataValue()
Set data filed value
public
setDataValue(string $columnName, mixed $value) : bool
Parameters
- $columnName : string
-
název datové kolonky
- $value : mixed
-
hodnota dat
Return values
bool —Success
setInit()
Object init value stub
public
setInit(mixed $init) : mixed
Parameters
- $init : mixed
Return values
mixed —setKeyColumn()
Nastaví jméno klíčového sloupečku v shopu.
public
setKeyColumn(string $keyColumn) : mixed
Parameters
- $keyColumn : string
Return values
mixed —setMyKey()
Nastavuje hodnotu klíčového políčka pro SQL.
public
setMyKey(int|string $myKeyValue) : bool
Parameters
- $myKeyValue : int|string
Return values
bool —setObjectName()
Nastavení jména objektu uživatele.
public
setObjectName([string $objectName = null ]) : string
Parameters
- $objectName : string = null
-
vynucené jméno objektu
Return values
string —setProperties()
Set/override object properties objectName and keyColumn
public
setProperties([array<string|int, mixed> $properties = [] ]) : mixed
Parameters
- $properties : array<string|int, mixed> = []
Return values
mixed —setSettings()
Nastavuje nastavení.
public
setSettings(array<string|int, mixed> $settings) : mixed
Parameters
- $settings : array<string|int, mixed>
-
asociativní pole nastavení
Return values
mixed —setSettingValue()
Nastaví položku nastavení.
public
setSettingValue(string $settingName, mixed $settingValue) : mixed
Parameters
- $settingName : string
-
klíčové slovo pro nastavení
- $settingValue : mixed
-
hodnota nastavení
Return values
mixed —setupProperty()
Set up one of the properties by 1) array 2) ENV 3) Constant
public
setupProperty(array<string|int, mixed> $options, string $name[, string $constant = '' ]) : mixed
Parameters
- $options : array<string|int, mixed>
-
array of given availble properties
- $name : string
-
name of property to set up
- $constant : string = ''
-
load default property value from constant / ENV
Return values
mixed —setUserLogin()
Nastavuje login uživatele.
public
setUserLogin(mixed $login) : bool
Parameters
- $login : mixed
Return values
bool —singleton()
Common instance of User class
public
static singleton([mixed $user = null ]) : User
Parameters
- $user : mixed = null
Return values
User —takeData()
Převezme data do aktuálního pole dat.
public
takeData(array<string|int, mixed> $data) : int
Parameters
- $data : array<string|int, mixed>
-
asociativní pole dat
Return values
int —tryToLogin()
Pokusí se o přihlášení.
public
tryToLogin(array<string|int, mixed> $formData) : null|bool
Try to Sign in.
Parameters
- $formData : array<string|int, mixed>
-
pole dat z přihlaš. formuláře např. $_REQUEST
Return values
null|bool —unsetDataValue()
Odstrani polozku z pole dat pro MySQL.
public
unsetDataValue(string $columnName) : bool
Parameters
- $columnName : string
-
název klíče k vymazání
Return values
bool —success
useIdentifier()
Use Given value as identifier
public
useIdentifier(mixed $identifier) : mixed
Parameters
- $identifier : mixed
Return values
mixed —validatePassword()
Try to validate Password
public
validatePassword(string $password) : bool
Parameters
- $password : string
-
plaintext