Documentation

GuestUser extends AccountModel
in package

Guest User Model

Table of Contents

Constants

ROLE_ID  = 1

Properties

$email  : null
$id  : int
$nickname  : null
$permissions  : array<string|int, mixed>
$table_name  : string|null
$username  : null
$db_row  : Row
$is_first_save  : bool
$keyField  : string|array<string|int, mixed>
$loadedObjects  : array<string|int, mixed>
$roleObj  : Role
$original_data  : array<string|int, mixed>|null

Methods

__call()  : mixed
{@inheritdoc}
__construct()  : mixed
class constructor
__get()  : mixed
{@inheritdoc}
__isset()  : bool
{@inheritdoc}
__set()  : void
{@inheritdoc}
__unset()  : void
{@inheritdoc}
checkLoaded()  : self
ensures model is loaded
checkPermission()  : bool
checks if user has permission
current()  : mixed
{@inheritdoc}
defaultTableName()  : string
gets model table name
delete()  : self
removes model from db
fill()  : self
fills empty model with data
getChangedData()  : array<string|int, mixed>|null
gets model's changed data
getCollection()  : BaseCollection
returns a Model collection
getCreatedAt()  : DateTime
gets user creation date
getData()  : mixed
gets model's data
getDbRow()  : Row
getEmail()  : null
gets user email
getId()  : int
gets user id
getIterator()  : Traversable|ArrayIterator
{@inheritdoc}
getJWT()  : string
getKeyField()  : string|array<string|int, mixed>
getKeyFieldValue()  : mixed
getLocale()  : string
gets user locale
getNickname()  : null
gets user nickname
getPassword()  : null
gets user password
getRole()  : Role
gets user role
getRoleId()  : int
gets user role id
getSearchCollection()  : BaseCollection
returns a Model collection using SearchManager for finding elements
getTableColumns()  : mixed
getUpdatedAt()  : DateTime
gets user last update time
getUsername()  : null
gets username
getUserSession()  : mixed
no user session for this model
hydrateStatementResult()  : array<string|int, mixed>
returns an array of models, starting from a statement Result
isFirstSave()  : bool
is first save flag
isLoaded()  : bool
checks if model is loaded
isNew()  : bool
checks if model is new
key()  : mixed
{@inheritdoc}
load()  : self
loads model by id
loadBy()  : self
loads model by field - value pair
loadByCondition()  : self|null
loads model by condition
new()  : static
gets new empty model
next()  : mixed
{@inheritdoc}
offsetExists()  : bool
{@inheritdoc}
offsetGet()  : mixed
{@inheritdoc}
offsetSet()  : void
{@inheritdoc}
offsetUnset()  : void
{@inheritdoc}
persist()  : self
no save for this model
postLoad()  : self
post load hook
postPersist()  : self
post persist hook
postRemove()  : self
post remove hook
prePersist()  : self
pre persist hook
preRemove()  : self
pre remove hook
remove()  : self
no delete for this model
reset()  : self
resets model
rewind()  : mixed
{@inheritdoc}
save()  : self
saves model on db
select()  : PDOStatement
basic select statement
setData()  : self
sets model's data
setDbRow()  : self
setIsFirstSave()  : $this
sets is first save flag
setTableName()  : self
toJson()  : string
gets Model json rapresentation
valid()  : mixed
{@inheritdoc}
getModelBasicWhere()  : Result
gets basic where statement for model
getModelName()  : string
gets object model name
getOriginalData()  : mixed
gets model's original data
getTableName()  : string
gets table name
loadedObjectsIdentifier()  : string
setOriginalData()  : $this
sets model's original data
checkDbName()  : self
checks if Row object is from correct table

Constants

Properties

$nickname

public null $nickname = null

nickname

$permissions

public array<string|int, mixed> $permissions = []

permissions

$table_name

public string|null $table_name = null

table name

$username

public null $username = null

username

$db_row

protected Row $db_row = null

database row

$is_first_save

protected bool $is_first_save

first save flag

$keyField

protected static string|array<string|int, mixed> $keyField = 'id'

$loadedObjects

protected static array<string|int, mixed> $loadedObjects = []

objects cache

$original_data

private array<string|int, mixed>|null $original_data = null

original model data

Methods

__call()

{@inheritdoc}

public __call(string $name, mixed $arguments) : mixed
Parameters
$name : string
$arguments : mixed
Tags
throws
Exception

__construct()

class constructor

public __construct([Row|null $db_row = null ]) : mixed
Parameters
$db_row : Row|null = null
Tags
throws
Exception

__get()

{@inheritdoc}

public __get(mixed $key) : mixed
Parameters
$key : mixed

__isset()

{@inheritdoc}

public __isset(mixed $name) : bool
Parameters
$name : mixed
Return values
bool

__set()

{@inheritdoc}

public __set(mixed $key, mixed $value) : void
Parameters
$key : mixed
$value : mixed

__unset()

{@inheritdoc}

public __unset(mixed $name) : void
Parameters
$name : mixed

checkLoaded()

ensures model is loaded

public checkLoaded() : self
Tags
throws
Exception
Return values
self

checkPermission()

checks if user has permission

public checkPermission(string $permission_name) : bool
Parameters
$permission_name : string
Tags
throws
Exception
Return values
bool

current()

{@inheritdoc}

public current() : mixed

defaultTableName()

gets model table name

public static defaultTableName() : string
Return values
string

delete()

removes model from db

public delete() : self
Tags
throws
BasicException
Return values
self

fill()

fills empty model with data

public fill(int|Row $id) : self
Parameters
$id : int|Row
Tags
throws
InvalidValueException
throws
BasicException
Return values
self

getChangedData()

gets model's changed data

public getChangedData() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getCreatedAt()

gets user creation date

