Documentation

Anonym extends Brick
in package
implements Person

Anonymous User Class.

Interfaces, Classes, Traits and Enums

Person

Table of Contents

$data  : array<string|int, mixed>|null
Common object data holder.
$debug  : bool
Debug mode flag.
$easeShared  : Shared
Sdílený objekt frameworku.
$keyColumn  : string
Key Column for Current Record.
$langCode  : string|null
Default Language Code.
$logged  : bool
Login indicator.
$logger  : Regent|null
Objekt pro logování.
$nameColumn  : string
$objectName  : string
Object name.
$parentObject  : mixed|Sand
Odkaz na vlastnící objekt.
$settings  : array<string|int, mixed>
User Settings array.
$settingsColumn  : string
Where to look for settings.
$type  : string
User type.
$userID  : int|null
An Anonymous user ID is always null.
__construct()  : mixed
Ease Brick Class.
__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.
cleanSatatusMessages()  : bool
Erase all status messages.
dataReset()  : void
Vynuluje všechny pole vlastností objektu.
draw()  : string
Default draw method.
getData()  : array<string|int, mixed>|null
Obtain data holded by object.
getDataCount()  : int
Vrací počet položek dat objektu.
getDataValue()  : mixed
Vrací hodnotu z pole dat pro MySQL.
getKeyColumn()  : string
Gives you Current KeyColumn Name.
getLogger()  : Regent
Provide logger object.
getMyKey()  : int
Gives you value of KEY Column.
getObjectName()  : string
Returns object name.
getPermission()  : string|null
Fake permissions.
getSettingValue()  : string|null
Anonymous has no settings.
getStatusMessages()  : array<string|int, Message>
Obtain global status messages.
getUserEmail()  : string
Anonymous has no mail.
getUserID()  : int
Anonymous has no ID.
getUserLevel()  : int
Anonymous has a level.
getUserLogin()  : string
Anonymous has no login.
howToProcess()  : string
How to process.
isLogged()  : bool
Anonymous cannot be logged.
logBanner()  : void
Add Info about used PHP and EasePHP Library.
logout()  : bool
Just fake.
remoteToIdentity()  : string
Returns user identity with logname if logged.
setData()  : int
Načte $data do polí objektu.
setDataValue()  : bool
Set data filed value.
setInit()  : void
Object init value stub.
setKeyColumn()  : void
Nastaví jméno klíčového sloupečku v shopu.
setMyKey()  : bool
Nastavuje hodnotu klíčového políčka pro SQL.
setObjectName()  : string
User object name setting.
setProperties()  : void
Set/override object properties objectName and keyColumn.
setSettingValue()  : bool
Sets to: has no settings.
setupBoolProperty()  : void
Set up one of the properties by 1) array 2) ENV 3) Constant to bool value.
setupIntProperty()  : void
Set up one of the properties by 1) array 2) ENV 3) Constant to int value.
setupProperty()  : void
Set up one of the properties by 1) array 2) ENV 3) Constant.
takeData()  : int
Převezme data do aktuálního pole dat.
tryToLogin()  : bool
Anonym cannot be signed in.
unsetDataValue()  : bool
Odstrani polozku z pole dat pro MySQL.
useIdentifier()  : void
Use Given value as identifier.

Properties

$data

Common object data holder.

public array<string|int, mixed>|null $data = null

$debug

Debug mode flag.

public bool $debug = false

$easeShared

Sdílený objekt frameworku.

public Shared $easeShared

$keyColumn

Key Column for Current Record.

public string $keyColumn = 'id'

$langCode

Default Language Code.

public string|null $langCode = null

$logged

Login indicator.

public bool $logged = false

$nameColumn

public string $nameColumn = ''

Name Column

$objectName

Object name.

public string $objectName = 'Molecule'

$parentObject

Odkaz na vlastnící objekt.

public mixed|Sand $parentObject

object

$settings

User Settings array.

public array<string|int, mixed> $settings = []
Tags
phpstan-ignore

missingType.iterableValue

$settingsColumn

Where to look for settings.

public string $settingsColumn = 'settings'

$type

User type.

public string $type = 'Anonymous'

$userID

An Anonymous user ID is always null.

public int|null $userID = null

Methods

__construct()

Ease Brick Class.

public __construct([null|mixed $init = null ][, mixed $properties = [] ]) : mixed
Parameters
$init : null|mixed = null
$properties : mixed = []
Return values
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

cleanSatatusMessages()

Erase all status messages.

public cleanSatatusMessages() : bool
Return values
bool

dataReset()

Vynuluje všechny pole vlastností objektu.

public dataReset() : void
Return values
void

draw()

Default draw method.

public draw() : string
Return values
string

getData()

Obtain data holded by object.

public getData() : array<string|int, mixed>|null
Tags
phpstan-ignore

missingType.iterableValue

Return values
array<string|int, mixed>|null

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

getKeyColumn()

Gives you Current KeyColumn Name.

public getKeyColumn() : string
Return values
string

getLogger()

Provide logger object.

public getLogger([array<string, string> $options = null ]) : Regent
Parameters
$options : array<string, string> = null
Return values
Regent

getMyKey()

Gives you value of KEY Column.

public getMyKey([array<string, string> $data = [] ]) : int
Parameters
$data : array<string, string> = []

data z nichž se vrací hodnota klíče

Return values
int

key column value

getObjectName()

Returns object name.

public getObjectName() : string
Return values
string

getPermission()

Fake permissions.

public getPermission(string $permKeyword) : string|null
Parameters
$permKeyword : string

permission keyword

Return values
string|null

getSettingValue()

Anonymous has no settings.

public getSettingValue(string $settingName) : string|null
Parameters
$settingName : string

settings-key name

Return values
string|null

getStatusMessages()

Obtain global status messages.

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

messages

getUserEmail()

Anonymous has no mail.

public getUserEmail() : string
Return values
string

getUserID()

Anonymous has no ID.

public getUserID() : int
Return values
int

getUserLevel()

Anonymous has a level.

public getUserLevel() : int
Return values
int

getUserLogin()

Anonymous has no login.

public getUserLogin() : string
Return values
string

howToProcess()

How to process.

public howToProcess(mixed $identifer) : string
Parameters
$identifer : mixed
Return values
string

id|name|values|reuse|unknown

isLogged()

Anonymous cannot be logged.

public isLogged() : bool
Return values
bool

FALSE

logBanner()

Add Info about used PHP and EasePHP Library.

public logBanner([string $prefix = '' ][, string $suffix = '' ]) : void
Parameters
$prefix : string = ''

banner prefix text (default is APPName)

$suffix : string = ''

banner suffix text

Return values
void

logout()

Just fake.

public logout() : bool
Return values
bool

true - always logged off

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 ?

Tags
phpstan-ignore

missingType.iterableValue

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) : void
Parameters
$init : mixed
Return values
void

setKeyColumn()

Nastaví jméno klíčového sloupečku v shopu.

public setKeyColumn(string $keyColumn) : void
Parameters
$keyColumn : string
Return values
void

setMyKey()

Nastavuje hodnotu klíčového políčka pro SQL.

public setMyKey(int|string $myKeyValue) : bool
Parameters
$myKeyValue : int|string
Return values
bool

setObjectName()

User object name setting.

public setObjectName([string $objectName = null ]) : string
Parameters
$objectName : string = null

forced object name

Return values
string

new name

setProperties()

Set/override object properties objectName and keyColumn.

public setProperties([array<string|int, mixed> $properties = [] ]) : void
Parameters
$properties : array<string|int, mixed> = []
Tags
phpstan-ignore

missingType.iterableValue

Return values
void

setSettingValue()

Sets to: has no settings.

public setSettingValue(mixed $settingName, mixed $settingValue) : bool
Parameters
$settingName : mixed
$settingValue : mixed
Return values
bool

setupBoolProperty()

Set up one of the properties by 1) array 2) ENV 3) Constant to bool value.

public setupBoolProperty(array<string, string> $options, string $name[, string $constant = '' ]) : void
Parameters
$options : array<string, string>

array of given availble properties

$name : string

name of property to set up

$constant : string = ''

load default property value from constant / ENV

Return values
void

setupIntProperty()

Set up one of the properties by 1) array 2) ENV 3) Constant to int value.

public setupIntProperty(array<string, string> $options, string $name[, string $constant = '' ]) : void
Parameters
$options : array<string, string>

array of given available properties

$name : string

name of property to set up

$constant : string = ''

load default property value from constant / ENV

Return values
void

setupProperty()

Set up one of the properties by 1) array 2) ENV 3) Constant.

public setupProperty(array<string, string> $options, string $name[, string $constant = '' ]) : void
Parameters
$options : array<string, string>

array of given available properties

$name : string

name of property to set up

$constant : string = ''

load default property value from constant / ENV

Return values
void

takeData()

Převezme data do aktuálního pole dat.

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

tryToLogin()

Anonym cannot be signed in.

public tryToLogin(array<string|int, mixed> $formData) : bool
Parameters
$formData : array<string|int, mixed>
Tags
phpstan-ignore

missingType.iterableValue

Return values
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) : void
Parameters
$identifier : mixed
Return values
void

Search results