public getCreatedAt() : DateTime
Return values
DateTime

getData()

gets model's data

public getData([mixed|null $column = null ]) : mixed
Parameters
$column : mixed|null = null

getDbRow()

public getDbRow() : Row
Return values
Row —

database row

getEmail()

gets user email

public getEmail() : null
Return values
null

getId()

gets user id

public getId() : int
Return values
int

getIterator()

{@inheritdoc}

public getIterator() : Traversable|ArrayIterator
Return values
Traversable|ArrayIterator

getJWT()

public getJWT() : string
Return values
string

getKeyField()

public static getKeyField() : string|array<string|int, mixed>
Return values
string|array<string|int, mixed>

getKeyFieldValue()

public getKeyFieldValue() : mixed

getLocale()

gets user locale

public getLocale() : string
Tags
throws
BasicException
throws
DependencyException
throws
NotFoundException
Return values
string

getNickname()

gets user nickname

public getNickname() : null
Return values
null

getPassword()

gets user password

public getPassword() : null
Return values
null

getRoleId()

gets user role id

public getRoleId() : int
Return values
int

getSearchCollection()

returns a Model collection using SearchManager for finding elements

public static getSearchCollection([array<string|int, mixed> $conditions = [] ]) : BaseCollection
Parameters
$conditions : array<string|int, mixed> = []
Return values
BaseCollection

getTableColumns()

public static getTableColumns() : mixed

getUpdatedAt()

gets user last update time

public getUpdatedAt() : DateTime
Return values
DateTime

getUsername()

gets username

public getUsername() : null
Return values
null

getUserSession()

no user session for this model

public getUserSession() : mixed

hydrateStatementResult()

returns an array of models, starting from a statement Result

public static hydrateStatementResult(Result $stmt) : array<string|int, mixed>
Parameters
$stmt : Result
Tags
throws
DependencyException
throws
NotFoundException
Return values
array<string|int, mixed>

isFirstSave()

is first save flag

public isFirstSave() : bool
Return values
bool

isLoaded()

checks if model is loaded

public isLoaded() : bool
Return values
bool

isNew()

checks if model is new

public isNew() : bool
Return values
bool

load()

loads model by id

public static load(mixed $id[, bool $reset = false ]) : self
Parameters
$id : mixed
$reset : bool = false
Return values
self

loadBy()

loads model by field - value pair

public static loadBy(string $field, mixed $value) : self
Parameters
$field : string
$value : mixed
Tags
throws
BasicException
throws
DependencyException
throws
NotFoundException
Return values
self

loadByCondition()

loads model by condition

public static loadByCondition(array<string|int, mixed> $condition) : self|null
Parameters
$condition : array<string|int, mixed>
Tags
throws
BasicException
throws
DependencyException
throws
NotFoundException
Return values
self|null

new()

gets new empty model

public static new([array<string|int, mixed> $initial_data = [] ]) : static
Parameters
$initial_data : array<string|int, mixed> = []
Tags
throws
InvalidValueException
throws
BasicException
Return values
static

offsetExists()

{@inheritdoc}

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

{@inheritdoc}

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

offsetSet()

{@inheritdoc}

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

offsetUnset()

{@inheritdoc}

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

persist()

no save for this model

public persist([bool $recursive = true ]) : self
Parameters
$recursive : bool = true
Return values
self

postLoad()

post load hook

public postLoad() : self
Return values
self

postPersist()

post persist hook

public postPersist() : self
Return values
self

postRemove()

post remove hook

public postRemove() : self
Return values
self

prePersist()

pre persist hook

public prePersist() : self
Return values
self

preRemove()

pre remove hook

public preRemove() : self
Return values
self

remove()

no delete for this model

public remove() : self
Return values
self

reset()

resets model

public reset() : self
Tags
throws
BasicException
Return values
self

rewind()

{@inheritdoc}

public rewind() : mixed

save()

saves model on db

public save() : self
Tags
throws
BasicException
Return values
self

select()

basic select statement

public static select([array<string|int, mixed> $options = [] ]) : PDOStatement
Parameters
$options : array<string|int, mixed> = []
Return values
PDOStatement

setData()

sets model's data

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

setDbRow()

public setDbRow(Row $db_row) : self
Parameters
$db_row : Row
Return values
self

setIsFirstSave()

sets is first save flag

public setIsFirstSave(bool $is_first_save) : $this
Parameters
$is_first_save : bool
Return values
$this

setTableName()

public setTableName(string $table_name) : self
Parameters
$table_name : string
Return values
self

toJson()

gets Model json rapresentation

public toJson([int $level = 0 ]) : string
Parameters
$level : int = 0

internally used

Return values
string

valid()

{@inheritdoc}

public valid() : mixed

getModelBasicWhere()

gets basic where statement for model

protected static getModelBasicWhere([array<string|int, mixed>|null $condition = [] ][, array<string|int, mixed> $order = [] ]) : Result
Parameters
$condition : array<string|int, mixed>|null = []
$order : array<string|int, mixed> = []
Return values
Result

getModelName()

gets object model name

protected getModelName() : string
Return values
string

getOriginalData()

gets model's original data

protected getOriginalData([mixed|null $key = null ]) : mixed
Parameters
$key : mixed|null = null

getTableName()

gets table name

protected getTableName() : string
Return values
string

loadedObjectsIdentifier()

protected static loadedObjectsIdentifier(mixed $id) : string
Parameters
$id : mixed
Return values
string

setOriginalData()

sets model's original data

protected setOriginalData(array<string|int, mixed>|null $original_data) : $this
Parameters
$original_data : array<string|int, mixed>|null
Return values
$this

checkDbName()

checks if Row object is from correct table

private checkDbName(Row $db_row) : self
Parameters
$db_row : Row
Tags
throws
InvalidValueException
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results